Merge pull request #1035 from LedgerHQ/fix/apa/clone_get_pk

Fix clone get address

Author: apaillier-ledger

ethereum-plugin-sdk

@@ -12,7 +12,7 @@ uint16_t handle_get_public_key(uint8_t p1,
                                uint8_t dataLength,
                                unsigned int *tx) {
     bip32_path_t bip32;
-    cx_err_t error = CX_INTERNAL_ERROR;
+    uint64_t chain_id;
 
     if (!G_called_from_swap) {
         reset_app_context();
@@ -33,18 +33,26 @@ uint16_t handle_get_public_key(uint8_t p1,
     }
 
     tmpCtx.publicKeyContext.getChaincode = (p2 == P2_CHAINCODE);
-    CX_CHECK(get_public_key_string(
-        &bip32,
-        tmpCtx.publicKeyContext.publicKey.W,
-        tmpCtx.publicKeyContext.address,
-        (tmpCtx.publicKeyContext.getChaincode ? tmpCtx.publicKeyContext.chainCode : NULL),
-        g_chain_config->chain_id));
+    if (get_public_key_string(
+            &bip32,
+            tmpCtx.publicKeyContext.publicKey.W,
+            tmpCtx.publicKeyContext.address,
+            (tmpCtx.publicKeyContext.getChaincode ? tmpCtx.publicKeyContext.chainCode : NULL),
+            g_chain_config->chain_id)) {
+        return SWO_INCORRECT_DATA;
+    }
 
-    uint64_t chain_id = g_chain_config->chain_id;
     if (dataLength >= sizeof(chain_id)) {
         chain_id = u64_from_BE(dataBuffer, sizeof(chain_id));
         dataLength -= sizeof(chain_id);
         dataBuffer += sizeof(chain_id);
+        if ((g_chain_config->chain_id != ETHEREUM_MAINNET_CHAINID) &&
+            (chain_id != g_chain_config->chain_id)) {
+            // clones only accept their own chain ID
+            return SWO_INCORRECT_DATA;
+        }
+    } else {
+        chain_id = g_chain_config->chain_id;
     }
 
     (void) dataBuffer;  // to prevent dead increment warning
@@ -62,10 +70,7 @@ uint16_t handle_get_public_key(uint8_t p1,
              "0x%.*s",
              40,
              tmpCtx.publicKeyContext.address);
-    // don't unnecessarily pass the current app's chain ID
-    ui_display_public_key(g_chain_config->chain_id == chain_id ? NULL : &chain_id);
+    ui_display_public_key(&chain_id);
     // Return code will be sent after UI approve/cancel
-    error = 0;
-end:
-    return error;
+    return SWO_NO_RESPONSE;
 }

src/features/get_public_key/cmd_get_public_key.c

@@ -76,7 +76,7 @@ uint32_t eth2WithdrawalIndex;
 
 const internalStorage_t N_storage_real;
 
-caller_app_t *caller_app = NULL;
+const caller_app_t *g_caller_app = NULL;
 const chain_config_t *g_chain_config;
 
 void reset_app_context(void) {
@@ -411,12 +411,13 @@ void coin_main(eth_libargs_t *args) {
         if (args->chain_config != NULL) {
             g_chain_config = args->chain_config;
         }
-        if ((caller_app = args->caller_app) != NULL) {
+        if (args->caller_app != NULL) {
             if (g_chain_config != NULL) {
-                caller_app->type = CALLER_TYPE_CLONE;
+                args->caller_app->type = CALLER_TYPE_CLONE;
             } else {
-                caller_app->type = CALLER_TYPE_PLUGIN;
+                args->caller_app->type = CALLER_TYPE_PLUGIN;
             }
+            g_caller_app = args->caller_app;
         }
     }
     if (g_chain_config == NULL) {

src/main.c

@@ -28,6 +28,18 @@ const nbgl_icon_details_t *get_network_icon_from_chain_id(const uint64_t *chain_
             return PIC(g_network_icons[i].icon);
         }
     }
+#else
+    // Nano devices don't have the array of icons, fallback on the app's icon
+    if (*chain_id == ETHEREUM_MAINNET_CHAINID) {
+        return &ICONGLYPH;
+    }
 #endif
     return NULL;
 }
+
+const nbgl_icon_details_t *get_clone_network_icon(const caller_app_t *caller_app) {
+    if ((caller_app == NULL) || (caller_app->type != CALLER_TYPE_CLONE)) {
+        return NULL;
+    }
+    return caller_app->icon;
+}

src/nbgl/network_icons.c

@@ -1,3 +1,8 @@
 #pragma once
 
+#include <stdint.h>
+#include "nbgl_types.h"
+#include "caller_app.h"
+
 const nbgl_icon_details_t *get_network_icon_from_chain_id(const uint64_t *chain_id);
+const nbgl_icon_details_t *get_clone_network_icon(const caller_app_t *caller_app);

src/nbgl/network_icons.h

@@ -7,7 +7,7 @@
 #include "ui_nbgl.h"
 #include "plugins.h"
 #include "trusted_name.h"
-#include "caller_api.h"
+#include "caller_app.h"
 #include "network.h"
 #include "cmd_get_tx_simulation.h"
 #include "cmd_get_gating.h"

src/nbgl/ui_approve_tx.c

@@ -28,19 +28,17 @@ void ui_display_public_key(const uint64_t *chain_id) {
     const char *network_name = NULL;
     uint8_t title_len = 1;  // Initialize lengths to 1 for '\0' character
 
-    // - if a chain_id is given and it's - known, we specify its network name
-    //                                   - unknown, we don't specify anything
-    // - if no chain_id is given we specify the APPNAME (legacy behaviour)
-
     // Compute the title message length
     title_len += strlen(title_prefix);
-    if (chain_id != NULL) {
-        if (chain_is_ethereum_compatible(chain_id)) {
-            network_name = get_network_name_from_chain_id(chain_id);
-        }
+
+    if (g_chain_config->chain_id == ETHEREUM_MAINNET_CHAINID) {
+        network_name = get_network_name_from_chain_id(chain_id);
+        icon = get_network_icon_from_chain_id(chain_id);
     } else {
-        network_name = APPNAME;
+        network_name = get_clone_network_name(g_caller_app);
+        icon = get_clone_network_icon(g_caller_app);
     }
+
     if (network_name != NULL) {
         title_len += strlen(network_name);
         title_len += 1;  // for '\n'
@@ -60,11 +58,6 @@ void ui_display_public_key(const uint64_t *chain_id) {
     }
     strlcat(g_titleMsg, title_sufix, title_len);
 
-    if (chain_id != NULL) {
-        icon = get_network_icon_from_chain_id(chain_id);
-    } else {
-        icon = get_app_icon(false);
-    }
 #ifndef FUZZ
     nbgl_useCaseAddressReview(strings.common.toAddress,
                               NULL,

src/nbgl/ui_get_public_key.c

@@ -1,7 +1,7 @@
 #include "nbgl_use_case.h"
 #include "app_mem_utils.h"
 #include "ui_nbgl.h"
-#include "caller_api.h"
+#include "caller_app.h"
 #include "network.h"
 #include "cmd_get_tx_simulation.h"
 #include "mem_utils.h"
@@ -226,13 +226,13 @@ static void prepare_and_display_home(const char *appname, const char *tagline, u
 static void get_appname_and_tagline(const char **appname, const char **tagline) {
     uint64_t mainnet_chain_id;
 
-    if (caller_app) {
-        *appname = caller_app->name;
+    if (g_caller_app) {
+        *appname = g_caller_app->name;
 
-        if (caller_app->type == CALLER_TYPE_PLUGIN) {
-            size_t name_len = strnlen(caller_app->name, MAX_PLUGIN_NAME_LEN + 1);
+        if (g_caller_app->type == CALLER_TYPE_PLUGIN) {
+            size_t name_len = strnlen(g_caller_app->name, MAX_PLUGIN_NAME_LEN + 1);
             if (name_len > MAX_PLUGIN_NAME_LEN) {
-                PRINTF("Plugin caller_app->name exceeds %u bytes; tagline omitted\n",
+                PRINTF("Plugin g_caller_app->name exceeds %u bytes; tagline omitted\n",
                        (unsigned) MAX_PLUGIN_NAME_LEN);
                 return;
             }

src/nbgl/ui_home.c

@@ -1,5 +1,5 @@
 #include "ui_nbgl.h"
-#include "caller_api.h"
+#include "caller_app.h"
 #include "plugins.h"
 #include "network_icons.h"
 #include "network.h"
@@ -12,11 +12,11 @@
  */
 const nbgl_icon_details_t *get_app_icon(bool caller_icon) {
     // Plugin or clone case: prefer the caller app's own icon
-    if (caller_icon && caller_app) {
-        if (caller_app->icon) {
-            return caller_app->icon;
+    if (caller_icon && g_caller_app) {
+        if (g_caller_app->icon) {
+            return g_caller_app->icon;
         }
-        PRINTF("%s: caller_app has no icon\n", __func__);
+        PRINTF("%s: g_caller_app has no icon\n", __func__);
     }
     // Default: Ethereum app icon
     return &ICONGLYPH;
@@ -29,11 +29,11 @@ const nbgl_icon_details_t *get_app_icon(bool caller_icon) {
  */
 const nbgl_icon_details_t *get_home_icon(void) {
     // Plugin or clone case: prefer the caller app's own icon
-    if (caller_app) {
-        if (caller_app->icon) {
-            return caller_app->icon;
+    if (g_caller_app) {
+        if (g_caller_app->icon) {
+            return g_caller_app->icon;
         }
-        PRINTF("%s: caller_app has no icon\n", __func__);
+        PRINTF("%s: g_caller_app has no icon\n", __func__);
     }
     // Default: Ethereum home icon
     return &ICONHOME;
@@ -48,16 +48,16 @@ const nbgl_icon_details_t *get_home_icon(void) {
  */
 const nbgl_icon_details_t *get_tx_icon(bool fromPlugin) {
     if (fromPlugin && (pluginType == PLUGIN_TYPE_EXTERNAL)) {
-        if ((caller_app != NULL) && (caller_app->name != NULL)) {
-            if (strcmp(strings.common.toAddress, caller_app->name) == 0) {
+        if ((g_caller_app != NULL) && (g_caller_app->name != NULL)) {
+            if (strcmp(strings.common.toAddress, g_caller_app->name) == 0) {
                 return get_app_icon(true);
             }
         }
         // icon is NULL in this case
         // Check with Alex if this is expected or a bug
         return NULL;
     }
-    if ((caller_app != NULL) && !fromPlugin) {
+    if ((g_caller_app != NULL) && !fromPlugin) {
         // Clone case
         return get_app_icon(true);
     }

src/nbgl/ui_icons.c

@@ -254,3 +254,10 @@ bool app_compatible_with_chain_id(const uint64_t *chain_id) {
             (chain_is_ethereum_compatible(&g_chain_config->chain_id) &&
              chain_is_ethereum_compatible(chain_id)));
 }
+
+const char *get_clone_network_name(const caller_app_t *caller_app) {
+    if ((caller_app == NULL) || (caller_app->type != CALLER_TYPE_CLONE)) {
+        return NULL;
+    }
+    return caller_app->name;
+}