address_book_common.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.
 *****************************************************************************/
 
#include <string.h>
#include "address_book_common.h"
#include "os_utils.h"
#include "os_print.h"
#include "buffer.h"
#include "tlv_library.h"
#include "bip32.h"
#include "address_book.h"
#include "io.h"
#include "status_words.h"
#include "nbgl_use_case.h"
 
#ifdef HAVE_ADDRESS_BOOK
 
ab_payload_u g_ab_payload = {0};
ab_ui_t      g_ab_ui      = {0};
 
bool address_book_handle_derivation_path(const tlv_data_t *data, path_bip32_t *bip32_path)
{
    buffer_t path_buffer = {0};
 
    if (!get_buffer_from_tlv_data(data, &path_buffer, 1, MAX_BIP32_PATH * 4 + 1)) {
        PRINTF("DERIVATION_PATH: failed to extract\n");
        return false;
    }
 
    // Parse BIP32 path using the standard parser
    if (buffer_get_path_bip32(&path_buffer, bip32_path) == false) {
        PRINTF("DERIVATION_PATH: failed to parse BIP32 path\n");
        return false;
    }
 
    return true;
}
 
bool address_book_handle_chain_id(const tlv_data_t *data, uint64_t *chain_id)
{
    if (!get_uint64_t_from_tlv_data(data, chain_id)) {
        PRINTF("CHAIN_ID: failed to extract\n");
        return false;
    }
    return true;
}
 
bool address_book_handle_blockchain_family(const tlv_data_t *data, blockchain_family_e *family)
{
    uint8_t value = 0;
    if (!get_uint8_t_from_tlv_data(data, &value)) {
        PRINTF("UINT8: failed to extract\n");
        return false;
    }
    if (value >= FAMILY_COUNT) {
        PRINTF("BLOCKCHAIN_FAMILY: Value out of range (%d, max %d)!\n", value, FAMILY_COUNT - 1);
        return false;
    }
    *family = (blockchain_family_e) value;
    return true;
}
 
bool address_book_handle_printable_string(const tlv_data_t *data,
                                          char             *output_buffer,
                                          size_t            buffer_size)
{
    // Extract the string (with null terminator added by get_string_from_tlv_data)
    if (!get_string_from_tlv_data(data, output_buffer, 1, buffer_size)) {
        PRINTF("String extraction failed\n");
        return false;
    }
    if (!is_printable_string(output_buffer, strlen(output_buffer))) {
        PRINTF("String contains non-printable characters\n");
        return false;
    }
    return true;
}
 
void address_book_display_review(const nbgl_icon_details_t *icon,
                                 const char                *reviewTitle,
                                 const char                *confirmText,
                                 nbgl_choiceCallback_t      choiceCallback)
{
    g_ab_ui.list.wrapping = true;
    // NB: no subtitle for address book reviews, as the content is already quite long
    // Indicate the flag ADDRESS_BOOK_OPERATION to force wording in review screens
    nbgl_useCaseReviewLight(TYPE_OPERATION | ADDRESS_BOOK_OPERATION,
                            &g_ab_ui.list,
                            icon,
                            reviewTitle,
                            NULL,
                            confirmText,
                            choiceCallback);
}
 
void address_book_handle_review_rejected(nbgl_callback_t finalize)
{
    io_send_sw(SWO_INCORRECT_DATA);
    nbgl_useCaseStatus("Canceled", false, finalize);
}
 
void address_book_finalize_review(bool            success,
                                  const char     *successMsg,
                                  const char     *errorMsg,
                                  nbgl_callback_t finalize)
{
    if (success) {
        nbgl_useCaseStatus(successMsg, true, finalize);
    }
    else {
        io_send_sw(SWO_INCORRECT_DATA);
        nbgl_useCaseStatus(errorMsg, false, finalize);
    }
}
 
#endif  // HAVE_ADDRESS_BOOK