lukechilds
/
electrum
mirror of https://github.com/lukechilds/electrum.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

KeepKey / Trezor: client split 

We're going to want to do a few things differently, such as
device recovery.  So move the client code to clientbase.py
and create a per-plugin client.py file for the derived client
class.
283
Neil Booth 9 years ago
parent
0d52911561
commit
f271f65842
5 changed files with 216 additions and 198 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      plugins/keepkey/client.py
  2. 4
      plugins/keepkey/keepkey.py
  3. 197
      plugins/trezor/client.py
  4. 191
      plugins/trezor/clientbase.py
  5. 6
      plugins/trezor/trezor.py

14
plugins/keepkey/client.py
View File

@ -0,0 +1,14 @@
from keepkeylib.client import proto, BaseClient, ProtocolMixin
from ..trezor.clientbase import TrezorClientBase
class KeepKeyClient(TrezorClientBase, ProtocolMixin, BaseClient):
def __init__(self, transport, handler, plugin, hid_id):
TrezorClientBase.__init__(self, handler, plugin, hid_id, proto)
BaseClient.__init__(self, transport)
ProtocolMixin.__init__(self, transport)
def recovery_device(self, *args):
ProtocolMixin.recovery_device(self, True, *args)
TrezorClientBase.wrap_methods(KeepKeyClient)

4
plugins/keepkey/keepkey.py
View File

@ -1,4 +1,3 @@
from ..trezor.client import trezor_client_class
from ..trezor.plugin import TrezorCompatiblePlugin, TrezorCompatibleWallet
@ -13,8 +12,7 @@ class KeepKeyPlugin(TrezorCompatiblePlugin):
minimum_firmware = (1, 0, 0)
wallet_class = KeepKeyWallet
try:
from keepkeylib.client import proto, BaseClient, ProtocolMixin
client_class = trezor_client_class(ProtocolMixin, BaseClient, proto)
from .client import KeepKeyClient as client_class
import keepkeylib.ckd_public as ckd_public
from keepkeylib.client import types
from keepkeylib.transport_hid import HidTransport, DEVICE_IDS

197
plugins/trezor/client.py
View File

