FreeRTOS: PKCS11
PKCS11 Cryptoki Library
Return to main page ↑
Configuration

Configuration settings of the PKCS #11 library.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed.

configpagemarker

configPKCS11_DEFAULT_USER_PIN

The default user pin for PKCS #11. This feature is generally not used for microcontroller based applications.

Possible values: Any four digit code Default value (if undefined): "0000"

pkcs11configMAX_LABEL_LENGTH

Max length of a PKCS #11 Label attribute

PKCS #11 uses labels to map human readable strings to a PKCS #11 object. This defines the maximum allowable length for such a string.

Possible values: Any positive integer.
Default value (if undefined): 32

pkcs11configMAX_NUM_OBJECTS

Maximum number of token objects that can be stored by the PKCS #11 module.

The maximum number of token objects that can be stored by the PKCS #11 module.

Possible values: Any positive integer.
Default value (if undefined): 6

pkcs11configPAL_DESTROY_SUPPORTED

Set to 1 if a PAL destroy object is implemented.

Set to 1 if a PAL destroy object is implemented. If not implemented PKCS #11 will not be able to destroy existing objects.

Possible values: Any positive integer.
Default value (if undefined): 0

pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS

The PKCS #11 label for device private key.

The PKCS #11 label for device private key. Private key for connection to AWS IoT endpoint. The corresponding public key should be registered with the AWS IoT endpoint.

Possible values: Any String smaller then pkcs11configMAX_LABEL_LENGTH.
Default value (if undefined): Device Priv TLS Key

pkcs11configLABEL_DEVICE_PUBLIC_KEY_FOR_TLS

The PKCS #11 label for device private key.

The public key corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS.

Possible values: Any String smaller then pkcs11configMAX_LABEL_LENGTH.
Default value (if undefined): Device Pub TLS Key

pkcs11configLABEL_DEVICE_CERTIFICATE_FOR_TLS

The PKCS #11 label for the device certificate. Device certificate corresponding to pkcs11configLABEL_DEVICE_PRIVATE_KEY_FOR_TLS.

Possible values: Any String smaller then pkcs11configMAX_LABEL_LENGTH.
Default value (if undefined): Device Cert

pkcs11configLABEL_ROOT_CERTIFICATE

The PKCS #11 label for the AWS Trusted Root Certificate.

The PKCS #11 label for the AWS Trusted Root Certificate.

Possible values: Any String smaller then pkcs11configMAX_LABEL_LENGTH.
Default value (if undefined): Root Cert