autosign.py 27 KB

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