1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-16 11:28:14 +00:00
trezor-firmware/cmd.py

337 lines
12 KiB
Python
Raw Normal View History

#!/usr/bin/python
import os
import binascii
import argparse
import json
import base64
from trezorlib.client import TrezorClientDebug
from trezorlib.api_blockchain import BlockchainApi
from trezorlib.protobuf_json import pb2json
def parse_args(commands):
parser = argparse.ArgumentParser(description='Commandline tool for Trezor devices.')
2013-08-30 21:32:02 +00:00
parser.add_argument('-t', '--transport', dest='transport', choices=['usb', 'serial', 'pipe', 'socket'], default='usb', help="Transport used for talking with the device")
parser.add_argument('-p', '--path', dest='path', default='', help="Path used by the transport (usually serial port)")
# parser.add_argument('-dt', '--debuglink-transport', dest='debuglink_transport', choices=['usb', 'serial', 'pipe', 'socket'], default='usb', help="Debuglink transport")
# parser.add_argument('-dp', '--debuglink-path', dest='debuglink_path', default='', help="Path used by the transport (usually serial port)")
parser.add_argument('-j', '--json', dest='json', action='store_true', help="Prints result as json object")
# parser.add_argument('-d', '--debug', dest='debug', action='store_true', help='Enable low-level debugging')
cmdparser = parser.add_subparsers(title='Available commands')
for cmd in commands._list_commands():
func = object.__getattribute__(commands, cmd)
try:
arguments = func.arguments
except AttributeError:
arguments = ((('params',), {'nargs': '*'}),)
item = cmdparser.add_parser(cmd, help=func.help)
for arg in arguments:
item.add_argument(*arg[0], **arg[1])
item.set_defaults(func=func)
item.set_defaults(cmd=cmd)
return parser.parse_args()
2013-11-15 00:43:05 +00:00
def get_transport(transport_string, path, **kwargs):
if transport_string == 'usb':
from trezorlib.transport_hid import HidTransport
2013-08-30 21:32:02 +00:00
if path == '':
2013-08-31 21:45:53 +00:00
try:
path = list_usb()[0][0]
2013-08-31 21:45:53 +00:00
except IndexError:
raise Exception("No Trezor found on USB")
2013-08-30 21:32:02 +00:00
for d in HidTransport.enumerate():
# Two-tuple of (normal_interface, debug_interface)
if path in d:
return HidTransport(d, **kwargs)
raise Exception("Device not found")
if transport_string == 'serial':
from trezorlib.transport_serial import SerialTransport
2013-11-15 00:43:05 +00:00
return SerialTransport(path, **kwargs)
if transport_string == 'pipe':
from trezorlib.transport_pipe import PipeTransport
2013-11-15 00:43:05 +00:00
return PipeTransport(path, is_device=False, **kwargs)
if transport_string == 'socket':
from trezorlib.transport_socket import SocketTransportClient
2013-11-15 00:43:05 +00:00
return SocketTransportClient(path, **kwargs)
if transport_string == 'fake':
from trezorlib.transport_fake import FakeTransport
2013-11-15 00:43:05 +00:00
return FakeTransport(path, **kwargs)
raise NotImplemented("Unknown transport")
class Commands(object):
def __init__(self, client):
self.client = client
@classmethod
def _list_commands(cls):
return [ x for x in dir(cls) if not x.startswith('_') ]
def list(self, args):
# Fake method for advertising 'list' command
pass
def get_address(self, args):
address_n = self.client.expand_path(args.n)
return self.client.get_address(args.coin, address_n)
2013-09-09 13:38:15 +00:00
def get_entropy(self, args):
return binascii.hexlify(self.client.get_entropy(args.size))
def get_features(self, args):
return self.client.features
def list_coins(self, args):
return [ coin.coin_name for coin in self.client.features.coins ]
def ping(self, args):
return self.client.ping(args.msg)
2013-11-15 00:43:05 +00:00
def get_public_node(self, args):
address_n = self.client.expand_path(args.n)
return self.client.get_public_node(args.coin, address_n)
def set_label(self, args):
return self.client.apply_settings(label=args.label)
2014-01-31 18:48:19 +00:00
def change_pin(self, args):
return self.client.change_pin(args.remove)
def wipe_device(self, args):
return self.client.wipe_device()
2014-02-02 17:27:44 +00:00
def recovery_device(self, args):
return self.client.recovery_device(args.words, args.passphrase_protection,
args.pin_protection, args.label, 'english')
def load_device(self, args):
if not args.mnemonic and not args.xprv:
raise Exception("Please provide mnemonic or xprv")
if args.mnemonic:
mnemonic = ' '.join(args.mnemonic)
return self.client.load_device_by_mnemonic(mnemonic, args.pin,
args.passphrase_protection, args.label, 'english')
2014-01-06 00:54:53 +00:00
else:
return self.client.load_device_by_xprv(args.xprv, args.pin,
args.passphrase_protection, args.label, 'english')
2014-01-06 00:54:53 +00:00
def reset_device(self, args):
2014-02-02 17:27:44 +00:00
return self.client.reset_device(True, args.strength, args.passphrase_protection,
args.pin_protection, args.label, 'english')
2013-10-12 15:40:48 +00:00
2013-11-15 00:43:05 +00:00
def sign_message(self, args):
2014-02-21 01:32:37 +00:00
ret = self.client.sign_message(args.coin, args.n, args.message)
output = {
'message': args.message,
'address': ret.address,
'signature': base64.b64encode(ret.signature)
}
return output
2013-11-15 00:43:05 +00:00
2013-11-26 16:29:50 +00:00
def verify_message(self, args):
signature = base64.b64decode(args.signature)
return self.client.verify_message(args.address, signature, args.message)
2013-11-26 16:29:50 +00:00
2013-10-12 15:40:48 +00:00
def firmware_update(self, args):
2013-10-19 12:19:09 +00:00
if not args.file:
raise Exception("Must provide firmware filename")
2013-10-12 15:40:48 +00:00
fp = open(args.file, 'r')
if fp.read(4) != 'TRZR':
raise Exception("Trezor firmware header expected")
fp.seek(0)
2013-10-21 16:30:43 +00:00
return self.client.firmware_update(fp=open(args.file, 'r'))
2013-10-12 15:40:48 +00:00
list.help = 'List connected Trezor USB devices'
ping.help = 'Send ping message'
get_address.help = 'Get bitcoin address in base58 encoding'
get_entropy.help = 'Get example entropy'
get_features.help = 'Retrieve device features and settings'
2013-11-15 00:43:05 +00:00
get_public_node.help = 'Get public node of given path'
set_label.help = 'Set new wallet label'
2014-01-31 18:48:19 +00:00
change_pin.help = 'Change new PIN or remove existing'
list_coins.help = 'List all supported coin types by the device'
wipe_device.help = 'Reset device to factory defaults and remove all private data.'
2014-02-02 17:27:44 +00:00
recovery_device.help = 'Start safe recovery workflow'
load_device.help = 'Load custom configuration to the device'
reset_device.help = 'Perform device setup and generate new seed'
2013-11-15 00:43:05 +00:00
sign_message.help = 'Sign message using address of given path'
2013-11-26 16:29:50 +00:00
verify_message.help = 'Verify message'
2013-10-12 15:40:48 +00:00
firmware_update.help = 'Upload new firmware to device (must be in bootloader mode)'
get_address.arguments = (
(('-c', '--coin'), {'type': str, 'default': 'Bitcoin'}),
# (('n',), {'metavar': 'N', 'type': int, 'nargs': '+'}),
(('-n', '-address'), {'type': str}),
)
get_entropy.arguments = (
(('size',), {'type': int}),
)
get_features.arguments = ()
list_coins.arguments = ()
ping.arguments = (
(('msg',), {'type': str}),
)
set_label.arguments = (
2014-01-09 23:11:03 +00:00
(('-l', '--label',), {'type': str, 'default': ''}),
# (('-c', '--clear'), {'action': 'store_true', 'default': False})
)
2014-01-31 18:48:19 +00:00
change_pin.arguments = (
(('-r', '--remove'), {'action': 'store_true', 'default': False}),
)
wipe_device.arguments = ()
2014-02-02 17:27:44 +00:00
recovery_device.arguments = (
(('-w', '--words'), {'type': int}),
(('-p', '--pin-protection'), {'action': 'store_true', 'default': False}),
(('-r', '--passphrase-protection'), {'action': 'store_true', 'default': False}),
(('-l', '--label'), {'type': str, 'default': ''}),
)
load_device.arguments = (
(('-m', '--mnemonic'), {'type': str, 'nargs': '+'}),
(('-x', '--xprv'), {'type': str}),
(('-p', '--pin'), {'type': str, 'default': ''}),
(('-r', '--passphrase-protection'), {'action': 'store_true', 'default': False}),
2014-01-06 00:54:53 +00:00
(('-l', '--label'), {'type': str, 'default': ''}),
)
reset_device.arguments = (
(('-t', '--strength'), {'type': int, 'choices': [128, 192, 256], 'default': 128}),
2014-02-02 17:27:44 +00:00
(('-p', '--pin-protection'), {'action': 'store_true', 'default': False}),
(('-r', '--passphrase-protection'), {'action': 'store_true', 'default': False}),
2014-01-06 00:54:53 +00:00
(('-l', '--label'), {'type': str, 'default': ''}),
)
2013-08-30 21:32:02 +00:00
2013-11-15 00:43:05 +00:00
sign_message.arguments = (
2014-02-21 01:32:37 +00:00
(('-c', '--coin'), {'type': str, 'default': 'Bitcoin'}),
2013-11-15 00:43:05 +00:00
(('n',), {'metavar': 'N', 'type': int, 'nargs': '+'}),
(('message',), {'type': str}),
)
2013-11-26 16:29:50 +00:00
verify_message.arguments = (
(('address',), {'type': str}),
(('signature',), {'type': str}),
(('message',), {'type': str}),
)
2013-11-15 00:43:05 +00:00
get_public_node.arguments = (
(('-c', '--coin'), {'type': str, 'default': 'Bitcoin'}),
(('-n', '-address'), {'type': str}),
2013-11-15 00:43:05 +00:00
)
2013-10-12 15:40:48 +00:00
firmware_update.arguments = (
(('-f', '--file'), {'type': str}),
)
2013-08-30 21:32:02 +00:00
def list_usb():
from trezorlib.transport_hid import HidTransport
return HidTransport.enumerate()
'''
class PinMatrixThread(threading.Thread):
# Hacked PinMatrixWidget into command line tool :-).
def __init__(self, input_text, message):
super(PinMatrixThread, self).__init__()
self.input_text = input_text
self.message = message
self.pin_value = ''
def run(self):
2014-02-03 18:30:40 +00:00
from trezorlib.pinmatrix import PinMatrixWidget
import sys
from PyQt4.Qt import QApplication, QWidget, QVBoxLayout
from PyQt4.QtGui import QPushButton, QLabel
from PyQt4.QtCore import QObject, SIGNAL
a = QApplication(sys.argv)
2014-01-06 00:54:53 +00:00
matrix = PinMatrixWidget()
def clicked():
self.pin_value = str(matrix.get_value())
a.closeAllWindows()
ok = QPushButton('OK')
QObject.connect(ok, SIGNAL('clicked()'), clicked)
vbox = QVBoxLayout()
vbox.addWidget(QLabel(self.input_text + self.message))
vbox.addWidget(matrix)
vbox.addWidget(ok)
w = QWidget()
w.setLayout(vbox)
w.move(100, 100)
w.show()
a.exec_()
def qt_pin_func(input_text, message=None):
# This is a hack to display Qt window in non-qt application.
# Qt window just asks for PIN and closes itself, which trigger join().
2014-01-06 00:54:53 +00:00
if False: # os.getenv('DISPLAY'):
# Let's hope that system is configured properly and this won't crash
t = PinMatrixThread(input_text, message)
t.start()
t.join()
return t.pin_value
else:
# Most likely no X is running,
# let's fallback to default pin_func implementation
return pin_func(input_text, message)
'''
def main():
args = parse_args(Commands)
if args.cmd == 'list':
2013-08-30 21:32:02 +00:00
devices = list_usb()
if args.json:
print json.dumps(devices)
else:
for dev in devices:
if dev[1] != None:
print "%s - debuglink enabled" % dev[0]
else:
print dev[0]
return
transport = get_transport(args.transport, args.path)
client = TrezorClientDebug(transport)
client.set_tx_func(BlockchainApi().get_tx)
cmds = Commands(client)
res = args.func(cmds, args)
if args.json:
print json.dumps(res, sort_keys=True, indent=4)
else:
print res
if __name__ == '__main__':
main()