Merge remote-tracking branch 'origin/master' into test/onscreen-signed-content-disclosure

Author: BitHighlander

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "device-protocol"]
 path = device-protocol
-url = https://github.com/keepkey/device-protocol.git
+url = https://github.com/BitHighlander/device-protocol.git
 branch = master
 [submodule "keepkeylib/eth/ethereum-lists"]
 path = keepkeylib/eth/ethereum-lists

device-protocol

@@ -49,6 +49,7 @@
 from . import messages_tron_pb2 as tron_proto
 from . import messages_ton_pb2 as ton_proto
 from . import messages_zcash_pb2 as zcash_proto
+from . import messages_hive_pb2 as hive_proto
 from . import types_pb2 as types
 from . import eos
 from . import nano
@@ -1724,10 +1725,28 @@ def ton_sign_message(self, address_n, message, show_display=False):
 
     # ── Zcash Address Display ─────────────────────────────────
     @expect(zcash_proto.ZcashAddress)
-    def zcash_display_address(self, address_n, address, ak, nk, rivk, account=None):
+    def zcash_display_address(self, address_n, address, ak, nk, rivk,
+                              account=None, expected_seed_fingerprint=None):
+        """Display a Zcash unified address on the device for user confirmation.
+
+        Args:
+            address_n: ZIP-32 derivation path [32', 133', account']
+            address: unified address string ("u1...")
+            ak, nk, rivk: 32-byte FVK components for verification
+            account: account index (alternative to full path)
+            expected_seed_fingerprint: optional 32-byte ZIP-32 §6.1 seed
+                fingerprint. If provided, device verifies the match before
+                displaying and rejects with Failure on mismatch.
+
+        Returns:
+            ZcashAddress with .address and .seed_fingerprint of the
+            attesting device.
+        """
         kwargs = dict(address_n=address_n, address=address, ak=ak, nk=nk, rivk=rivk)
         if account is not None:
             kwargs['account'] = account
+        if expected_seed_fingerprint is not None:
+            kwargs['expected_seed_fingerprint'] = expected_seed_fingerprint
         return self.call(zcash_proto.ZcashDisplayAddress(**kwargs))
 
     # ── Zcash Orchard ──────────────────────────────────────────
