ts_input.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2022 The MMGen Project <mmgen@tuta.io>
  5. #
  6. # Project source code repository: https://github.com/mmgen/mmgen
  7. # Licensed according to the terms of GPL Version 3. See LICENSE for details.
  8. """
  9. ts_input.py: user input tests for the MMGen test.py test suite
  10. """
  11. from ..include.common import *
  12. from .ts_base import *
  13. from .input import *
  14. from mmgen.wallet import Wallet
  15. class TestSuiteInput(TestSuiteBase):
  16. 'user input'
  17. networks = ('btc',)
  18. tmpdir_nums = []
  19. color = True
  20. cmd_group = (
  21. ('get_seed_from_stdin', (1,'reading seed phrase from STDIN', [])),
  22. ('get_passphrase_ui', (1,"hash preset, password and label (wallet.py)", [])),
  23. ('get_passphrase_cmdline', (1,"hash preset, password and label (wallet.py - from cmdline)", [])),
  24. ('get_passphrase_crypto', (1,"hash preset, password and label (crypto.py)", [])),
  25. ('password_entry_noecho', (1,"utf8 password entry", [])),
  26. ('password_entry_echo', (1,"utf8 password entry (echoed)", [])),
  27. ('mnemonic_entry_mmgen', (1,"stealth mnemonic entry (mmgen)", [])),
  28. ('mnemonic_entry_mmgen_minimal', (1,"stealth mnemonic entry (mmgen - minimal entry mode)", [])),
  29. ('mnemonic_entry_bip39', (1,"stealth mnemonic entry (bip39)", [])),
  30. ('mnemonic_entry_bip39_short', (1,"stealth mnemonic entry (bip39 - short entry mode)", [])),
  31. ('mn2hex_interactive_mmgen', (1,"mn2hex_interactive (mmgen)", [])),
  32. ('mn2hex_interactive_mmgen_fixed',(1,"mn2hex_interactive (mmgen - fixed (10-letter) entry mode)", [])),
  33. ('mn2hex_interactive_bip39', (1,"mn2hex_interactive (bip39)", [])),
  34. ('mn2hex_interactive_bip39_short',(1,"mn2hex_interactive (bip39 - short entry mode (+pad entry))", [])),
  35. ('mn2hex_interactive_bip39_fixed',(1,"mn2hex_interactive (bip39 - fixed (4-letter) entry mode)", [])),
  36. ('mn2hex_interactive_xmr', (1,"mn2hex_interactive (xmrseed)", [])),
  37. ('mn2hex_interactive_xmr_short', (1,"mn2hex_interactive (xmrseed - short entry mode)", [])),
  38. ('dieroll_entry', (1,"dieroll entry (base6d)", [])),
  39. ('dieroll_entry_usrrand', (1,"dieroll entry (base6d) with added user entropy", [])),
  40. )
  41. def get_seed_from_stdin(self):
  42. self.spawn('',msg_only=True)
  43. from subprocess import run,PIPE
  44. cmd = ['cmds/mmgen-walletconv','--in-fmt=words','--out-fmt=bip39','--outdir=test/trash']
  45. mn = sample_mn['mmgen']['mn']
  46. os.environ['MMGEN_TEST_SUITE'] = ''
  47. cp = run( cmd, input=mn.encode(), stdout=PIPE, stderr=PIPE )
  48. os.environ['MMGEN_TEST_SUITE'] = '1'
  49. assert b'written to file' in cp.stderr, "test 'get_seed_from_stdin' failed"
  50. imsg(cp.stderr.decode().strip())
  51. return 'ok'
  52. def get_passphrase_ui(self):
  53. t = self.spawn('test/misc/get_passphrase.py',['--usr-randchars=0','seed'],cmd_dir='.')
  54. # 1 - new wallet, default hp,label;empty pw
  55. t.expect('accept the default.*: ','\n',regex=True)
  56. # bad repeat
  57. t.expect('new MMGen wallet: ','pass1\n')
  58. t.expect('peat passphrase: ','pass2\n')
  59. # good repeat
  60. t.expect('new MMGen wallet: ','\n')
  61. t.expect('peat passphrase: ','\n')
  62. t.expect('mpty pass')
  63. t.expect('no label: ','\n')
  64. t.expect('[][3][No Label]')
  65. # 2 - new wallet, user-selected hp,pw,label
  66. t.expect('accept the default.*: ', '1\n', regex=True)
  67. t.expect('new MMGen wallet: ','pass1\n')
  68. t.expect('peat passphrase: ','pass1\n')
  69. t.expect('no label: ','lbl1\n')
  70. t.expect('[pass1][1][lbl1]')
  71. # 3 - passchg, nothing changes
  72. t.expect('new hash preset')
  73. t.expect('reuse the old value.*: ','\n',regex=True)
  74. t.expect('unchanged')
  75. t.expect('new passphrase.*: ','pass1\n',regex=True)
  76. t.expect('peat new passphrase: ','pass1\n')
  77. t.expect('unchanged')
  78. t.expect('reuse the label .*: ','\n',regex=True)
  79. t.expect('unchanged')
  80. t.expect('[pass1][1][lbl1]')
  81. # 4 - passchg, everything changes
  82. t.expect('new hash preset')
  83. t.expect('reuse the old value.*: ','2\n',regex=True)
  84. t.expect(' changed to')
  85. t.expect('new passphrase.*: ','pass2\n',regex=True)
  86. t.expect('peat new passphrase: ','pass2\n')
  87. t.expect(' changed')
  88. t.expect('reuse the label .*: ','lbl2\n',regex=True)
  89. t.expect(' changed to')
  90. t.expect('[pass2][2][lbl2]')
  91. # 5 - wallet from file
  92. t.expect('from file')
  93. # bad passphrase
  94. t.expect('passphrase for MMGen wallet: ','bad\n')
  95. t.expect('Trying again')
  96. # good passphrase
  97. t.expect('passphrase for MMGen wallet: ','reference password\n')
  98. t.expect('[reference password][1][No Label]')
  99. t.read()
  100. return t
  101. def get_passphrase_cmdline(self):
  102. with open('test/trash/pwfile','w') as fp:
  103. fp.write('reference password\n')
  104. t = self.spawn('test/misc/get_passphrase.py', [
  105. '--usr-randchars=0',
  106. '--label=MyLabel',
  107. '--passwd-file=test/trash/pwfile',
  108. '--hash-preset=1',
  109. 'seed' ],
  110. cmd_dir = '.' )
  111. for foo in range(4):
  112. t.expect('[reference password][1][MyLabel]')
  113. t.read()
  114. return t
  115. def get_passphrase_crypto(self):
  116. t = self.spawn('test/misc/get_passphrase.py',['--usr-randchars=0','crypto'],cmd_dir='.')
  117. # new passwd
  118. t.expect('passphrase for .*: ', 'x\n', regex=True)
  119. t.expect('peat passphrase: ', '\n')
  120. t.expect('passphrase for .*: ', 'pass1\n', regex=True)
  121. t.expect('peat passphrase: ', 'pass1\n')
  122. t.expect('[pass1]')
  123. # existing passwd
  124. t.expect('passphrase for .*: ', 'pass2\n', regex=True)
  125. t.expect('[pass2]')
  126. # hash preset
  127. t.expect('accept the default .*: ', '0\n', regex=True)
  128. t.expect('nvalid')
  129. t.expect('accept the default .*: ', '8\n', regex=True)
  130. t.expect('nvalid')
  131. t.expect('accept the default .*: ', '7\n', regex=True)
  132. t.expect('[7]')
  133. # hash preset (default)
  134. t.expect('accept the default .*: ', '\n', regex=True)
  135. t.expect(f'[{g.dfl_hash_preset}]')
  136. t.read()
  137. return t
  138. def password_entry(self,prompt,cmd_args):
  139. t = self.spawn('test/misc/password_entry.py',cmd_args,cmd_dir='.')
  140. pw = 'abc-α'
  141. t.expect(prompt,pw+'\n')
  142. ret = t.expect_getend('Entered: ')
  143. assert ret == pw, f'Password mismatch! {ret} != {pw}'
  144. return t
  145. def password_entry_noecho(self):
  146. if self.skip_for_win():
  147. m = "getpass() doesn't work with pexpect.popen_spawn!\n"
  148. m += 'Perform the following test by hand with non-ASCII password abc-α:\n'
  149. m += ' test/misc/password_entry.py'
  150. return ('skip_warn',m)
  151. return self.password_entry('Enter passphrase: ',[])
  152. def password_entry_echo(self):
  153. if self.skip_for_win():
  154. m = "getpass() doesn't work with pexpect.popen_spawn!\n"
  155. m += 'Perform the following test by hand with non-ASCII password abc-α:\n'
  156. m += ' test/misc/password_entry.py --echo-passphrase'
  157. return ('skip_warn',m)
  158. return self.password_entry('Enter passphrase (echoed): ',['--echo-passphrase'])
  159. def _mn2hex(self,fmt,entry_mode='full',mn=None,pad_entry=False,enter_for_dfl=False):
  160. mn = mn or sample_mn[fmt]['mn'].split()
  161. t = self.spawn('mmgen-tool',['mn2hex_interactive','fmt='+fmt,'mn_len=12','print_mn=1'])
  162. from mmgen.mn_entry import mn_entry
  163. mne = mn_entry(fmt,entry_mode)
  164. t.expect(
  165. 'Type a number.*: ',
  166. ('\n' if enter_for_dfl else str(mne.entry_modes.index(entry_mode)+1)),
  167. regex = True )
  168. t.expect('Using (.+) entry mode',regex=True)
  169. mode = strip_ansi_escapes(t.p.match.group(1)).lower()
  170. assert mode == mne.em.name.lower(), f'{mode} != {mne.em.name.lower()}'
  171. stealth_mnemonic_entry(t,mne,mn,entry_mode=entry_mode,pad_entry=pad_entry)
  172. t.expect(sample_mn[fmt]['hex'])
  173. t.read()
  174. return t
  175. def _user_seed_entry(self,fmt,usr_rand=False,out_fmt=None,entry_mode='full',mn=None):
  176. wcls = Wallet.fmt_code_to_type(fmt)
  177. wf = os.path.join(ref_dir,f'FE3C6545.{wcls.ext}')
  178. if wcls.wclass == 'mnemonic':
  179. mn = mn or read_from_file(wf).strip().split()
  180. elif wcls.wclass == 'dieroll':
  181. mn = mn or list(remove_whitespace(read_from_file(wf)))
  182. for idx,val in ((5,'x'),(18,'0'),(30,'7'),(44,'9')):
  183. mn.insert(idx,val)
  184. t = self.spawn('mmgen-walletconv',['-r10','-S','-i',fmt,'-o',out_fmt or fmt])
  185. t.expect(f'{capfirst(wcls.wclass)} type:.*{wcls.mn_type}',regex=True)
  186. t.expect(wcls.choose_seedlen_prompt,'1')
  187. t.expect('(Y/n): ','y')
  188. if wcls.wclass == 'mnemonic':
  189. t.expect('Type a number.*: ','6',regex=True)
  190. t.expect('invalid')
  191. from mmgen.mn_entry import mn_entry
  192. mne = mn_entry(fmt,entry_mode)
  193. t.expect('Type a number.*: ',str(mne.entry_modes.index(entry_mode)+1),regex=True)
  194. t.expect('Using (.+) entry mode',regex=True)
  195. mode = strip_ansi_escapes(t.p.match.group(1)).lower()
  196. assert mode == mne.em.name.lower(), f'{mode} != {mne.em.name.lower()}'
  197. stealth_mnemonic_entry(t,mne,mn,entry_mode=entry_mode)
  198. elif wcls.wclass == 'dieroll':
  199. user_dieroll_entry(t,mn)
  200. if usr_rand:
  201. t.expect(wcls.user_entropy_prompt,'y')
  202. t.usr_rand(10)
  203. else:
  204. t.expect(wcls.user_entropy_prompt,'n')
  205. if not usr_rand:
  206. sid_chk = 'FE3C6545'
  207. sid = t.expect_getend(f'Valid {wcls.desc} for Seed ID ')
  208. sid = strip_ansi_escapes(sid.split(',')[0])
  209. assert sid == sid_chk, f'Seed ID mismatch! {sid} != {sid_chk}'
  210. t.expect('to confirm: ','YES\n')
  211. t.read()
  212. return t
  213. def mnemonic_entry_mmgen_minimal(self):
  214. from mmgen.mn_entry import mn_entry
  215. # erase_chars: '\b\x7f'
  216. m = mn_entry('mmgen','minimal')
  217. np = 2
  218. mn = (
  219. 'z',
  220. 'aa',
  221. '1d2ud',
  222. 'fo{}ot{}#'.format('1' * np, '2' * (m.em.pad_max - np)), # substring of 'football'
  223. 'des1p)%erate\n', # substring of 'desperately'
  224. '#t!(ie',
  225. '!)sto8o',
  226. 'the123m8!%s',
  227. '349t(5)rip',
  228. 'di\b\bdesce',
  229. 'cea',
  230. 'bu\x7f\x7fsuic',
  231. 'app\bpl',
  232. 'wd',
  233. 'busy')
  234. return self._user_seed_entry('words',entry_mode='minimal',mn=mn)
  235. def mnemonic_entry_mmgen(self): return self._user_seed_entry('words',entry_mode='full')
  236. def mnemonic_entry_bip39(self): return self._user_seed_entry('bip39',entry_mode='full')
  237. def mnemonic_entry_bip39_short(self): return self._user_seed_entry('bip39',entry_mode='short')
  238. def mn2hex_interactive_mmgen(self): return self._mn2hex('mmgen',entry_mode='full')
  239. def mn2hex_interactive_mmgen_fixed(self): return self._mn2hex('mmgen',entry_mode='fixed')
  240. def mn2hex_interactive_bip39(self): return self._mn2hex('bip39',entry_mode='full')
  241. def mn2hex_interactive_bip39_short(self): return self._mn2hex('bip39',entry_mode='short',pad_entry=True)
  242. def mn2hex_interactive_bip39_fixed(self): return self._mn2hex('bip39',entry_mode='fixed',enter_for_dfl=True)
  243. def mn2hex_interactive_xmr(self): return self._mn2hex('xmrseed',entry_mode='full')
  244. def mn2hex_interactive_xmr_short(self): return self._mn2hex('xmrseed',entry_mode='short')
  245. def dieroll_entry(self): return self._user_seed_entry('dieroll')
  246. def dieroll_entry_usrrand(self): return self._user_seed_entry('dieroll',usr_rand=True,out_fmt='bip39')