 |
OPTIGA™ Trust M
Host Library Documentation
|
|
OPTIGA™ Trust M
Host Library Documentation
|
This file is defines the compilation switches to build code with required features. More...
Go to the source code of this file.
Macros | |
| #define | OPTIGA_CRYPT_RANDOM_ENABLED |
| OPTIGA CRYPT random number generation feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_HASH_ENABLED |
| OPTIGA CRYPT hash feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED |
| OPTIGA CRYPT ECC generate keypair feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECDSA_SIGN_ENABLED |
| OPTIGA CRYPT ECDSA signature feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED |
| OPTIGA CRYPT verify ECDSA signature feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECDH_ENABLED |
| OPTIGA CRYPT ECDH feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED |
| OPTIGA CRYPT ECC 521 feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED |
| OPTIGA CRYPT ECC Brainpool feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED |
| OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED |
| OPTIGA CRYPT TLS PRF sha384 feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED |
| OPTIGA CRYPT TLS PRF sha512 feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED |
| OPTIGA CRYPT RSA generate keypair feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_SIGN_ENABLED |
| OPTIGA CRYPT RSA sign feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_VERIFY_ENABLED |
| OPTIGA CRYPT RSA verify sign feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED |
| OPTIGA CRYPT RSA Encrypt feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_DECRYPT_ENABLED |
| OPTIGA CRYPT RSA Decrypt feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED |
| OPTIGA CRYPT RSA pre-master feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED |
| OPTIGA CRYPT RSA SSA with SHA512 as digest feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED |
| OPTIGA CRYPT symmetric encrypt feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_SYM_DECRYPT_ENABLED |
| OPTIGA CRYPT symmetric decrypt feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_HMAC_ENABLED |
| OPTIGA CRYPT HMAC feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_HKDF_ENABLED |
| OPTIGA CRYPT HKDF feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED |
| OPTIGA CRYPT symmetric generate key feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED |
| OPTIGA CRYPT generate auth code feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_HMAC_VERIFY_ENABLED |
| OPTIGA CRYPT HMAC verify feature enable/disable macro. More... | |
| #define | OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED |
| OPTIGA CRYPT clear AUTO state feature enable/disable macro. More... | |
| #define | OPTIGA_COMMS_SHIELDED_CONNECTION |
| OPTIGA COMMS shielded connection feature. To disable the feature, undefine the macro. More... | |
| #define | OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL OPTIGA_COMMS_NO_PROTECTION |
| Default reset protection level for OPTIGA CRYPT and UTIL APIs. More... | |
| #define | OPTIGA_COMMS_DEFAULT_RESET_TYPE (0U) |
| Default reset type in optiga_comms_open. Cold Reset - (0) : This is applicable if the host platform has GPIO option for RST and VDD. Soft Reset - (1) : This is applicable if the host platform doesn't have GPIO options for VDD and RST. Warm Reset - (2) : This is applicable if the host platform doesn't have GPIO option for VDD. Any other value will lead to error. More... | |
| #define | OPTIGA_LIB_DEBUG_NULL_CHECK |
| NULL parameter check. To disable the check, undefine the macro. More... | |
| #define | OPTIGA_CMD_MAX_REGISTRATIONS (0x06) |
| Maximum number of instance registration. More... | |
| #define | OPTIGA_MAX_COMMS_BUFFER_SIZE (0x615) |
| Maximum buffer size required to communicate with OPTIGA. More... | |
| #define | OPTIGA_LIB_ENABLE_LOGGING |
| Macro to enable logger Enable macro OPTIGA_LIB_ENABLE_UTIL_LOGGING for Util Service layer logging Enable macro OPTIGA_LIB_ENABLE_CRYPT_LOGGING for Crypt Service layer logging Enable macro OPTIGA_LIB_ENABLE_CMD_LOGGING for Command layer logging Enable macro OPTIGA_LIB_ENABLE_COMMS_LOGGING for Communication layer logging More... | |
| #define | OPTIGA_PAL_INIT_ENABLED |
| Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality. More... | |
| #define | EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED |
| OPTIGA UTIL confidentiality protected update feature enable/disable macro. More... | |
| #define | EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED |
| OPTIGA UTIL key object protected update feature enable/disable macro. More... | |
| #define | EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED |
| OPTIGA UTIL metadata object protected update feature enable/disable macro. More... | |
This file is defines the compilation switches to build code with required features.
Definition in file optiga_lib_config_m_v3.h.
| #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED |
OPTIGA UTIL confidentiality protected update feature enable/disable macro.
Definition at line 147 of file optiga_lib_config_m_v3.h.
| #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED |
OPTIGA UTIL key object protected update feature enable/disable macro.
Definition at line 149 of file optiga_lib_config_m_v3.h.
| #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED |
OPTIGA UTIL metadata object protected update feature enable/disable macro.
Definition at line 151 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CMD_MAX_REGISTRATIONS (0x06) |
Maximum number of instance registration.
Definition at line 120 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL OPTIGA_COMMS_NO_PROTECTION |
Default reset protection level for OPTIGA CRYPT and UTIL APIs.
Definition at line 105 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_COMMS_DEFAULT_RESET_TYPE (0U) |
Default reset type in optiga_comms_open.
Cold Reset - (0) : This is applicable if the host platform has GPIO option for RST and VDD.
Soft Reset - (1) : This is applicable if the host platform doesn't have GPIO options for VDD and RST.
Warm Reset - (2) : This is applicable if the host platform doesn't have GPIO option for VDD.
Any other value will lead to error.
Definition at line 113 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_COMMS_SHIELDED_CONNECTION |
OPTIGA COMMS shielded connection feature. To disable the feature, undefine the macro.
Definition at line 102 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED |
OPTIGA CRYPT clear AUTO state feature enable/disable macro.
Definition at line 97 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED |
OPTIGA CRYPT ECC Brainpool feature enable/disable macro.
Definition at line 61 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED |
OPTIGA CRYPT ECC generate keypair feature enable/disable macro.
Definition at line 51 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED |
OPTIGA CRYPT ECC 521 feature enable/disable macro.
Definition at line 59 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECDH_ENABLED |
OPTIGA CRYPT ECDH feature enable/disable macro.
Definition at line 57 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECDSA_SIGN_ENABLED |
OPTIGA CRYPT ECDSA signature feature enable/disable macro.
Definition at line 53 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED |
OPTIGA CRYPT verify ECDSA signature feature enable/disable macro.
Definition at line 55 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED |
OPTIGA CRYPT generate auth code feature enable/disable macro.
Definition at line 93 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_HASH_ENABLED |
OPTIGA CRYPT hash feature enable/disable macro.
Definition at line 49 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_HKDF_ENABLED |
OPTIGA CRYPT HKDF feature enable/disable macro.
Definition at line 89 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_HMAC_ENABLED |
OPTIGA CRYPT HMAC feature enable/disable macro.
Definition at line 87 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_HMAC_VERIFY_ENABLED |
OPTIGA CRYPT HMAC verify feature enable/disable macro.
Definition at line 95 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RANDOM_ENABLED |
OPTIGA CRYPT random number generation feature enable/disable macro.
Definition at line 47 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_DECRYPT_ENABLED |
OPTIGA CRYPT RSA Decrypt feature enable/disable macro.
Definition at line 77 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED |
OPTIGA CRYPT RSA Encrypt feature enable/disable macro.
Definition at line 75 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED |
OPTIGA CRYPT RSA generate keypair feature enable/disable macro.
Definition at line 69 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED |
OPTIGA CRYPT RSA pre-master feature enable/disable macro.
Definition at line 79 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_SIGN_ENABLED |
OPTIGA CRYPT RSA sign feature enable/disable macro.
Definition at line 71 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED |
OPTIGA CRYPT RSA SSA with SHA512 as digest feature enable/disable macro.
Definition at line 81 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_RSA_VERIFY_ENABLED |
OPTIGA CRYPT RSA verify sign feature enable/disable macro.
Definition at line 73 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_SYM_DECRYPT_ENABLED |
OPTIGA CRYPT symmetric decrypt feature enable/disable macro.
Definition at line 85 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED |
OPTIGA CRYPT symmetric encrypt feature enable/disable macro.
Definition at line 83 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED |
OPTIGA CRYPT symmetric generate key feature enable/disable macro.
Definition at line 91 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED |
OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro.
Definition at line 63 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED |
OPTIGA CRYPT TLS PRF sha384 feature enable/disable macro.
Definition at line 65 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED |
OPTIGA CRYPT TLS PRF sha512 feature enable/disable macro.
Definition at line 67 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_LIB_DEBUG_NULL_CHECK |
NULL parameter check. To disable the check, undefine the macro.
Definition at line 118 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_LIB_ENABLE_LOGGING |
Macro to enable logger
Enable macro OPTIGA_LIB_ENABLE_UTIL_LOGGING for Util Service layer logging
Enable macro OPTIGA_LIB_ENABLE_CRYPT_LOGGING for Crypt Service layer logging
Enable macro OPTIGA_LIB_ENABLE_CMD_LOGGING for Command layer logging
Enable macro OPTIGA_LIB_ENABLE_COMMS_LOGGING for Communication layer logging
Definition at line 129 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_MAX_COMMS_BUFFER_SIZE (0x615) |
Maximum buffer size required to communicate with OPTIGA.
Definition at line 122 of file optiga_lib_config_m_v3.h.
| #define OPTIGA_PAL_INIT_ENABLED |
Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality.
Definition at line 131 of file optiga_lib_config_m_v3.h.