Merge pull request #527 from LedgerHQ/feat/apa/eip712_address_substitution

EIP-712 address substitution

Author: apaillier-ledger

client/CHANGELOG.md

@@ -231,3 +231,25 @@ def personal_sign(self, path: str, msg: bytes):
             with self._send(chunk):
                 pass
         return self._send(chunks[-1])
+
+    def provide_token_metadata(self,
+                               ticker: str,
+                               addr: bytes,
+                               decimals: int,
+                               chain_id: int,
+                               sig: Optional[bytes] = None):
+        if sig is None:
+            # Temporarily get a command with an empty signature to extract the payload and
+            # compute the signature on it
+            tmp = self._cmd_builder.provide_erc20_token_information(ticker,
+                                                                    addr,
+                                                                    decimals,
+                                                                    chain_id,
+                                                                    bytes())
+            # skip APDU header & empty sig
+            sig = sign_data(Key.CAL, tmp[6:])
+        return self._send(self._cmd_builder.provide_erc20_token_information(ticker,
+                                                                            addr,
+                                                                            decimals,
+                                                                            chain_id,
+                                                                            sig))

client/src/ledger_app_clients/ethereum/client.py

@@ -13,6 +13,7 @@ class InsType(IntEnum):
     GET_PUBLIC_ADDR = 0x02
     SIGN = 0x04
     PERSONAL_SIGN = 0x08
+    PROVIDE_ERC20_TOKEN_INFORMATION = 0x0a
     PROVIDE_NFT_INFORMATION = 0x14
     SET_PLUGIN = 0x16
     EIP712_SEND_STRUCT_DEF = 0x1a
@@ -310,3 +311,21 @@ def personal_sign(self, path: str, msg: bytes):
             payload = payload[chunk_size:]
             p1 = P1Type.SIGN_SUBSQT_CHUNK
         return chunks
+
+    def provide_erc20_token_information(self,
+                                        ticker: str,
+                                        addr: bytes,
+                                        decimals: int,
+                                        chain_id: int,
+                                        sig: bytes) -> bytes:
+        payload = bytearray()
+        payload.append(len(ticker))
+        payload += ticker.encode()
+        payload += addr
+        payload += struct.pack(">I", decimals)
+        payload += struct.pack(">I", chain_id)
+        payload += sig
+        return self._serialize(InsType.PROVIDE_ERC20_TOKEN_INFORMATION,
+                               0x00,
+                               0x00,
+                               payload)

client/src/ledger_app_clients/ethereum/command_builder.py

@@ -337,12 +337,11 @@ def next_timeout(_signum: int, _frame):
 
 
 def enable_autonext():
-    seconds = 1/4
     if app_client._client.firmware.device == 'stax':  # Stax Speculos is slow
-        interval = seconds * 3
+        delay = 1.5
     else:
-        interval = seconds
-    signal.setitimer(signal.ITIMER_REAL, seconds, interval)
+        delay = 1/4
+    signal.setitimer(signal.ITIMER_REAL, delay, delay)
 
 
 def disable_autonext():

client/src/ledger_app_clients/ethereum/eip712/InputData.py

@@ -16,6 +16,7 @@
 #include "typed_data.h"
 #include "commands_712.h"
 #include "common_ui.h"
+#include "domain_name.h"
 
 static t_ui_context *ui_ctx = NULL;
 
@@ -184,6 +185,46 @@ static void ui_712_format_str(const uint8_t *const data, uint8_t length) {
     }
 }
 
+/**
+ * Find a substitute token ticker for a given address
+ *
+ * @param[in] addr the given address
+ * @return the ticker name if found, \ref NULL otherwise
+ */
+static const char *get_address_token_ticker(const uint8_t *addr) {
+    tokenDefinition_t *token;
+
+    // Loop over the received token informations
+    for (uint8_t token_idx = 0; token_idx < MAX_ITEMS; ++token_idx) {
+        if (tmpCtx.transactionContext.tokenSet[token_idx] == 1) {
+            token = &tmpCtx.transactionContext.extraInfo[token_idx].token;
+            if (memcmp(token->address, addr, ADDRESS_LENGTH) == 0) {
+                return token->ticker;
+            }
+        }
+    }
+    return NULL;
+}
+
+/**
+ * Find a substitute (token ticker or domain name) for a given address
+ *
+ * @param[in] addr the given address
+ * @return the substitute if found, \ref NULL otherwise
+ */
+static const char *get_address_substitute(const uint8_t *addr) {
+    const char *str = NULL;
+
+    str = get_address_token_ticker(addr);
+    if (str == NULL) {
+        if (has_domain_name(&eip712_context->chain_id, addr)) {
+            // No handling of the verbose domains setting
+            str = g_domain_name;
+        }
+    }
+    return str;
+}
+
 /**
  * Format a given data as a string representation of an address
  *
@@ -196,13 +237,20 @@ static bool ui_712_format_addr(const uint8_t *const data, uint8_t length) {
         apdu_response_code = APDU_RESPONSE_INVALID_DATA;
         return false;
     }
+
     if (ui_712_field_shown()) {
-        if (!getEthDisplayableAddress((uint8_t *) data,
-                                      strings.tmp.tmp,
-                                      sizeof(strings.tmp.tmp),
-                                      &global_sha3,
-                                      chainConfig->chainId)) {
-            THROW(APDU_RESPONSE_ERROR_NO_INFO);
+        const char *sub;
+
+        if (!N_storage.verbose_eip712 && ((sub = get_address_substitute(data)) != NULL)) {
+            ui_712_set_value(sub, strlen(sub));
+        } else {
+            if (!getEthDisplayableAddress((uint8_t *) data,
+                                          strings.tmp.tmp,
+                                          sizeof(strings.tmp.tmp),
+                                          &global_sha3,
+                                          chainConfig->chainId)) {
+                THROW(APDU_RESPONSE_ERROR_NO_INFO);
+            }
         }
     }
     return true;

src_features/signMessageEIP712/ui_logic.c

@@ -0,0 +1,3 @@
+from pathlib import Path
+
+ROOT_SNAPSHOT_PATH = Path(__file__).parent

tests/ragger/constants.py

@@ -0,0 +1,29 @@
+{
+    "domain": {
+        "chainId": 1,
+        "name": "Token test",
+        "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
+        "version": "1"
+    },
+    "message": {
+        "from": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa",
+        "to": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+        "amount": "117",
+        "token": "0x6B175474E89094C44Da98b954EedeAC495271d0F"
+    },
+    "primaryType": "Transfer",
+    "types": {
+        "EIP712Domain": [
+            { "name": "name", "type": "string" },
+            { "name": "version", "type": "string" },
+            { "name": "chainId", "type": "uint256" },
+            { "name": "verifyingContract", "type": "address" }
+        ],
+        "Transfer": [
+            { "name": "from", "type": "address" },
+            { "name": "to", "type": "address" },
+            { "name": "amount", "type": "uint256" },
+            { "name": "token", "type": "address" }
+        ]
+    }
+}