410 lines
13 KiB
Python
410 lines
13 KiB
Python
# (c) Copyright 2021 by Coinkite Inc. This file is covered by license found in COPYING-CC.
|
|
#
|
|
# Mk4 NFC feature related tests.
|
|
#
|
|
# - many test "sync" issues here; case is right but gets outs of sync with DUT
|
|
# - use `./simulator.py --eff --set nfc=1`
|
|
#
|
|
import pytest, time
|
|
from binascii import b2a_hex, a2b_hex
|
|
from struct import pack, unpack
|
|
import ndef
|
|
from hashlib import sha256
|
|
from txn import *
|
|
|
|
@pytest.mark.parametrize('case', range(6))
|
|
def test_ndef(case, load_shared_mod):
|
|
# NDEF unit tests -- runs in cpython
|
|
|
|
def get_body(efile):
|
|
# unwrap CC_FILE and cruft
|
|
assert efile[-1] == 0xfe
|
|
assert efile[0] == 0xE2
|
|
st = len(cc_ndef.CC_FILE)
|
|
if efile[st] == 0xff:
|
|
xl = unpack('>H', efile[st+1:st+3])[0]
|
|
st += 3
|
|
else:
|
|
xl = efile[st]
|
|
st += 1
|
|
body = efile[st:-1]
|
|
assert len(body) == xl
|
|
return body
|
|
|
|
def decode(msg):
|
|
return list(ndef.message_decoder(get_body(msg)))
|
|
|
|
cc_ndef = load_shared_mod('cc_ndef', '../shared/ndef.py')
|
|
n = cc_ndef.ndefMaker()
|
|
|
|
if case == 0:
|
|
n.add_text("Hello world")
|
|
|
|
got, = decode(n.bytes())
|
|
assert got.type == 'urn:nfc:wkt:T'
|
|
assert got.text == 'Hello world'
|
|
assert got.language == 'en'
|
|
assert got.encoding == 'UTF-8'
|
|
|
|
elif case == 1:
|
|
n.add_text("Hello world")
|
|
n.add_url("store.coinkite.com/store/coldcard")
|
|
|
|
txt,url = decode(n.bytes())
|
|
assert txt.text == 'Hello world'
|
|
|
|
assert url.type == 'urn:nfc:wkt:U'
|
|
assert url.uri == 'https://store.coinkite.com/store/coldcard' == url.iri
|
|
|
|
elif case == 2:
|
|
hx = b2a_hex(bytes(range(32)))
|
|
n.add_text("Title")
|
|
n.add_custom('bitcoin.org:sha256', hx)
|
|
|
|
txt,sha = decode(n.bytes())
|
|
assert txt.text == 'Title'
|
|
assert sha.data == hx
|
|
|
|
elif case == 3:
|
|
psbt = b'psbt\xff' + bytes(5000)
|
|
n.add_text("Title")
|
|
n.add_custom('bitcoin.org:psbt', psbt)
|
|
n.add_text("Footer")
|
|
|
|
txt,p,ft = decode(n.bytes())
|
|
assert txt.text == 'Title'
|
|
assert ft.text == 'Footer'
|
|
assert p.data == psbt
|
|
assert p.type == 'urn:nfc:ext:bitcoin.org:psbt'
|
|
|
|
elif case == 4:
|
|
hx = b2a_hex(bytes(range(32)))
|
|
n.add_custom('bitcoin.org:txid', hx)
|
|
got, = decode(n.bytes())
|
|
assert got.type == 'urn:nfc:ext:bitcoin.org:txid'
|
|
assert got.data == hx
|
|
|
|
elif case == 5:
|
|
hx = bytes(2000)
|
|
n.add_custom('bitcoin.org:txn', hx)
|
|
got, = decode(n.bytes())
|
|
assert got.type == 'urn:nfc:ext:bitcoin.org:txn'
|
|
assert got.data == hx
|
|
|
|
@pytest.mark.parametrize('ccfile', [
|
|
'E1 40 80 09 03 10 D1 01 0C 55 01 6E 78 70 2E 63 6F 6D 2F 6E 66 63 FE 00',
|
|
'E1 40 40 00 03 2A D1012655016578616D706C652E636F6D2F74656D703D303030302F746170636F756E7465723D30303030FE000000',
|
|
b'\xe1@@\x00\x03*\xd1\x01&U\x01example.com/temp=0000/tapcounter=0000\xfe\x00\x00\x00',
|
|
'rx',
|
|
'short',
|
|
'long',
|
|
])
|
|
def test_ndef_ccfile(ccfile, load_shared_mod):
|
|
# NDEF unit tests
|
|
|
|
def decode(body):
|
|
return list(ndef.message_decoder(body))
|
|
|
|
cc_ndef = load_shared_mod('cc_ndef', '../shared/ndef.py')
|
|
|
|
txt_msg = None
|
|
if ccfile == 'rx':
|
|
ccfile = cc_ndef.CC_WR_FILE
|
|
elif ccfile == 'short':
|
|
n = cc_ndef.ndefMaker()
|
|
txt_msg = "this is a test"
|
|
n.add_text(txt_msg)
|
|
ccfile = n.bytes()
|
|
elif ccfile == 'long':
|
|
n = cc_ndef.ndefMaker()
|
|
txt_msg = "t" * 600
|
|
n.add_text(txt_msg)
|
|
ccfile = n.bytes()
|
|
elif isinstance(ccfile, str):
|
|
ccfile = a2b_hex(ccfile.replace(' ', ''))
|
|
|
|
st, ll, is_wr, mlen = cc_ndef.ccfile_decode(ccfile[0:16])
|
|
assert ccfile[st+ll] == 0xfe
|
|
body = ccfile[st:st+ll]
|
|
ref = decode(body)
|
|
|
|
if ll == 0: return # empty we can't parse
|
|
|
|
got = list(cc_ndef.record_parser(body))
|
|
|
|
for r,g in zip(ref, got):
|
|
assert r.type == g[0]
|
|
urn, data, meta = g
|
|
if r.type == 'urn:nfc:wkt:U':
|
|
assert r.data == bytes([meta['prefix']]) + bytes(data)
|
|
if r.type == 'urn:nfc:wkt:T':
|
|
assert data == r.text.encode('utf-8')
|
|
assert meta['lang'] == 'en'
|
|
if txt_msg:
|
|
assert data == txt_msg.encode('utf-8')
|
|
|
|
|
|
@pytest.fixture
|
|
def try_sign_nfc(cap_story, pick_menu_item, goto_home, need_keypress, sim_exec, nfc_read, nfc_write, nfc_block4rf):
|
|
|
|
# like "try_sign" but use NFC to send/receive PSBT/results
|
|
|
|
sim_exec('from pyb import SDCard; SDCard.ejected = True; import nfc; nfc.NFCHandler.startup()')
|
|
|
|
def doit(f_or_data, accept=True, expect_finalize=False, accept_ms_import=False, complete=False, encoding='binary', over_nfc=True):
|
|
|
|
|
|
if f_or_data[0:5] == b'psbt\xff':
|
|
ip = f_or_data
|
|
filename = 'memory'
|
|
else:
|
|
filename = f_or_data
|
|
ip = open(f_or_data, 'rb').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)
|
|
recs = [ndef.TextRecord(ip)]
|
|
elif encoding == 'base64':
|
|
from base64 import b64encode, b64decode
|
|
ip = b64encode(ip)
|
|
recs = [ndef.TextRecord(ip)]
|
|
else:
|
|
assert encoding == 'binary'
|
|
recs = [ndef.Record(type='urn:nfc:ext:bitcoin.org:psbt', data=ip),
|
|
ndef.Record(type='urn:nfc:ext:bitcoin.org:sha256', data=sha256(ip).digest()),
|
|
ndef.TextRecord('some text here about situ'),
|
|
]
|
|
|
|
open('debug/nfc-sent.psbt', 'wb').write(ip)
|
|
|
|
# wrap in a CCFile
|
|
serialized = b''.join(ndef.message_encoder(recs))
|
|
ccfile = bytearray([0xE2, 0x43, 0x00, 0x01, 0x00, 0x00, 0x04, 0x00, 0x03])
|
|
if len(serialized) > 250:
|
|
ccfile.extend(b'\xff' + pack('>H', len(serialized)))
|
|
else:
|
|
ccfile.append(len(serialized))
|
|
ccfile.extend(serialized)
|
|
ccfile.append(0xfe)
|
|
|
|
time.sleep(.2) # required
|
|
goto_home()
|
|
pick_menu_item('Ready To Sign')
|
|
|
|
time.sleep(.1)
|
|
_, story = cap_story()
|
|
assert 'NFC' in story
|
|
|
|
need_keypress('3')
|
|
time.sleep(.1)
|
|
nfc_write(ccfile)
|
|
|
|
time.sleep(.5)
|
|
|
|
if accept_ms_import:
|
|
# would be better to do cap_story here
|
|
need_keypress('y')
|
|
time.sleep(0.050)
|
|
|
|
title, story = cap_story()
|
|
assert title == 'OK TO SEND?'
|
|
|
|
if accept != None:
|
|
need_keypress('y' if accept else 'x')
|
|
|
|
if accept == False:
|
|
time.sleep(0.050)
|
|
|
|
# look for "Aborting..." ??
|
|
return ip, None, None
|
|
|
|
if not over_nfc:
|
|
# wait for it to finish
|
|
for r in range(10):
|
|
time.sleep(0.1)
|
|
title, story = cap_story()
|
|
if title == 'PSBT Signed': break
|
|
else:
|
|
assert False, 'timed out'
|
|
|
|
txid = None
|
|
lines = story.split('\n')
|
|
if 'Final TXID:' in lines:
|
|
txid = lines[-1]
|
|
|
|
need_keypress('3')
|
|
time.sleep(.1)
|
|
contents = nfc_read()
|
|
need_keypress('y')
|
|
else:
|
|
nfc_block4rf()
|
|
contents = nfc_read()
|
|
need_keypress('y')
|
|
txid = None
|
|
|
|
got_txid = None
|
|
got_txn = None
|
|
got_psbt = None
|
|
got_hash = None
|
|
for got in ndef.message_decoder(contents):
|
|
if got.type == 'urn:nfc:wkt:T':
|
|
assert 'Transaction' in got.text or 'PSBT' in got.text
|
|
if 'Transaction' in got.text and txid:
|
|
assert b2a_hex(txid).decode() in got.text
|
|
elif got.type == 'urn:nfc:ext:bitcoin.org:txid':
|
|
got_txid = b2a_hex(got.data).decode('ascii')
|
|
elif got.type == 'urn:nfc:ext:bitcoin.org:txn':
|
|
got_txn = got.data
|
|
elif got.type == 'urn:nfc:ext:bitcoin.org:psbt':
|
|
got_psbt = got.data
|
|
elif got.type == 'urn:nfc:ext:bitcoin.org:sha256':
|
|
got_hash = got.data
|
|
else:
|
|
raise ValueError(got.type)
|
|
|
|
assert got_psbt or got_txn, 'no data?'
|
|
assert got_hash
|
|
assert got_hash == sha256(got_psbt or got_txn).digest()
|
|
|
|
if got_txid and not txid:
|
|
# Txid not shown in pure NFC case
|
|
txid = got_txid
|
|
|
|
if got_txid:
|
|
assert got_txn
|
|
assert got_txid == txid
|
|
assert expect_finalize
|
|
result = got_txn
|
|
open("debug/nfc-result.txn", 'wb').write(result)
|
|
else:
|
|
assert not expect_finalize
|
|
result = got_psbt
|
|
|
|
open("debug/nfc-result.psbt", 'wb').write(result)
|
|
|
|
if 0:
|
|
# check output encoding matches input
|
|
if encoding == 'hex' or finalize:
|
|
result = a2b_hex(result.strip())
|
|
elif encoding == 'base64':
|
|
result = b64decode(result)
|
|
else:
|
|
assert encoding == 'binary'
|
|
|
|
# read back final product
|
|
if got_txn:
|
|
from pycoin.tx.Tx import Tx
|
|
# parse it a little
|
|
assert result[0:4] != b'psbt'
|
|
t = Tx.from_bin(got_txn)
|
|
assert t.version in [1, 2]
|
|
#XXX#assert t.id() == txid # XXX why fail intermittently? sync.
|
|
|
|
if got_psbt:
|
|
assert got_psbt[0:5] == b'psbt\xff'
|
|
|
|
from psbt import BasicPSBT
|
|
was = BasicPSBT().parse(ip)
|
|
now = BasicPSBT().parse(got_psbt)
|
|
assert was.txn == now.txn
|
|
assert was != now
|
|
|
|
return ip, (got_psbt or got_txn), txid
|
|
|
|
yield doit
|
|
|
|
# cleanup / restore
|
|
sim_exec('from pyb import SDCard; SDCard.ejected = False')
|
|
|
|
@pytest.mark.parametrize('num_outs', [ 1, 20, 250])
|
|
def test_nfc_after(num_outs, fake_txn, try_sign, nfc_read, need_keypress, cap_story, only_mk4):
|
|
# 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 = nfc_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)
|
|
|
|
@pytest.mark.unfinalized # iff partial=1
|
|
@pytest.mark.parametrize('encoding', ['binary', 'hex', 'base64'])
|
|
@pytest.mark.parametrize('num_outs', [1,2])
|
|
@pytest.mark.parametrize('partial', [1, 0])
|
|
def test_nfc_signing(encoding, num_outs, partial, try_sign_nfc, fake_txn, dev, settings_set):
|
|
xp = dev.master_xpub
|
|
|
|
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_nfc(psbt, expect_finalize=not partial, encoding=encoding)
|
|
|
|
def test_rf_uid(rf_interface, cap_story, goto_home, pick_menu_item):
|
|
# read UID of NFC chip over the air
|
|
sw, ident = rf_interface.apdu(0xff, 0xca) # PAPDU_GET_UID
|
|
assert sw == '0x9000'
|
|
assert ident[-2:] == b'\x02\xe0' # ST vendor
|
|
assert len(ident) == 8
|
|
uid = ''.join('%02x'%i for i in reversed(ident))
|
|
|
|
# check UI is reporting same value
|
|
goto_home()
|
|
pick_menu_item('Advanced/Tools')
|
|
pick_menu_item('Upgrade')
|
|
pick_menu_item('Show Version')
|
|
_, story = cap_story()
|
|
|
|
assert uid in story
|
|
print(uid)
|
|
|
|
|
|
def test_ndef_roundtrip(load_shared_mod):
|
|
# specific failing case
|
|
cc_ndef = load_shared_mod('cc_ndef', '../shared/ndef.py')
|
|
|
|
r = open('data/ms-import.ndef', 'rb').read()
|
|
|
|
assert cc_ndef.ccfile_decode(r) == (12, 399, False, 4096)
|
|
|
|
|
|
|
|
# EOF
|