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

Register Identity flow (P1=0x01, struct type 0x2d). More...

#include <string.h>
#include "os_utils.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"
Include dependency graph for identity_register.c:

Go to the source code of this file.

Classes

struct  s_identity_ctx

Macros

#define STRUCT_VERSION   0x01
#define REGISTER_IDENTITY_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_scope (const tlv_data_t *data, void *context_ptr)
 Handler for tag SCOPE.
static bool handle_identifier (const tlv_data_t *data, void *context_ptr)
 Handler for tag ACCOUNT_IDENTIFIER.
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 handle_group_handle (const tlv_data_t *data, void *context_ptr)
 Handler for tag GROUP_HANDLE (optional — links to an existing group).
static bool handle_hmac_proof (const tlv_data_t *data, void *context_ptr)
 Handler for tag HMAC_PROOF (optional — proves ownership of an existing group).
static bool verify_fields (const s_identity_ctx *context)
 Check that all mandatory TLV tags were received.
static void print_payload (const s_identity_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.
static void ui_display (const s_identity_ctx *context)
 Display the Register Identity review screen.
bolos_err_t register_identity (uint8_t *buffer_in, size_t buffer_in_length)
 Register a new identity.

Detailed Description

Register Identity flow (P1=0x01, struct type 0x2d).

Flow:

  1. Parse TLV payload (name + scope + identifier [+ derivation_path])
  2. Coin-app validation: handle_check_register_identity()
  3. Display UI: contact name + identifier
  4. On confirm: compute HMAC Proof of Registration and send to host

Active under HAVE_ADDRESS_BOOK.

Definition in file identity_register.c.

Macro Definition Documentation

◆ REGISTER_IDENTITY_TAGS

#define REGISTER_IDENTITY_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(0xf1, TAG_SCOPE, handle_scope, ENFORCE_UNIQUE_TAG) \
X(0xf2, TAG_ACCOUNT_IDENTIFIER, handle_identifier, 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) \
X(0xf6, TAG_GROUP_HANDLE, handle_group_handle, ENFORCE_UNIQUE_TAG) \
X(0x29, TAG_HMAC_PROOF, handle_hmac_proof, ENFORCE_UNIQUE_TAG)
static bool handle_contact_name(const tlv_data_t *data, void *context_ptr)
Handler for tag CONTACT_NAME.
static bool handle_hmac_proof(const tlv_data_t *data, void *context_ptr)
Handler for tag HMAC_PROOF.
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_group_handle(const tlv_data_t *data, void *context_ptr)
Handler for tag GROUP_HANDLE.
static bool handle_blockchain_family(const tlv_data_t *data, void *context_ptr)
Handler for tag BLOCKCHAIN_FAMILY.
static bool handle_scope(const tlv_data_t *data, void *context_ptr)
Handler for tag SCOPE.
static bool handle_chain_id(const tlv_data_t *data, void *context_ptr)
Handler for tag CHAIN_ID.
static bool handle_identifier(const tlv_data_t *data, void *context_ptr)
Handler for tag ACCOUNT_IDENTIFIER.
@ ENFORCE_UNIQUE_TAG

Definition at line 61 of file identity_register.c.

◆ STRUCT_VERSION

#define STRUCT_VERSION   0x01

Definition at line 49 of file identity_register.c.

Function Documentation

◆ build_and_send_response()

bool build_and_send_response ( void )
static

Build and send response.

Two paths depending on whether an existing group was provided:

  • New group: generate group_handle, compute hmac_proof + hmac_rest.
  • Existing group: group_handle + hmac_proof already verified pre-UI; echo them back and compute only hmac_rest for the new (scope, identifier) pair.

Response format: TYPE_REGISTER_IDENTITY(1) | group_handle(64) | hmac_proof(32) | hmac_rest(32) = 129 B

Returns
true if successful, false otherwise

Definition at line 322 of file identity_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 195 of file identity_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 181 of file identity_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 121 of file identity_register.c.

◆ handle_group_handle()

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

Handler for tag GROUP_HANDLE (optional — links to an existing group).

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

Definition at line 210 of file identity_register.c.

◆ handle_hmac_proof()

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

Handler for tag HMAC_PROOF (optional — proves ownership of an existing group).

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

Definition at line 232 of file identity_register.c.

◆ handle_identifier()

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

Handler for tag ACCOUNT_IDENTIFIER.

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

Definition at line 160 of file identity_register.c.

◆ handle_scope()

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

Handler for tag SCOPE.

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

Definition at line 141 of file identity_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 83 of file identity_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 102 of file identity_register.c.

◆ print_payload()

void print_payload ( const s_identity_ctx * context)
static

Print the received descriptor.

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

Definition at line 290 of file identity_register.c.

◆ register_identity()

bolos_err_t register_identity ( uint8_t * buffer_in,
size_t buffer_in_length )

Register a new identity.

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

Definition at line 430 of file identity_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 383 of file identity_register.c.

◆ ui_display()

void ui_display ( const s_identity_ctx * context)
static

Display the Register Identity review screen.

Definition at line 403 of file identity_register.c.

◆ verify_fields()

bool verify_fields ( const s_identity_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 254 of file identity_register.c.