Add updatefirmware command

Author: achow101

hwilib/cli.py

@@ -2,7 +2,8 @@
 
 from .commands import backup_device, displayaddress, enumerate, find_device, \
     get_client, getmasterxpub, getxpub, getkeypool, getdescriptors, prompt_pin, restore_device, send_pin, setup_device, \
-    signmessage, signtx, wipe_device, install_udev_rules
+    signmessage, signtx, wipe_device, install_udev_rules, \
+    update_firmware
 from .errors import (
     handle_errors,
     DEVICE_CONN_ERROR,
@@ -68,6 +69,9 @@ def send_pin_handler(args, client):
 def install_udev_rules_handler(args):
     return install_udev_rules('udev', args.location)
 
+def update_firmware_handler(args, client):
+    return update_firmware(client, args.file)
+
 class HWIHelpFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter):
     pass
 
@@ -181,6 +185,10 @@ def process_commands(cli_args):
     sendpin_parser.add_argument('pin', help='The numeric positions of the PIN')
     sendpin_parser.set_defaults(func=send_pin_handler)
 
+    update_firmware_parser = subparsers.add_parser('updatefirmware', help='Verify and load firmware from a file onto a device')
+    update_firmware_parser.add_argument('file', help='The path to the firmware file')
+    update_firmware_parser.set_defaults(func=update_firmware_handler)
+
     if sys.platform.startswith("linux"):
         udevrules_parser = subparsers.add_parser('installudevrules', help='Install and load the udev rule files for the hardware wallet devices')
         udevrules_parser.add_argument('--location', help='The path where the udev rules files will be copied', default='/etc/udev/rules.d/')

hwilib/commands.py

@@ -245,3 +245,6 @@ def install_udev_rules(source, location):
         from .udevinstaller import UDevInstaller
         return UDevInstaller.install(source, location)
     return {'error': 'udev rules are not needed on your platform', 'code': NOT_IMPLEMENTED}
+
+def update_firmware(client, file):
+    return client.update_firmware(file)

hwilib/devices/coldcard.py

@@ -242,6 +242,10 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The Coldcard does not need a PIN sent from the host')
 
+    # Verify firmware file then load it onto device
+    def update_firmware(self, file):
+        raise NotImplementedError('The Coldcard does not implement this method yet')
+
 def enumerate(password=''):
     results = []
     devices = hid.enumerate(COINKITE_VID, CKCC_PID)

hwilib/devices/digitalbitbox.py

@@ -583,6 +583,10 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The Digital Bitbox does not need a PIN sent from the host')
 
+    # Verify firmware file then load it onto device
+    def update_firmware(self, file):
+        raise NotImplementedError('The Digital Bitbox does not implement this method yet')
+
 def enumerate(password=''):
     results = []
     devices = hid.enumerate(DBB_VENDOR_ID, DBB_DEVICE_ID)

hwilib/devices/ledger.py

@@ -354,6 +354,10 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The Ledger Nano S and X do not need a PIN sent from the host')
 
+    # Verify firmware file then load it onto device
+    def update_firmware(self, file):
+        raise UnavailableActionError('The Ledger Nano S and X do not support firmware updates from 3rd party software.')
+
 def enumerate(password=''):
     results = []
     devices = []

hwilib/devices/trezor.py

@@ -434,6 +434,10 @@ def send_pin(self, pin):
             return {'success': False}
         return {'success': True}
 
+    # Verify firmware file then load it onto device
+    def update_firmware(self, file):
+        raise NotImplementedError('The {} does not implement this method yet'.format(self.type))
+
 def enumerate(password=''):
     results = []
     for dev in enumerate_devices():

hwilib/hwwclient.py

@@ -64,3 +64,7 @@ def prompt_pin(self):
     # Send pin
     def send_pin(self):
         raise NotImplementedError('The HardwareWalletClient base class does not implement this method')
+
+    # Verify firmware file then load it onto device
+    def update_firmware(self, file):
+        raise NotImplementedError('The HardwareWalletClient base class does not implement this method')