optiga_util.h

Go to the documentation of this file.

#ifndef _OPTIGA_UTIL_H_
#define _OPTIGA_UTIL_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "optiga_cmd.h"

#define OPTIGA_UTIL_WRITE_ONLY      (0x00)
#define OPTIGA_UTIL_ERASE_AND_WRITE (0x40)


#define OPTIGA_UTIL_CONTEXT_NONE        (0x00)

typedef union optiga_util_params
{
    // set data object params
    optiga_set_data_object_params_t optiga_set_data_object_params;
    // get data object params
    optiga_get_data_object_params_t optiga_get_data_object_params;
    // set object protected params
    optiga_set_object_protected_params_t optiga_set_object_protected_params;
}optiga_util_params_t;

struct optiga_util
{
    optiga_util_params_t params;
    optiga_cmd_t * my_cmd;
    void* caller_context;
    callback_handler_t handler;
    uint16_t instance_state;
#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
    uint8_t protection_level;
    uint8_t protocol_version;
#endif //OPTIGA_COMMS_SHIELDED_CONNECTION

};
typedef struct optiga_util optiga_util_t;

#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION

void optiga_util_set_comms_params(optiga_util_t * me,
                                  uint8_t configuration_type,
                                  uint8_t value);
#endif

LIBRARY_EXPORTS optiga_util_t * optiga_util_create(uint8_t optiga_instance_id,
                                   callback_handler_t handler,
                                   void * caller_context);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_destroy(optiga_util_t * me);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_open_application(optiga_util_t * me,
                                                 bool_t perform_restore);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_close_application(optiga_util_t * me,
                                                  bool_t perform_hibernate);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_read_data(optiga_util_t * me,
                                          uint16_t optiga_oid,
                                          uint16_t offset,
                                          uint8_t * buffer,
                                          uint16_t * length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_read_metadata(optiga_util_t * me,
                                              uint16_t optiga_oid,
                                              uint8_t * buffer,
                                              uint16_t * length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_write_data(optiga_util_t * me,
                                           uint16_t optiga_oid,
                                           uint8_t write_type,
                                           uint16_t offset,
                                           const uint8_t * buffer,
                                           uint16_t length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_write_metadata(optiga_util_t * me,
                                               uint16_t optiga_oid,
                                               const uint8_t * buffer,
                                               uint8_t length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_protected_update_start(optiga_util_t * me,
                                                       uint8_t manifest_version,
                                                       const uint8_t * manifest,
                                                       uint16_t manifest_length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_protected_update_continue(optiga_util_t * me,
                                                          const uint8_t * fragment,
                                                          uint16_t fragment_length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_protected_update_final(optiga_util_t * me,
                                                       const uint8_t * fragment,
                                                       uint16_t fragment_length);

LIBRARY_EXPORTS optiga_lib_status_t optiga_util_update_count(optiga_util_t * me,
                                             uint16_t optiga_counter_oid,
                                             uint8_t count);

#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
#define OPTIGA_UTIL_SET_COMMS_PROTECTION_LEVEL(p_instance, protection_level) \
{ \
    optiga_util_set_comms_params(p_instance, \
                                        OPTIGA_COMMS_PROTECTION_LEVEL, \
                                        protection_level); \
}
#else
#define OPTIGA_UTIL_SET_COMMS_PROTECTION_LEVEL(p_instance, protection_level) {}
#endif

#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
#define OPTIGA_UTIL_SET_COMMS_PROTOCOL_VERSION(p_instance, version) \
{ \
    optiga_util_set_comms_params(p_instance, \
                                        OPTIGA_COMMS_PROTOCOL_VERSION, \
                                        version);\
}
#else
#define OPTIGA_UTIL_SET_COMMS_PROTOCOL_VERSION(p_instance, version) {}
#endif

#if defined (OPTIGA_LIB_ENABLE_LOGGING) && defined (OPTIGA_LIB_ENABLE_UTIL_LOGGING)

#define OPTIGA_UTIL_LOG_MESSAGE(msg) \
{\
    optiga_lib_print_message(msg,OPTIGA_UTIL_SERVICE,OPTIGA_UTIL_SERVICE_COLOR);\
}

#define OPTIGA_UTIL_LOG_HEX_DATA(array,array_len) \
{\
    optiga_lib_print_array_hex_format(array,array_len,OPTIGA_UNPROTECTED_DATA_COLOR);\
}

#define OPTIGA_UTIL_LOG_STATUS(return_value) \
{ \
    if (OPTIGA_LIB_SUCCESS != return_value) \
    { \
        optiga_lib_print_status(OPTIGA_UTIL_SERVICE,OPTIGA_ERROR_COLOR,return_value); \
    } \
    else\
    { \
        optiga_lib_print_status(OPTIGA_UTIL_SERVICE,OPTIGA_UTIL_SERVICE_COLOR,return_value); \
    } \
}
#else

#define OPTIGA_UTIL_LOG_MESSAGE(msg) {}
#define OPTIGA_UTIL_LOG_HEX_DATA(array, array_len) {}
#define OPTIGA_UTIL_LOG_STATUS(return_value) {}

#endif

#ifdef __cplusplus
}
#endif

#endif /*_OPTIGA_UTIL_H_ */