address_book.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 "os_helpers.h"
#include "os_print.h"
#include "os_utils.h"
#include "address_book.h"
#include "status_words.h"
#include "identity.h"
#ifdef HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
#include "ledger_account.h"
#endif
 
#if defined(HAVE_ADDRESS_BOOK)
 
/* Private defines------------------------------------------------------------*/
#define P1_REGISTER_IDENTITY 0x01
#define P1_EDIT_CONTACT_NAME 0x02
#define P1_EDIT_IDENTIFIER   0x03
#define P1_EDIT_SCOPE        0x04
#define P1_PROVIDE_CONTACT   0x20
 
#ifdef HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
#define P1_REGISTER_LEDGER_ACCOUNT        0x11
#define P1_EDIT_LEDGER_ACCOUNT            0x12
#define P1_PROVIDE_LEDGER_ACCOUNT_CONTACT 0x21
#endif
 
#define P2_FIRST_CHUNK 0x00
#define P2_NEXT_CHUNK  0x80
 
#ifdef CUSTOM_IO_APDU_BUFFER_SIZE
#define ADDRESS_BOOK_MAX_CHUNKED_PAYLOAD (CUSTOM_IO_APDU_BUFFER_SIZE - 3 - 5)
#else
#define ADDRESS_BOOK_MAX_CHUNKED_PAYLOAD (OS_IO_SEPH_BUFFER_SIZE - 3 - 5)
#endif
 
/* Private types, structures, unions -----------------------------------------*/
typedef enum {
    REASSEMBLY_PENDING,   
    REASSEMBLY_COMPLETE,  
    REASSEMBLY_ERROR,     
} reassembly_status_t;
 
/* Private variables ---------------------------------------------------------*/
static uint8_t  s_chunk_buf[ADDRESS_BOOK_MAX_CHUNKED_PAYLOAD] = {0};
static uint16_t s_chunk_total                                 = 0;
static uint16_t s_chunk_received                              = 0;
 
/* Private functions ---------------------------------------------------------*/
 
static reassembly_status_t reassemble_chunks(uint8_t  *data,
                                             size_t    len,
                                             uint8_t   p2,
                                             uint8_t **out_buf,
                                             size_t   *out_len)
{
    if (p2 == P2_FIRST_CHUNK) {
        if (len < 2) {
            PRINTF("[Address Book] First chunk too short (no length header)\n");
            return REASSEMBLY_ERROR;
        }
        s_chunk_total    = U2BE(data, 0);
        s_chunk_received = 0;
        data += 2;
        len -= 2;
        if (s_chunk_total == 0 || s_chunk_total > sizeof(s_chunk_buf)) {
            PRINTF("[Address Book] Invalid total length: %u\n", s_chunk_total);
            s_chunk_total = 0;
            return REASSEMBLY_ERROR;
        }
    }
    else {
        if (s_chunk_total == 0) {
            PRINTF("[Address Book] Unexpected continuation chunk\n");
            return REASSEMBLY_ERROR;
        }
    }
 
    if ((s_chunk_received > s_chunk_total) || (len > (s_chunk_total - s_chunk_received))) {
        PRINTF(
            "[Address Book] Chunk overflow: %u + %zu > %u\n", s_chunk_received, len, s_chunk_total);
        s_chunk_total = 0;
        return REASSEMBLY_ERROR;
    }
    memmove(s_chunk_buf + s_chunk_received, data, len);
    s_chunk_received += (uint16_t) len;
 
    if (s_chunk_received < s_chunk_total) {
        return REASSEMBLY_PENDING;
    }
 
    *out_buf      = s_chunk_buf;
    *out_len      = s_chunk_received;
    s_chunk_total = 0;
    return REASSEMBLY_COMPLETE;
}
 
/* Exported functions --------------------------------------------------------*/
bolos_err_t addr_book_handle_apdu(uint8_t *buffer, size_t buffer_len, uint8_t p1, uint8_t p2)
{
    bolos_err_t err         = SWO_CONDITIONS_NOT_SATISFIED;
    uint8_t    *payload     = NULL;
    size_t      payload_len = 0;
 
    // All sub-commands share the same chunked transport: reassemble the full
    // payload first, then dispatch on P1. Intermediate chunks return success
    // (an intermediate SW is sent) and wait for the next chunk.
    switch (reassemble_chunks(buffer, buffer_len, p2, &payload, &payload_len)) {
        case REASSEMBLY_ERROR:
            return SWO_INCORRECT_DATA;
        case REASSEMBLY_PENDING:
            return SWO_SUCCESS;
        case REASSEMBLY_COMPLETE:
            break;
    }
 
    switch (p1) {
        case P1_REGISTER_IDENTITY:
            err = register_identity(payload, payload_len);
            break;
 
        case P1_EDIT_CONTACT_NAME:
            err = edit_contact_name(payload, payload_len);
            break;
 
        case P1_EDIT_IDENTIFIER:
            err = edit_identifier(payload, payload_len);
            break;
 
        case P1_EDIT_SCOPE:
            err = edit_scope(payload, payload_len);
            break;
 
        case P1_PROVIDE_CONTACT:
            err = provide_contact(payload, payload_len);
            break;
 
#ifdef HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
        case P1_REGISTER_LEDGER_ACCOUNT:
            err = register_ledger_account(payload, payload_len);
            break;
 
        case P1_EDIT_LEDGER_ACCOUNT:
            err = edit_ledger_account(payload, payload_len);
            break;
 
        case P1_PROVIDE_LEDGER_ACCOUNT_CONTACT:
            err = provide_ledger_account_contact(payload, payload_len);
            break;
#endif  // HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
 
        default:
            break;
    }
 
    return err;
}
#endif  // HAVE_ADDRESS_BOOK