identity_edit_scope.c

Go to the documentation of this file.

/*****************************************************************************
 *   (c) 2026 Ledger SAS.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *****************************************************************************/
 
/* Includes ------------------------------------------------------------------*/
#include <string.h>
#include "os_apdu.h"
#include "status_words.h"
#include "tlv_library.h"
#include "buffer.h"
#include "bip32.h"
#include "address_book.h"
#include "address_book_entrypoints.h"
#include "address_book_crypto.h"
#include "address_book_common.h"
#include "identity.h"
#include "io.h"
#include "nbgl_use_case.h"
 
#if defined(HAVE_ADDRESS_BOOK)
 
/* Private defines------------------------------------------------------------*/
#define STRUCT_VERSION 0x01
 
/* Private types, structures, unions -----------------------------------------*/
typedef struct {
    edit_scope_t   *edit;
    TLV_reception_t received_tags;
    uint8_t         hmac_proof[CX_SHA256_SIZE];       
    uint8_t         hmac_rest[CX_SHA256_SIZE];        
    uint8_t         group_handle[GROUP_HANDLE_SIZE];  
} s_edit_scope_ctx;
 
/* Private macros-------------------------------------------------------------*/
#define EDIT_SCOPE_TAGS(X)                                                    \
    X(0x01, TAG_STRUCTURE_TYPE, handle_struct_type, ENFORCE_UNIQUE_TAG)       \
    X(0x02, TAG_STRUCTURE_VERSION, handle_struct_version, ENFORCE_UNIQUE_TAG) \
    X(0xf0, TAG_CONTACT_NAME, handle_contact_name, ENFORCE_UNIQUE_TAG)        \
    X(0xf1, TAG_SCOPE, handle_scope, ENFORCE_UNIQUE_TAG)                      \
    X(0xf2, TAG_ACCOUNT_IDENTIFIER, handle_identifier, ENFORCE_UNIQUE_TAG)    \
    X(0xf5, TAG_PREVIOUS_SCOPE, handle_previous_scope, ENFORCE_UNIQUE_TAG)    \
    X(0xf6, TAG_GROUP_HANDLE, handle_group_handle, ENFORCE_UNIQUE_TAG)        \
    X(0x21, TAG_DERIVATION_PATH, handle_derivation_path, ENFORCE_UNIQUE_TAG)  \
    X(0x23, TAG_CHAIN_ID, handle_chain_id, ENFORCE_UNIQUE_TAG)                \
    X(0x29, TAG_HMAC_PROOF, handle_hmac_proof, ENFORCE_UNIQUE_TAG)            \
    X(0xf7, TAG_HMAC_REST, handle_hmac_rest, ENFORCE_UNIQUE_TAG)              \
    X(0x51, TAG_BLOCKCHAIN_FAMILY, handle_blockchain_family, ENFORCE_UNIQUE_TAG)
 
/* Private variables ---------------------------------------------------------*/
 
/* Private functions ---------------------------------------------------------*/
 
static bool handle_struct_type(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    UNUSED(context);
    if (!tlv_enforce_u8_value(data, TYPE_EDIT_SCOPE)) {
        PRINTF("[Edit Scope] Invalid STRUCTURE_TYPE value\n");
        return false;
    }
    return true;
}
 
static bool handle_struct_version(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    UNUSED(context);
    if (!tlv_enforce_u8_value(data, STRUCT_VERSION)) {
        PRINTF("[Edit Scope] Invalid STRUCTURE_VERSION value\n");
        return false;
    }
    return true;
}
 
static bool handle_contact_name(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    if (!address_book_handle_printable_string(data,
                                              context->edit->identity.contact_name,
                                              sizeof(context->edit->identity.contact_name))) {
        PRINTF("[Edit Scope] CONTACT_NAME: failed to parse\n");
        return false;
    }
    return true;
}
 
static bool handle_scope(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    if (!address_book_handle_printable_string(
            data, context->edit->identity.scope, sizeof(context->edit->identity.scope))) {
        PRINTF("[Edit Scope] SCOPE: failed to parse\n");
        return false;
    }
    return true;
}
 
static bool handle_identifier(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    buffer_t buf = {0};
    if (!get_buffer_from_tlv_data(data, &buf, 1, IDENTIFIER_MAX_LENGTH)) {
        PRINTF("[Edit Scope] IDENTIFIER: failed to extract\n");
        return false;
    }
    memmove(context->edit->identity.identifier, buf.ptr, buf.size);
    context->edit->identity.identifier_len = (uint8_t) buf.size;
    return true;
}
 
static bool handle_previous_scope(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    if (!address_book_handle_printable_string(
            data, context->edit->old_scope, sizeof(context->edit->old_scope))) {
        PRINTF("[Edit Scope] PREVIOUS_SCOPE: failed to parse\n");
        return false;
    }
    return true;
}
 
