435 lines
16 KiB
Python
435 lines
16 KiB
Python
# (c) Copyright 2020 by Coinkite Inc. This file is covered by license found in COPYING-CC.
|
|
#
|
|
# Run tests on the simulator itself, not here... these are basically "unit tests"
|
|
#
|
|
|
|
import pytest, os, shutil
|
|
from helpers import B2A
|
|
from constants import AF_P2WSH, AF_P2SH, AF_P2WSH_P2SH, AF_CLASSIC, AF_P2WPKH, AF_P2WPKH_P2SH
|
|
from charcodes import *
|
|
|
|
|
|
def test_remote_exec(sim_exec):
|
|
assert sim_exec("RV.write('testing123')") == 'testing123'
|
|
|
|
def test_codecs(sim_execfile):
|
|
assert sim_execfile('devtest/segwit_addr.py') == ''
|
|
|
|
def test_public(sim_execfile):
|
|
"verify contents of public 'dump' file"
|
|
import bech32
|
|
from bip32 import BIP32Node
|
|
from base58 import decode_base58_checksum
|
|
from helpers import hash160
|
|
|
|
pub = sim_execfile('devtest/dump_public.py')
|
|
assert 'Error' not in pub
|
|
|
|
#print(pub)
|
|
|
|
pub, dev = pub.split('#DEBUG#', 1)
|
|
assert 'pub' in pub
|
|
assert 'prv' not in pub
|
|
assert 'prv' in dev
|
|
|
|
lines = [i.strip() for i in pub.split('\n')]
|
|
|
|
for ln in lines:
|
|
if ln[1:4] == 'pub':
|
|
node_pub = BIP32Node.from_wallet_key(ln)
|
|
break
|
|
|
|
node_prv = BIP32Node.from_wallet_key(dev.strip())
|
|
|
|
# pub and private are linked
|
|
assert node_prv.hwif(as_private=False) == node_pub.hwif()
|
|
|
|
# check every path we derived
|
|
count = 0
|
|
for ln in lines:
|
|
if ln[0:1] == 'm' and '=>' in ln:
|
|
subpath, result = ln.split(' => ', 1)
|
|
|
|
sk = node_prv.subkey_for_path(subpath)
|
|
|
|
if result[1:4] == 'pub' and result[0] not in 'xt':
|
|
# SLIP-132 garbage
|
|
assert 'SLIP-132' in result
|
|
result = result.split('#', 1)[0].strip()
|
|
|
|
# just base58/checksum check
|
|
assert decode_base58_checksum(result)
|
|
|
|
elif result[1:4] == 'pub':
|
|
try:
|
|
expect = BIP32Node.from_wallet_key(result)
|
|
except Exception as e:
|
|
if 'unknown prefix' in str(e):
|
|
# BIP32Node not yet ready for SLIP-132
|
|
assert result[0] != 'x'
|
|
print("SKIP: " + ln)
|
|
continue
|
|
raise
|
|
assert sk.hwif() == result
|
|
elif result[0] in '1mn':
|
|
assert result == sk.address()
|
|
elif result[0:3] in { 'bc1', 'tb1' }:
|
|
h20 = sk.hash160()
|
|
assert result == bech32.encode(result[0:2], 0, h20)
|
|
elif result[0] in '23':
|
|
h20 = hash160(b'\x00\x14' + sk.hash160())
|
|
assert h20 == decode_base58_checksum(result)[1:]
|
|
else:
|
|
raise ValueError(result)
|
|
|
|
count += 1
|
|
print("OK: %s" % ln)
|
|
|
|
|
|
assert count > 12
|
|
|
|
|
|
def test_nvram(unit_test, only_mk3):
|
|
# exercise nvram simulation: not mk4
|
|
unit_test('devtest/nvram.py')
|
|
|
|
def test_nvram_mk4(unit_test, only_mk4plus):
|
|
# exercise nvram simulation: only mk4
|
|
unit_test('devtest/nvram_mk4.py')
|
|
|
|
@pytest.mark.manual
|
|
def test_backups_simple(unit_test, set_seed_words):
|
|
# exercise dump of pub data
|
|
# - (bug) mk4 can only run this test in isolation from other test in this file.
|
|
unit_test('devtest/backups.py')
|
|
|
|
@pytest.mark.manual
|
|
def test_backups_blankish(unit_test, set_seed_words):
|
|
# exercise dump of pub data
|
|
# - (bug) mk4 can only run this test in isolation from other test in this file.
|
|
|
|
# want a zero in last byte of hex representation of raw secret...
|
|
'''
|
|
>>> tcc.bip39.from_data(bytes([0x10]*32))
|
|
'avoid letter advice cage ... absurd amount doctor blanket'
|
|
'''
|
|
set_seed_words('avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor blanket')
|
|
|
|
unit_test('devtest/backups.py')
|
|
|
|
def test_bip143(unit_test):
|
|
# exercise hash digesting for bip143 signatures
|
|
unit_test('devtest/unit_bip143.py')
|
|
|
|
def test_addr_decode(unit_test):
|
|
# - runs som known examples thru CTxIn and check it categories, and extracts pubkey/pkh right
|
|
unit_test('devtest/unit_addrs.py')
|
|
|
|
def test_clear_seed(unit_test):
|
|
# just testing the test?
|
|
unit_test('devtest/clear_seed.py')
|
|
|
|
def test_slip132(unit_test):
|
|
# slip132 ?pub stuff
|
|
unit_test('devtest/unit_slip132.py')
|
|
|
|
def test_multisig(unit_test):
|
|
# scripts/multisig unit tests
|
|
unit_test('devtest/unit_multisig.py')
|
|
|
|
def test_decoding(unit_test):
|
|
# utils.py Hex/Base64 streaming decoders
|
|
unit_test('devtest/unit_decoding.py')
|
|
|
|
@pytest.mark.parametrize('hasher', ['sha256', 'sha1', 'sha512'])
|
|
@pytest.mark.parametrize('msg', [b'123', b'b'*78])
|
|
@pytest.mark.parametrize('key', [b'3245', b'b'*78])
|
|
def test_hmac(sim_exec, msg, key, hasher):
|
|
import hashlib, hmac
|
|
|
|
cmd = "import ngu; from ubinascii import hexlify as b2a_hex; " + \
|
|
f"RV.write(b2a_hex(ngu.hmac.hmac_{hasher}({key}, {msg})))"
|
|
print(cmd)
|
|
|
|
got = sim_exec(cmd)
|
|
expect = hmac.new(key, msg, hasher).hexdigest()
|
|
|
|
assert got == expect
|
|
#print(expect)
|
|
|
|
@pytest.mark.parametrize('secret,counter,expect', [
|
|
( b'abcdefghij', 1, '765705'),
|
|
( b'abcdefghij', 2, '816065'),
|
|
( b'12345678901234567890', 0, '755224'), # test vectors from RFC4226
|
|
( b'12345678901234567890', 1, '287082'),
|
|
( b'12345678901234567890', 2, '359152'),
|
|
( b'12345678901234567890', 3, '969429'),
|
|
( b'12345678901234567890', 4, '338314'),
|
|
( b'12345678901234567890', 5, '254676'),
|
|
( b'12345678901234567890', 6, '287922'),
|
|
( b'12345678901234567890', 7, '162583'),
|
|
( b'12345678901234567890', 8, '399871'),
|
|
( b'12345678901234567890', 9, '520489'),
|
|
])
|
|
def test_hotp(sim_exec, secret, counter, expect):
|
|
cmd = "from users import calc_hotp; " + \
|
|
f"RV.write(calc_hotp({secret}, {counter}))"
|
|
got = sim_exec(cmd)
|
|
assert got == expect
|
|
|
|
def test_hmac_key(dev, sim_exec, count=10):
|
|
from hashlib import pbkdf2_hmac, sha256
|
|
from ckcc_protocol.constants import PBKDF2_ITER_COUNT
|
|
|
|
sn = sim_exec('import version; RV.write(version.serial_number().encode())').encode()
|
|
salt = sha256(b'pepper'+sn).digest()
|
|
|
|
for i in range(count):
|
|
pw = ('test%09d' % i).encode('ascii')
|
|
pw = pw[1:i] if i > 2 else pw
|
|
cmd = "from users import calc_hmac_key; from ubinascii import hexlify as b2a_hex; " + \
|
|
f"RV.write(b2a_hex(calc_hmac_key({pw})))"
|
|
|
|
got = sim_exec(cmd)
|
|
|
|
#print('pw=%r s=%r cnt=%d' % (pw, salt, PBKDF2_ITER_COUNT))
|
|
expect = B2A(pbkdf2_hmac('sha512', pw, salt, PBKDF2_ITER_COUNT)[0:32])
|
|
|
|
assert got == expect
|
|
print(got)
|
|
|
|
@pytest.mark.parametrize('path,ans', [
|
|
("m", "m"),
|
|
("", "m"),
|
|
("55555p/66666", "m/55555h/66666"),
|
|
("m/1/2/3", "m/1/2/3"),
|
|
("m/1'/2h/3p/4H/5P", "m/1h/2h/3h/4h/5h"),
|
|
("m/1'/2h/3p/4H/*'", "m/1h/2h/3h/4h/*h"),
|
|
("m/1'/2h/3p/4H/*", "m/1h/2h/3h/4h/*"),
|
|
("m/10000000/5'/*", "m/10000000/5h/*"),
|
|
])
|
|
@pytest.mark.parametrize('star', [False, True])
|
|
def test_cleanup_deriv_path_good(path, ans, star, sim_exec):
|
|
|
|
cmd = f'from utils import cleanup_deriv_path; RV.write(cleanup_deriv_path({repr(path)}, allow_star={star}))'
|
|
rv = sim_exec(cmd)
|
|
|
|
if not star and '*' in path:
|
|
assert 'Traceback' in rv
|
|
assert 'invalid characters' in rv
|
|
else:
|
|
assert rv == ans
|
|
|
|
@pytest.mark.parametrize('path,ans', [
|
|
("m/", "empty path component"),
|
|
("m//", "empty path component"),
|
|
("m/*/*", "invalid characters"),
|
|
("m/4/100000000000000", "bad component"),
|
|
("m/100000000000000/*", "bad component"),
|
|
("m/-34/*", "invalid characters"),
|
|
("m/*/5/*", "invalid characters"),
|
|
("m/*/*", "invalid characters"),
|
|
("m/*/5", "invalid characters"),
|
|
])
|
|
def test_cleanup_deriv_path_fails(path, ans, sim_exec, star=True):
|
|
|
|
cmd = f'from utils import cleanup_deriv_path; RV.write(cleanup_deriv_path({repr(path)}, allow_star={star}))'
|
|
rv = sim_exec(cmd)
|
|
|
|
assert 'Traceback' in rv
|
|
assert ans in rv
|
|
|
|
|
|
@pytest.mark.parametrize('script_hex, expect', [
|
|
# not OP_RETURN -> None
|
|
('51', None), # OP_1
|
|
('0014' + '00'*20, None), # p2wpkh
|
|
# real null-data -> b""
|
|
('6a', b''), # bare OP_RETURN
|
|
('6a00', b''), # OP_RETURN OP_0
|
|
('6a4c00', b''), # OP_RETURN PUSHDATA1 len 0 (empty push)
|
|
# single push -> the data
|
|
('6a0468696465', b'hide'), # OP_RETURN <push "hide">
|
|
('6a01ff', b'\xff'), # OP_RETURN <push 0xff>
|
|
# data behind OP_RETURN -> None (caller shows raw script)
|
|
('6a000468696465', None), # OP_RETURN OP_0 <push "hide">
|
|
('6a04414141410442424242', None), # OP_RETURN <push><push>
|
|
('6a55', None), # OP_RETURN OP_5
|
|
# non-push opcode after OP_RETURN (not OP_0) -> None, not null-data
|
|
('6a76', None), # OP_RETURN OP_DUP
|
|
('6a6a', None), # OP_RETURN OP_RETURN
|
|
# truncated / malformed pushes after OP_RETURN -> None (show raw script)
|
|
('6a04ff', None), # OP_RETURN <direct push len 4, only 1 byte>
|
|
('6a4c04ff', None), # OP_RETURN PUSHDATA1 len 4, only 1 byte
|
|
('6a4d', None), # OP_RETURN PUSHDATA2 truncated length
|
|
('', None), # empty script
|
|
])
|
|
def test_op_return_decode(script_hex, expect, sim_exec):
|
|
cmd = ('from chains import BitcoinMain; from ubinascii import unhexlify; '
|
|
'RV.write(repr(BitcoinMain.op_return(unhexlify(%r))))' % script_hex)
|
|
rv = sim_exec(cmd)
|
|
assert 'Traceback' not in rv, rv
|
|
assert rv == repr(expect)
|
|
|
|
|
|
@pytest.mark.parametrize('patterns, paths, answers', [
|
|
(["m"], ("m", "m/2", "*", "any"), [True, False, False, False]),
|
|
(["any"], ("m", "m/2", "*", "1/2/3/4/5/6h/55h"), [True]*4),
|
|
(["m/1", "m/2/*h"], ("m", "m/1", "m/3/4", "m/2/4h", "m/2/4"),
|
|
[0, 1, 0, 1, 0]),
|
|
(["m/1/*", "m/2/*h"], ("m/1/2", "m/1/2h", "m/2/1", "m/2/1h"),
|
|
[1, 0, 0, 1]),
|
|
(["m/20/*", "m/30h/*h"], ("m/20/2", "m/30/2h", "m/2h/1", "m/30h/1h"),
|
|
[1, 0, 0, 1]),
|
|
])
|
|
def test_match_deriv_path(patterns, paths, answers, sim_exec):
|
|
# only testing internal function which inputs are already normalized by cleanu_deriv_path
|
|
for path, ans in zip(paths, answers):
|
|
cmd = f'from utils import match_deriv_path; RV.write(str(match_deriv_path({repr(patterns)}, {repr(path)})))'
|
|
rv = sim_exec(cmd)
|
|
assert rv == str(bool(ans))
|
|
|
|
|
|
def test_is_dir(microsd_path, sim_exec):
|
|
dir = microsd_path("my_dir/my_inner_dir")
|
|
try:
|
|
os.makedirs(dir)
|
|
except FileExistsError: pass
|
|
with open(dir + "/nothing.txt", "w") as f:
|
|
f.write("ok")
|
|
cmd = 'import files; cs = files.CardSlot().__enter__(); RV.write(str(cs.is_dir("my_dir"))); cs.__exit__()'
|
|
rv = sim_exec(cmd)
|
|
assert rv == "True"
|
|
cmd = 'import files; cs = files.CardSlot().__enter__(); RV.write(str(cs.is_dir("my_dir/my_inner_dir"))); cs.__exit__()'
|
|
rv = sim_exec(cmd)
|
|
assert rv == "True"
|
|
cmd = 'import files; cs = files.CardSlot().__enter__(); RV.write(str(cs.is_dir("my_dir/my_inner_dir/nothing.txt"))); cs.__exit__()'
|
|
rv = sim_exec(cmd)
|
|
assert rv == "False"
|
|
shutil.rmtree(microsd_path("my_dir"))
|
|
|
|
DOUBLE_W = ['⋯', '✔', '✓', '→', '←', '↦', '◉', '◯', '◌', '※', '—', '\x0e', '\x11', '\t', '\x0f', '\x12', '\x13', '\x14', '\x16', '\x17']
|
|
|
|
@pytest.mark.parametrize('txt, target', [
|
|
('Disk, press \x0e to share via NFC, \x11 to share', ['Disk, press \x0e to share via NFC,', '\x11 to share']),
|
|
((KEY_NFC * 17)+".", [KEY_NFC * 16, KEY_NFC + '.']),
|
|
((KEY_NFC * 17)+(17*KEY_QR), [KEY_NFC * 16, KEY_NFC +(KEY_QR * 15), 2 * KEY_QR]),
|
|
((KEY_NFC * 17)+" "+(17*KEY_QR), [KEY_NFC * 16, KEY_NFC, KEY_QR * 16, KEY_QR]),
|
|
((KEY_NFC * 16)+".", [(KEY_NFC * 16)+'.']),
|
|
(f"Use {KEY_NFC}, or {KEY_F1}, {KEY_F2}, {KEY_F3}, or or or {KEY_F4}", [f"Use {KEY_NFC}, or {KEY_F1}, {KEY_F2}, {KEY_F3}, or or or", f"{KEY_F4}"]),
|
|
("".join(DOUBLE_W), ["".join(DOUBLE_W[:16]), "".join(DOUBLE_W[16:])]),
|
|
("".join(6*DOUBLE_W), ["".join(6*DOUBLE_W)[i:i + 16] for i in range(0, len(6*DOUBLE_W), 16)]),
|
|
])
|
|
def test_word_wrap_double_wide(only_q1, txt, target, sim_exec):
|
|
width = 33 # check shared/ux.py CHAR_PER_W
|
|
cmd = f'from utils import word_wrap; RV.write("\\n".join(word_wrap({txt!r}, {width})))'
|
|
got = sim_exec(cmd)
|
|
assert 'Traceback' not in got
|
|
|
|
lines = got.split('\n')
|
|
|
|
assert lines == target
|
|
|
|
@pytest.mark.parametrize('txt, target, width', [
|
|
((17*'a')+". ccc", [(17*'a')+".", "ccc"], 17),
|
|
((17*'a')+".", [(17*'a')+"."], 17),
|
|
((17*'-')+". ccc", [(17*'-')+".", "ccc"], 17),
|
|
((34 * 'A'), [33 * "A", "A"], 33),
|
|
((33 * 'A')+". ccc", [(33 * "A")+".", "ccc"], 33),
|
|
('Coldcard is ready to sign spending transactions!', ['Coldcard is ready to sign', 'spending transactions!'], 33),
|
|
('Coldcard is ready to sign spending transactions!', ['Coldcard is ready', 'to sign spending', 'transactions!'], 17),
|
|
((16*"B")+ " AAAA", [16*"B", "AAAA"], 17),
|
|
((16*"B")+ " AAAA", [(16*"B")+" ", "AAAA"], 17),
|
|
((17*"B")+ " AAAA", [17*"B", "AAAA"], 17),
|
|
((17*"B")+ " AAAA", [17*"B", " AAAA"], 17),
|
|
("(recommended), or by typing numbers.", ["(recommended), or", "by typing numbers."], 17),
|
|
("difficult to recover your funds.", ["difficult to", "recover your", "funds."], 17),
|
|
("USB Serial Number:", ["USB Serial Number:"], 17),
|
|
("USB Serial Number;", ["USB Serial Number;"], 17),
|
|
("USB Serial Number/", ["USB Serial", "Number/"], 17),
|
|
])
|
|
def test_word_wrap(txt, target, width, sim_exec):
|
|
cmd = f'from utils import word_wrap; RV.write("\\n".join(word_wrap({txt!r}, {width})))'
|
|
got = sim_exec(cmd)
|
|
assert 'Traceback' not in got
|
|
|
|
lines = got.split('\n')
|
|
|
|
assert lines == target
|
|
|
|
|
|
def check_own_address_detect(addr, sim_exec):
|
|
cmd = f"""
|
|
from glob import settings
|
|
from utils import validate_own_address
|
|
rv = []
|
|
for ctype in ('BTC', 'XTN', 'XRT'):
|
|
settings.set('chain', ctype)
|
|
try:
|
|
rv.append((ctype, validate_own_address({addr!r})[1]))
|
|
except:
|
|
rv.append((ctype, 0))
|
|
settings.set('chain', 'XTN')
|
|
RV.write(repr(rv))
|
|
"""
|
|
lst = sim_exec(cmd)
|
|
assert 'Error' not in lst
|
|
return eval(lst)
|
|
|
|
|
|
@pytest.mark.parametrize('addr,net,fmt', [
|
|
( 'bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4', 'BTC', AF_P2WPKH ),
|
|
])
|
|
def test_addr_detect(addr, net, fmt, sim_exec):
|
|
for got_net, match in check_own_address_detect(addr, sim_exec):
|
|
if match:
|
|
assert net == got_net
|
|
assert match == fmt
|
|
else:
|
|
assert net != got_net
|
|
assert match == 0
|
|
|
|
'''
|
|
>>> [AF_P2WSH, AF_P2SH, AF_P2WSH_P2SH, AF_CLASSIC, AF_P2WPKH, AF_P2WPKH_P2SH]
|
|
[14, 8, 26, 1, 7, 19]
|
|
'''
|
|
@pytest.mark.parametrize('addr_fmt', [
|
|
AF_P2WSH, AF_P2SH, AF_P2WSH_P2SH, AF_CLASSIC, AF_P2WPKH, AF_P2WPKH_P2SH
|
|
])
|
|
@pytest.mark.parametrize('testnet', [ False, True] )
|
|
def test_addr_fake_detect(addr_fmt, testnet, sim_exec):
|
|
from txn import fake_address
|
|
|
|
addr = fake_address(addr_fmt, testnet)
|
|
|
|
expect_net = ('BTC' if not testnet else 'XTN')
|
|
|
|
expect_addr_fmt = addr_fmt if addr_fmt not in { AF_P2WSH_P2SH, AF_P2WPKH_P2SH } else AF_P2SH
|
|
|
|
for got_net, match in check_own_address_detect(addr, sim_exec):
|
|
if match:
|
|
if got_net == 'XRT':
|
|
assert expect_net == 'XTN'
|
|
else:
|
|
assert got_net == expect_net
|
|
assert match == expect_addr_fmt
|
|
else:
|
|
assert got_net != expect_net
|
|
assert match == 0
|
|
|
|
def test_af(sim_execfile):
|
|
res = sim_execfile('devtest/unit_af.py')
|
|
assert res == ""
|
|
|
|
|
|
def test_aes_compatibility(sim_execfile):
|
|
res = sim_execfile('devtest/unit_aes_compat.py')
|
|
assert res == ""
|
|
|
|
|
|
def test_script(sim_execfile):
|
|
res = sim_execfile('devtest/unit_script.py')
|
|
assert res == ""
|
|
|
|
# EOF
|