@ -1,194 +1,11 @@
from sys import stderr
from electrum.i18n import _
from electrum.util import PrintError
class GuiMixin(object):
# Requires: self.proto, self.device
messages = {
3: _("Confirm transaction outputs on %s device to continue"),
8: _("Confirm transaction fee on %s device to continue"),
7: _("Confirm message to sign on %s device to continue"),
10: _("Confirm address on %s device to continue"),
'change pin': _("Confirm PIN change on %s device to continue"),
'default': _("Check %s device to continue"),
'homescreen': _("Confirm home screen change on %s device to continue"),
'label': _("Confirm label change on %s device to continue"),
'remove pin': _("Confirm removal of PIN on %s device to continue"),
'passphrase': _("Confirm on %s device to continue"),
}
def callback_ButtonRequest(self, msg):
msg_code = self.msg_code_override or msg.code
message = self.messages.get(msg_code, self.messages['default'])
if msg.code in [3, 8] and hasattr(self, 'cancel'):
cancel_callback = self.cancel
else:
cancel_callback = None
self.handler.show_message(message % self.device, cancel_callback)
return self.proto.ButtonAck()
def callback_PinMatrixRequest(self, msg):
if msg.type == 1:
msg = _("Enter your current %s PIN:")
elif msg.type == 2:
msg = _("Enter a new %s PIN:")
elif msg.type == 3:
msg = (_("Please re-enter your new %s PIN.\n"
"Note the numbers have been shuffled!"))
else:
msg = _("Please enter %s PIN")
pin = self.handler.get_pin(msg % self.device)
if not pin:
return self.proto.Cancel()
return self.proto.PinMatrixAck(pin=pin)
def callback_PassphraseRequest(self, req):
msg = _("Please enter your %s passphrase")
passphrase = self.handler.get_passphrase(msg % self.device)
if passphrase is None:
return self.proto.Cancel()
return self.proto.PassphraseAck(passphrase=passphrase)
def callback_WordRequest(self, msg):
msg = _("Enter seed word as explained on your %s") % self.device
word = self.handler.get_word(msg)
if word is None:
return self.proto.Cancel()
return self.proto.WordAck(word=word)
def trezor_client_class(protocol_mixin, base_client, proto):
'''Returns a class dynamically.'''
class TrezorClient(protocol_mixin, GuiMixin, base_client, PrintError):
from trezorlib.client import proto, BaseClient, ProtocolMixin
from clientbase import TrezorClientBase
class TrezorClient(TrezorClientBase, ProtocolMixin, BaseClient):
def __init__(self, transport, handler, plugin, hid_id):
base_client.__init__(self, transport)
protocol_mixin.__init__(self, transport)
self.proto = proto
self.device = plugin.device
self.handler = handler
self.hid_id_ = hid_id
self.tx_api = plugin
self.msg_code_override = None
def __str__(self):
return "%s/%s" % (self.label(), self.hid_id())
def label(self):
'''The name given by the user to the device.'''
return self.features.label
def hid_id(self):
'''The HID ID of the device.'''
return self.hid_id_
def is_initialized(self):
'''True if initialized, False if wiped.'''
return self.features.initialized
# Copied from trezorlib/client.py as there it is not static, sigh
@staticmethod
def expand_path(n):
'''Convert bip32 path to list of uint32 integers with prime flags
0/-1/1' -> [0, 0x80000001, 0x80000001]'''
path = []
for x in n.split('/')[1:]:
prime = 0
if x.endswith("'"):
x = x.replace('\'', '')
prime = TrezorClient.PRIME_DERIVATION_FLAG
if x.startswith('-'):
prime = TrezorClient.PRIME_DERIVATION_FLAG
path.append(abs(int(x)) | prime)
return path
def first_address(self, derivation):
return self.address_from_derivation(derivation)
def address_from_derivation(self, derivation):
return self.get_address('Bitcoin', self.expand_path(derivation))
def toggle_passphrase(self):
self.msg_code_override = 'passphrase'
try:
enabled = not self.features.passphrase_protection
self.apply_settings(use_passphrase=enabled)
finally:
self.msg_code_override = None
def change_label(self, label):
self.msg_code_override = 'label'
try:
self.apply_settings(label=label)
finally:
self.msg_code_override = None
def change_homescreen(self, homescreen):
self.msg_code_override = 'homescreen'
try:
self.apply_settings(homescreen=homescreen)
finally:
self.msg_code_override = None
def set_pin(self, remove):
self.msg_code_override = 'remove pin' if remove else 'change pin'
try:
self.change_pin(remove)
finally:
self.msg_code_override = None
def clear_session(self):
'''Clear the session to force pin (and passphrase if enabled)
re-entry. Does not leak exceptions.'''
self.print_error("clear session:", self)
try:
super(TrezorClient, self).clear_session()
except BaseException as e:
# If the device was removed it has the same effect...
self.print_error("clear_session: ignoring error", str(e))
pass
def close(self):
'''Called when Our wallet was closed or the device removed.'''
self.print_error("disconnected")
self.clear_session()
# Release the device
self.transport.close()
def firmware_version(self):
f = self.features
return (f.major_version, f.minor_version, f.patch_version)
def atleast_version(self, major, minor=0, patch=0):
return cmp(self.firmware_version(), (major, minor, patch))
def wrapper(func):
'''Wrap base class methods to show exceptions and clear
any dialog box it opened.'''
def wrapped(self, *args, **kwargs):
try:
return func(self, *args, **kwargs)
except BaseException as e:
self.handler.show_error(str(e))
raise e
finally:
self.handler.finished()
return wrapped
TrezorClientBase.__init__(self, handler, plugin, hid_id, proto)
BaseClient.__init__(self, transport)
ProtocolMixin.__init__(self, transport)
cls = TrezorClient
for method in ['apply_settings', 'change_pin', 'decrypt_message',
'get_address', 'get_public_node', 'load_device_by_mnemonic',
'load_device_by_xprv', 'recovery_device',
'reset_device', 'sign_message', 'sign_tx', 'wipe_device']:
setattr(cls, method, wrapper(getattr(cls, method)))
return cls
TrezorClientBase.wrap_methods(TrezorClient)

191
plugins/trezor/clientbase.py
View File

