Cipher#

sl_se_cipher_operation_t#

sl_se_cipher_operation_t

Cipher operation types.

sl_se_aes_crypt_ecb#

sl_status_t sl_se_aes_crypt_ecb (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, size_t length, const unsigned char * input, unsigned char * output)

AES-ECB block encryption/decryption.

Returns

• Status code, sl_status.h.

sl_se_aes_crypt_cbc#

sl_status_t sl_se_aes_crypt_cbc (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, size_t length, unsigned char iv, const unsigned char * input, unsigned char * output)

AES-CBC buffer encryption/decryption.

Note

• Length should be a multiple of the block size (16 bytes).

Returns

• Status code, sl_status.h.

sl_se_aes_crypt_cfb128#

sl_status_t sl_se_aes_crypt_cfb128 (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, size_t length, uint32_t * iv_off, unsigned char iv, const unsigned char * input, unsigned char * output)

AES-CFB128 buffer encryption/decryption.

Returns

• Status code, sl_status.h.

sl_se_aes_crypt_cfb8#

sl_status_t sl_se_aes_crypt_cfb8 (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, size_t length, unsigned char iv, const unsigned char * input, unsigned char * output)

AES-CFB8 buffer encryption/decryption.

Returns

• Status code, sl_status.h.

sl_se_aes_crypt_ctr#

sl_status_t sl_se_aes_crypt_ctr (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, uint32_t * nc_off, unsigned char nonce_counter, unsigned char stream_block, const unsigned char * input, unsigned char * output)

AES-CTR buffer encryption/decryption.

Warnings

• Avoid passing in the same buffer for nonce_counter and stream_block as the incrementation operation of nonce_counter can lead to corruption of the ciphertext

Returns

• Status code, sl_status.h.

sl_se_ccm_encrypt_and_tag#

sl_status_t sl_se_ccm_encrypt_and_tag (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char * iv, size_t iv_len, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, unsigned char * tag, size_t tag_len)

AES-CCM buffer encryption.

Returns

• Status code, sl_status.h.

sl_se_ccm_auth_decrypt#

sl_status_t sl_se_ccm_auth_decrypt (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char * iv, size_t iv_len, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, const unsigned char * tag, size_t tag_len)

AES-CCM buffer decryption.

Returns

• Status code, sl_status.h.

sl_se_ccm_multipart_starts#

sl_status_t sl_se_ccm_multipart_starts (sl_se_ccm_multipart_context_t * ccm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, uint32_t total_message_length, const uint8_t * iv, size_t iv_len, const uint8_t * add, size_t add_len, size_t tag_len)

Prepare a CCM streaming command context object.

Prepare a CCM streaming command context object to be used in subsequent CCM streaming function calls.

Returns

• Status code, sl_status.h.

sl_se_ccm_multipart_update#

sl_status_t sl_se_ccm_multipart_update (sl_se_ccm_multipart_context_t * ccm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const uint8_t * input, uint8_t * output, size_t * output_length)

This function feeds an input buffer into an ongoing CCM computation.

It is called between sl_se_ccm_multipart_starts() and sl_se_ccm_multipart_finish(). Can be called repeatedly.

Returns

• Status code, sl_status.h.

sl_se_ccm_multipart_finish#

sl_status_t sl_se_ccm_multipart_finish (sl_se_ccm_multipart_context_t * ccm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, uint8_t * tag, uint8_t tag_size, uint8_t * output, uint8_t output_size, uint8_t * output_length)

Finish a CCM streaming operation and return the resulting CCM tag.

It is called after sl_se_ccm_multipart_update().

Returns

• Returns SL_SE_INVALID_SIGNATURE if authentication step fails. Status code, sl_status.h.

sl_se_gcm_crypt_and_tag#

sl_status_t sl_se_gcm_crypt_and_tag (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, size_t length, const unsigned char * iv, size_t iv_len, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, size_t tag_len, unsigned char * tag)

This function performs GCM encryption or decryption of a buffer.

Note

• For encryption, the output buffer can be the same as the input buffer. For decryption, the output buffer cannot be the same as input buffer. If the buffers overlap, the output buffer must trail at least 8 bytes behind the input buffer.

Warnings

• When this function performs a decryption, it outputs the authentication tag and does not verify that the data is authentic. You should use this function to perform encryption only. For decryption, use sl_se_gcm_auth_decrypt() instead.

Returns

• SL_STATUS_OK when the command was executed successfully, otherwise an appropriate error code (sl_status.h).

sl_se_gcm_auth_decrypt#

sl_status_t sl_se_gcm_auth_decrypt (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char * iv, size_t iv_len, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, size_t tag_len, const unsigned char * tag)

This function performs a GCM authenticated decryption of a buffer.

Note

• The output buffer cannot be the same as input buffer. If the buffers overlap, the output buffer must trail at least 8 bytes behind the input buffer.

Returns

• SL_STATUS_OK when the command was executed successfully, otherwise an appropriate error code (sl_status.h).

sl_se_cmac#

sl_status_t sl_se_cmac (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, const unsigned char * input, size_t input_len, unsigned char * output)

This function calculates the full generic CMAC on the input buffer with the provided key.

Returns

• Status code, sl_status.h.

sl_se_cmac_multipart_starts#

sl_status_t sl_se_cmac_multipart_starts (sl_se_cmac_multipart_context_t * cmac_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key)

Prepare a CMAC streaming command context object.

Prepare a CMAC streaming command context object to be used in subsequent CMAC streaming function calls.

Returns

• Status code, sl_status.h.

sl_se_cmac_multipart_update#

