identity.h

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.
 *****************************************************************************/
 
#pragma once
 
#if defined(HAVE_ADDRESS_BOOK)
 
/* Includes ------------------------------------------------------------------*/
#include "os_types.h"
#include "address_book.h"
#include "bip32.h"
 
/* Exported defines   --------------------------------------------------------*/
#define TYPE_REGISTER_IDENTITY 0x2d
#define TYPE_EDIT_CONTACT_NAME 0x2e
#define TYPE_EDIT_IDENTIFIER   0x31
#define TYPE_EDIT_SCOPE        0x32
#define TYPE_PROVIDE_CONTACT   0x33
 
/* Exported defines (unconditional — plain numeric constants) ----------------*/
#define GID_SIZE          32  
#define GROUP_HANDLE_SIZE 64  
 
#define CONTACT_NAME_LENGTH   33  
#define SCOPE_LENGTH          33  
#define IDENTIFIER_MAX_LENGTH 80  
 
/* Exported types, structures, unions ----------------------------------------*/
 
typedef struct {
    uint8_t             gid[GID_SIZE];  
    char                contact_name[CONTACT_NAME_LENGTH];
    char                scope[SCOPE_LENGTH];
    uint8_t             identifier[IDENTIFIER_MAX_LENGTH];
    uint8_t             identifier_len;
    path_bip32_t        bip32_path;  
    blockchain_family_e blockchain_family;
    uint64_t            chain_id;  
} identity_t;
 
typedef struct {
    identity_t identity;                               
    uint8_t    old_identifier[IDENTIFIER_MAX_LENGTH];  
    uint8_t    old_identifier_len;                     
} edit_identifier_t;
 
typedef struct {
    uint8_t      gid[GID_SIZE];                          
    char         contact_name[CONTACT_NAME_LENGTH];      
    char         old_contact_name[CONTACT_NAME_LENGTH];  
    path_bip32_t bip32_path;                             
} edit_contact_name_t;
 
typedef struct {
    identity_t identity;                 
    char       old_scope[SCOPE_LENGTH];  
} edit_scope_t;
 
/* Exported functions prototypes --------------------------------------------- */
bolos_err_t register_identity(uint8_t *buffer_in, size_t buffer_in_length);
bolos_err_t edit_contact_name(uint8_t *buffer_in, size_t buffer_in_length);
bolos_err_t edit_identifier(uint8_t *buffer_in, size_t buffer_in_length);
bolos_err_t edit_scope(uint8_t *buffer_in, size_t buffer_in_length);
bolos_err_t provide_contact(uint8_t *buffer_in, size_t buffer_in_length);
 
#endif  // HAVE_ADDRESS_BOOK