Merge pull request #412 from LedgerHQ/feature/apa/ens

Domain names support

Author: apaillier-ledger

.github/workflows/ci-workflow.yml

@@ -166,111 +166,18 @@ jobs:
 # =====================================================
 
   build_ragger_elfs:
-    name: Building binaries for Ragger tests
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder-lite:latest
-
-    steps:
-      - name: Clone
-        uses: actions/checkout@v3
-
-      - name: Build test binaries
-        run: |
-          make -j BOLOS_SDK=$NANOS_SDK CAL_CI_KEY=1
-          mv bin/app.elf app-nanos.elf
-          make clean
-          make -j BOLOS_SDK=$NANOX_SDK CAL_CI_KEY=1
-          mv bin/app.elf app-nanox.elf
-          make clean
-          make -j BOLOS_SDK=$NANOSP_SDK CAL_CI_KEY=1
-          mv bin/app.elf app-nanosp.elf
-
-      - name: Upload app binaries
-        uses: actions/upload-artifact@v3
-        with:
-          name: ragger_elfs
-          path: ./app-*.elf
-
-  create_ragger_env:
-    name: Cache Ragger environment
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Clone
-        uses: actions/checkout@v3
-
-      - name: APT update
-        run: |
-          sudo apt update
-
-      - name: Create virtual env with dependencies
-        run: |
-          cd tests/ragger
-          python3 -m venv ./venv
-          . ./venv/bin/activate
-          pip3 install --extra-index-url https://test.pypi.org/simple/ -r requirements.txt
-          # Used for the cache key
-          echo "py_deps=$(pip freeze | md5sum | cut -d' ' -f1)" >> $GITHUB_ENV
-
-      - name: Download QEMU
-        run: |
-          sudo apt install --download-only -y qemu-user-static
-          mkdir -p tests/ragger/packages
-          cp /var/cache/apt/archives/*.deb tests/ragger/packages/
-          # Used for the cache key
-          echo "deb_deps=$(find /var/cache/apt/archives/ -maxdepth 0 -type f -name '*.deb' | md5sum | cut -d' ' -f 1)" >> $GITHUB_ENV
-
-      - name: Set up cache
-        uses: actions/cache@v3
-        with:
-          key: ${{ runner.os }}-raggenv-${{ env.py_deps }}-${{ env.deb_deps }}
-          path: |
-            tests/ragger/venv/
-            tests/ragger/packages/
-    outputs:
-      py_deps: ${{ env.py_deps }}
-      deb_deps: ${{ env.deb_deps }}
-
+    name: Build app for Ragger tests
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_build.yml@v1
+    with:
+      upload_app_binaries_artifact: "ragger_elfs"
+      flags: "DEBUG=1 CAL_CI_KEY=1 DOMAIN_NAME_TEST_KEY=1"
+      run_for_devices: '["nanos", "nanox", "nanosp"]'
 
   jobs-ragger-tests:
-    name: Ragger tests
-    strategy:
-      matrix:
-        model: ["nanos", "nanox", "nanosp"]
-    needs: [build_ragger_elfs, create_ragger_env]
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Clone
-        uses: actions/checkout@v3
-
-      - name: Download previously built artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: ragger_elfs
-          path: tmp/
-
-      - name: Put them where they belong
-        run: |
-          mkdir -p tests/ragger/elfs
-          find tmp/ -type f -name '*.elf' -exec cp {} tests/ragger/elfs/ \;
-
-      - name: Get cached environment
-        uses: actions/cache@v3
-        with:
-          key: ${{ runner.os }}-raggenv-${{ needs.create_ragger_env.outputs.py_deps }}-${{ needs.create_ragger_env.outputs.deb_deps }}
-          path: |
-            tests/ragger/venv/
-            tests/ragger/packages/
-
-      - name: Install QEMU
-        run: |
-          sudo mv tests/ragger/packages/*.deb /var/cache/apt/archives/
-          sudo apt install -y qemu-user-static
-
-      - name: Run tests
-        run: |
-          cd tests/ragger
-          . ./venv/bin/activate
-          pytest --path ./elfs --model ${{ matrix.model }} -s -v --tb=short
+    name: Run Ragger tests
+    needs: build_ragger_elfs
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_ragger_tests.yml@v1
+    with:
+      download_app_binaries_artifact: "ragger_elfs"
+      test_dir: tests/ragger
+      run_for_devices: '["nanos", "nanox", "nanosp"]'

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.10.2](https://github.com/ledgerhq/app-ethereum/compare/1.10.1...1.10.2) - 2022-02-09
+## [1.10.2](https://github.com/ledgerhq/app-ethereum/compare/1.10.1...1.10.2) - 2023-XX-XX
 
 ### Added
 
@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - (network) Velas EVM
 - (network) Boba Network
 - (network) Energi
+- Domain names support (LNX / LNS+)
 
 ### Changed
 

Makefile

@@ -35,7 +35,7 @@ APP_LOAD_PARAMS += --path "1517992542'/1101353413'"
 APPVERSION_M=1
 APPVERSION_N=10
 APPVERSION_P=2
-APPVERSION=$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)
+APPVERSION=$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)-dev
 APP_LOAD_FLAGS= --appFlags 0xa40 --dep Ethereum:$(APPVERSION)
 
 ###########################
@@ -157,6 +157,15 @@ ifneq ($(CAL_CI_KEY),0)
 DEFINES += HAVE_CAL_CI_KEY
 endif
 
+# ENS
+ifneq ($(TARGET_NAME),TARGET_NANOS)
+DEFINES += HAVE_DOMAIN_NAME
+DOMAIN_NAME_TEST_KEY:=0
+ifneq ($(DOMAIN_NAME_TEST_KEY),0)
+DEFINES += HAVE_DOMAIN_NAME_TEST_KEY
+endif
+endif
+
 # Enabling debug PRINTF
 DEBUG:=0
 ifneq ($(DEBUG),0)

doc/ethapp.adoc

@@ -38,6 +38,9 @@ Application version 1.9.19 - 2022-05-17
   - Add EIP712 STRUCT DEFINITION & EIP712 STRUCT IMPLEMENTATION
   - Update to SIGN ETH EIP712
 
+### 1.10.2
+  - Add domain names support
+
 ## About
 
 This application describes the APDU messages interface to communicate with the Ethereum application.
@@ -881,6 +884,82 @@ _Output data_
 None
 
 
+### GET CHALLENGE
+
+#### Description
+
+Sends a random 32-bit long value. Can prevent replay of signed payloads when the challenge
+is included in said payload.
+
+#### Coding
+
+_Command_
+
+[width="80%"]
+|=============================================================
+| *CLA* | *INS*  | *P1*               | *P2*       | *LC*
+|   E0  |   20   | 00                 | 00         | 00
+|=============================================================
+
+_Input data_
+
+None
+
+_Output data_
+
+[width="80%"]
+|===========================================
+| *Description*                 | *Length*
+| Challenge value (BE)          | 4
+|===========================================
+
+
+### PROVIDE DOMAIN NAME
+
+#### Description
+
+This command provides a domain name (like ENS) to be displayed during transactions in place of the address it is associated to.
+It shall be run just before a transaction involving the associated address that would be displayed on the device.
+
+The signature is computed on the TLV payload (minus the signature obviously).
+
+#### Coding
+
+_Command_
+
+[width="80%"]
+|==============================================================
+| *CLA* | *INS*  | *P1*               | *P2*       | *LC*
+|   E0  |   22   | 01 : first chunk
+
+                   00 : following chunk
+                                      | 00         | 00
+|==============================================================
+
+_Input data_
+
+##### If P1 == first chunk
+
+[width="80%"]
+|==========================================
+| *Description*         | *Length (byte)*
+| Payload length        | 2
+| TLV payload           | variable
+|==========================================
+
+##### If P1 == following chunk
+
+[width="80%"]
+|==========================================
+| *Description*         | *Length (byte)*
+| TLV payload           | variable
+|==========================================
+
+_Output data_
+
+None
+
+
 ## Transport protocol
 
 ### General transport description

src/apdu_constants.h

@@ -24,6 +24,8 @@
 #define INS_EIP712_STRUCT_DEF               0x1A
 #define INS_EIP712_STRUCT_IMPL              0x1C
 #define INS_EIP712_FILTERING                0x1E
+#define INS_ENS_GET_CHALLENGE               0x20
+#define INS_ENS_PROVIDE_INFO                0x22
 #define P1_CONFIRM                          0x01
 #define P1_NON_CONFIRM                      0x00
 #define P2_NO_CHAINCODE                     0x00

src/main.c

@@ -29,6 +29,8 @@
 #include "handle_get_printable_amount.h"
 #include "handle_check_address.h"
 #include "commands_712.h"
+#include "challenge.h"
+#include "domain_name.h"
 
 #ifdef HAVE_STARKWARE
 #include "stark_crypto.h"
@@ -749,6 +751,19 @@ void handleApdu(unsigned int *flags, unsigned int *tx) {
                     break;
 #endif  // HAVE_EIP712_FULL_SUPPORT
 
+#ifdef HAVE_DOMAIN_NAME
+                case INS_ENS_GET_CHALLENGE:
+                    handle_get_challenge();
+                    break;
+
+                case INS_ENS_PROVIDE_INFO:
+                    handle_provide_domain_name(G_io_apdu_buffer[OFFSET_P1],
+                                               G_io_apdu_buffer[OFFSET_P2],
+                                               G_io_apdu_buffer + OFFSET_CDATA,
+                                               G_io_apdu_buffer[OFFSET_LC]);
+                    break;
+#endif  // HAVE_DOMAIN_NAME
+
 #if 0
         case 0xFF: // return to dashboard
           goto return_to_dashboard;
@@ -954,19 +969,22 @@ void coin_main(chain_config_t *coin_config) {
                 G_io_app.plane_mode = os_setting_get(OS_SETTING_PLANEMODE, NULL, 0);
 #endif  // TARGET_NANOX
 
-                if (N_storage.initialized != 0x01) {
+                if (!N_storage.initialized) {
                     internalStorage_t storage;
 #ifdef HAVE_ALLOW_DATA
-                    storage.dataAllowed = 0x01;
+                    storage.dataAllowed = true;
 #else
-                    storage.dataAllowed = 0x00;
+                    storage.dataAllowed = false;
 #endif
-                    storage.contractDetails = 0x00;
-                    storage.displayNonce = 0x00;
+                    storage.contractDetails = false;
+                    storage.displayNonce = false;
 #ifdef HAVE_EIP712_FULL_SUPPORT
-                    storage.verbose_eip712 = 0x00;
+                    storage.verbose_eip712 = false;
+#endif
+#ifdef HAVE_DOMAIN_NAME
+                    storage.verbose_domain_name = false;
 #endif
-                    storage.initialized = 0x01;
+                    storage.initialized = true;
                     nvm_write((void *) &N_storage, (void *) &storage, sizeof(internalStorage_t));
                 }
 
@@ -980,6 +998,11 @@ void coin_main(chain_config_t *coin_config) {
                 BLE_power(1, "Nano X");
 #endif  // HAVE_BLE
 
+#ifdef HAVE_DOMAIN_NAME
+                // to prevent it from having a fixed value at boot
+                roll_challenge();
+#endif  // HAVE_DOMAIN_NAME
+
                 app_main();
             }
             CATCH(EXCEPTION_IO_RESET) {

src/shared_context.h

@@ -24,13 +24,16 @@ typedef struct bip32_path_t {
 } bip32_path_t;
 
 typedef struct internalStorage_t {
-    unsigned char dataAllowed;
-    unsigned char contractDetails;
-    unsigned char displayNonce;
+    bool dataAllowed;
+    bool contractDetails;
+    bool displayNonce;
 #ifdef HAVE_EIP712_FULL_SUPPORT
     bool verbose_eip712;
 #endif  // HAVE_EIP712_FULL_SUPPORT
-    uint8_t initialized;
+#ifdef HAVE_DOMAIN_NAME
+    bool verbose_domain_name;
+#endif  // HAVE_DOMAIN_NAME
+    bool initialized;
 } internalStorage_t;
 
 #ifdef HAVE_STARKWARE

src_bagl/ui_domain_name.c

@@ -0,0 +1,17 @@
+#ifdef HAVE_DOMAIN_NAME
+
+#include "ux.h"
+#include "domain_name.h"
+
+//////////////////////////////////////////////////////////////////////
+// clang-format off
+UX_STEP_NOCB(
+    ux_domain_name_step,
+    bnnn_paging,
+    {
+      .title = "Domain",
+      .text = g_domain_name
+    });
+// clang-format on
+
+#endif  // HAVE_DOMAIN_NAME

src_bagl/ui_domain_name.h

@@ -0,0 +1,12 @@
+#ifdef HAVE_DOMAIN_NAME
+
+#ifndef UI_DOMAIN_NAME_H_
+#define UI_DOMAIN_NAME_H_
+
+#include "ux.h"
+
+extern const ux_flow_step_t ux_domain_name_step;
+
+#endif  // UI_DOMAIN_NAME_H_
+
+#endif  // HAVE_DOMAIN_NAME