@ -0,0 +1,191 @@
from sys import stderr
from electrum.i18n import _
from electrum.util import PrintError
class GuiMixin(object):
# Requires: self.proto, self.device
messages = {
3: _("Confirm transaction outputs on %s device to continue"),
8: _("Confirm transaction fee on %s device to continue"),
7: _("Confirm message to sign on %s device to continue"),
10: _("Confirm address on %s device to continue"),
'change pin': _("Confirm PIN change on %s device to continue"),
'default': _("Check %s device to continue"),
'homescreen': _("Confirm home screen change on %s device to continue"),
'label': _("Confirm label change on %s device to continue"),
'remove pin': _("Confirm removal of PIN on %s device to continue"),
'passphrase': _("Confirm on %s device to continue"),
}
def callback_ButtonRequest(self, msg):
msg_code = self.msg_code_override or msg.code
message = self.messages.get(msg_code, self.messages['default'])
if msg.code in [3, 8] and hasattr(self, 'cancel'):
cancel_callback = self.cancel
else:
cancel_callback = None
self.handler.show_message(message % self.device, cancel_callback)
return self.proto.ButtonAck()
def callback_PinMatrixRequest(self, msg):
if msg.type == 1:
msg = _("Enter your current %s PIN:")
elif msg.type == 2:
msg = _("Enter a new %s PIN:")
elif msg.type == 3:
msg = (_("Please re-enter your new %s PIN.\n"
"Note the numbers have been shuffled!"))
else:
msg = _("Please enter %s PIN")
pin = self.handler.get_pin(msg % self.device)
if not pin:
return self.proto.Cancel()
return self.proto.PinMatrixAck(pin=pin)
def callback_PassphraseRequest(self, req):
msg = _("Please enter your %s passphrase")
passphrase = self.handler.get_passphrase(msg % self.device)
if passphrase is None:
return self.proto.Cancel()
return self.proto.PassphraseAck(passphrase=passphrase)
def callback_WordRequest(self, msg):
msg = _("Enter seed word as explained on your %s") % self.device
word = self.handler.get_word(msg)
if word is None:
return self.proto.Cancel()
return self.proto.WordAck(word=word)
class TrezorClientBase(GuiMixin, PrintError):
def __init__(self, handler, plugin, hid_id, proto):
self.proto = proto
self.device = plugin.device
self.handler = handler
self.hid_id_ = hid_id
self.tx_api = plugin
self.msg_code_override = None
def __str__(self):
return "%s/%s" % (self.label(), self.hid_id())
def label(self):
'''The name given by the user to the device.'''
return self.features.label
def hid_id(self):
'''The HID ID of the device.'''
return self.hid_id_
def is_initialized(self):
'''True if initialized, False if wiped.'''
return self.features.initialized
@staticmethod
def expand_path(n):
'''Convert bip32 path to list of uint32 integers with prime flags
0/-1/1' -> [0, 0x80000001, 0x80000001]'''
# This code is similar to code in trezorlib where it unforunately
# is not declared as a staticmethod. Our n has an extra element.
PRIME_DERIVATION_FLAG = 0x80000000
path = []
for x in n.split('/')[1:]:
prime = 0
if x.endswith("'"):
x = x.replace('\'', '')
prime = PRIME_DERIVATION_FLAG
if x.startswith('-'):
prime = PRIME_DERIVATION_FLAG
path.append(abs(int(x)) | prime)
return path
def first_address(self, derivation):
return self.address_from_derivation(derivation)
def address_from_derivation(self, derivation):
return self.get_address('Bitcoin', self.expand_path(derivation))
def toggle_passphrase(self):
self.msg_code_override = 'passphrase'
try:
enabled = not self.features.passphrase_protection
self.apply_settings(use_passphrase=enabled)
finally:
self.msg_code_override = None
def change_label(self, label):
self.msg_code_override = 'label'
try:
self.apply_settings(label=label)
finally:
self.msg_code_override = None
def change_homescreen(self, homescreen):
self.msg_code_override = 'homescreen'
try:
self.apply_settings(homescreen=homescreen)
finally:
self.msg_code_override = None
def set_pin(self, remove):
self.msg_code_override = 'remove pin' if remove else 'change pin'
try:
self.change_pin(remove)
finally:
self.msg_code_override = None
def clear_session(self):
'''Clear the session to force pin (and passphrase if enabled)
re-entry. Does not leak exceptions.'''
self.print_error("clear session:", self)
try:
super(TrezorClientBase, self).clear_session()
except BaseException as e:
# If the device was removed it has the same effect...
self.print_error("clear_session: ignoring error", str(e))
pass
def close(self):
'''Called when Our wallet was closed or the device removed.'''
self.print_error("disconnected")
self.clear_session()
# Release the device
self.transport.close()
def firmware_version(self):
f = self.features
return (f.major_version, f.minor_version, f.patch_version)
def atleast_version(self, major, minor=0, patch=0):
return cmp(self.firmware_version(), (major, minor, patch))
@staticmethod
def wrapper(func):
'''Wrap base class methods to show exceptions and clear
any dialog box it opened.'''
def wrapped(self, *args, **kwargs):
try:
return func(self, *args, **kwargs)
except BaseException as e:
self.handler.show_error(str(e))
raise e
finally:
self.handler.finished()
return wrapped
@staticmethod
def wrap_methods(cls):
for method in ['apply_settings', 'change_pin', 'decrypt_message',
'get_address', 'get_public_node',
'load_device_by_mnemonic', 'load_device_by_xprv',
'recovery_device', 'reset_device', 'sign_message',
'sign_tx', 'wipe_device']:
setattr(cls, method, cls.wrapper(getattr(cls, method)))

6
plugins/trezor/trezor.py
View File

@ -1,5 +1,4 @@
from ..trezor.client import trezor_client_class
from ..trezor.plugin import TrezorCompatiblePlugin, TrezorCompatibleWallet
from .plugin import TrezorCompatiblePlugin, TrezorCompatibleWallet
class TrezorWallet(TrezorCompatibleWallet):
@ -13,8 +12,7 @@ class TrezorPlugin(TrezorCompatiblePlugin):
minimum_firmware = (1, 2, 1)
wallet_class = TrezorWallet
try:
from trezorlib.client import proto, BaseClient, ProtocolMixin
client_class = trezor_client_class(ProtocolMixin, BaseClient, proto)
from .client import TrezorClient as client_class
import trezorlib.ckd_public as ckd_public
from trezorlib.client import types
from trezorlib.transport_hid import HidTransport, DEVICE_IDS

Write Preview
Loading…
Cancel
Save