#!/usr/bin/env python3 # # MMGen Wallet, a terminal-based cryptocurrency wallet # Copyright (C)2013-2024 The MMGen Project # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . """ test.cmdtest_d.ct_ref: Reference file tests for the cmdtest.py test suite """ import os from mmgen.util import capfirst from mmgen.wallet import get_wallet_cls from ..include.common import ( cfg, imsg_r, ok, joinpath, cmp_or_die, ref_kafile_pass, read_from_file, sample_text ) from .common import ( dfl_words_file, ref_dir, chksum_pat, pwfile, ref_bw_file_spc, ref_enc_fn, get_env_without_debug_vars, tool_enc_passwd, skip ) from .ct_base import CmdTestBase from .ct_shared import CmdTestShared wpasswd = 'reference password' class CmdTestRef(CmdTestBase, CmdTestShared): 'saved reference address, password and transaction files' tmpdir_nums = [8] networks = ('btc', 'btc_tn', 'ltc', 'ltc_tn') passthru_opts = ('daemon_data_dir', 'rpc_port', 'coin', 'testnet') need_daemon = True sources = { 'ref_addrfile': '98831F3A{}[1,31-33,500-501,1010-1011]{}.addrs', 'ref_segwitaddrfile':'98831F3A{}-S[1,31-33,500-501,1010-1011]{}.addrs', 'ref_bech32addrfile':'98831F3A{}-B[1,31-33,500-501,1010-1011]{}.addrs', 'ref_keyaddrfile': '98831F3A{}[1,31-33,500-501,1010-1011]{}.akeys.mmenc', 'ref_viewkeyaddrfile': '98831F3A-XMR-M[1-3].vkeys', 'ref_passwdfile_b32_24': '98831F3A-фубар@crypto.org-b32-24[1,4,1100].pws', 'ref_passwdfile_b32_12': '98831F3A-фубар@crypto.org-b32-12[1,4,1100].pws', 'ref_passwdfile_b58_10': '98831F3A-фубар@crypto.org-b58-10[1,4,1100].pws', 'ref_passwdfile_b58_20': '98831F3A-фубар@crypto.org-b58-20[1,4,1100].pws', 'ref_passwdfile_hex_32': '98831F3A-фубар@crypto.org-hex-32[1,4,1100].pws', 'ref_passwdfile_hex_48': '98831F3A-фубар@crypto.org-hex-48[1,4,1100].pws', 'ref_passwdfile_hex_64': '98831F3A-фубар@crypto.org-hex-64[1,4,1100].pws', 'ref_passwdfile_bip39_12': '98831F3A-фубар@crypto.org-bip39-12[1,4,1100].pws', 'ref_passwdfile_bip39_18': '98831F3A-фубар@crypto.org-bip39-18[1,4,1100].pws', 'ref_passwdfile_bip39_24': '98831F3A-фубар@crypto.org-bip39-24[1,4,1100].pws', 'ref_passwdfile_xmrseed_25': '98831F3A-фубар@crypto.org-xmrseed-25[1,4,1100].pws', 'ref_passwdfile_hex2bip39_12': '98831F3A-фубар@crypto.org-hex2bip39-12[1,4,1100].pws', 'ref_tx_file': { # data shared with ref_altcoin, autosign 'btc': ( '0B8D5A[15.31789,14,tl=1320969600].rawtx', '0C7115[15.86255,14,tl=1320969600].testnet.rawtx' ), 'ltc': ( 'AF3CDF-LTC[620.76194,1453,tl=1320969600].rawtx', 'A5A1E0-LTC[1454.64322,1453,tl=1320969600].testnet.rawtx' ), 'bch': ( '460D4D-BCH[10.19764,tl=1320969600].rawtx', '359FD5-BCH[6.68868,tl=1320969600].testnet.rawtx' ), 'eth': ( '88FEFD-ETH[23.45495,40000].rawtx', 'B472BD-ETH[23.45495,40000].testnet.rawtx' ), 'mm1': ( '5881D2-MM1[1.23456,50000].rawtx', '6BDB25-MM1[1.23456,50000].testnet.rawtx' ), 'etc': ( 'ED3848-ETC[1.2345,40000].rawtx', '' ) }, } chk_data = { 'ref_subwallet_sid': { '98831F3A:32L':'D66B4885', '98831F3A:1S':'20D95B09', }, 'ref_addrfile_chksum': { 'btc': ('6FEF 6FB9 7B13 5D91', '424E 4326 CFFE 5F51'), 'ltc': ('AD52 C3FE 8924 AAF0', '4EBE 2E85 E969 1B30'), }, 'ref_segwitaddrfile_chksum': { 'btc': ('06C1 9C87 F25C 4EE6', '072C 8B07 2730 CB7A'), 'ltc': ('63DF E42A 0827 21C3', '5DD1 D186 DBE1 59F2'), }, 'ref_bech32addrfile_chksum': { 'btc': ('9D2A D4B6 5117 F02E', '0527 9C39 6C1B E39A'), 'ltc': ('FF1C 7939 5967 AB82', 'ED3D 8AA4 BED4 0B40'), }, 'ref_keyaddrfile_chksum': { 'btc': ('9F2D D781 1812 8BAD', '88CC 5120 9A91 22C2'), 'ltc': ('B804 978A 8796 3ED4', '98B5 AC35 F334 0398'), }, 'ref_passwdfile_b32_12_chksum': '7252 CD8D EF0D 3DB1', 'ref_passwdfile_b32_24_chksum': '8D56 3845 A072 A5B9', 'ref_passwdfile_b58_10_chksum': '534F CC1A 6701 9FED', 'ref_passwdfile_b58_20_chksum': 'DDD9 44B0 CA28 183F', 'ref_passwdfile_hex_32_chksum': '05C7 3678 E25E BC32', 'ref_passwdfile_hex_48_chksum': '7DBB FFD0 633E DE6F', 'ref_passwdfile_hex_64_chksum': 'F11D CB0A 8AE3 4D21', 'ref_passwdfile_bip39_12_chksum': 'BF57 02A3 5229 CF18', 'ref_passwdfile_bip39_18_chksum': '31D3 1656 B7DC 27CF', 'ref_passwdfile_bip39_24_chksum': 'E565 3A59 7D91 4671', 'ref_passwdfile_xmrseed_25_chksum': 'B488 21D3 4539 968D', 'ref_passwdfile_hex2bip39_12_chksum': '93AD 4AE2 03D1 8A0A', } cmd_group = ( # TODO: move to tooltest2 ('ref_words_to_subwallet_chk1', 'subwallet generation from reference words file (long subseed)'), ('ref_words_to_subwallet_chk2', 'subwallet generation from reference words file (short subseed)'), ('ref_subwallet_addrgen1', 'subwallet address file generation (long subseed)'), ('ref_subwallet_addrgen2', 'subwallet address file generation (short subseed)'), ('ref_subwallet_keygen1', 'subwallet key-address file generation (long subseed)'), ('ref_subwallet_keygen2', 'subwallet key-address file generation (short subseed)'), ('ref_addrfile_chk', 'saved reference address file'), ('ref_segwitaddrfile_chk', 'saved reference address file (segwit)'), ('ref_bech32addrfile_chk', 'saved reference address file (bech32)'), ('ref_keyaddrfile_chk', 'saved reference key-address file'), ('ref_passwdfile_chk_b58_20', 'saved reference password file (base58, 20 chars)'), ('ref_passwdfile_chk_b58_10', 'saved reference password file (base58, 10 chars)'), ('ref_passwdfile_chk_b32_24', 'saved reference password file (base32, 24 chars)'), ('ref_passwdfile_chk_b32_12', 'saved reference password file (base32, 12 chars)'), ('ref_passwdfile_chk_hex_32', 'saved reference password file (hexadecimal, 32 chars)'), ('ref_passwdfile_chk_hex_48', 'saved reference password file (hexadecimal, 48 chars)'), ('ref_passwdfile_chk_hex_64', 'saved reference password file (hexadecimal, 64 chars)'), ('ref_passwdfile_chk_bip39_12', 'saved reference password file (BIP39, 12 words)'), ('ref_passwdfile_chk_bip39_18', 'saved reference password file (BIP39, 18 words)'), ('ref_passwdfile_chk_bip39_24', 'saved reference password file (BIP39, 24 words)'), ('ref_passwdfile_chk_xmrseed_25', 'saved reference password file (Monero new-style mnemonic, 25 words)'), ('ref_passwdfile_chk_hex2bip39_12', 'saved reference password file (hex-to-BIP39, 12 words)'), # Create the fake inputs: # ('txcreate8', 'transaction creation (8)'), ('ref_tx_chk', 'signing saved reference tx file'), ('ref_brain_chk_spc3', 'saved brainwallet (non-standard spacing)'), ('ref_dieroll_chk_seedtruncate', 'saved dieroll wallet with extra entropy bits'), ('ref_tool_decrypt', 'decryption of saved MMGen-encrypted file'), ) @property def nw_desc(self): return '{} {}'.format( self.proto.coin, ('Mainnet','Testnet')[self.proto.testnet]) def _get_ref_subdir_by_coin(self,coin): return { 'btc': '', 'bch': '', 'ltc': 'litecoin', 'eth': 'ethereum', 'etc': 'ethereum_classic', 'xmr': 'monero', 'zec': 'zcash', 'dash': 'dash' }[coin.lower()] @property def ref_subdir(self): return self._get_ref_subdir_by_coin(self.proto.coin) def ref_words_to_subwallet_chk1(self): return self.ref_words_to_subwallet_chk('32L') def ref_words_to_subwallet_chk2(self): return self.ref_words_to_subwallet_chk('1S') def ref_words_to_subwallet_chk(self, ss_idx): wf = dfl_words_file ocls = get_wallet_cls('words') args = ['-d', self.tr.trash_dir, '-o', ocls.fmt_codes[-1], wf, ss_idx] t = self.spawn( 'mmgen-subwalletgen', self.testnet_opt + args, extra_desc = '(generate subwallet)', no_passthru_opts = True) t.expect(f'Generating subseed {ss_idx}') chk_sid = self.chk_data['ref_subwallet_sid'][f'98831F3A:{ss_idx}'] fn = t.written_to_file(capfirst(ocls.desc)) assert chk_sid in fn, f'incorrect filename: {fn} (does not contain {chk_sid})' ok() t = self.spawn( 'mmgen-walletchk', self.testnet_opt + [fn], extra_desc = '(check subwallet)', no_passthru_opts = True) t.expect(r'Valid MMGen native mnemonic data for Seed ID ([0-9A-F]*)\b', regex=True) sid = t.p.match.group(1) assert sid == chk_sid, f'subseed ID {sid} does not match expected value {chk_sid}' return t def ref_subwallet_addrgen(self, ss_idx, target='addr'): wf = dfl_words_file args = ['-d', self.tr.trash_dir, '--subwallet='+ss_idx, wf, '1-10'] t = self.spawn(f'mmgen-{target}gen', args) t.expect(f'Generating subseed {ss_idx}') chk_sid = self.chk_data['ref_subwallet_sid'][f'98831F3A:{ss_idx}'] assert chk_sid == t.expect_getend('Checksum for .* data ', regex=True)[:8] if target == 'key': t.expect('Encrypt key list? (y/N): ', 'n') fn = t.written_to_file(('Addresses', 'Secret keys')[target=='key']) assert chk_sid in fn, f'incorrect filename: {fn} (does not contain {chk_sid})' return t def ref_subwallet_addrgen1(self): return self.ref_subwallet_addrgen('32L') def ref_subwallet_addrgen2(self): return self.ref_subwallet_addrgen('1S') def ref_subwallet_keygen1(self): return self.ref_subwallet_addrgen('32L', target='key') def ref_subwallet_keygen2(self): return self.ref_subwallet_addrgen('1S', target='key') def ref_addrfile_chk( self, ftype = 'addr', coin = None, subdir = None, pfx = None, mmtype = None, id_key = None, pat = None): pat = pat or f'{self.nw_desc}.*Legacy' af_key = f'ref_{ftype}file' + ('_' + id_key if id_key else '') af_fn = CmdTestRef.sources[af_key].format(pfx or self.altcoin_pfx, '' if coin else self.tn_ext) af = joinpath(ref_dir, (subdir or self.ref_subdir, '')[ftype=='passwd'], af_fn) coin_arg = [] if coin is None else ['--coin='+coin] tool_cmd = ftype.replace('segwit', '').replace('bech32', '')+'file_chksum' t = self.spawn('mmgen-tool', coin_arg + ['--verbose', '-p1', tool_cmd, af]) if ftype == 'keyaddr': t.do_decrypt_ka_data(pw=ref_kafile_pass, have_yes_opt=True) chksum_key = '_'.join([af_key, 'chksum'] + ([coin.lower()] if coin else []) + ([mmtype] if mmtype else [])) rc = self.chk_data[chksum_key] ref_chksum = rc if (ftype == 'passwd' or coin) else rc[self.proto.base_coin.lower()][self.proto.testnet] if pat: t.expect(pat, regex=True) t.expect(chksum_pat, regex=True) m = t.p.match.group(0) cmp_or_die(ref_chksum, m) return t def ref_segwitaddrfile_chk(self): if not 'S' in self.proto.mmtypes: return skip(f'not supported by {self.proto.cls_name} protocol') return self.ref_addrfile_chk(ftype='segwitaddr', pat=f'{self.nw_desc}.*Segwit') def ref_bech32addrfile_chk(self): if not 'B' in self.proto.mmtypes: return skip(f'not supported by {self.proto.cls_name} protocol') return self.ref_addrfile_chk(ftype='bech32addr', pat=f'{self.nw_desc}.*Bech32') def ref_keyaddrfile_chk(self): return self.ref_addrfile_chk(ftype='keyaddr') def ref_passwdfile_chk(self, key, pat): return self.ref_addrfile_chk(ftype='passwd', id_key=key, pat=pat) def ref_passwdfile_chk_b58_20(self): return self.ref_passwdfile_chk(key='b58_20', pat=r'Base58.*len.* 20\b') def ref_passwdfile_chk_b58_10(self): return self.ref_passwdfile_chk(key='b58_10', pat=r'Base58.*len.* 10\b') def ref_passwdfile_chk_b32_24(self): return self.ref_passwdfile_chk(key='b32_24', pat=r'Base32.*len.* 24\b') def ref_passwdfile_chk_b32_12(self): return self.ref_passwdfile_chk(key='b32_12', pat=r'Base32.*len.* 12\b') def ref_passwdfile_chk_hex_32(self): return self.ref_passwdfile_chk(key='hex_32', pat=r'Hexadec.*len.* 32\b') def ref_passwdfile_chk_hex_48(self): return self.ref_passwdfile_chk(key='hex_48', pat=r'Hexadec.*len.* 48\b') def ref_passwdfile_chk_hex_64(self): return self.ref_passwdfile_chk(key='hex_64', pat=r'Hexadec.*len.* 64\b') def ref_passwdfile_chk_bip39_12(self): return self.ref_passwdfile_chk(key='bip39_12', pat=r'BIP39.*len.* 12\b') def ref_passwdfile_chk_bip39_18(self): return self.ref_passwdfile_chk(key='bip39_18', pat=r'BIP39.*len.* 18\b') def ref_passwdfile_chk_bip39_24(self): return self.ref_passwdfile_chk(key='bip39_24', pat=r'BIP39.*len.* 24\b') def ref_passwdfile_chk_xmrseed_25(self): return self.ref_passwdfile_chk(key='xmrseed_25', pat=r'Mon.*len.* 25\b') def ref_passwdfile_chk_hex2bip39_12(self): return self.ref_passwdfile_chk(key='hex2bip39_12', pat=r'BIP39.*len.* 12\b') def ref_tx_chk(self): fn = self.sources['ref_tx_file'][self.coin][bool(self.tn_ext)] if not fn: return tf = joinpath(ref_dir, self.ref_subdir, fn) wf = dfl_words_file self.write_to_tmpfile(pwfile, wpasswd) return self.txsign(wf, tf, save=False, has_label=True, view='y') def ref_brain_chk_spc3(self): return self.ref_brain_chk(bw_file=ref_bw_file_spc) def ref_dieroll_chk_seedtruncate(self): wf = joinpath(ref_dir, 'overflow128.b6d') return self.walletchk(wf, sid='8EC6D4A2') def ref_tool_decrypt(self): f = joinpath(ref_dir, ref_enc_fn) dec_file = joinpath(self.tmpdir, 'famous.txt') t = self.spawn( 'mmgen-tool', ['-q', 'decrypt', f, 'outfile='+dec_file, 'hash_preset=1'], env = os.environ if cfg.debug_utf8 else get_env_without_debug_vars()) t.passphrase('data', tool_enc_passwd) t.written_to_file('Decrypted data') dec_txt = read_from_file(dec_file) imsg_r(dec_txt) cmp_or_die(sample_text+'\n', dec_txt) # file adds a newline to sample_text return t