firmware/testing/test_vdisk.py
2026-03-04 17:32:21 -05:00

329 lines
10 KiB
Python

# (c) Copyright 2021 by Coinkite Inc. This file is covered by license found in COPYING-CC.
#
# Mk4 Virtual Disk related tests.
#
import pytest, glob, re, time, io, os
from binascii import b2a_hex, a2b_hex
import ndef
from hashlib import sha256
from txn import *
from base64 import b64encode, b64decode
def test_vd_basics(dev, virtdisk_path, is_simulator):
# Check right files are in place.
if is_simulator():
assert os.path.isfile(virtdisk_path('README.md'))
return
assert os.path.isfile(virtdisk_path('README.txt'))
assert os.path.isdir(virtdisk_path('ident'))
for fn in ['serial.txt', 'version.txt']:
assert os.path.isfile(virtdisk_path(f'ident/{fn}'))
sn = open(virtdisk_path('ident/serial.txt'), 'rt').read().strip()
assert sn == dev.serial
assert os.path.isfile(virtdisk_path(f'ident/ckcc-{sn}.txt'))
@pytest.fixture
def try_sign_virtdisk(press_select, virtdisk_path, cap_story, virtdisk_wipe, press_cancel,
pick_menu_item, goto_home, sim_root_dir):
# like "try_sign" but use Virtual Disk to send/receive PSBT/results
# - on real dev, need user to manually say yes ... alot
# - on simulator, start with "--eject" arg so no SDCard emulated
def doit(f_or_data, accept=True, expect_finalize=False, accept_ms_import=False,
encoding='binary'):
assert not accept_ms_import, 'no support'
assert accept, 'no support'
virtdisk_wipe()
if f_or_data[0:5] == b'psbt\xff':
ip = f_or_data
filename = 'memory'
else:
filename = f_or_data
with open(f_or_data, 'rb') as f:
ip = f.read()
if ip[0:10] == b'70736274ff':
ip = a2b_hex(ip.strip())
assert ip[0:5] == b'psbt\xff'
if encoding == 'hex':
ip = b2a_hex(ip)
elif encoding == 'base64':
ip = b64encode(ip)
else:
assert encoding == 'binary'
assert ip[0:5] == b'psbt\xff'
# clear old junk
virtdisk_wipe()
xfn = virtdisk_path('testcase.psbt')
with open(xfn, 'wb') as f:
f.write(ip)
goto_home()
pick_menu_item("Ready To Sign")
# CC scans drive, reads PSBT, verifies...
time.sleep(1)
title, story = cap_story()
assert "OK TO SEND" in title
# approve siging txn
if accept:
press_select()
else:
press_cancel()
if accept is False:
time.sleep(0.050)
# look for "Aborting..." ??
return ip, None, None
# wait for it to finish signing
time.sleep(.1)
title, story = cap_story()
split_story = story.split("\n\n")
result_fn = split_story[1]
result_txn = None
result_txid = None
if expect_finalize:
result_txn = split_story[3]
result_txid = split_story[4].split("\n")[-1]
got_psbt = None
got_txn = None
txid, got_txid = None, None
for i in range(15):
if result_txn:
with open(virtdisk_path(result_txn), 'rb') as f:
got_txn = f.read()
with open(virtdisk_path(result_fn), 'rb') as f:
got_psbt = f.read()
# for delete-psbt mode
for ff in glob.glob(virtdisk_path('*.txn')):
if ff == result_txn: continue
try:
got_txid = re.findall(r'[0-9a-f]{64}', ff)[0]
except IndexError:
got_txid = None
with open(ff, 'rt') as f:
got_txn = a2b_hex(f.read().strip())
if got_txn or got_psbt:
break
time.sleep(1)
else:
raise pytest.fail('never got result: ' + result_fn)
if got_txid and not txid:
# Txid not shown unless "delete psbt" mode
txid = got_txid
if got_txid:
assert expect_finalize
assert got_txn
assert got_txid == txid == result_txid
with open(f"{sim_root_dir}/debug/vd-result.txn", 'wb') as f:
f.write(got_txid)
# check output encoding matches input (for PSBT only)
if got_psbt:
if encoding == 'hex':
got_psbt = a2b_hex(got_psbt.strip())
elif encoding == 'base64':
got_psbt = b64decode(got_psbt)
else:
assert encoding == 'binary'
# validate what we got
if got_txn:
from ctransaction import CTransaction
# parse it a little
assert got_txn[0:4] != b'psbt'
t = CTransaction()
t.deserialize(io.BytesIO(got_txn))
assert t.nVersion in [1, 2]
if txid:
assert t.txid().hex() == txid
else:
txid = t.txid().hex()
if got_psbt:
assert got_psbt[0:5] == b'psbt\xff'
with open(f"{sim_root_dir}/debug/vd-result.psbt", 'wb') as f:
f.write(got_psbt)
from psbt import BasicPSBT
was = BasicPSBT().parse(ip)
now = BasicPSBT().parse(got_psbt)
assert was.txn == now.txn
assert was != now
return ip, (got_txn or got_psbt), txid
return doit
@pytest.mark.unfinalized # iff partial=1
@pytest.mark.reexport
@pytest.mark.parametrize('encoding', ['binary', 'hex', 'base64'])
@pytest.mark.parametrize('num_outs', [1,2])
@pytest.mark.parametrize('partial', [1, 0])
def test_virtdisk_signing(encoding, num_outs, partial, try_sign_virtdisk, fake_txn, dev,
sd_cards_eject, signing_artifacts_reexport):
xp = dev.master_xpub
sd_cards_eject()
def hack(psbt):
if partial:
# change first input to not be ours
pk = list(psbt.inputs[0].bip32_paths.keys())[0]
pp = psbt.inputs[0].bip32_paths[pk]
psbt.inputs[0].bip32_paths[pk] = b'what' + pp[4:]
psbt = fake_txn(2, num_outs, xp, segwit_in=True, psbt_hacker=hack)
_, txn, txid = try_sign_virtdisk(psbt, expect_finalize=not partial, encoding=encoding)
sd_cards_eject(slot_a=0)
_psbt, _txn = signing_artifacts_reexport("vdisk", tx_final=not partial, txid=txid,
encoding=encoding)
if partial:
assert _psbt == txn
else:
assert _txn == txn
if 0:
@pytest.mark.parametrize('num_outs', [ 1, 20, 250])
def test_virtdisk_after(num_outs, fake_txn, try_sign, nfc_read, need_keypress, cap_story):
# Read signing result (transaction) over NFC, decode it.
psbt = fake_txn(1, num_outs)
orig, result = try_sign(psbt, accept=True, finalize=True)
too_big = len(result) > 8000
if too_big: assert num_outs > 100
if num_outs > 100: assert too_big
time.sleep(.1)
title, story = cap_story()
assert 'TXID' in title, story
txid = a2b_hex(story.split()[0])
assert 'Press (3)' in story
need_keypress('3')
if too_big:
title, story = cap_story()
assert 'is too large' in story
return
contents = virtdisk_read()
#need_keypress('x')
#print("contents = " + B2A(contents))
for got in ndef.message_decoder(contents):
if got.type == 'urn:nfc:wkt:T':
assert 'Transaction' in got.text
assert b2a_hex(txid).decode() in got.text
elif got.type == 'urn:nfc:ext:bitcoin.org:txid':
assert got.data == txid
elif got.type == 'urn:nfc:ext:bitcoin.org:txn':
assert got.data == result
elif got.type == 'urn:nfc:ext:bitcoin.org:sha256':
assert got.data == sha256(result).digest()
else:
raise ValueError(got.type)
def test_macos_detection():
# not a portable test... at all.
import platform, subprocess, plistlib
if not platform.platform().startswith('macOS-'):
raise pytest.xfail("requires MacOS")
if not os.path.isdir('/Volumes/COLDCARD'):
raise pytest.xfail("needs COLDCARD connected & mounted")
cmd = ['diskutil', 'info', '-plist', '/Volumes/COLDCARD']
pl = subprocess.check_output(cmd)
pl = plistlib.loads(pl)
assert pl['VolumeName'] == 'COLDCARD'
assert pl['BusProtocol'] == 'USB'
assert pl['FilesystemName'] == 'MS-DOS FAT16'
assert pl['VolumeAllocationBlockSize'] == 512
assert pl['IOKitSize'] == 4194304 # requires 5.0.6
@pytest.mark.parametrize('multiple_runs', range(3))
@pytest.mark.parametrize('testnet', [True, False])
def test_import_prv_virtdisk(testnet, pick_menu_item, cap_story, need_keypress,
unit_test, cap_menu, get_secrets, multiple_runs,
reset_seed_words, virtdisk_path, virtdisk_wipe,
settings_set, press_select, enable_hw_ux):
# copied from test_ux as we need vdisk enabled and card ejected
if testnet:
netcode = "XTN"
settings_set('chain', 'XTN')
else:
netcode = "BTC"
settings_set('chain', 'XTN')
unit_test('devtest/clear_seed.py')
enable_hw_ux("vdisk")
fname = 'test-%d.txt' % os.getpid()
path = virtdisk_path(fname)
from bip32 import BIP32Node
node = BIP32Node.from_master_secret(os.urandom(32), netcode=netcode)
prv = node.hwif(as_private=True) + '\n'
if testnet:
assert "tprv" in prv
else:
assert "xprv" in prv
with open(path, 'wt') as f:
f.write(prv)
print("Created: %s" % path)
m = cap_menu()
assert m[0] == 'New Seed Words'
pick_menu_item('Import Existing')
pick_menu_item('Import XPRV')
title, body = cap_story()
assert "press (2) to import from Virtual Disk" in body
need_keypress("2")
time.sleep(.01)
pick_menu_item(fname)
unit_test('devtest/abort_ux.py')
v = get_secrets()
assert v['xpub'] == node.hwif()
assert v['xprv'] == node.hwif(as_private=True)
reset_seed_words()
# EOF