Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
ledger_account_register.c File Reference

Register Ledger Account flow (P1=0x11, struct type 0x2f). More...

#include <string.h>
#include "os_utils.h"
#include "os_apdu.h"
#include "os_pic.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 "ledger_account.h"
#include "io.h"
#include "nbgl_use_case.h"
Include dependency graph for ledger_account_register.c:

Go to the source code of this file.

Classes

struct  s_ledger_account_ctx

Macros

#define STRUCT_VERSION   0x01
#define LEDGER_ACCOUNT_TAGS(X)

Functions

static bool handle_struct_type (const tlv_data_t *data, void *context_ptr)
 Handler for tag STRUCTURE_TYPE.
static bool handle_struct_version (const tlv_data_t *data, void *context_ptr)
 Handler for tag STRUCTURE_VERSION.
static bool handle_contact_name (const tlv_data_t *data, void *context_ptr)
 Handler for tag CONTACT_NAME.
static bool handle_derivation_path (const tlv_data_t *data, void *context_ptr)
 Handler for tag DERIVATION_PATH.
static bool handle_chain_id (const tlv_data_t *data, void *context_ptr)
 Handler for tag CHAIN_ID.
static bool handle_blockchain_family (const tlv_data_t *data, void *context_ptr)
 Handler for tag BLOCKCHAIN_FAMILY.
static bool verify_fields (const s_ledger_account_ctx *context)
 Check that all mandatory TLV tags were received.
static void print_payload (const s_ledger_account_ctx *context)
 Print the received descriptor.
static bool build_and_send_response (void)
 Build and send response.
static void review_choice (bool confirm)
 NBGL callback invoked after the user confirms or rejects the registration.
bolos_err_t register_ledger_account (uint8_t *buffer_in, size_t buffer_in_length)
 Register a new Ledger Account.

Detailed Description

Register Ledger Account flow (P1=0x11, struct type 0x2f).

Flow:

  1. Parse TLV payload (account name + derivation path + chain ID + blockchain family)
  2. Coin-app validation: handle_check_register_ledger_account()
  3. Display UI: account name + derivation path
  4. On confirm: compute HMAC Proof of Registration and send to host

Active under HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT.

Definition in file ledger_account_register.c.

Macro Definition Documentation

◆ LEDGER_ACCOUNT_TAGS

#define LEDGER_ACCOUNT_TAGS ( X)
Value:
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(0x69, TAG_DERIVATION_PATH, handle_derivation_path, ENFORCE_UNIQUE_TAG) \
X(0x23, TAG_CHAIN_ID, handle_chain_id, ENFORCE_UNIQUE_TAG) \
X(0x51, TAG_BLOCKCHAIN_FAMILY, handle_blockchain_family, ENFORCE_UNIQUE_TAG)
static bool handle_contact_name(const tlv_data_t *data, void *context_ptr)
Handler for tag CONTACT_NAME.
static bool handle_struct_type(const tlv_data_t *data, void *context_ptr)
Handler for tag STRUCTURE_TYPE.
static bool handle_struct_version(const tlv_data_t *data, void *context_ptr)
Handler for tag STRUCTURE_VERSION.
static bool handle_blockchain_family(const tlv_data_t *data, void *context_ptr)
Handler for tag BLOCKCHAIN_FAMILY.
static bool handle_chain_id(const tlv_data_t *data, void *context_ptr)
Handler for tag CHAIN_ID.
static bool handle_derivation_path(const tlv_data_t *data, void *context_ptr)
Handler for tag DERIVATION_PATH.
@ ENFORCE_UNIQUE_TAG

Definition at line 63 of file ledger_account_register.c.

◆ STRUCT_VERSION

#define STRUCT_VERSION   0x01

Definition at line 51 of file ledger_account_register.c.

Function Documentation

◆ build_and_send_response()

bool build_and_send_response ( void )
static

Build and send response.

Compute HMAC Proof of Registration and send it to the host Response format: type(1) | hmac_proof(32).

Returns
true if successful, false otherwise

Definition at line 245 of file ledger_account_register.c.

◆ handle_blockchain_family()

bool handle_blockchain_family ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag BLOCKCHAIN_FAMILY.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 168 of file ledger_account_register.c.

◆ handle_chain_id()

bool handle_chain_id ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag CHAIN_ID.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 154 of file ledger_account_register.c.

◆ handle_contact_name()

bool handle_contact_name ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag CONTACT_NAME.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 120 of file ledger_account_register.c.

◆ handle_derivation_path()

bool handle_derivation_path ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag DERIVATION_PATH.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 140 of file ledger_account_register.c.

◆ handle_struct_type()

bool handle_struct_type ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag STRUCTURE_TYPE.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 82 of file ledger_account_register.c.

◆ handle_struct_version()

bool handle_struct_version ( const tlv_data_t * data,
void * context_ptr )
static

Handler for tag STRUCTURE_VERSION.

Parameters
[in]datathe tlv data
[in]context_ptrthe received payload
Returns
whether the handling was successful

Definition at line 101 of file ledger_account_register.c.

◆ print_payload()

void print_payload ( const s_ledger_account_ctx * context)
static

Print the received descriptor.

Parameters
[in]contextthe received payload Only for debug purpose.

Definition at line 211 of file ledger_account_register.c.

◆ register_ledger_account()

bolos_err_t register_ledger_account ( uint8_t * buffer_in,
size_t buffer_in_length )

Register a new Ledger Account.

Parameters
[in]buffer_inthe input buffer containing the account data
[in]buffer_in_lengththe length of the input buffer
Returns
bolos_err_t the result of the registration

Definition at line 293 of file ledger_account_register.c.

◆ review_choice()

void review_choice ( bool confirm)
static

NBGL callback invoked after the user confirms or rejects the registration.

Parameters
[in]confirmtrue if user confirmed, false if rejected

Definition at line 269 of file ledger_account_register.c.

◆ verify_fields()

bool verify_fields ( const s_ledger_account_ctx * context)
static

Check that all mandatory TLV tags were received.

Parameters
[in]contextthe received payload
Returns
whether all mandatory fields are present

Definition at line 183 of file ledger_account_register.c.