sl_status_t sl_se_cmac_multipart_update (sl_se_cmac_multipart_context_t * cmac_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, const uint8_t * input, size_t input_len)

This function feeds an input buffer into an ongoing CMAC computation.

It is called between sl_se_cmac_multipart_starts() and sl_se_cmac_multipart_finish(). Can be called repeatedly.

Returns

• Status code, sl_status.h.

sl_se_cmac_multipart_finish#

sl_status_t sl_se_cmac_multipart_finish (sl_se_cmac_multipart_context_t * cmac_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, uint8_t * output)

Finish a CMAC streaming operation and return the resulting CMAC tag.

It is called after sl_se_cmac_multipart_update().

Returns

• Status code, sl_status.h.

sl_se_gcm_multipart_starts#

sl_status_t sl_se_gcm_multipart_starts (sl_se_gcm_multipart_context_t * gcm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_cipher_operation_t mode, const uint8_t * iv, size_t iv_len, const uint8_t * add, size_t add_len)

Prepare a GCM streaming command context object.

Prepare a GCM streaming command context object to be used in subsequent GCM streaming function calls.

Returns

• Status code, sl_status.h.

sl_se_gcm_multipart_update#

sl_status_t sl_se_gcm_multipart_update (sl_se_gcm_multipart_context_t * gcm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const uint8_t * input, uint8_t * output, size_t * output_length)

This function feeds an input buffer into an ongoing GCM computation.

It is called between sl_se_gcm_multipart_starts() and sl_se_gcm_multiapart_finish(). Can be called repeatedly.

Returns

• Status code, sl_status.h.

sl_se_gcm_multipart_finish#

sl_status_t sl_se_gcm_multipart_finish (sl_se_gcm_multipart_context_t * gcm_ctx, sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, uint8_t * tag, uint8_t tag_length, uint8_t * output, uint8_t output_size, uint8_t * output_length)

Finish a GCM streaming operation and return the resulting GCM tag.

It is called after sl_se_gcm_multipart_update().

Returns

• Returns SL_SE_INVALID_SIGNATURE if authentication step fails. Status code, sl_status.h.

sl_se_hmac#

sl_status_t sl_se_hmac (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, sl_se_hash_type_t hash_type, const uint8_t * message, size_t message_len, uint8_t * output, size_t output_len)

Compute a HMAC on a full message.

This function computes a Keyed-Hashed Message Authentication Code (HMAC) for the given input message. HMAC can be used with any iterative cryptographic hash function, e.g., SHA-1 in combination with a secret shared key. The cryptographic strength of HMAC depends on the properties of the underlying hash function. For instance, if the algorithm is chosen to be SHA-256, it will generate a 32 bytes HMAC. This function supports SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512. The key can be of any length. If the key is shorter than the block size of the hash function the SE will append zeros to the key so the key size matches the block size of the hash function. If the key is longer than the block size of the hash function the key will be hashed to produce a key digest, then append zeros so the resulting 'hashed' key size matches the block size of the hash function. In any case the minimal recommended key length is the digest size of the hash function.

Returns

• Status code, sl_status.h.

sl_se_chacha20_crypt#

sl_status_t sl_se_chacha20_crypt (sl_se_command_context_t * cmd_ctx, sl_se_cipher_operation_t mode, const sl_se_key_descriptor_t * key, size_t length, const unsigned char initial_counter, const unsigned char nonce, const unsigned char * input, unsigned char * output)

ChaCha20 buffer encryption/decryption, as defined by RFC8439 section 2.4.

Returns

• Status code, sl_status.h.

sl_se_chacha20_poly1305_encrypt_and_tag#

sl_status_t sl_se_chacha20_poly1305_encrypt_and_tag (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char nonce, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, unsigned char * tag)

ChaCha20-Poly1305 authenticated encryption with additional data, as defined by RFC8439 section 2.8.

Returns

• Status code, sl_status.h.

sl_se_chacha20_poly1305_auth_decrypt#

sl_status_t sl_se_chacha20_poly1305_auth_decrypt (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char nonce, const unsigned char * add, size_t add_len, const unsigned char * input, unsigned char * output, const unsigned char tag)

ChaCha20-Poly1305 authenticated decryption with additional data, as defined by RFC8439 section 2.8.

Returns

• Status code, sl_status.h.

sl_se_poly1305_genkey_tag#

sl_status_t sl_se_poly1305_genkey_tag (sl_se_command_context_t * cmd_ctx, const sl_se_key_descriptor_t * key, size_t length, const unsigned char nonce, const unsigned char * input, unsigned char * tag)

Generate a Poly1305 MAC (message authentication code) for a given message using an ephemeral key derived using ChaCha20.

Note

• This function first derives a Poly1305 key based on a ChaCha20 key and nonce, which are input to this function. The key derivation adheres to RFC8439 section 2.6. The derived key is then used to calculate a MAC of the input data, according to RFC8439 section 2.5.

Returns

• Status code, sl_status.h.

SL_SE_CMAC_STREAMING_INIT_DEFAULT#

#define SL_SE_CMAC_STREAMING_INIT_DEFAULT

{ NULL, { 0 }, { 0 }, 0 }

Initial values for CMAC streaming context struct sl_se_cmac_streaming_context_t.

SL_SE_GCM_STREAMING_INIT_DEFAULT#

#define SL_SE_GCM_STREAMING_INIT_DEFAULT

Initial values for AES-GCM streaming context struct sl_se_gcm_streaming_context_t.

SL_SE_AES_BLOCK_SIZE#

#define SL_SE_AES_BLOCK_SIZE

(16u)

Block size for the AES.