autosign.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983
  1. #!/usr/bin/env python3
  2. #
  3. # MMGen Wallet, a terminal-based cryptocurrency wallet
  4. # Copyright (C)2013-2025 The MMGen Project <mmgen@tuta.io>
  5. # Licensed under the GNU General Public License, Version 3:
  6. # https://www.gnu.org/licenses
  7. # Public project repositories:
  8. # https://github.com/mmgen/mmgen-wallet
  9. # https://gitlab.com/mmgen/mmgen-wallet
  10. """
  11. autosign: Autosign MMGen transactions, message files and XMR wallet output files
  12. """
  13. import sys, os, asyncio
  14. from stat import S_IWUSR, S_IRUSR
  15. from pathlib import Path
  16. from subprocess import run, PIPE, DEVNULL
  17. from .cfg import Config
  18. from .util import msg, msg_r, ymsg, rmsg, gmsg, bmsg, die, suf, fmt, fmt_list, is_int, have_sudo, capfirst
  19. from .color import yellow, red, orange, brown, blue
  20. from .wallet import Wallet, get_wallet_cls
  21. from .addrlist import AddrIdxList
  22. from .filename import find_file_in_dir
  23. from .fileutil import shred_file
  24. from .ui import keypress_confirm
  25. def SwapMgr(*args, **kwargs):
  26. match sys.platform:
  27. case 'linux':
  28. return SwapMgrLinux(*args, **kwargs)
  29. case 'darwin':
  30. return SwapMgrMacOS(*args, **kwargs)
  31. class SwapMgrBase:
  32. def __init__(self, cfg, *, ignore_zram=False):
  33. self.cfg = cfg
  34. self.ignore_zram = ignore_zram
  35. self.desc = 'disk swap' if ignore_zram else 'swap'
  36. def enable(self, *, quiet=False):
  37. ret = self.do_enable()
  38. if not quiet:
  39. self.cfg._util.qmsg(
  40. f'{capfirst(self.desc)} successfully enabled' if ret else
  41. f'{capfirst(self.desc)} is already enabled' if ret is None else
  42. f'Could not enable {self.desc}')
  43. return ret
  44. def disable(self, *, quiet=False):
  45. self.cfg._util.qmsg_r(f'Attempting to disable {self.desc}...')
  46. ret = self.do_disable()
  47. self.cfg._util.qmsg('success')
  48. if not quiet:
  49. self.cfg._util.qmsg(
  50. f'{capfirst(self.desc)} successfully disabled ({fmt_list(ret, fmt="no_quotes")})'
  51. if ret and isinstance(ret, list) else
  52. f'{capfirst(self.desc)} successfully disabled' if ret else
  53. f'No active {self.desc}')
  54. return ret
  55. def process_cmds(self, op, cmds):
  56. if not cmds:
  57. return
  58. if have_sudo(silent=True) and not self.cfg.test_suite:
  59. for cmd in cmds:
  60. run(cmd.split(), check=True)
  61. else:
  62. pre = 'failure\n' if op == 'disable' else ''
  63. fs = blue('{a} {b} manually by executing the following command{c}:\n{d}')
  64. post = orange('[To prevent this message in the future, enable sudo without a password]')
  65. m = pre + fs.format(
  66. a = 'Please disable' if op == 'disable' else 'Enable',
  67. b = self.desc,
  68. c = suf(cmds),
  69. d = fmt_list(cmds, indent=' ', fmt='col')) + '\n' + post
  70. msg(m)
  71. if not self.cfg.test_suite:
  72. sys.exit(1)
  73. class SwapMgrLinux(SwapMgrBase):
  74. def get_active(self):
  75. for cmd in ('/sbin/swapon', 'swapon'):
  76. try:
  77. cp = run([cmd, '--show=NAME', '--noheadings'], stdout=PIPE, text=True, check=True)
  78. break
  79. except Exception:
  80. if cmd == 'swapon':
  81. raise
  82. res = cp.stdout.splitlines()
  83. return [e for e in res if not e.startswith('/dev/zram')] if self.ignore_zram else res
  84. def do_enable(self):
  85. if ret := self.get_active():
  86. ymsg(f'Warning: {self.desc} is already enabled: ({fmt_list(ret, fmt="no_quotes")})')
  87. self.process_cmds('enable', ['sudo swapon --all'])
  88. return True
  89. def do_disable(self):
  90. swapdevs = self.get_active()
  91. if not swapdevs:
  92. return None
  93. self.process_cmds('disable', [f'sudo swapoff {swapdev}' for swapdev in swapdevs])
  94. return swapdevs
  95. class SwapMgrMacOS(SwapMgrBase):
  96. def get_active(self):
  97. cmd = 'launchctl print system/com.apple.dynamic_pager'
  98. return run(cmd.split(), stdout=DEVNULL, stderr=DEVNULL).returncode == 0
  99. def _do_action(self, active, op, cmd):
  100. if self.get_active() is active:
  101. return None
  102. else:
  103. cmd = f'sudo launchctl {cmd} -w /System/Library/LaunchDaemons/com.apple.dynamic_pager.plist'
  104. self.process_cmds(op, [cmd])
  105. return True
  106. def do_enable(self):
  107. return self._do_action(active=True, op='enable', cmd='load')
  108. def do_disable(self):
  109. return self._do_action(active=False, op='disable', cmd='unload')
  110. class Signable:
  111. non_xmr_signables = (
  112. 'transaction',
  113. 'automount_transaction',
  114. 'message')
  115. xmr_signables = ( # order is important!
  116. 'xmr_wallet_outputs_file', # import XMR wallet outputs BEFORE signing transactions
  117. 'xmr_transaction')
  118. class base:
  119. clean_all = False
  120. multiple_ok = True
  121. action_desc = 'signed'
  122. fail_msg = 'failed to sign'
  123. def __init__(self, parent):
  124. self.parent = parent
  125. self.cfg = parent.cfg
  126. self.dir = getattr(parent, self.dir_name)
  127. self.name = type(self).__name__
  128. @property
  129. def unsigned(self):
  130. return self._unprocessed('_unsigned', self.rawext, self.sigext)
  131. def _unprocessed(self, attrname, rawext, sigext):
  132. if not hasattr(self, attrname):
  133. dirlist = sorted(self.dir.iterdir())
  134. names = {f.name for f in dirlist}
  135. setattr(
  136. self,
  137. attrname,
  138. tuple(f for f in dirlist
  139. if f.name.endswith('.' + rawext)
  140. and f.name[:-len(rawext)] + sigext not in names))
  141. return getattr(self, attrname)
  142. def print_bad_list(self, bad_files):
  143. msg('\n{a}\n{b}'.format(
  144. a = red(f'Failed {self.desc}s:'),
  145. b = ' {}\n'.format('\n '.join(
  146. self.gen_bad_list(sorted(bad_files, key=lambda f: f.name))))))
  147. def gen_bad_list(self, bad_files):
  148. for f in bad_files:
  149. yield red(f.name)
  150. class transaction(base):
  151. desc = 'non-automount transaction'
  152. dir_name = 'tx_dir'
  153. rawext = 'rawtx'
  154. sigext = 'sigtx'
  155. automount = False
  156. async def sign(self, f):
  157. from .tx import UnsignedTX
  158. tx1 = UnsignedTX(
  159. cfg = self.cfg,
  160. filename = f,
  161. automount = self.automount)
  162. if tx1.proto.coin == 'XMR':
  163. ctx = Signable.xmr_compat_transaction(self.parent)
  164. for k in ('desc', 'print_summary', 'print_bad_list'):
  165. setattr(self, k, getattr(ctx, k))
  166. return await ctx.sign(f, compat_call=True)
  167. if tx1.proto.sign_mode == 'daemon':
  168. from .rpc import rpc_init
  169. tx1.rpc = await rpc_init(self.cfg, tx1.proto, ignore_wallet=True)
  170. from .tx.keys import TxKeys
  171. tx2 = await tx1.sign(
  172. TxKeys(
  173. self.cfg,
  174. tx1,
  175. seedfiles = self.parent.wallet_files[:],
  176. keylist = self.parent.keylist,
  177. passwdfile = str(self.parent.keyfile),
  178. autosign = True).keys)
  179. if tx2:
  180. tx2.file.write(ask_write=False, outdir=self.dir)
  181. return tx2
  182. else:
  183. return False
  184. def print_summary(self, signables):
  185. if self.cfg.full_summary:
  186. bmsg('\nAutosign summary:\n')
  187. msg_r('\n'.join(tx.info.format(terse=True) for tx in signables))
  188. return
  189. def gen():
  190. for tx in signables:
  191. non_mmgen = [o for o in tx.outputs if not o.mmid]
  192. if non_mmgen:
  193. yield (tx, non_mmgen)
  194. body = list(gen())
  195. if body:
  196. bmsg('\nAutosign summary:')
  197. fs = '{} {} {}'
  198. t_wid, a_wid = 6, 44
  199. def gen():
  200. yield fs.format('TX ID ', 'Non-MMGen outputs'+' '*(a_wid-17), 'Amount')
  201. yield fs.format('-'*t_wid, '-'*a_wid, '-'*7)
  202. for tx, non_mmgen in body:
  203. for nm in non_mmgen:
  204. yield fs.format(
  205. tx.txid.fmt(t_wid, color=True) if nm is non_mmgen[0] else ' '*t_wid,
  206. nm.addr.fmt(nm.addr.view_pref, a_wid, color=True),
  207. nm.amt.hl() + ' ' + yellow(tx.coin))
  208. msg('\n' + '\n'.join(gen()))
  209. else:
  210. msg('\nNo non-MMGen outputs')
  211. class automount_transaction(transaction):
  212. desc = 'automount transaction'
  213. dir_name = 'txauto_dir'
  214. rawext = 'arawtx'
  215. sigext = 'asigtx'
  216. subext = 'asubtx'
  217. multiple_ok = False
  218. automount = True
  219. @property
  220. def unsubmitted(self):
  221. return self._unprocessed('_unsubmitted', self.sigext, self.subext)
  222. @property
  223. def unsubmitted_raw(self):
  224. return self._unprocessed('_unsubmitted_raw', self.rawext, self.subext)
  225. unsent = unsubmitted
  226. unsent_raw = unsubmitted_raw
  227. @property
  228. def submitted(self):
  229. return self._processed('_submitted', self.subext)
  230. def _processed(self, attrname, ext):
  231. if not hasattr(self, attrname):
  232. setattr(self, attrname, tuple(f for f in sorted(self.dir.iterdir())
  233. if f.name.endswith('.' + ext)))
  234. return getattr(self, attrname)
  235. def die_wrong_num_txs(self, tx_type, *, msg=None, desc=None, show_dir=False):
  236. match len(getattr(self, tx_type)): # num_txs
  237. case 0: subj, suf, pred = ('No', 's', 'present')
  238. case 1: subj, suf, pred = ('One', '', 'already present')
  239. case _: subj, suf, pred = ('More than one', '', 'already present')
  240. die('AutosignTXError', '{m}{a} {b} transaction{c} {d} {e}!'.format(
  241. m = msg + '\n' if msg else '',
  242. a = subj,
  243. b = desc or tx_type,
  244. c = suf,
  245. d = pred,
  246. e = f'in ‘{getattr(self.parent, self.dir_name)}’'
  247. if show_dir else 'on removable device'))
  248. def check_create_ok(self):
  249. if len(self.unsigned):
  250. self.die_wrong_num_txs('unsigned', msg='Cannot create transaction')
  251. if len(self.unsent):
  252. die('AutosignTXError', 'Cannot create transaction: you have an unsent transaction')
  253. def get_unsubmitted(self, tx_type='unsubmitted'):
  254. if len(self.unsubmitted) == 1:
  255. return self.unsubmitted[0]
  256. else:
  257. self.die_wrong_num_txs(tx_type)
  258. def get_unsent(self):
  259. return self.get_unsubmitted('unsent')
  260. def get_submitted(self):
  261. if len(self.submitted) == 0:
  262. self.die_wrong_num_txs('submitted')
  263. else:
  264. return self.submitted
  265. def get_abortable(self):
  266. if len(self.unsent_raw) != 1:
  267. self.die_wrong_num_txs('unsent_raw', desc='unsent')
  268. if len(self.unsent) > 1:
  269. self.die_wrong_num_txs('unsent')
  270. if self.unsent:
  271. if self.unsent[0].stem != self.unsent_raw[0].stem:
  272. die(1, f'{self.unsent[0]}, {self.unsent_raw[0]}: file mismatch')
  273. return self.unsent_raw + self.unsent
  274. def shred_abortable(self):
  275. files = self.get_abortable() # raises AutosignTXError if no unsent TXs available
  276. keypress_confirm(
  277. self.cfg,
  278. 'The following file{} will be securely deleted:\n{}\nOK?'.format(
  279. suf(files),
  280. fmt_list(map(str, files), fmt='col', indent=' ')),
  281. do_exit = True)
  282. for fn in files:
  283. msg(f'Shredding file ‘{fn}’')
  284. shred_file(self.cfg, fn, iterations=15)
  285. sys.exit(0)
  286. async def get_last_created(self):
  287. from .tx import CompletedTX
  288. files = [f for f in self.dir.iterdir() if f.name.endswith(self.subext)]
  289. return sorted(
  290. [await CompletedTX(cfg=self.cfg, filename=str(txfile), quiet_open=True)
  291. for txfile in files],
  292. key = lambda x: x.timestamp)[-1]
  293. class xmr_signable: # mixin class
  294. automount = True
  295. summary_footer = ''
  296. def need_daemon_restart(self, m, new_idx):
  297. old_idx = self.parent.xmr_cur_wallet_idx
  298. self.parent.xmr_cur_wallet_idx = new_idx
  299. return old_idx != new_idx or m.wd.state != 'ready'
  300. def print_summary(self, signables):
  301. bmsg('\nAutosign summary:')
  302. msg('\n'.join(s.get_info(indent=' ') for s in signables) + self.summary_footer)
  303. class xmr_transaction(xmr_signable, automount_transaction):
  304. desc = 'Monero non-compat transaction'
  305. dir_name = 'xmr_tx_dir'
  306. rawext = 'rawtx'
  307. sigext = 'sigtx'
  308. subext = 'subtx'
  309. async def sign(self, f, compat_call=False):
  310. from . import xmrwallet
  311. from .xmrwallet.file.tx import MoneroMMGenTX
  312. tx1 = MoneroMMGenTX.Completed(self.parent.xmrwallet_cfg, f)
  313. m = xmrwallet.op(
  314. 'sign',
  315. self.parent.xmrwallet_cfg,
  316. infile = str(self.parent.wallet_files[0]), # MMGen wallet file
  317. wallets = str(tx1.src_wallet_idx),
  318. compat_call = compat_call)
  319. tx2 = await m.main(f, restart_daemon=self.need_daemon_restart(m, tx1.src_wallet_idx))
  320. tx2.write(ask_write=False)
  321. return tx2
  322. class xmr_compat_transaction(xmr_transaction):
  323. desc = 'Monero compat transaction'
  324. dir_name = 'txauto_dir'
  325. rawext = 'arawtx'
  326. sigext = 'asigtx'
  327. subext = 'asubtx'
  328. class xmr_wallet_outputs_file(xmr_signable, base):
  329. desc = 'Monero wallet outputs file'
  330. dir_name = 'xmr_outputs_dir'
  331. rawext = 'raw'
  332. sigext = 'sig'
  333. clean_all = True
  334. summary_footer = '\n'
  335. @property
  336. def unsigned(self):
  337. import json
  338. return tuple(
  339. f for f in super().unsigned
  340. if not json.loads(f.read_text())['MoneroMMGenWalletOutputsFile']['data']['imported'])
  341. async def sign(self, f):
  342. from . import xmrwallet
  343. wallet_idx = xmrwallet.op_cls('wallet').get_idx_from_fn(f)
  344. m = xmrwallet.op(
  345. 'import_outputs',
  346. self.parent.xmrwallet_cfg,
  347. infile = str(self.parent.wallet_files[0]), # MMGen wallet file
  348. wallets = str(wallet_idx))
  349. obj = await m.main(f, wallet_idx, restart_daemon=self.need_daemon_restart(m, wallet_idx))
  350. obj.write(quiet=not obj.data.sign)
  351. self.action_desc = 'imported and signed' if obj.data.sign else 'imported'
  352. return obj
  353. class message(base):
  354. desc = 'message file'
  355. dir_name = 'msg_dir'
  356. rawext = 'rawmsg.json'
  357. sigext = 'sigmsg.json'
  358. fail_msg = 'failed to sign or signed incompletely'
  359. async def sign(self, f):
  360. from .msg import UnsignedMsg, SignedMsg
  361. m = UnsignedMsg(self.cfg, infile=f)
  362. await m.sign(wallet_files=self.parent.wallet_files[:], passwd_file=str(self.parent.keyfile))
  363. m = SignedMsg(self.cfg, data=m.__dict__)
  364. m.write_to_file(
  365. outdir = self.dir.resolve(),
  366. ask_overwrite = False)
  367. if m.data.get('failed_sids'):
  368. die(
  369. 'MsgFileFailedSID',
  370. f'Failed Seed IDs: {fmt_list(m.data["failed_sids"], fmt="bare")}')
  371. return m
  372. def print_summary(self, signables):
  373. gmsg('\nSigned message files:')
  374. for message in signables:
  375. gmsg(' ' + message.signed_filename)
  376. def gen_bad_list(self, bad_files):
  377. for f in bad_files:
  378. sigfile = f.parent / (f.name[:-len(self.rawext)] + self.sigext)
  379. yield orange(sigfile.name) if sigfile.exists() else red(f.name)
  380. class Autosign:
  381. dev_label = 'MMGEN_TX'
  382. linux_mount_subdir = 'mmgen_autosign'
  383. macOS_ramdisk_name = 'AutosignRamDisk'
  384. wallet_subdir = 'autosign'
  385. linux_blkid_cmd = 'sudo blkid -s LABEL -o value'
  386. keylist_fn = 'keylist.mmenc'
  387. cmds = ('setup', 'xmr_setup', 'sign', 'wait')
  388. util_cmds = (
  389. 'gen_key',
  390. 'macos_ramdisk_setup',
  391. 'macos_ramdisk_delete',
  392. 'enable_swap',
  393. 'disable_swap',
  394. 'clean',
  395. 'wipe_key')
  396. mn_fmts = {
  397. 'mmgen': 'words',
  398. 'bip39': 'bip39'}
  399. dfl_mn_fmt = 'mmgen'
  400. non_xmr_dirs = {
  401. 'tx_dir': 'tx',
  402. 'txauto_dir': 'txauto',
  403. 'msg_dir': 'msg'}
  404. xmr_dirs = {
  405. 'xmr_dir': 'xmr',
  406. 'xmr_tx_dir': 'xmr/tx',
  407. 'xmr_outputs_dir': 'xmr/outputs'}
  408. have_xmr = False
  409. xmr_only = False
  410. def init_fixup(self): # see test/overlay/fakemods/mmgen/autosign.py
  411. pass
  412. def __init__(self, cfg, *, cmd=None):
  413. if cfg.mnemonic_fmt:
  414. if cfg.mnemonic_fmt not in self.mn_fmts:
  415. die(1, '{!r}: invalid mnemonic format (must be one of: {})'.format(
  416. cfg.mnemonic_fmt,
  417. fmt_list(self.mn_fmts, fmt='no_spc')))
  418. match sys.platform:
  419. case 'linux':
  420. self.dfl_mountpoint = f'/mnt/{self.linux_mount_subdir}'
  421. self.dfl_shm_dir = '/dev/shm'
  422. # linux-only attrs:
  423. self.old_dfl_mountpoint = '/mnt/tx'
  424. self.old_dfl_mountpoint_errmsg = f"""
  425. Mountpoint ‘{self.old_dfl_mountpoint}’ is no longer supported!
  426. Please rename ‘{self.old_dfl_mountpoint}’ to ‘{self.dfl_mountpoint}’
  427. and update your fstab accordingly.
  428. """
  429. self.mountpoint_errmsg_fs = """
  430. Mountpoint ‘{}’ does not exist or does not point
  431. to a directory! Please create the mountpoint and add an entry
  432. to your fstab as described in this script’s help text.
  433. """
  434. case 'darwin':
  435. self.dfl_mountpoint = f'/Volumes/{self.dev_label}'
  436. self.dfl_shm_dir = f'/Volumes/{self.macOS_ramdisk_name}'
  437. self.cfg = cfg
  438. self.dfl_wallet_dir = f'{self.dfl_shm_dir}/{self.wallet_subdir}'
  439. self.mountpoint = Path(cfg.mountpoint or self.dfl_mountpoint)
  440. self.shm_dir = Path(self.dfl_shm_dir)
  441. self.wallet_dir = Path(cfg.wallet_dir or self.dfl_wallet_dir)
  442. match sys.platform:
  443. case 'linux':
  444. self.mount_cmd = f'mount {self.mountpoint}'
  445. self.umount_cmd = f'umount {self.mountpoint}'
  446. case 'darwin':
  447. self.mount_cmd = f'diskutil mount {self.dev_label}'
  448. self.umount_cmd = f'diskutil eject {self.dev_label}'
  449. self.init_fixup()
  450. if sys.platform == 'darwin': # test suite uses ‘fixed-up’ shm_dir
  451. from .platform.darwin.util import MacOSRamDisk
  452. self.ramdisk = MacOSRamDisk(
  453. cfg,
  454. self.macOS_ramdisk_name,
  455. self._get_macOS_ramdisk_size(),
  456. path = self.shm_dir)
  457. self.keyfile = self.mountpoint / 'autosign.key'
  458. if any(k in cfg._uopts for k in ('help', 'longhelp')):
  459. return
  460. self.coins = cfg.coins.upper().split(',') if cfg.coins else []
  461. if cfg.xmrwallets and not 'XMR' in self.coins:
  462. self.coins.append('XMR')
  463. if not self.coins and cmd in self.cmds:
  464. ymsg('Warning: no coins specified, defaulting to BTC')
  465. self.coins = ['BTC']
  466. if 'XMR' in self.coins:
  467. self.have_xmr = True
  468. if len(self.coins) == 1:
  469. self.xmr_only = True
  470. self.xmr_cur_wallet_idx = None
  471. self.dirs = {}
  472. self.signables = ()
  473. if not self.xmr_only:
  474. self.dirs |= self.non_xmr_dirs
  475. self.signables += Signable.non_xmr_signables
  476. if self.have_xmr:
  477. self.dirs |= self.xmr_dirs | (
  478. {'txauto_dir': 'txauto'} if cfg.xmrwallet_compat and self.xmr_only else {})
  479. self.signables += Signable.xmr_signables + (
  480. ('automount_transaction',) if cfg.xmrwallet_compat and self.xmr_only else ())
  481. for name, path in self.dirs.items():
  482. setattr(self, name, self.mountpoint / path)
  483. self.swap = SwapMgr(self.cfg, ignore_zram=True)
  484. async def check_daemons_running(self):
  485. from .protocol import init_proto
  486. for coin in self.coins:
  487. proto = init_proto(self.cfg, coin, network=self.cfg.network, need_amt=True)
  488. if proto.sign_mode == 'daemon':
  489. self.cfg._util.vmsg(f'Checking {coin} daemon')
  490. from .rpc import rpc_init
  491. from .exception import SocketError
  492. try:
  493. await rpc_init(self.cfg, proto, ignore_wallet=True)
  494. except SocketError as e:
  495. from .daemon import CoinDaemon
  496. d = CoinDaemon(self.cfg, proto=proto, test_suite=self.cfg.test_suite)
  497. die(2,
  498. f'\n{e}\nIs the {d.coind_name} daemon ({d.exec_fn}) running '
  499. + 'and listening on the correct port?')
  500. @property
  501. def wallet_files(self):
  502. if not hasattr(self, '_wallet_files'):
  503. try:
  504. dirlist = self.wallet_dir.iterdir()
  505. except:
  506. die(1,
  507. f'Cannot open wallet directory ‘{self.wallet_dir}’. '
  508. 'Did you run ‘mmgen-autosign setup’?')
  509. self._wallet_files = [f for f in dirlist if f.suffix == '.mmdat']
  510. if not self._wallet_files:
  511. die(1, 'No wallet files present!')
  512. return self._wallet_files
  513. def do_mount(self, *, silent=False, verbose=False):
  514. def check_or_create(dirname):
  515. path = getattr(self, dirname)
  516. if path.is_dir():
  517. if not path.stat().st_mode & S_IWUSR|S_IRUSR == S_IWUSR|S_IRUSR:
  518. die(1, f'‘{path}’ is not read/write for this user!')
  519. elif path.exists():
  520. die(1, f'‘{path}’ is not a directory!')
  521. elif path.is_symlink():
  522. die(1, f'‘{path}’ is a symlink not pointing to a directory!')
  523. else:
  524. msg(f'Creating ‘{path}’')
  525. path.mkdir(parents=True)
  526. if sys.platform == 'linux' and not self.mountpoint.is_dir():
  527. def do_die(m):
  528. die(1, '\n' + yellow(fmt(m.strip(), indent=' ')))
  529. if Path(self.old_dfl_mountpoint).is_dir():
  530. do_die(self.old_dfl_mountpoint_errmsg)
  531. else:
  532. do_die(self.mountpoint_errmsg_fs.format(self.mountpoint))
  533. if not self.mountpoint.is_mount():
  534. redir = None if verbose else DEVNULL
  535. if run(self.mount_cmd.split(), stderr=redir, stdout=redir).returncode == 0:
  536. if not silent:
  537. msg(f'Mounting ‘{self.mountpoint}’')
  538. else:
  539. die(1, f'Unable to mount device ‘{self.dev_label}’ at ‘{self.mountpoint}’')
  540. for dirname in self.dirs:
  541. check_or_create(dirname)
  542. def do_umount(self, *, silent=False, verbose=False):
  543. if self.mountpoint.is_mount():
  544. run(['sync'], check=True)
  545. if not silent:
  546. msg(f'Unmounting ‘{self.mountpoint}’')
  547. redir = None if verbose else DEVNULL
  548. run(self.umount_cmd.split(), stdout=redir, check=True)
  549. if not silent:
  550. bmsg('It is now safe to extract the removable device')
  551. def decrypt_wallets(self):
  552. msg(f'Unlocking wallet{suf(self.wallet_files)} with key from ‘{self.keyfile}’')
  553. fails = 0
  554. for wf in self.wallet_files:
  555. try:
  556. Wallet(self.cfg, fn=wf, ignore_in_fmt=True, passwd_file=str(self.keyfile))
  557. except SystemExit as e:
  558. if e.code != 0:
  559. fails += 1
  560. return not fails
  561. async def sign_all(self, target_name):
  562. target = getattr(Signable, target_name)(self)
  563. if target.unsigned:
  564. good = []
  565. bad = []
  566. if len(target.unsigned) > 1 and not target.multiple_ok:
  567. ymsg(f'Autosign error: only one unsigned {target.desc} transaction allowed at a time!')
  568. target.print_bad_list(target.unsigned)
  569. return False
  570. for f in target.unsigned:
  571. ret = None
  572. try:
  573. ret = await target.sign(f)
  574. except Exception as e:
  575. ymsg('An error occurred with {} ‘{}’:\n {}: ‘{}’'.format(
  576. target.desc, f.name, type(e).__name__, e))
  577. except:
  578. ymsg('An error occurred with {} ‘{}’'.format(target.desc, f.name))
  579. good.append(ret) if ret else bad.append(f)
  580. self.cfg._util.qmsg('')
  581. await asyncio.sleep(0.3)
  582. msg(brown(f'{len(good)} {target.desc}{suf(good)} {target.action_desc}'))
  583. if bad:
  584. rmsg(f'{len(bad)} {target.desc}{suf(bad)} {target.fail_msg}')
  585. if good and not self.cfg.no_summary:
  586. target.print_summary(good)
  587. if bad:
  588. target.print_bad_list(bad)
  589. return not bad
  590. else:
  591. return f'No unsigned {target.desc}s'
  592. async def do_sign(self):
  593. if not self.cfg.stealth_led:
  594. self.led.set('busy')
  595. self.do_mount()
  596. key_ok = self.decrypt_wallets()
  597. self.init_non_mmgen_keys()
  598. if key_ok:
  599. if self.cfg.stealth_led:
  600. self.led.set('busy')
  601. ret = [await self.sign_all(signable) for signable in self.signables]
  602. for val in ret:
  603. if isinstance(val, str):
  604. msg(val)
  605. if self.cfg.test_suite_autosign_threaded:
  606. await asyncio.sleep(0.3)
  607. self.do_umount()
  608. self.led.set('error' if not all(ret) else 'off' if self.cfg.stealth_led else 'standby')
  609. return all(ret)
  610. else:
  611. msg('Password is incorrect!')
  612. self.do_umount()
  613. if not self.cfg.stealth_led:
  614. self.led.set('error')
  615. return False
  616. def wipe_encryption_key(self):
  617. if self.keyfile.exists():
  618. ymsg(f'Shredding wallet encryption key ‘{self.keyfile}’')
  619. shred_file(self.cfg, self.keyfile)
  620. else:
  621. gmsg('No wallet encryption key on removable device')
  622. def create_key(self):
  623. desc = f'key file ‘{self.keyfile}’'
  624. msg('Creating ' + desc)
  625. try:
  626. self.keyfile.write_text(os.urandom(32).hex())
  627. self.keyfile.chmod(0o400)
  628. except:
  629. die(2, 'Unable to write ' + desc)
  630. msg('Wrote ' + desc)
  631. def gen_key(self, *, no_unmount=False):
  632. if not self.device_inserted:
  633. die(1, 'Removable device not present!')
  634. self.do_mount()
  635. self.wipe_encryption_key()
  636. self.create_key()
  637. if not no_unmount:
  638. self.do_umount()
  639. def macos_ramdisk_setup(self):
  640. self.ramdisk.create()
  641. def macos_ramdisk_delete(self):
  642. self.ramdisk.destroy()
  643. def _get_macOS_ramdisk_size(self):
  644. from .platform.darwin.util import MacOSRamDisk, warn_ramdisk_too_small
  645. # allow 1MB for each Monero wallet
  646. xmr_size = len(AddrIdxList(fmt_str=self.cfg.xmrwallets)) if self.cfg.xmrwallets else 0
  647. calc_size = xmr_size + 1
  648. usr_size = self.cfg.macos_ramdisk_size or self.cfg.macos_autosign_ramdisk_size
  649. if is_int(usr_size):
  650. usr_size = int(usr_size)
  651. else:
  652. die(1, f'{usr_size}: invalid user-specified macOS ramdisk size (not an integer)')
  653. min_size = MacOSRamDisk.min_size
  654. size = max(usr_size, calc_size, min_size)
  655. if usr_size and usr_size < min_size:
  656. warn_ramdisk_too_small(usr_size, min_size)
  657. return size
  658. def setup(self):
  659. def remove_wallet_dir():
  660. msg(f'Deleting ‘{self.wallet_dir}’')
  661. import shutil
  662. try:
  663. shutil.rmtree(self.wallet_dir)
  664. except:
  665. pass
  666. def create_wallet_dir():
  667. try:
  668. self.wallet_dir.mkdir(parents=True)
  669. except:
  670. pass
  671. try:
  672. self.wallet_dir.stat()
  673. except:
  674. die(2, f'Unable to create wallet directory ‘{self.wallet_dir}’')
  675. self.gen_key(no_unmount=True)
  676. self.swap.disable()
  677. if sys.platform == 'darwin':
  678. self.macos_ramdisk_setup()
  679. remove_wallet_dir()
  680. create_wallet_dir()
  681. wf = find_file_in_dir(get_wallet_cls('mmgen'), self.cfg.data_dir)
  682. if wf and keypress_confirm(
  683. cfg = self.cfg,
  684. prompt = f'Default wallet ‘{wf}’ found.\nUse default wallet for autosigning?',
  685. default_yes = True):
  686. ss_in = Wallet(Config(), fn=wf)
  687. else:
  688. ss_in = Wallet(self.cfg, in_fmt=self.mn_fmts[self.cfg.mnemonic_fmt or self.dfl_mn_fmt])
  689. ss_out = Wallet(self.cfg, ss=ss_in, passwd_file=str(self.keyfile))
  690. ss_out.write_to_file(desc='autosign wallet', outdir=self.wallet_dir)
  691. if self.cfg.keys_from_file:
  692. self.setup_non_mmgen_keys()
  693. @property
  694. def xmrwallet_cfg(self):
  695. if not hasattr(self, '_xmrwallet_cfg'):
  696. self._xmrwallet_cfg = Config({
  697. '_clone': self.cfg,
  698. 'coin': 'xmr',
  699. 'wallet_rpc_user': 'autosign',
  700. 'wallet_rpc_password': 'autosign password',
  701. 'wallet_rpc_port': 23232 if self.cfg.test_suite_xmr_autosign else None,
  702. 'wallet_dir': str(self.wallet_dir),
  703. 'autosign': True,
  704. 'autosign_mountpoint': str(self.mountpoint),
  705. 'offline': True,
  706. 'compat': False,
  707. 'passwd_file': str(self.keyfile)})
  708. return self._xmrwallet_cfg
  709. def xmr_setup(self):
  710. def create_signing_wallets():
  711. from . import xmrwallet
  712. if len(self.wallet_files) > 1:
  713. ymsg(
  714. 'Warning: more than one wallet file, using the first '
  715. f'({self.wallet_files[0]}) for xmrwallet generation')
  716. m = xmrwallet.op(
  717. 'create_offline',
  718. self.xmrwallet_cfg,
  719. infile = str(self.wallet_files[0]), # MMGen wallet file
  720. wallets = self.cfg.xmrwallets) # XMR wallet idxs
  721. asyncio.run(m.main())
  722. asyncio.run(m.stop_wallet_daemon())
  723. self.clean_old_files()
  724. create_signing_wallets()
  725. def clean_old_files(self):
  726. def do_shred(fn):
  727. nonlocal count
  728. msg_r('.')
  729. shred_file(self.cfg, fn, iterations=15)
  730. count += 1
  731. def clean_dir(s_name):
  732. def clean_files(rawext, sigext):
  733. for f in s.dir.iterdir():
  734. if s.clean_all and (f.name.endswith(f'.{rawext}') or f.name.endswith(f'.{sigext}')):
  735. do_shred(f)
  736. elif f.name.endswith(f'.{sigext}'):
  737. raw = f.parent / (f.name[:-len(sigext)] + rawext)
  738. if raw.is_file():
  739. do_shred(raw)
  740. s = getattr(Signable, s_name)(self)
  741. msg_r(f'Cleaning directory ‘{s.dir}’..')
  742. if s.dir.is_dir():
  743. clean_files(s.rawext, s.sigext)
  744. if hasattr(s, 'subext'):
  745. clean_files(s.rawext, s.subext)
  746. clean_files(s.sigext, s.subext)
  747. msg('done' if s.dir.is_dir() else 'skipped (no dir)')
  748. count = 0
  749. for s_name in self.signables:
  750. clean_dir(s_name)
  751. bmsg(f'{count} file{suf(count)} shredded')
  752. @property
  753. def device_inserted(self):
  754. if self.cfg.no_insert_check:
  755. return True
  756. match sys.platform:
  757. case 'linux':
  758. cp = run(self.linux_blkid_cmd.split(), stdout=PIPE, text=True)
  759. if cp.returncode not in (0, 2):
  760. die(2, f'blkid exited with error code {cp.returncode}')
  761. return self.dev_label in cp.stdout.splitlines()
  762. case 'darwin':
  763. if self.cfg.test_suite_root_pfx:
  764. return self.mountpoint.exists()
  765. else:
  766. return run(
  767. ['diskutil', 'info', self.dev_label],
  768. stdout=DEVNULL, stderr=DEVNULL).returncode == 0
  769. async def main_loop(self):
  770. if not self.cfg.stealth_led:
  771. self.led.set('standby')
  772. threaded = self.cfg.test_suite_autosign_threaded
  773. n = 1 if threaded else 0
  774. prev_status = False
  775. while True:
  776. status = self.device_inserted
  777. if status and not prev_status:
  778. msg('Device insertion detected')
  779. await self.do_sign()
  780. prev_status = status
  781. if not n % 10:
  782. msg_r(f'\r{" "*17}\rWaiting')
  783. await asyncio.sleep(0.2 if threaded else 1)
  784. if not threaded:
  785. msg_r('.')
  786. n += 1
  787. def at_exit(self, exit_val, message=None):
  788. if message:
  789. msg(message)
  790. self.led.stop()
  791. sys.exit(0 if self.cfg.test_suite_autosign_threaded else int(exit_val))
  792. def init_exit_handler(self):
  793. def handler(arg1, arg2):
  794. self.at_exit(1, '\nCleaning up...')
  795. import signal
  796. signal.signal(signal.SIGTERM, handler)
  797. signal.signal(signal.SIGINT, handler)
  798. def init_led(self):
  799. from .led import LEDControl
  800. self.led = LEDControl(
  801. enabled = self.cfg.led,
  802. simulate = self.cfg.test_suite_autosign_led_simulate)
  803. self.led.set('off')
  804. def setup_non_mmgen_keys(self):
  805. from .fileutil import get_lines_from_file, write_data_to_file
  806. from .crypto import Crypto
  807. lines = get_lines_from_file(self.cfg, self.cfg.keys_from_file, desc='keylist data')
  808. write_data_to_file(
  809. self.cfg,
  810. str(self.wallet_dir / self.keylist_fn),
  811. Crypto(self.cfg).mmgen_encrypt(
  812. data = '\n'.join(lines).encode(),
  813. passwd = self.keyfile.read_text()),
  814. desc = 'encrypted keylist data',
  815. binary = True)
  816. if keypress_confirm(self.cfg, 'Securely delete original keylist file?'):
  817. shred_file(self.cfg, self.cfg.keys_from_file)
  818. def init_non_mmgen_keys(self):
  819. if not hasattr(self, 'keylist'):
  820. path = self.wallet_dir / self.keylist_fn
  821. if path.exists():
  822. from .crypto import Crypto
  823. from .fileutil import get_data_from_file
  824. self.keylist = Crypto(self.cfg).mmgen_decrypt(
  825. get_data_from_file(
  826. self.cfg,
  827. path,
  828. desc = 'encrypted keylist data',
  829. binary = True),
  830. passwd = self.keyfile.read_text()).decode().split()
  831. else:
  832. self.keylist = None