static bool handle_group_handle(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    buffer_t buf = {0};
    if (!get_buffer_from_tlv_data(data, &buf, GROUP_HANDLE_SIZE, GROUP_HANDLE_SIZE)) {
        PRINTF("[Edit Scope] GROUP_HANDLE: invalid length (expected %d bytes)\n",
               GROUP_HANDLE_SIZE);
        return false;
    }
    memmove(context->group_handle, buf.ptr, GROUP_HANDLE_SIZE);
    return true;
}
 
static bool handle_derivation_path(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    return address_book_handle_derivation_path(data, &context->edit->identity.bip32_path);
}
 
static bool handle_chain_id(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    return address_book_handle_chain_id(data, &context->edit->identity.chain_id);
}
 
static bool handle_blockchain_family(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    return address_book_handle_blockchain_family(data, &context->edit->identity.blockchain_family);
}
 
static bool handle_hmac_proof(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    buffer_t buf = {0};
    if (!get_buffer_from_tlv_data(data, &buf, CX_SHA256_SIZE, CX_SHA256_SIZE)) {
        PRINTF("[Edit Scope] HMAC_PROOF: invalid length (expected %d bytes)\n", CX_SHA256_SIZE);
        return false;
    }
    memmove(context->hmac_proof, buf.ptr, CX_SHA256_SIZE);
    return true;
}
 
static bool handle_hmac_rest(const tlv_data_t *data, s_edit_scope_ctx *context)
{
    buffer_t buf = {0};
    if (!get_buffer_from_tlv_data(data, &buf, CX_SHA256_SIZE, CX_SHA256_SIZE)) {
        PRINTF("[Edit Scope] HMAC_REST: invalid length (expected %d bytes)\n", CX_SHA256_SIZE);
        return false;
    }
    memmove(context->hmac_rest, buf.ptr, CX_SHA256_SIZE);
    return true;
}
 
DEFINE_TLV_PARSER(EDIT_SCOPE_TAGS, NULL, edit_scope_tlv_parser)
 
 
static bool verify_fields(const s_edit_scope_ctx *context)
{
    bool result = TLV_CHECK_RECEIVED_TAGS(context->received_tags,
                                          TAG_STRUCTURE_TYPE,
                                          TAG_STRUCTURE_VERSION,
                                          TAG_CONTACT_NAME,
                                          TAG_SCOPE,
                                          TAG_ACCOUNT_IDENTIFIER,
                                          TAG_PREVIOUS_SCOPE,
                                          TAG_GROUP_HANDLE,
                                          TAG_DERIVATION_PATH,
                                          TAG_BLOCKCHAIN_FAMILY,
                                          TAG_HMAC_PROOF,
                                          TAG_HMAC_REST);
    if (!result) {
        PRINTF("[Edit Scope] Missing mandatory fields!\n");
        return false;
    }
    if (context->edit->identity.blockchain_family == FAMILY_ETHEREUM) {
        result = TLV_CHECK_RECEIVED_TAGS(context->received_tags, TAG_CHAIN_ID);
        if (!result) {
            PRINTF("[Edit Scope] Missing CHAIN_ID for Ethereum!\n");
            return false;
        }
    }
    return true;
}
 
static void print_payload(const s_edit_scope_ctx *context)
{
    UNUSED(context);
    PRINTF("****************************************************************************\n");
    PRINTF("[Edit Scope] - Retrieved Descriptor:\n");
    PRINTF("[Edit Scope] -    Contact name:      %s\n", context->edit->identity.contact_name);
    PRINTF("[Edit Scope] -    Old scope:         %s\n", context->edit->old_scope);
    PRINTF("[Edit Scope] -    New scope:         %s\n", context->edit->identity.scope);
    PRINTF("[Edit Scope] -    Blockchain family: %s\n",
           FAMILY_AS_STR(context->edit->identity.blockchain_family));
    if (context->edit->identity.blockchain_family == FAMILY_ETHEREUM) {
        PRINTF("[Edit Scope] -    Chain ID:          %llu\n", context->edit->identity.chain_id);
    }
}
 
static bool build_and_send_response(void)
{
    uint8_t hmac_rest[CX_SHA256_SIZE] = {0};
 
    if (!address_book_compute_hmac_rest(&g_ab_payload.edit_scope.identity.bip32_path,
                                        g_ab_payload.edit_scope.identity.gid,
                                        g_ab_payload.edit_scope.identity.scope,
                                        g_ab_payload.edit_scope.identity.identifier,
                                        g_ab_payload.edit_scope.identity.identifier_len,
                                        g_ab_payload.edit_scope.identity.blockchain_family,
                                        g_ab_payload.edit_scope.identity.chain_id,
                                        hmac_rest)) {
        PRINTF("[Edit Scope] Error: Failed to compute new HMAC_REST\n");
        return false;
    }
 
    bool ok = address_book_send_hmac_proof(TYPE_EDIT_SCOPE, hmac_rest);
    explicit_bzero(hmac_rest, sizeof(hmac_rest));
    return ok;
}
 
