Merge pull request #715 from LedgerHQ/abo_update_api_level_21

Update API_LEVEL_21
LedgerHQ · Jul 4, 2024 · edba017 · edba017
2 parents 3da2d9e + eb62d4c
commit edba017
Show file tree

Hide file tree

Showing 37 changed files with 262 additions and 542 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,46 @@
+name: Documentation generation & update
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  generate:
+    name: Generate the documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install APT dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install graphviz doxygen
+      - name: Generate the documentation
+        run: make doc
+      - name: Upload documentation bundle
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: build/doc/html/
+
+  deploy:
+    name: Deploy the documentation on Github pages
+    runs-on: ubuntu-latest
+    needs: generate
+    if: github.event_name == 'push'  && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/'))
+    steps:
+      - name: Download documentation bundle
+        uses: actions/download-artifact@v4
+      - name: Deploy documentation on pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: documentation/
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
@@ -47,9 +47,9 @@ The @subpage u2f_mainpage page contains all information necessary to use the U2F
 The @subpage ux_mainpage page contains all information necessary to user the User eXperience (and partially Graphical Library) for
 \b Nanos applications development (using \b BAGL).
 
-@subsection ux_stax_presentation User eXperience on Applications using \b NBGL
+@subsection ux_nbgl_presentation User eXperience on Applications using \b NBGL
 
-The @subpage ux_stax_mainpage page contains all information necessary to user the User eXperience for
+The @subpage ux_nbgl_mainpage page contains all information necessary to user the User eXperience for
 \b Stax, \b NanoX and \b NanoS+ applications development using \b NBGL (most recent ones).
 
 

diff --git a/include/os_pki.h b/include/os_pki.h
@@ -17,6 +17,8 @@
 #define CERTIFICATE_STRUCTURE_TYPE_CERTIFICATE (0x01)
 /** Maximum certificate trusted name length */
 #define CERTIFICATE_TRUSTED_NAME_MAXLEN        (32)
+/** Certificate depth maximum value */
+#define CERTIFICATE_DEPTH_MAX_VALUE            (0xFF)
 
 /** Certificate tags associated to each certificate field */
 typedef enum {
@@ -88,6 +90,7 @@ enum {
     CERTIFICATE_TARGET_DEVICE_NANOX,
     CERTIFICATE_TARGET_DEVICE_NANOSP,
     CERTIFICATE_TARGET_DEVICE_STAX,
+    CERTIFICATE_TARGET_DEVICE_FLEX,
     CERTIFICATE_TARGET_DEVICE_UNKNOWN
 };
 
@@ -137,7 +140,7 @@ static const os_pki_certificate_tag_info_t C_os_pki_certificate_tag_info[] = {
     [CERTIFICATE_INFO_INDEX_PK_SIGN_ALGO_ID]       = {CERTIFICATE_SIGN_ALGO_ID_UNKNOWN,         0x01                     },
     [CERTIFICATE_INFO_INDEX_TARGET_DEVICE]         = {CERTIFICATE_TARGET_DEVICE_UNKNOWN,        0x01                     },
     [CERTIFICATE_INFO_INDEX_SIGNATURE]             = {CERTIFICATE_FIELD_UNKNOWN_VALUE,          CERTIFICATE_FIELD_VAR_LEN},
-    [CERTIFICATE_INFO_INDEX_DEPTH]                 = {CERTIFICATE_FIELD_UNKNOWN_VALUE,          0x01                     },
+    [CERTIFICATE_INFO_INDEX_DEPTH]                 = {CERTIFICATE_DEPTH_MAX_VALUE,              0x01                     },
 };
 
 static const cx_md_t C_os_sign_algo_hash_info[] = {

diff --git a/include/sdk_apdu_commands.h b/include/sdk_apdu_commands.h
@@ -97,13 +97,9 @@
  * |DATA  |CERT_LEN|CERT      |Certificate        |
  *
  * - Response APDU
- * |DATA             |LENGTH           | DESCRIPTION                     |
- * |-----------------|-----------------|---------------------------------|
- * |TRUSTED_NAME_LEN |0x01             | Certificate trusted name length |
- * |TRUSTED_NAME     |TRUSTED_NAME_LEN | Certificate trusted name        |
- * |PUBLIC_KEY_LEN   |0x01             | Certificate public key length   |
- * |PUBLIC_KEY       |PUBLIC_KEY_LEN   | Certificate public key          |
- * |STATUS_WORD      |0x02             | 0x9000 on success               |
+ * |DATA             |LENGTH           | DESCRIPTION       |
+ * |-----------------|-----------------|-------------------|
+ * |STATUS_WORD      |0x02             | 0x9000 on success |
  */
 #define DEFAULT_APDU_INS_LOAD_CERTIFICATE 0x06
 #endif  // HAVE_LEDGER_PKI

diff --git a/lib_blewbxx_impl/doc/mainpage.dox b/lib_blewbxx_impl/doc/mainpage.dox
@@ -1,6 +1,6 @@
 /** @page ble_mainpage BlueTooth Low-Energy Stack
 
-@section mainpage_intro Introduction
+@section ble_mainpage_intro Introduction
 
 This page describes the API of BLE (BlueTooth Low-Energy) Stack provided in \b NanoX and \b Stax products.
 

diff --git a/lib_cxng/doc/mainpage.dox b/lib_cxng/doc/mainpage.dox
@@ -1,6 +1,6 @@
 /** @page cxng_mainpage Cryptographic Library
 
-@section mainpage_intro Introduction
+@section cxng_mainpage_intro Introduction
 
 This documentation describes the different interfaces of Bolos Cryptographic Library.
 

diff --git a/lib_nbgl/doc/mainpage.dox b/lib_nbgl/doc/mainpage.dox
@@ -1,7 +1,7 @@
 #ifdef HAVE_SE_TOUCH
 /** @page nbgl_mainpage New BOLOS Graphic API for Stax
 
-@section mainpage_intro Introduction
+@section nbgl_mainpage_intro Introduction
 
 This documentation describes the different interfaces of <b>NBGL</b>, the library that
 is targeted to be integrated in Stax product.