Merge pull request #561 from Foundation-Devices/SFT-3834-sign-message-with-microsd

SFT-3834: added microsd message signing

Author: mjg-foundation

ports/stm32/boards/Passport/modules/flows/health_check_common_flow.py

@@ -9,18 +9,19 @@
 
 
 class HealthCheckCommonFlow(Flow):
-    def __init__(self, lines):
+    def __init__(self, lines, normal_signing=False):
         super().__init__(initial_state=self.validate_lines, name='HealthCheckCommonFlow')
         self.lines = lines
         self.text = None
         self.subpath = None
         self.addr_type = AF_CLASSIC
+        self.normal_signing = normal_signing
 
     async def validate_lines(self):
         from pages import ErrorPage
         from utils import validate_sign_text
         if len(self.lines) not in [2, 3]:
-            await ErrorPage('Health check format is invalid.').show()
+            await ErrorPage('{} format is invalid.'.format('Message' if self.normal_signing else 'Health check')).show()
             self.set_result(None)
             return
 
@@ -47,7 +48,8 @@ async def sign_health_check(self):
         from pages import ErrorPage
         from tasks import sign_text_file_task
         from utils import spinner_task
-        (signature, address, error) = await spinner_task('Performing Health Check', sign_text_file_task,
+        text = 'Signing message' if self.normal_signing else 'Performing health check'
+        (signature, address, error) = await spinner_task(text, sign_text_file_task,
                                                          args=[self.text, self.subpath, self.addr_type])
         if error is None:
             self.signature = signature

ports/stm32/boards/Passport/modules/flows/health_check_microsd_flow.py

@@ -14,21 +14,33 @@ def is_health_check(filename, path=None):
 
     if '-hc' in filename:
         return True
+
     return False
 
 
+def is_signable(filename, path=None):
+    filename = filename.lower()
+
+    if '-signed' in filename:
+        return False
+
+    return True
+
+
 class HealthCheckMicrosdFlow(Flow):
-    def __init__(self, context=None):
+    def __init__(self, context=None, normal_signing=False):
         super().__init__(initial_state=self.choose_file, name='HealthCheckMicrosdFlow')
         self.file_path = None
         self.lines = None
         self.signed_message = None
         self.service_name = context
+        self.normal_signing = normal_signing
 
     async def choose_file(self):
         from flows import FilePickerFlow
 
-        result = await FilePickerFlow(show_folders=True, filter_fn=is_health_check).run()
+        result = await FilePickerFlow(show_folders=True,
+                                      filter_fn=(is_signable if self.normal_signing else is_health_check)).run()
         if result is None:
             self.set_result(False)
             return
@@ -53,7 +65,7 @@ async def parse_message(self):
     async def common_flow(self):
         from flows import HealthCheckCommonFlow
 
-        self.signed_message = await HealthCheckCommonFlow(self.lines).run()
+        self.signed_message = await HealthCheckCommonFlow(self.lines, normal_signing=self.normal_signing).run()
         if self.signed_message is None:
             self.set_result(False)
             return
@@ -65,8 +77,9 @@ async def write_signed_file(self):
         orig_path, basename = self.file_path.rsplit('/', 1)
         base, ext = basename.rsplit('.', 1)
         filename = base + '-signed' + '.' + ext
+        success_text = "signed message" if self.normal_signing else "updated health check"
         result = await SaveToMicroSDFlow(filename=filename,
                                          data=self.signed_message,
-                                         success_text="updated health check",
+                                         success_text=success_text,
                                          path=orig_path).run()
         self.set_result(result)

ports/stm32/boards/Passport/modules/flows/sign_electrum_message_flow.py

@@ -20,7 +20,7 @@ def __init__(self):
         self.message = None
         self.address = None
         self.signature = None
-        super().__init__(initial_state=self.scan_message, name='Sign Electrum Message Flow')
+        super().__init__(initial_state=self.scan_message, name='SignElectrumMessageFlow')
 
     async def scan_message(self):
         result = await ScanQRFlow(qr_types=[QRType.QR],
@@ -81,7 +81,7 @@ async def show_message(self):
         self.goto(self.do_sign)
 
     async def do_sign(self):
-        (sig, address, error) = await spinner_task('Signing Message', sign_text_file_task,
+        (sig, address, error) = await spinner_task('Signing message', sign_text_file_task,
                                                    args=[self.message, self.subpath, self.addr_format])
         if error is None:
             self.signature = sig

ports/stm32/boards/Passport/modules/menus.py

@@ -43,12 +43,23 @@ def manage_account_menu():
     ]
 
 
+def sign_message_submenu():
+    from flows import SignElectrumMessageFlow, HealthCheckMicrosdFlow
+
+    return [
+        {'icon': 'ICON_SCAN_QR', 'label': 'Sign with QR Code', 'flow': SignElectrumMessageFlow,
+         'statusbar': {'title': 'SIGN MESSAGE'}},
+        {'icon': 'ICON_MICROSD', 'label': 'Sign with microSD', 'flow': HealthCheckMicrosdFlow,
+         'statusbar': {'title': 'SIGN MESSAGE'}, 'args': {'normal_signing': True}},
+    ]
+
+
 def account_tools():
-    from flows import VerifyAddressFlow, SignElectrumMessageFlow, AddressExplorerFlow
+    from flows import VerifyAddressFlow, AddressExplorerFlow
 
     return [
         {'icon': 'ICON_VERIFY_ADDRESS', 'label': 'Verify Address', 'flow': VerifyAddressFlow},
-        {'icon': 'ICON_SCAN_QR', 'label': 'Sign a Message', 'flow': SignElectrumMessageFlow,
+        {'icon': 'ICON_SIGN', 'label': 'Sign a Message', 'submenu': sign_message_submenu,
          'statusbar': {'title': 'SIGN MESSAGE'}},
         {'icon': 'ICON_VERIFY_ADDRESS', 'label': 'Explore Addresses', 'flow': AddressExplorerFlow,
          'statusbar': {'title': 'LIST ADDRESSES'}},