static void review_choice(bool confirm)
{
    if (confirm) {
        bool        ok = build_and_send_response();
        const char *successMsg
            = (g_ab_payload.edit_scope.identity.blockchain_family == FAMILY_BITCOIN)
                  ? "Scope changed"
                  : "Address name changed";
        if (ok) {
            on_edit_scope_applied(&g_ab_payload.edit_scope);
        }
        else {
            PRINTF("[Edit Scope] Error: Failed to build and send HMAC proof\n");
        }
        address_book_finalize_review(ok, successMsg, "Error during update", finalize_ui_edit_scope);
    }
    else {
        address_book_handle_review_rejected(finalize_ui_edit_scope);
    }
}
 
static void ui_display(void)
{
    uint8_t nbPairs   = 0;
    bool    isBitcoin = (g_ab_payload.edit_scope.identity.blockchain_family == FAMILY_BITCOIN);
 
    memset(&g_ab_ui.list, 0, sizeof(g_ab_ui.list));
    memset(g_ab_ui.pairs, 0, sizeof(g_ab_ui.pairs));
    g_ab_ui.pairs[nbPairs].item  = "Contact name";
    g_ab_ui.pairs[nbPairs].value = g_ab_payload.edit_scope.identity.contact_name;
    nbPairs++;
    g_ab_ui.pairs[nbPairs].item  = isBitcoin ? "Old scope" : "Old address name";
    g_ab_ui.pairs[nbPairs].value = g_ab_payload.edit_scope.old_scope;
    nbPairs++;
    g_ab_ui.pairs[nbPairs].item  = isBitcoin ? "New scope" : "New address name";
    g_ab_ui.pairs[nbPairs].value = g_ab_payload.edit_scope.identity.scope;
    nbPairs++;
    g_ab_ui.list.pairs   = g_ab_ui.pairs;
    g_ab_ui.list.nbPairs = nbPairs;
    address_book_display_review(&LARGE_ADDRESS_BOOK_ICON,
                                "Review change to contact details",
#ifdef SCREEN_SIZE_WALLET
                                "Confirm change?",
#else
                                "Confirm change",
#endif
                                review_choice);
}
 
/* Exported functions --------------------------------------------------------*/
 
bolos_err_t edit_scope(uint8_t *buffer_in, size_t buffer_in_length)
{
    const buffer_t   payload = {.ptr = buffer_in, .size = buffer_in_length};
    s_edit_scope_ctx ctx     = {0};
 
    // Init the structure
    ctx.edit = &g_ab_payload.edit_scope;
    memset(&g_ab_payload.edit_scope, 0, sizeof(g_ab_payload.edit_scope));
 
    // Parse using SDK TLV parser
    if (!edit_scope_tlv_parser(&payload, &ctx, &ctx.received_tags)) {
        PRINTF("[Edit Scope] TLV parsing failed\n");
        return SWO_INCORRECT_DATA;
    }
    if (!verify_fields(&ctx)) {
        return SWO_INCORRECT_DATA;
    }
    print_payload(&ctx);
 
    // Verify the group handle and extract the gid
    if (!address_book_verify_group_handle(&g_ab_payload.edit_scope.identity.bip32_path,
                                          ctx.group_handle,
                                          g_ab_payload.edit_scope.identity.gid)) {
        PRINTF("[Edit Scope] Group handle verification failed\n");
        return SWO_SECURITY_CONDITION_NOT_SATISFIED;
    }
 
    // Verify that the wallet holds a valid HMAC_PROOF for the contact name
    if (!address_book_verify_hmac_proof(&g_ab_payload.edit_scope.identity.bip32_path,
                                        g_ab_payload.edit_scope.identity.gid,
                                        g_ab_payload.edit_scope.identity.contact_name,
                                        ctx.hmac_proof)) {
        PRINTF("[Edit Scope] HMAC_PROOF verification failed\n");
        return SWO_SECURITY_CONDITION_NOT_SATISFIED;
    }
 
    // Verify that the wallet holds a valid HMAC_REST for the previous scope
    if (!address_book_verify_hmac_rest(&g_ab_payload.edit_scope.identity.bip32_path,
                                       g_ab_payload.edit_scope.identity.gid,
                                       g_ab_payload.edit_scope.old_scope,
                                       g_ab_payload.edit_scope.identity.identifier,
                                       g_ab_payload.edit_scope.identity.identifier_len,
                                       g_ab_payload.edit_scope.identity.blockchain_family,
                                       g_ab_payload.edit_scope.identity.chain_id,
                                       ctx.hmac_rest)) {
        PRINTF("[Edit Scope] HMAC_REST verification failed\n");
        return SWO_SECURITY_CONDITION_NOT_SATISFIED;
    }
 
    // Display confirmation UI
    ui_display();
    return SWO_NO_RESPONSE;
}
 
#endif  // HAVE_ADDRESS_BOOK