eth tx verification: use same address case as in input

Previously, no matter the format of the adress given by user to the
client, BitBox02 was showing this address in mixed case in the
verification step(see 'mixed-case checksum address encoding in EIP-55').

Even though this is acceptable, we thought that this could create
confusion among users when they see that the address they inputted is
not the same on the device(only difference is in the case though). To
avoid any questions, this commit achieves showing the address in the
same case as in user input on the device. Valid cases are : all upper,
all lower or mixed(EIP-55).

The client libraries will also implement a mechanism to categorize the
case of the input address to pass to BitBox02 firmware.

Signed-off-by: asi345 <[email protected]>

Author: asi345

CHANGELOG.md

@@ -14,6 +14,7 @@ customers cannot upgrade their bootloader, its changes are recorded separately.
 - Bitcoin: allow multisig accounts at arbitrary keypaths
 - Bitcoin: allow spendung UTXOs at very high BIP-44 address indices
 - Ethereum: allow signing EIP-712 messages containing multi-line strings
+- Ethereum: display the addresses on device in the same case as the user input
 - Allow exiting the screen asking to insert the microSD card
 - HWW: add initialized status byte to _api_info response
 

messages/eth.proto

@@ -27,6 +27,12 @@ enum ETHCoin {
   RinkebyETH = 2;
 }
 
+enum ETHAddressCase {
+  ETH_ADDRESS_CASE_MIXED = 0;
+  ETH_ADDRESS_CASE_UPPER = 1;
+  ETH_ADDRESS_CASE_LOWER = 2;
+}
+
 message ETHPubRequest {
   repeated uint32 keypath = 1;
   // Deprecated: use chain_id instead.
@@ -56,6 +62,7 @@ message ETHSignRequest {
   AntiKleptoHostNonceCommitment host_nonce_commitment = 9;
   // If non-zero, `coin` is ignored and `chain_id` is used to identify the network.
   uint64 chain_id = 10;
+  ETHAddressCase address_case = 11;
 }
 
 // TX payload for an EIP-1559 (type 2) transaction: https://eips.ethereum.org/EIPS/eip-1559
@@ -70,6 +77,7 @@ message ETHSignEIP1559Request {
   bytes value = 8; // smallest big endian serialization, max. 32 bytes
   bytes data = 9;
   AntiKleptoHostNonceCommitment host_nonce_commitment = 10;
+  ETHAddressCase address_case = 11;
 }
 
 message ETHSignMessageRequest {

py/bitbox02/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 # 7.0.0
 - get_info: add optional device initialized boolean to returned tuple
+- eth_sign: add address_case field, which should be initialized by the client
 
 # 6.3.0
 - Allow infering product and version via API call instead of via USB descriptor

py/bitbox02/bitbox02/bitbox02/bitbox02.py

@@ -788,7 +788,13 @@ def eth_pub(
         )
         return self._eth_msg_query(request, expected_response="pub").pub.pub
 
-    def eth_sign(self, transaction: bytes, keypath: Sequence[int], chain_id: int = 1) -> bytes:
+    def eth_sign(
+        self,
+        transaction: bytes,
+        keypath: Sequence[int],
+        address_case: eth.ETHAddressCase.ValueType = eth.ETH_ADDRESS_CASE_MIXED,
+        chain_id: int = 1,
+    ) -> bytes:
         """
         transaction should be given as a full rlp encoded eth transaction.
         """
@@ -853,6 +859,7 @@ def handle_antiklepto(request: eth.ETHRequest) -> bytes:
                     recipient=recipient,
                     value=value,
                     data=data,
+                    address_case=address_case,
                 )
             )
             return handle_antiklepto(request)
@@ -871,6 +878,7 @@ def handle_antiklepto(request: eth.ETHRequest) -> bytes:
                 recipient=recipient,
                 value=value,
                 data=data,
+                address_case=address_case,
             )
         )