-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
Copy pathtest_mnemonic.py
287 lines (251 loc) · 17.9 KB
/
test_mnemonic.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
from typing import NamedTuple, Optional
import json
import os
from electrum import keystore
from electrum import mnemonic
from electrum import slip39
from electrum import old_mnemonic
from electrum.util import bfh
from electrum.mnemonic import is_new_seed, is_old_seed, calc_seed_type, is_matching_seed, can_seed_have_passphrase
from electrum.version import SEED_PREFIX_SW, SEED_PREFIX
from . import ElectrumTestCase
from .test_wallet_vertical import UNICODE_HORROR, UNICODE_HORROR_HEX
class SeedTestCase(NamedTuple):
words: str
bip32_seed: str
lang: Optional[str] = 'en'
words_hex: Optional[str] = None
entropy: Optional[int] = None
passphrase: Optional[str] = None
passphrase_hex: Optional[str] = None
seed_version: str = SEED_PREFIX
SEED_TEST_CASES = {
'english': SeedTestCase(
words='wild father tree among universe such mobile favorite target dynamic credit identify',
seed_version=SEED_PREFIX_SW,
bip32_seed='aac2a6302e48577ab4b46f23dbae0774e2e62c796f797d0a1b5faeb528301e3064342dafb79069e7c4c6b8c38ae11d7a973bec0d4f70626f8cc5184a8d0b0756'),
'english_with_passphrase': SeedTestCase(
words='wild father tree among universe such mobile favorite target dynamic credit identify',
seed_version=SEED_PREFIX_SW,
passphrase='Did you ever hear the tragedy of Darth Plagueis the Wise?',
bip32_seed='4aa29f2aeb0127efb55138ab9e7be83b36750358751906f86c662b21a1ea1370f949e6d1a12fa56d3d93cadda93038c76ac8118597364e46f5156fde6183c82f'),
'japanese': SeedTestCase(
lang='ja',
words='なのか ひろい しなん まなぶ つぶす さがす おしゃれ かわく おいかける けさき かいとう さたん',
words_hex='e381aae381aee3818b20e381b2e3828de3818420e38197e381aae3829320e381bee381aae381b5e3829920e381a4e381b5e38299e3819920e38195e3818be38299e3819920e3818ae38197e38283e3828c20e3818be3828fe3818f20e3818ae38184e3818be38191e3828b20e38191e38195e3818d20e3818be38184e381a8e3818620e38195e3819fe38293',
entropy=1938439226660562861250521787963972783469,
bip32_seed='d3eaf0e44ddae3a5769cb08a26918e8b308258bcb057bb704c6f69713245c0b35cb92c03df9c9ece5eff826091b4e74041e010b701d44d610976ce8bfb66a8ad'),
'japanese_with_passphrase': SeedTestCase(
lang='ja',
words='なのか ひろい しなん まなぶ つぶす さがす おしゃれ かわく おいかける けさき かいとう さたん',
words_hex='e381aae381aee3818b20e381b2e3828de3818420e38197e381aae3829320e381bee381aae381b5e3829920e381a4e381b5e38299e3819920e38195e3818be38299e3819920e3818ae38197e38283e3828c20e3818be3828fe3818f20e3818ae38184e3818be38191e3828b20e38191e38195e3818d20e3818be38184e381a8e3818620e38195e3819fe38293',
entropy=1938439226660562861250521787963972783469,
passphrase=UNICODE_HORROR,
passphrase_hex=UNICODE_HORROR_HEX,
bip32_seed='251ee6b45b38ba0849e8f40794540f7e2c6d9d604c31d68d3ac50c034f8b64e4bc037c5e1e985a2fed8aad23560e690b03b120daf2e84dceb1d7857dda042457'),
'chinese': SeedTestCase(
lang='zh',
words='眼 悲 叛 改 节 跃 衡 响 疆 股 遂 冬',
words_hex='e79cbc20e682b220e58f9b20e694b920e88a8220e8b78320e8a1a120e5938d20e7968620e882a120e9818220e586ac',
seed_version=SEED_PREFIX_SW,
entropy=3083737086352778425940060465574397809099,
bip32_seed='0b9077db7b5a50dbb6f61821e2d35e255068a5847e221138048a20e12d80b673ce306b6fe7ac174ebc6751e11b7037be6ee9f17db8040bb44f8466d519ce2abf'),
'chinese_with_passphrase': SeedTestCase(
lang='zh',
words='眼 悲 叛 改 节 跃 衡 响 疆 股 遂 冬',
words_hex='e79cbc20e682b220e58f9b20e694b920e88a8220e8b78320e8a1a120e5938d20e7968620e882a120e9818220e586ac',
seed_version=SEED_PREFIX_SW,
entropy=3083737086352778425940060465574397809099,
passphrase='给我一些测试向量谷歌',
passphrase_hex='e7bb99e68891e4b880e4ba9be6b58be8af95e59091e9878fe8b0b7e6ad8c',
bip32_seed='6c03dd0615cf59963620c0af6840b52e867468cc64f20a1f4c8155705738e87b8edb0fc8a6cee4085776cb3a629ff88bb1a38f37085efdbf11ce9ec5a7fa5f71'),
'spanish': SeedTestCase(
lang='es',
words='almíbar tibio superar vencer hacha peatón príncipe matar consejo polen vehículo odisea',
words_hex='616c6d69cc8162617220746962696f20737570657261722076656e63657220686163686120706561746fcc816e20707269cc816e63697065206d6174617220636f6e73656a6f20706f6c656e2076656869cc8163756c6f206f6469736561',
entropy=3423992296655289706780599506247192518735,
bip32_seed='18bffd573a960cc775bbd80ed60b7dc00bc8796a186edebe7fc7cf1f316da0fe937852a969c5c79ded8255cdf54409537a16339fbe33fb9161af793ea47faa7a'),
'spanish_with_passphrase': SeedTestCase(
lang='es',
words='almíbar tibio superar vencer hacha peatón príncipe matar consejo polen vehículo odisea',
words_hex='616c6d69cc8162617220746962696f20737570657261722076656e63657220686163686120706561746fcc816e20707269cc816e63697065206d6174617220636f6e73656a6f20706f6c656e2076656869cc8163756c6f206f6469736561',
entropy=3423992296655289706780599506247192518735,
passphrase='araña difícil solución término cárcel',
passphrase_hex='6172616ecc83612064696669cc8163696c20736f6c7563696fcc816e207465cc81726d696e6f206361cc817263656c',
bip32_seed='363dec0e575b887cfccebee4c84fca5a3a6bed9d0e099c061fa6b85020b031f8fe3636d9af187bf432d451273c625e20f24f651ada41aae2c4ea62d87e9fa44c'),
'spanish2': SeedTestCase(
lang='es',
words='equipo fiar auge langosta hacha calor trance cubrir carro pulmón oro áspero',
words_hex='65717569706f20666961722061756765206c616e676f7374612068616368612063616c6f72207472616e63652063756272697220636172726f2070756c6d6fcc816e206f726f2061cc81737065726f',
seed_version=SEED_PREFIX_SW,
entropy=448346710104003081119421156750490206837,
bip32_seed='001ebce6bfde5851f28a0d44aae5ae0c762b600daf3b33fc8fc630aee0d207646b6f98b18e17dfe3be0a5efe2753c7cdad95860adbbb62cecad4dedb88e02a64'),
'spanish3': SeedTestCase(
lang='es',
words='vidrio jabón muestra pájaro capucha eludir feliz rotar fogata pez rezar oír',
words_hex='76696472696f206a61626fcc816e206d756573747261207061cc816a61726f206361707563686120656c756469722066656c697a20726f74617220666f676174612070657a2072657a6172206f69cc8172',
seed_version=SEED_PREFIX_SW,
entropy=3444792611339130545499611089352232093648,
passphrase='¡Viva España! repiten veinte pueblos y al hablar dan fe del ánimo español... ¡Marquen arado martillo y clarín',
passphrase_hex='c2a1566976612045737061c3b16121207265706974656e207665696e746520707565626c6f73207920616c206861626c61722064616e2066652064656c20c3a16e696d6f2065737061c3b16f6c2e2e2e20c2a14d61727175656e20617261646f206d617274696c6c6f207920636c6172c3ad6e',
bip32_seed='c274665e5453c72f82b8444e293e048d700c59bf000cacfba597629d202dcf3aab1cf9c00ba8d3456b7943428541fed714d01d8a0a4028fc3a9bb33d981cb49f'),
}
class Test_NewMnemonic(ElectrumTestCase):
def test_mnemonic_to_seed_basic(self):
# note: not a valid electrum seed
seed = mnemonic.Mnemonic.mnemonic_to_seed(mnemonic='foobar', passphrase='none')
self.assertEqual('741b72fd15effece6bfe5a26a52184f66811bd2be363190e07a42cca442b1a5bb22b3ad0eb338197287e6d314866c7fba863ac65d3f156087a5052ebc7157fce',
seed.hex())
def test_mnemonic_to_seed(self):
for test_name, test in SEED_TEST_CASES.items():
if test.words_hex is not None:
self.assertEqual(test.words_hex, test.words.encode('utf8').hex(), msg=test_name)
self.assertTrue(is_new_seed(test.words, prefix=test.seed_version), msg=test_name)
m = mnemonic.Mnemonic(lang=test.lang)
if test.entropy is not None:
self.assertEqual(test.entropy, m.mnemonic_decode(test.words), msg=test_name)
if test.passphrase_hex is not None:
self.assertEqual(test.passphrase_hex, test.passphrase.encode('utf8').hex(), msg=test_name)
seed = mnemonic.Mnemonic.mnemonic_to_seed(mnemonic=test.words, passphrase=test.passphrase)
self.assertEqual(test.bip32_seed, seed.hex(), msg=test_name)
def test_random_seeds(self):
iters = 10
m = mnemonic.Mnemonic(lang='en')
pool = set()
for _ in range(iters):
seed = m.make_seed(seed_type="standard")
pool.add(seed)
with self.subTest(seed=seed, msg="decode-encode"):
i = m.mnemonic_decode(seed)
self.assertEqual(m.mnemonic_encode(i), seed)
with self.subTest(seed=seed, msg="num-words"):
self.assertTrue(12 <= len(seed.split()) <= 13)
self.assertEqual(iters, len(pool))
class Test_OldMnemonic(ElectrumTestCase):
def test(self):
seed = '8edad31a95e7d59f8837667510d75a4d'
result = old_mnemonic.mn_encode(seed)
words = 'hardly point goal hallway patience key stone difference ready caught listen fact'
self.assertEqual(result, words.split())
self.assertEqual(old_mnemonic.mn_decode(result), seed)
class Test_BIP39(ElectrumTestCase):
def test_checksum(self):
mnemonic = u'gravity machine north sort system female filter attitude volume fold club stay feature office ecology stable narrow fog'
is_checksum_valid, is_wordlist_valid = keystore.bip39_is_checksum_valid(mnemonic)
self.assertTrue(is_wordlist_valid)
self.assertTrue(is_checksum_valid)
def test_cjk_normalization(self):
# test case from https://github.com/Electron-Cash/Electron-Cash/issues/2740
cjk_toku_kanchi_hex = "e381a8e3818ae3818fe38080e3818be38293e381a1e38080e3819de38186e38193e38299e38080e381bee38293e3818be38299e38080e3818de3818be3818fe38080e381bbe38184e3818fe38080e3818fe38186e381b5e3818fe38080e381a6e381b5e3819fe38299e38080e38191e3828fe38197e38184e38080e3819fe381a1e381afe38299e381aae38080e381b2e381a4e38288e38186e38080e381bbe38182e38293"
cjk_toku_kanchi = bfh(cjk_toku_kanchi_hex).decode("utf-8")
assert cjk_toku_kanchi == "とおく かんち そうご まんが きかく ほいく くうふく てふだ けわしい たちばな ひつよう ほあん"
bip32_seed = keystore.bip39_to_seed(cjk_toku_kanchi, passphrase="")
self.assertEqual(
bytes.fromhex("2c53f34b1bcd338681783e671386ccaa12f5f1b08a2eee679a43f8acf956130d9246ddc98aaf50e9bdceb9b2cb4096a94fe0beec816b2a233eda29a376d17912"),
bip32_seed)
bip32_seed = keystore.bip39_to_seed(cjk_toku_kanchi, passphrase=cjk_toku_kanchi)
self.assertEqual(
bytes.fromhex("885df1b4e9906fb0ef187f4414cced1092c85cbf0b30676865f80f294d745a3a7ddfd37d8a512e644684bdfa8ced2da970f0d742423c72d3300f622c3a42f609"),
bip32_seed)
class Test_seeds(ElectrumTestCase):
""" Test old and new seeds. """
mnemonics = {
('cell dumb heartbeat north boom tease ship baby bright kingdom rare squeeze', 'old'),
('cell dumb heartbeat north boom tease ' * 4, 'old'),
('cell dumb heartbeat north boom tease ship baby bright kingdom rare badword', ''),
('cElL DuMb hEaRtBeAt nOrTh bOoM TeAsE ShIp bAbY BrIgHt kInGdOm rArE SqUeEzE', 'old'),
(' cElL DuMb hEaRtBeAt nOrTh bOoM TeAsE ShIp bAbY BrIgHt kInGdOm rArE SqUeEzE ', 'old'),
# below seed is actually 'invalid old' as it maps to 33 hex chars
('hurry idiot prefer sunset mention mist jaw inhale impossible kingdom rare squeeze', 'old'),
('cram swing cover prefer miss modify ritual silly deliver chunk behind inform able', 'standard'),
('cram swing cover prefer miss modify ritual silly deliver chunk behind inform', ''),
('ostrich security deer aunt climb inner alpha arm mutual marble solid task', 'standard'),
('OSTRICH SECURITY DEER AUNT CLIMB INNER ALPHA ARM MUTUAL MARBLE SOLID TASK', 'standard'),
(' oStRiCh sEcUrItY DeEr aUnT ClImB InNeR AlPhA ArM MuTuAl mArBlE SoLiD TaSk ', 'standard'),
('science dawn member doll dutch real can brick knife deny drive list', '2fa'),
('science dawn member doll dutch real ca brick knife deny drive list', ''),
(' sCience dawn member doll Dutch rEAl can brick knife deny drive lisT', '2fa'),
# pre-version-2.7 2fa seed with 25 words:
('bind clever room kidney crucial sausage spy edit canvas soul liquid ribbon slam open alpha suffer gate relax voice carpet law hill woman tonight abstract', '2fa'),
(' bInd cLEveR room kidney crucial sausage spy edit canvas soul liquid ribbon SLAM open alpha suffer gate relax voice carpet law hill woman tonight abstract ', '2fa'),
# pre-version-2.7 2fa seed with 24 words:
('sibling leg cable timber patient foot occur plate travel finger chef scale radio citizen promote immune must chef fluid sea sphere common acid lab', '2fa'),
('frost pig brisk excite novel report camera enlist axis nation novel desert', 'segwit'),
(' fRoSt pig brisk excIte novel rePort CamEra enlist axis nation nOVeL dEsert ', 'segwit'),
# short seed cheat sheet:
('x8', 'standard'),
('9dk', 'segwit'),
('abandon bike', 'segwit'), # <- has valid English words
('6vs', '2fa_segwit'),
('agree install', '2fa_segwit'), # <- has valid English words
}
def test_new_seed(self):
seed = "cram swing cover prefer miss modify ritual silly deliver chunk behind inform able"
self.assertTrue(is_new_seed(seed))
seed = "cram swing cover prefer miss modify ritual silly deliver chunk behind inform"
self.assertFalse(is_new_seed(seed))
def test_old_seed(self):
self.assertTrue(is_old_seed(" ".join(["like"] * 12)))
self.assertFalse(is_old_seed(" ".join(["like"] * 18)))
self.assertTrue(is_old_seed(" ".join(["like"] * 24)))
self.assertFalse(is_old_seed("not a seed"))
self.assertTrue(is_old_seed("0123456789ABCDEF" * 2))
self.assertTrue(is_old_seed("0123456789ABCDEF" * 4))
def test_calc_seed_type(self):
for idx, (seed_words, _type) in enumerate(self.mnemonics):
with self.subTest(msg=f"seed_type_subcase_{idx}", seed_words=seed_words):
self.assertEqual(_type, calc_seed_type(seed_words), msg=seed_words)
def test_is_matching_seed(self):
self.assertTrue(is_matching_seed(seed="9dk", seed_again="9dk "))
self.assertTrue(is_matching_seed(seed="9dk", seed_again=" 9dk"))
self.assertTrue(is_matching_seed(seed="9dk", seed_again=" 9dk "))
self.assertTrue(is_matching_seed(seed="when blade focus", seed_again="when blade focus "))
self.assertTrue(is_matching_seed(seed="when blade focus", seed_again=" when blade focus "))
self.assertTrue(is_matching_seed(seed=" when blade focus ", seed_again=" when blade focus "))
self.assertTrue(is_matching_seed(
seed=" when blade focus ",
seed_again=
""" when blade
focus """))
self.assertFalse(is_matching_seed(seed="when blade focus", seed_again="wen blade focus"))
self.assertFalse(is_matching_seed(seed="when blade focus", seed_again="when bladefocus"))
self.assertFalse(is_matching_seed(seed="when blade focus", seed_again="when blAde focus"))
self.assertFalse(is_matching_seed(seed="when blade focus", seed_again="when bl4de focus"))
self.assertFalse(is_matching_seed(seed="when blade focus", seed_again="when bla4de focus"))
def test_can_seed_have_passphrase(self):
seed_invalid = 'xxx'
with self.assertRaises(Exception) as ctx:
self.assertFalse(can_seed_have_passphrase(seed_invalid))
self.assertTrue("unexpected seed type" in ctx.exception.args[0])
seed_old = 'cell dumb heartbeat north boom tease ship baby bright kingdom rare squeeze'
self.assertFalse(can_seed_have_passphrase(seed_old))
seed_standard = 'cram swing cover prefer miss modify ritual silly deliver chunk behind inform able'
self.assertTrue(can_seed_have_passphrase(seed_standard))
seed_segwit = 'frost pig brisk excite novel report camera enlist axis nation novel desert'
self.assertTrue(can_seed_have_passphrase(seed_segwit))
seed_2fa_12 = 'science dawn member doll dutch real can brick knife deny drive list'
self.assertTrue(can_seed_have_passphrase(seed_2fa_12))
seed_2fa_24 = 'sibling leg cable timber patient foot occur plate travel finger chef scale radio citizen promote immune must chef fluid sea sphere common acid lab'
self.assertFalse(can_seed_have_passphrase(seed_2fa_24))
seed_2fa_25 = 'bind clever room kidney crucial sausage spy edit canvas soul liquid ribbon slam open alpha suffer gate relax voice carpet law hill woman tonight abstract'
self.assertFalse(can_seed_have_passphrase(seed_2fa_25))
seed_2fa_segwit = 'agree install'
self.assertTrue(can_seed_have_passphrase(seed_2fa_segwit))
class Test_slip39(ElectrumTestCase):
""" Test SLIP39 test vectors. """
def test_slip39_vectors(self):
test_vector_file = os.path.join(os.path.dirname(__file__), "slip39-vectors.json")
with open(test_vector_file, "r") as f:
vectors = json.load(f)
for description, mnemonics, expected_secret, extended_private_key in vectors:
if expected_secret:
encrypted_seed = slip39.recover_ems(mnemonics)
assert bytes.fromhex(expected_secret) == encrypted_seed.decrypt("TREZOR"), 'Incorrect secret for test vector "{}".'.format(description)
else:
with self.assertRaises(slip39.Slip39Error):
slip39.recover_ems(mnemonics)
self.fail(
'Failed to raise exception for test vector "{}".'.format(description)
)
def test_make_group_prefix(self):
self.assertEqual(slip39._make_group_prefix(5, 0, 4, 3, 2, 1), "academic cover decision")