optiga_cmd.h

Go to the documentation of this file.

#ifndef _OPTIGA_CMD_H_
#define _OPTIGA_CMD_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "optiga_lib_common.h"

typedef struct optiga_cmd optiga_cmd_t;

typedef struct optiga_context optiga_context_t;

optiga_cmd_t * optiga_cmd_create(uint8_t optiga_instance_id,
                                 callback_handler_t handler,
                                 void * caller_context);

optiga_lib_status_t optiga_cmd_destroy(optiga_cmd_t * me);


optiga_lib_status_t optiga_cmd_release_lock(const optiga_cmd_t * me);


optiga_lib_status_t optiga_cmd_open_application(optiga_cmd_t * me,
                                                uint8_t cmd_param,
                                                void * params);

optiga_lib_status_t optiga_cmd_close_application(optiga_cmd_t * me,
                                                 uint8_t cmd_param,
                                                 void * params);

optiga_lib_status_t optiga_cmd_get_data_object(optiga_cmd_t * me,
                                               uint8_t cmd_param,
                                               optiga_get_data_object_params_t * params);

optiga_lib_status_t optiga_cmd_set_data_object(optiga_cmd_t * me,
                                               uint8_t cmd_param,
                                               optiga_set_data_object_params_t * params);

#if defined (OPTIGA_CRYPT_RANDOM_ENABLED) || defined (OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED)

optiga_lib_status_t optiga_cmd_get_random(optiga_cmd_t * me,
                                          uint8_t cmd_param,
                                          optiga_get_random_params_t * params);
#endif //OPTIGA_CRYPT_RANDOM_ENABLED || OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED

#ifdef OPTIGA_CRYPT_HASH_ENABLED

optiga_lib_status_t optiga_cmd_calc_hash(optiga_cmd_t * me,
                                         uint8_t cmd_param,
                                         optiga_calc_hash_params_t * params);
#endif //OPTIGA_CRYPT_HASH_ENABLED

#if defined (OPTIGA_CRYPT_ECDSA_SIGN_ENABLED) || defined (OPTIGA_CRYPT_RSA_SIGN_ENABLED)

optiga_lib_status_t optiga_cmd_calc_sign(optiga_cmd_t * me,
                                         uint8_t cmd_param,
                                         optiga_calc_sign_params_t * params);
#endif //OPTIGA_CRYPT_ECDSA_SIGN_ENABLED || OPTIGA_CRYPT_RSA_SIGN_ENABLED

#if defined (OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED) || defined (OPTIGA_CRYPT_RSA_VERIFY_ENABLED)

optiga_lib_status_t optiga_cmd_verify_sign(optiga_cmd_t * me,
                                           uint8_t cmd_param,
                                           optiga_verify_sign_params_t * params);
#endif //OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED || OPTIGA_CRYPT_RSA_VERIFY_ENABLED

#ifdef OPTIGA_CRYPT_ECDH_ENABLED

optiga_lib_status_t optiga_cmd_calc_ssec(optiga_cmd_t * me,
                                         uint8_t cmd_param,
                                         optiga_calc_ssec_params_t * params);
#endif //OPTIGA_CRYPT_ECDH_ENABLED

#ifdef OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

optiga_lib_status_t optiga_cmd_derive_key(optiga_cmd_t * me,
                                          uint8_t cmd_param,
                                          optiga_derive_key_params_t * params);
#endif //OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

#if defined (OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED) || defined (OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED)

optiga_lib_status_t optiga_cmd_gen_keypair(optiga_cmd_t * me,
                                           uint8_t cmd_param,
                                           optiga_gen_keypair_params_t * params);
#endif //(OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED) || (OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED)

#ifdef OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

optiga_lib_status_t optiga_cmd_encrypt_asym(optiga_cmd_t * me,
                                            uint8_t cmd_param,
                                            optiga_encrypt_asym_params_t * params);
#endif // OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

#ifdef OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

optiga_lib_status_t optiga_cmd_decrypt_asym(optiga_cmd_t * me,
                                            uint8_t cmd_param,
                                            optiga_decrypt_asym_params_t * params);
#endif // OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

optiga_lib_status_t optiga_cmd_set_object_protected(optiga_cmd_t * me,
                                                    uint8_t cmd_param,
                                                    optiga_set_object_protected_params_t * params);

#if defined (OPTIGA_LIB_ENABLE_LOGGING) && defined (OPTIGA_LIB_ENABLE_CMD_LOGGING)

#define OPTIGA_CMD_LOG_MESSAGE(msg) \
{\
    optiga_lib_print_message(msg,OPTIGA_COMMAND_LAYER,OPTIGA_COMMAND_LAYER_COLOR);\
}

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

#define OPTIGA_CMD_LOG_STATUS(return_value) \
{ \
    if (OPTIGA_LIB_SUCCESS != return_value) \
    { \
        optiga_lib_print_status(OPTIGA_COMMAND_LAYER,OPTIGA_ERROR_COLOR,return_value); \
    } \
    else\
    { \
        optiga_lib_print_status(OPTIGA_COMMAND_LAYER,OPTIGA_COMMAND_LAYER_COLOR,return_value); \
    } \
}
#else

#define OPTIGA_CMD_LOG_MESSAGE(msg) {}
#define OPTIGA_CMD_LOG_HEX_DATA(array, array_len) {}
#define OPTIGA_CMD_LOG_STATUS(return_value) {}

#endif

#ifdef __cplusplus
}
#endif

#endif /*_OPTIGA_CMD_H_ */