@@ -1744,7 +1763,8 @@ def zcash_sign_pczt(self, address_n, actions, account=None,
                         header_digest=None, transparent_digest=None,
                         sapling_digest=None, orchard_digest=None,
                         orchard_flags=None, orchard_value_balance=None,
-                        orchard_anchor=None, transparent_inputs=None):
+                        orchard_anchor=None, transparent_inputs=None,
+                        expected_seed_fingerprint=None):
         """Sign a Zcash Orchard shielded transaction via PCZT protocol.
 
         Phase 2: Sends ZcashSignPCZT, then loops on ZcashPCZTActionAck
@@ -1800,6 +1820,8 @@ def zcash_sign_pczt(self, address_n, actions, account=None,
             kwargs['orchard_value_balance'] = orchard_value_balance
         if orchard_anchor is not None:
             kwargs['orchard_anchor'] = orchard_anchor
+        if expected_seed_fingerprint is not None:
+            kwargs['expected_seed_fingerprint'] = expected_seed_fingerprint
 
         resp = self.call(zcash_proto.ZcashSignPCZT(**kwargs))
 
@@ -1836,6 +1858,74 @@ def zcash_sign_pczt(self, address_n, actions, account=None,
 
         return resp
 
+    # ── Hive ────────────────────────────────────────────────────
+    @expect(hive_proto.HivePublicKey)
+    def hive_get_public_key(self, address_n, show_display=False, role=None):
+        kwargs = dict(address_n=address_n, show_display=show_display)
+        if role is not None:
+            kwargs['role'] = role
+        return self.call(hive_proto.HiveGetPublicKey(**kwargs))
+
+    @expect(hive_proto.HivePublicKeys)
+    def hive_get_public_keys(self, account_index=0, show_display=False):
+        return self.call(
+            hive_proto.HiveGetPublicKeys(account_index=account_index, show_display=show_display)
+        )
+
+    @expect(hive_proto.HiveSignedTx)
+    def hive_sign_tx(self, address_n, chain_id, ref_block_num, ref_block_prefix,
+                     expiration, sender, recipient, amount, decimals, asset_symbol, memo=''):
+        return self.call(hive_proto.HiveSignTx(**{
+            'address_n': address_n,
+            'chain_id': chain_id,
+            'ref_block_num': ref_block_num,
+            'ref_block_prefix': ref_block_prefix,
+            'expiration': expiration,
+            'from': sender,
+            'to': recipient,
+            'amount': amount,
+            'decimals': decimals,
+            'asset_symbol': asset_symbol,
+            'memo': memo,
+        }))
+
+    @expect(hive_proto.HiveSignedAccountCreate)
+    def hive_sign_account_create(self, address_n, chain_id, ref_block_num, ref_block_prefix,
+                                 expiration, creator, new_account_name, fee_amount=3000,
+                                 owner_key='', active_key='', posting_key='', memo_key=''):
+        return self.call(hive_proto.HiveSignAccountCreate(
+            address_n=address_n,
+            chain_id=chain_id,
+            ref_block_num=ref_block_num,
+            ref_block_prefix=ref_block_prefix,
+            expiration=expiration,
+            creator=creator,
+            new_account_name=new_account_name,
+            fee_amount=fee_amount,
+            owner_key=owner_key,
+            active_key=active_key,
+            posting_key=posting_key,
+            memo_key=memo_key,
+        ))
+
+    @expect(hive_proto.HiveSignedAccountUpdate)
+    def hive_sign_account_update(self, address_n, chain_id, ref_block_num, ref_block_prefix,
+                                 expiration, account,
+                                 new_owner_key='', new_active_key='',
+                                 new_posting_key='', new_memo_key=''):
+        return self.call(hive_proto.HiveSignAccountUpdate(
+            address_n=address_n,
+            chain_id=chain_id,
+            ref_block_num=ref_block_num,
+            ref_block_prefix=ref_block_prefix,
+            expiration=expiration,
+            account=account,
+            new_owner_key=new_owner_key,
+            new_active_key=new_active_key,
+            new_posting_key=new_posting_key,
+            new_memo_key=new_memo_key,
+        ))
+
 class KeepKeyClient(ProtocolMixin, TextUIMixin, BaseClient):
     pass
 

keepkeylib/client.py

@@ -0,0 +1,69 @@
+from . import messages_hive_pb2 as proto
+
+
+def get_public_key(client, address_n, show_display=False, role=None):
+    kwargs = dict(address_n=address_n, show_display=show_display)
+    if role is not None:
+        kwargs['role'] = role
+    return client.call(proto.HiveGetPublicKey(**kwargs))
+
+
+def get_public_keys(client, account_index=0, show_display=False):
+    return client.call(
+        proto.HiveGetPublicKeys(account_index=account_index, show_display=show_display)
+    )
+
+
+def sign_tx(client, address_n, chain_id, ref_block_num, ref_block_prefix,
+            expiration, sender, recipient, amount, decimals, asset_symbol, memo=''):
+    # 'from' is a Python keyword so use **-unpacking to set the field
+    return client.call(proto.HiveSignTx(**{
+        'address_n': address_n,
+        'chain_id': chain_id,
+        'ref_block_num': ref_block_num,
+        'ref_block_prefix': ref_block_prefix,
+        'expiration': expiration,
+        'from': sender,
+        'to': recipient,
+        'amount': amount,
+        'decimals': decimals,
+        'asset_symbol': asset_symbol,
+        'memo': memo,
+    }))
+
+
+def sign_account_create(client, address_n, chain_id, ref_block_num, ref_block_prefix,
+                        expiration, creator, new_account_name, fee_amount=3000,
+                        owner_key='', active_key='', posting_key='', memo_key=''):
+    return client.call(proto.HiveSignAccountCreate(
+        address_n=address_n,
+        chain_id=chain_id,
+        ref_block_num=ref_block_num,
+        ref_block_prefix=ref_block_prefix,
+        expiration=expiration,
+        creator=creator,
+        new_account_name=new_account_name,
+        fee_amount=fee_amount,
+        owner_key=owner_key,
+        active_key=active_key,
+        posting_key=posting_key,
+        memo_key=memo_key,
+    ))
+
+
+def sign_account_update(client, address_n, chain_id, ref_block_num, ref_block_prefix,
+                        expiration, account,
+                        new_owner_key='', new_active_key='',
+                        new_posting_key='', new_memo_key=''):
+    return client.call(proto.HiveSignAccountUpdate(
+        address_n=address_n,
+        chain_id=chain_id,
+        ref_block_num=ref_block_num,
+        ref_block_prefix=ref_block_prefix,
+        expiration=expiration,
+        account=account,
+        new_owner_key=new_owner_key,
+        new_active_key=new_active_key,
+        new_posting_key=new_posting_key,
+        new_memo_key=new_memo_key,
+    ))

keepkeylib/hive.py

@@ -13,6 +13,7 @@
 from . import messages_tron_pb2 as tron_proto
 from . import messages_ton_pb2 as ton_proto
 from . import messages_zcash_pb2 as zcash_proto
+from . import messages_hive_pb2 as hive_proto
 
 map_type_to_class = {}
 map_class_to_type = {}
@@ -97,4 +98,23 @@ def check_missing():
         map_type_to_class[wire_id] = msg_class
         map_class_to_type[msg_class] = wire_id
 
-# check_missing() — skip: Zcash types are not in old messages_pb2 enum
+# Manually register Hive messages (not in the old messages_pb2.py enum)
+_hive_wire_ids = {
+    1600: ('HiveGetPublicKey',        hive_proto),
+    1601: ('HivePublicKey',           hive_proto),
+    1602: ('HiveSignTx',              hive_proto),
+    1603: ('HiveSignedTx',            hive_proto),
+    1604: ('HiveGetPublicKeys',       hive_proto),
+    1605: ('HivePublicKeys',          hive_proto),
+    1606: ('HiveSignAccountCreate',   hive_proto),
+    1607: ('HiveSignedAccountCreate', hive_proto),
+    1608: ('HiveSignAccountUpdate',   hive_proto),
+    1609: ('HiveSignedAccountUpdate', hive_proto),
+}
+for wire_id, (msg_name, mod) in _hive_wire_ids.items():
+    msg_class = getattr(mod, msg_name, None)
+    if msg_class is not None:
+        map_type_to_class[wire_id] = msg_class
+        map_class_to_type[msg_class] = wire_id
+
+# check_missing() — skip: Zcash/Hive types are not in old messages_pb2 enum