Merge pull request #963 from LedgerHQ/cev/cleanup

Cleanup & Renaming

Author: cedelavergne-ledger

doc/eth_contract_support_embedded.adoc

@@ -38,6 +38,6 @@ The following online tool can be used to compute selectors https://emn178.github
 
 A UI implementation might want to convert an ERC 20 token contract address to a ticker for easier validation
 
-2 tickers can be temporarily provisioned to the application by using the PROVIDE ERC 20 TOKEN INFORMATION APDU, described in *src/features/provideErc20TokenInformation* - the UI can then iterate on the provisioned tickers to display relevant information to the user
+2 tickers can be temporarily provisioned to the application by using the PROVIDE ERC 20 TOKEN INFORMATION APDU, described in *src/features/provide_erc20_token_information* - the UI can then iterate on the provisioned tickers to display relevant information to the user
 
 The same mechanism will be extended to support well known contract addresses in the future

makefile_conf/features.mk

@@ -1,6 +1,6 @@
 # Activate requested features
 # ---------------------------
-# Bypass the signature verification for setExternalPlugin, setPlugin, provideERC20TokenInfo and provideNFTInfo calls
+# Bypass the signature verification for set_external_plugin, set_plugin, provide_erc20_token_information and provide_nft_information calls
 BYPASS_SIGNATURES ?= 0
 ifneq ($(BYPASS_SIGNATURES),0)
     DEFINES += HAVE_BYPASS_SIGNATURES

src/apdu_constants.h

@@ -79,52 +79,52 @@
 #define APDU_NO_RESPONSE                0x0000
 #define APDU_RESPONSE_MODE_CHECK_FAILED 0x6001
 
-uint16_t handleGetPublicKey(uint8_t p1,
-                            uint8_t p2,
-                            const uint8_t *dataBuffer,
-                            uint8_t dataLength,
-                            unsigned int *flags,
-                            unsigned int *tx);
-uint16_t handleProvideErc20TokenInformation(const uint8_t *workBuffer,
-                                            uint8_t dataLength,
-                                            unsigned int *tx);
-uint16_t handleProvideNFTInformation(const uint8_t *dataBuffer,
-                                     uint8_t dataLength,
-                                     unsigned int *tx);
-uint16_t handleSign(uint8_t p1,
-                    uint8_t p2,
-                    const uint8_t *dataBuffer,
-                    uint8_t dataLength,
-                    unsigned int *flags);
-uint16_t handleGetAppConfiguration(unsigned int *tx);
-uint16_t handleSignPersonalMessage(uint8_t p1,
-                                   const uint8_t *const payload,
-                                   uint8_t length,
-                                   unsigned int *flags);
-uint16_t handleSignEIP712Message_v0(uint8_t p1,
-                                    const uint8_t *dataBuffer,
-                                    uint8_t dataLength,
-                                    unsigned int *flags);
+uint16_t handle_get_public_key(uint8_t p1,
+                               uint8_t p2,
+                               const uint8_t *dataBuffer,
+                               uint8_t dataLength,
+                               unsigned int *flags,
+                               unsigned int *tx);
+uint16_t handle_provide_erc20_token_information(const uint8_t *workBuffer,
+                                                uint8_t dataLength,
+                                                unsigned int *tx);
+uint16_t handle_provide_nft_information(const uint8_t *dataBuffer,
+                                        uint8_t dataLength,
+                                        unsigned int *tx);
+uint16_t handle_sign(uint8_t p1,
+                     uint8_t p2,
+                     const uint8_t *dataBuffer,
+                     uint8_t dataLength,
+                     unsigned int *flags);
+uint16_t handle_get_app_configuration(unsigned int *tx);
+uint16_t handle_sign_personal_message(uint8_t p1,
+                                      const uint8_t *const payload,
+                                      uint8_t length,
+                                      unsigned int *flags);
+uint16_t handle_sign_eip712_message_v0(uint8_t p1,
+                                       const uint8_t *dataBuffer,
+                                       uint8_t dataLength,
+                                       unsigned int *flags);
 
-uint16_t handleSetExternalPlugin(const uint8_t *workBuffer, uint8_t dataLength);
+uint16_t handle_set_external_plugin(const uint8_t *workBuffer, uint8_t dataLength);
 
-uint16_t handleSetPlugin(const uint8_t *workBuffer, uint8_t dataLength);
+uint16_t handle_set_plugin(const uint8_t *workBuffer, uint8_t dataLength);
 
-uint16_t handlePerformPrivacyOperation(uint8_t p1,
-                                       uint8_t p2,
-                                       const uint8_t *workBuffer,
-                                       uint8_t dataLength,
-                                       unsigned int *flags,
-                                       unsigned int *tx);
+uint16_t handle_perform_privacy_operation(uint8_t p1,
+                                          uint8_t p2,
+                                          const uint8_t *workBuffer,
+                                          uint8_t dataLength,
+                                          unsigned int *flags,
+                                          unsigned int *tx);
 
 #ifdef HAVE_ETH2
 
