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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
|
#!/usr/bin/env python3
# This file is part of the SBK project
# https://github.com/mbarkhau/sbk
#
# Copyright (c) 2019-2021 Manuel Barkhau (mbarkhau@gmail.com) - MIT License
# SPDX-License-Identifier: MIT
# messy ui code is messy ...
# pylint: disable=too-many-instance-attributes
# pylint: disable=too-many-return-statements
"""GUI Panels for SBK."""
import os
import time
import typing as typ
import logging
import pathlib as pl
import threading
import PyQt5.QtGui as qtg
import PyQt5.QtCore as qtc
import PyQt5.QtWidgets as qtw
from . import params
from . import shamir
from . import gui_tasks as gt
from . import ui_common
from . import common_types as ct
from . import gui_panels_base as gpb
logger = logging.getLogger("sbk.gui_panels")
ICON_PATH = pl.Path("logo_256.png")
class SelectCommandPanel(gpb.Panel):
buttons: typ.Dict[str, qtw.QPushButton]
def __init__(self, index: int):
self.title = "SBK"
super().__init__(index)
self._layout = qtw.QVBoxLayout()
pixmap = qtg.QPixmap(str(ICON_PATH))
pixmap = pixmap.scaledToWidth(128)
icon_label = qtw.QLabel(self)
icon_label.setPixmap(pixmap)
icon_label.setAlignment(qtc.Qt.AlignCenter)
self._layout.addStretch(1)
self._layout.addWidget(icon_label)
self._layout.addStretch(1)
self.buttons = {}
def add_button(label: str, button_id: str, *, enabled: bool = True) -> qtw.QPushButton:
button = qtw.QPushButton(label)
button.clicked.connect(self.init_button_handler(button_id))
button.setEnabled(enabled)
self.buttons[button_id] = button
self._layout.addWidget(button)
return button
add_button("Open &Electrum", 'open', enabled=False)
add_button("&Show Keys" , 'show', enabled=False)
# add_button("&Derive GPG Keypair", 'derive_gpg', enabled=False)
self._layout.addStretch(1)
add_button("&Generate Keys" , 'generate').setDefault(True)
add_button("&Load Salt and Brainkey", 'load')
add_button("&Recover from Shares" , 'recover')
self._layout.addStretch(1)
# add_button("&Debug", 'debug', enabled=False)
# self._layout.addStretch(1)
add_button("&Options", 'options')
self._layout.addStretch(8)
self.setLayout(self._layout)
def switch(self) -> None:
state = gpb.get_state()
self.trace("switch " + str((state['salt'], state['brainkey'], state['param_cfg'])))
state['panel_index'] = 0
if state['salt'] and state['brainkey'] and state['param_cfg']:
self.buttons['open'].setEnabled(True)
self.buttons['show'].setEnabled(True)
else:
self.buttons['open'].setEnabled(False)
self.buttons['show'].setEnabled(False)
super().switch()
def init_button_handler(self, button_name: str) -> typ.Callable:
def handler(*args, **kwargs):
self.trace(f"handle button {button_name=} {args} {kwargs}")
p = self.parent()
if button_name in ('generate', 'load', 'recover'):
gpb.shared_panel_state['salt' ] = None
gpb.shared_panel_state['brainkey' ] = None
gpb.shared_panel_state['param_cfg'] = None
gpb.shared_panel_state['shares' ] = []
if button_name == 'generate':
p.get_or_init_panel(SeedGenerationPanel).switch()
elif button_name == 'load':
p.get_or_init_panel(LoadKeysPanel).switch()
elif button_name == 'recover':
p.get_or_init_panel(RecoverKeysPanel).switch()
elif button_name == 'options':
p.get_or_init_panel(OptionsPanel).switch()
elif button_name == 'open':
p.get_or_init_panel(OpenWalletPanel).switch()
elif button_name == 'show':
p.get_or_init_panel(ShowKeysPanel).switch()
elif button_name == 'debug':
param_cfg = params.bytes2param_cfg(b"\x11\x00\x00")
gpb.shared_panel_state['param_cfg'] = param_cfg
p.get_or_init_panel(OpenWalletPanel).switch()
else:
raise NotImplementedError()
return handler
class OptionsPanel(gpb.NavigablePanel):
def __init__(self, index: int):
self.title = "SBK - Options"
self.back_panel_clazz = SelectCommandPanel
self.next_panel_clazz = SelectCommandPanel
super().__init__(index)
self.next_button.setVisible(False)
form = qtw.QFormLayout()
state = gpb.get_state()
self.offline = qtw.QCheckBox()
self.offline.setTristate(False)
self.offline.setCheckState(qtc.Qt.Checked if state['offline'] else qtc.Qt.Unchecked)
form.addRow("&Offline", self.offline)
self.wallet_name = qtw.QLineEdit()
if state['wallet_name'] == 'empty':
self.wallet_name.setPlaceholderText("empty")
else:
self.wallet_name.setText(state['wallet_name'])
form.addRow("&Wallet Name", self.wallet_name)
self.threshold = qtw.QSpinBox()
self.threshold.setRange(2, 5)
self.threshold.setValue(state['threshold'])
form.addRow("&Threshold", self.threshold)
self.num_shares = qtw.QSpinBox()
self.num_shares.setRange(3, 63)
self.num_shares.setValue(state['num_shares'])
form.addRow("&Shares", self.num_shares)
def constrain_threshold():
threshold = min(self.num_shares.value(), params.MAX_THRESHOLD)
self.threshold.setMaximum(threshold)
def constrain_num_shares():
self.num_shares.setMinimum(self.threshold.value())
self.num_shares.valueChanged.connect(constrain_threshold)
self.threshold.valueChanged.connect(constrain_num_shares)
self.parallelism = qtw.QSpinBox()
self.parallelism.setRange(1, state['max_parallelism'])
self.parallelism.setValue(state['parallelism'])
form.addRow("&Parallelism [Threads]", self.parallelism)
self.target_memory = qtw.QSpinBox()
self.target_memory.setRange(10, state['max_memory'])
self.target_memory.setValue(state['target_memory'])
self.target_memory.setSingleStep(10)
form.addRow("&Memory Usage [MB]", self.target_memory)
self.target_duration = qtw.QSpinBox()
self.target_duration.setRange(1, 600)
self.target_duration.setValue(state['target_duration'])
form.addRow("&Duration [Seconds]", self.target_duration)
self._layout = qtw.QVBoxLayout()
self._layout.addLayout(form)
self._layout.addStretch(1)
self._layout.addLayout(self.nav_layout)
self.setLayout(self._layout)
def destroy_panel(self) -> None:
state = gpb.shared_panel_state
target_memory = self.target_memory.value()
parallelism = self.parallelism.value()
state['threshold' ] = self.threshold.value()
state['num_shares' ] = self.num_shares.value()
state['parallelism' ] = parallelism
state['target_memory' ] = target_memory
state['target_duration' ] = self.target_duration.value()
state['memory_per_thread'] = round(target_memory / parallelism)
class SeedGenerationPanel(gpb.Panel):
task1: typ.Optional[gt.ParamConfigWorker]
task2: typ.Optional[gt.SeedGenerationTask]
def __init__(self, index: int):
self.title = "SBK - Key Derivation ..."
super().__init__(index)
self._layout = qtw.QVBoxLayout()
label1 = qtw.QLabel("KDF Calibration")
label2 = qtw.QLabel("Key Derivation")
self.progressbar1 = qtw.QProgressBar()
self.progressbar1.setRange(0, 5000)
self.progressbar1.setValue(0)
self.progressbar2 = qtw.QProgressBar()
self.progressbar2.setRange(0, 90000)
self.progressbar2.setValue(0)
# Instantiated in switch(), because we want fresh parameters
# from previous panel every time.
self.task1 = None
self.task2 = None
self._layout.addWidget(label1)
self._layout.addWidget(self.progressbar1)
self._layout.addWidget(label2)
self._layout.addWidget(self.progressbar2)
self._layout.addStretch(1)
self.setLayout(self._layout)
def switch(self) -> None:
self.progressbar1.setValue(0)
self.progressbar2.setValue(0)
state = gpb.get_state()
threshold = state['threshold']
num_shares = state['num_shares']
parallelism = state['parallelism']
memory_per_thread = state['memory_per_thread']
target_duration = state['target_duration']
self.task1 = gt.ParamConfigWorker(
threshold, num_shares, parallelism, memory_per_thread, target_duration
)
self.task1.progress.connect(progressbar_updater(self.progressbar1))
self.task1.finished.connect(self.on_param_config_done)
super().switch()
self.task1.start()
def on_param_config_done(self, param_cfg: params.ParamConfig) -> None:
self.trace("on_param_config_done")
gpb.shared_panel_state['param_cfg'] = param_cfg
self.task2 = gt.SeedGenerationTask(param_cfg)
self.task2.progress.connect(progressbar_updater(self.progressbar2))
self.task2.finished.connect(self.on_seed_generation_done)
self.task2.start()
def on_seed_generation_done(self, status: str) -> None:
if status == 'ok':
self.trace("on_seed_generation_done")
self.parent().get_or_init_panel(SecurityWarningPanel).switch()
else:
qtw.QMessageBox.critical(self, 'Error', status)
self.parent().close()
WARNING_TEXT = f"""
<html><head/><body style="white-space:pre-wrap;">
<p>
{ui_common.SECURITY_WARNING_TEXT.strip()}
</p>
<p style="font-family:monospace;line-height:100%;">
{ui_common.SECURITY_WARNING_QR_CODE}
<p>
</body></html>
"""
class SecurityWarningPanel(gpb.NavigablePanel):
def __init__(self, index: int):
self.title = "SBK - Create New Wallet"
self.back_panel_clazz = SelectCommandPanel
self.next_panel_clazz = CreateKeysShowPanel
super().__init__(index)
label = qtw.QLabel(WARNING_TEXT.strip())
label_wrap = qtw.QHBoxLayout()
label_wrap.addStretch(1)
label_wrap.addWidget(label)
label_wrap.addStretch(1)
self._layout = qtw.QVBoxLayout()
self._layout.addLayout(label_wrap)
self._layout.addStretch(2)
self._layout.addLayout(self.nav_layout)
self.setLayout(self._layout)
class ShowKeysPanel(gpb.NavigablePanel):
def __init__(self, index: int):
self.title = "SBK - View Keys"
super().__init__(index)
self.header = gpb.header_widget()
self.text = qtw.QLabel()
self.grid_widgets: typ.List[qtw.QWidget] = []
self.grid_layout = qtw.QGridLayout()
self._layout = qtw.QVBoxLayout()
self._layout.addWidget(self.header)
self._layout.addLayout(gpb.column_headers(self))
self._layout.addLayout(self.grid_layout)
self._layout.addStretch(1)
self._layout.addLayout(self.nav_layout)
self.setLayout(self._layout)
def switch(self) -> None:
self.trace(f"switch {type(self).__name__} {gpb.shared_panel_state['panel_index']}")
self.header.setText(gpb.get_label_text())
secret = gpb.get_current_secret()
intcodes = ui_common.bytes2intcodes(secret.secret_data)
mnemonics = ui_common.intcodes2mnemonics(intcodes)
num_rows = len(intcodes) // 2
assert num_rows * 2 == len(intcodes)
lr_intcodes = list(sum(zip(intcodes[:num_rows], intcodes[num_rows:]), ()))
_lr_intcodes = iter(lr_intcodes)
_mnemonics = iter(mnemonics)
all_row_widgets: gpb.RowWidgets = []
while True:
try:
row_widgets = (
gpb._label_widget(self, next(_lr_intcodes), bold=True),
gpb._label_widget(self, next(_mnemonics ), bold=True),
gpb._label_widget(self, next(_mnemonics ), bold=True),
gpb._label_widget(self, next(_lr_intcodes), bold=True),
)
all_row_widgets.append(row_widgets)
except StopIteration:
break
new_widgets = gpb.init_grid(self, self.grid_layout, all_row_widgets)
self.grid_widgets.extend(new_widgets)
super().switch()
@property
def back_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
self.trace(f"back show {state['panel_index']}")
if state['panel_index'] == 0:
return SelectCommandPanel
else:
state['panel_index'] -= 1
return ShowKeysPanel
@property
def next_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
self.trace(f"next show {state['panel_index']}")
if state['panel_index'] + 1 < len(state['shares']) + 2:
state['panel_index'] += 1
return ShowKeysPanel
else:
return SelectCommandPanel
def destroy_panel(self) -> None:
for widget in self.grid_widgets:
self.grid_layout.removeWidget(widget)
widget.deleteLater()
del self.grid_widgets[:]
super().destroy_panel()
class CreateKeysShowPanel(ShowKeysPanel):
def __init__(self, index: int):
self.title = "SBK - Create New Wallet"
super().__init__(index)
@property
def back_panel_clazz(self) -> typ.Type[gpb.Panel]:
self.trace(f"back show {gpb.shared_panel_state['panel_index']}")
if gpb.shared_panel_state['panel_index'] == 0:
return SecurityWarningPanel
else:
gpb.shared_panel_state['panel_index'] = max(gpb.shared_panel_state['panel_index'] - 1, 0)
return CreateKeysVerifyPanel
@property
def next_panel_clazz(self) -> typ.Type[gpb.Panel]:
self.trace(f"next show {gpb.shared_panel_state['panel_index']}")
return CreateKeysVerifyPanel
MaybeBytes = typ.Union[bytes, None]
class CreateKeysVerifyPanel(gpb.EnterSecretPanel):
def __init__(self, index: int):
self.title = "SBK - Create New Wallet"
super().__init__(index)
def label_text(self) -> str:
return gpb.get_label_text()
def secret_len(self) -> int:
current_secret = gpb.get_current_secret()
return len(current_secret.secret_data)
@property
def back_panel_clazz(self) -> typ.Type[gpb.Panel]:
return CreateKeysShowPanel
@property
def next_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
num_shares = len(state['shares'])
num_secrets = num_shares + 2
if state['panel_index'] + 1 < num_secrets:
state['panel_index'] = max(state['panel_index'] + 1, 0)
return CreateKeysShowPanel
else:
return SelectCommandPanel
def is_final_panel(self) -> bool:
state = gpb.shared_panel_state
num_shares = len(state['shares'])
num_secrets = num_shares + 2
return state['panel_index'] + 1 >= num_secrets
class LoadKeysPanel(gpb.EnterSecretPanel):
def __init__(self, index: int):
self.title = "SBK - Load Wallet"
super().__init__(index)
def label_text(self) -> str:
if gpb.shared_panel_state['panel_index'] == 0:
return "Enter Salt"
else:
return "Enter Brainkey"
def secret_len(self) -> int:
if gpb.shared_panel_state['panel_index'] == 0:
return params.SALT_LEN
else:
return params.BRAINKEY_LEN
@property
def back_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
if state['panel_index'] == 0:
return SelectCommandPanel
else:
state['panel_index'] = max(state['panel_index'] - 1, 0)
return LoadKeysPanel
@property
def next_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
if state['panel_index'] == 0:
state['panel_index'] = max(state['panel_index'] + 1, 0)
return LoadKeysPanel
else:
return SelectCommandPanel
def destroy_panel(self) -> None:
state = gpb.shared_panel_state
recovered_datas = self.recover_datas()
if all(recovered_datas):
recovered_data = b"".join(recovered_datas) # type: ignore
if state['panel_index'] == 0:
assert len(recovered_data) == params.SALT_LEN
state['param_cfg'] = params.bytes2param_cfg(recovered_data)
state['salt' ] = ct.Salt(recovered_data)
else:
assert len(recovered_data) == params.BRAINKEY_LEN
state['brainkey'] = ct.BrainKey(recovered_data)
param_cfg = state['param_cfg']
salt = state['salt']
brainkey = state['brainkey']
if param_cfg and salt and brainkey:
param_cfg = param_cfg._replace(num_shares=state['num_shares'])
raw_salt = ct.RawSalt(bytes(salt)[params.PARAM_CFG_LEN :])
shares = shamir.split(param_cfg, raw_salt, brainkey)
state['shares'] = shares
super().destroy_panel()
def progressbar_updater(progressbar: qtw.QProgressBar) -> typ.Callable[[gt.ProgressStatus], None]:
def update_progressbar(status: gt.ProgressStatus) -> None:
try:
progressbar.setRange(0, status.length)
progressbar.setValue(round(status.current))
except RuntimeError:
pass
return update_progressbar
def load_wallet() -> None:
def launch():
seed_data = gpb.shared_panel_state['seed_data']
offline = gpb.shared_panel_state['offline']
assert seed_data is not None
ui_common.load_wallet(seed_data, offline)
launcher_thread = threading.Thread(target=launch, daemon=False)
launcher_thread.start()
# Delay closing the panel while the wallet loads
# this is a bit less jarring.
electrum_daemon_path = pl.Path("~").expanduser() / ".electrum" / "daemon"
wait_start = time.time()
while True:
if os.path.exists(electrum_daemon_path):
time.sleep(0.5)
return
if time.time() - wait_start > 5:
return
time.sleep(0.1)
class OpenWalletPanel(gpb.Panel):
task: typ.Optional[gt.SeedDerivationTask]
def __init__(self, index: int):
self.title = "SBK - Key Derivation ..."
super().__init__(index)
self._layout = qtw.QVBoxLayout()
label = qtw.QLabel("KDF Derivation")
self.progressbar = qtw.QProgressBar()
self.progressbar.setRange(0, 5000)
self.progressbar.setValue(0)
# Instantiated in switch(), because we want fresh parameters
# from previous panel every time.
self.task = None
self._layout.addWidget(label)
self._layout.addWidget(self.progressbar)
self._layout.addStretch(1)
self.setLayout(self._layout)
def switch(self) -> None:
self.trace("switch")
state = gpb.get_state()
seed_data = state['seed_data']
param_cfg = state['param_cfg']
assert param_cfg is not None
if seed_data is None:
salt = state['salt']
brainkey = state['brainkey']
assert salt is not None
assert brainkey is not None
self.task = gt.SeedDerivationTask(param_cfg, salt, brainkey)
self.task.progress.connect(progressbar_updater(self.progressbar))
self.task.finished.connect(self.on_key_dervation_done)
super().switch()
self.trace("start derivation")
self.task.start()
else:
# seed_data freshly generated
load_wallet()
self.parent().close()
return
def on_key_dervation_done(self, status: str) -> None:
if status == 'ok':
self.trace("OpenWalletPanel.on_key_dervation_done")
load_wallet()
self.parent().close()
else:
qtw.QMessageBox.critical(self, 'Error', status)
self.parent().close()
def is_final_panel(self) -> bool:
# pylint: disable=no-self-use # override for ABC
return True
class RecoverKeysPanel(gpb.EnterSecretPanel):
def __init__(self, index: int):
self.title = "SBK - Recover Wallet"
super().__init__(index)
def label_text(self) -> str:
param_cfg = gpb.get_param_cfg()
if param_cfg is None:
num_shares = -1
else:
num_shares = param_cfg.num_shares
panel_index = gpb.shared_panel_state['panel_index']
share_no = panel_index + 1
if num_shares == -1:
return f"Enter Share {share_no}/N"
else:
return f"Enter Share {share_no}/{num_shares}"
def secret_len(self) -> int:
return params.SHARE_LEN
def destroy_panel(self) -> None:
recovered_datas = self.recover_datas()
if all(recovered_datas):
share_data = ct.Share(b"".join(recovered_datas)) # type: ignore
shares = gpb.shared_panel_state['shares']
gpb.shared_panel_state['shares'] = list(shares) + [share_data]
super().destroy_panel()
@property
def back_panel_clazz(self) -> typ.Type[gpb.Panel]:
panel_index = gpb.shared_panel_state['panel_index']
if panel_index == 0:
return SelectCommandPanel
else:
gpb.shared_panel_state['panel_index'] = max(panel_index - 1, 0)
return RecoverKeysPanel
@property
def next_panel_clazz(self) -> typ.Type[gpb.Panel]:
state = gpb.shared_panel_state
panel_index = state['panel_index']
if panel_index == 0:
state['panel_index'] = panel_index + 1
return RecoverKeysPanel
else:
param_cfg = gpb.get_param_cfg()
# we should only reach here if a valid share was entered previously
assert param_cfg is not None
num_shares = param_cfg.num_shares
if len(state['shares']) < num_shares:
state['panel_index'] = panel_index + 1
return RecoverKeysPanel
else:
raw_salt, brainkey = shamir.join(param_cfg, state['shares'])
# recompute shares, because user only enters as many as needed
shares = shamir.split(param_cfg, raw_salt, brainkey)
param_cfg_data = params.param_cfg2bytes(param_cfg)
salt = ct.Salt(param_cfg_data + raw_salt)
state['salt' ] = salt
state['brainkey'] = brainkey
state['shares' ] = shares
return SelectCommandPanel
def is_final_panel(self) -> bool:
param_cfg = gpb.get_param_cfg()
assert param_cfg is not None
num_shares = param_cfg.num_shares
return len(gpb.shared_panel_state['shares']) >= num_shares
|