-uint16_t handleGetEth2PublicKey(uint8_t p1,
-                                uint8_t p2,
-                                const uint8_t *dataBuffer,
-                                uint8_t dataLength,
-                                unsigned int *flags,
-                                unsigned int *tx);
+uint16_t handle_get_eth2_public_key(uint8_t p1,
+                                    uint8_t p2,
+                                    const uint8_t *dataBuffer,
+                                    uint8_t dataLength,
+                                    unsigned int *flags,
+                                    unsigned int *tx);
 
 #endif
 

src/chainConfig.h src/chain_config.hsrc/chainConfig.h renamed to src/chain_config.h

@@ -25,3 +25,7 @@ typedef struct chain_config_s {
 } chain_config_t;
 
 #define ETHEREUM_MAINNET_CHAINID 1
+
+// Chain ID Validation (per EIP-2294)
+// See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2294.md
+#define MAX_VALID_CHAIN_ID 0x7FFFFFFFFFFFFFDB

src/features/generic_tx_parser/gtp_field.h

@@ -18,6 +18,8 @@
 #include "calldata.h"
 #include "lists.h"
 
+#define MAX_FIELD_NAME_SIZE 21
+
 typedef enum {
     PARAM_TYPE_RAW = 0,
     PARAM_TYPE_AMOUNT,
@@ -49,7 +51,7 @@ typedef struct s_field_constraint {
 
 typedef struct s_field {
     uint8_t version;
-    char name[21];
+    char name[MAX_FIELD_NAME_SIZE];
     e_param_type param_type;
     union {
         s_param_raw param_raw;

src/features/generic_tx_parser/gtp_param_network.c

@@ -17,6 +17,7 @@
 #include "tx_ctx.h"
 #include "apdu_constants.h"
 #include "tlv_apdu.h"
+#include "chain_config.h"
 
 /**
  * @brief TLV tags for network parameter structure
@@ -88,7 +89,6 @@ bool handle_param_network_struct(const buffer_t *buf, s_param_network_context *c
  */
 static bool format_network_name(const s_parsed_value *value, char *buf, size_t buf_size) {
     uint64_t chain_id = 0;
-    uint64_t max_range = 0x7FFFFFFFFFFFFFDB;  // per EIP-2294
 
     // Check length
     if (value->length != sizeof(uint64_t)) {
@@ -99,7 +99,7 @@ static bool format_network_name(const s_parsed_value *value, char *buf, size_t b
     // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2294.md
     chain_id = u64_from_BE(value->ptr, value->length);
     // Check if the chain_id is supported
-    if ((chain_id > max_range) || (chain_id == 0)) {
+    if ((chain_id > MAX_VALID_CHAIN_ID) || (chain_id == 0)) {
         PRINTF("Unsupported chain ID: %llu\n", chain_id);
         return false;
     }

src/features/generic_tx_parser/gtp_param_raw.c

@@ -111,7 +111,7 @@ bool format_uint(const s_field *field,
 }
 
 bool format_int(const s_value *def, const s_parsed_value *value, char *buf, size_t buf_size) {
-    uint8_t tmp[32];
+    uint8_t tmp[INT256_LENGTH];
     bool ret;
     union {
         uint256_t value256;

src/features/generic_tx_parser/gtp_param_token_amount.h

@@ -7,7 +7,8 @@
 #include "gtp_value.h"
 #include "common_utils.h"
 
-#define MAX_NATIVE_ADDRS 4
+#define MAX_NATIVE_ADDRS         4
+#define ABOVE_THRESHOLD_MSG_SIZE 21
 
 typedef struct {
     uint8_t version;
@@ -17,7 +18,7 @@ typedef struct {
     uint8_t native_addr_count;
     uint8_t native_addrs[MAX_NATIVE_ADDRS][ADDRESS_LENGTH];
     uint256_t threshold;
-    char above_threshold_msg[21];
+    char above_threshold_msg[ABOVE_THRESHOLD_MSG_SIZE];
 } s_param_token_amount;
 
 typedef struct {

src/features/generic_tx_parser/gtp_param_trusted_name.c

@@ -6,7 +6,7 @@
 #include "gtp_field_table.h"
 #include "utils.h"
 #include "shared_context.h"
-#include "getPublicKey.h"
+#include "get_public_key.h"
 #include "apdu_constants.h"
 #include "tx_ctx.h"
 #include "tlv_apdu.h"

src/features/generic_tx_parser/gtp_param_unit.h

@@ -5,10 +5,12 @@
 #include "buffer.h"
 #include "gtp_value.h"
 
+#define BASE_STR_SIZE 11
+
 typedef struct {
     uint8_t version;
     s_value value;
-    char base[11];
+    char base[BASE_STR_SIZE];
     uint8_t decimals;
 } s_param_unit;