Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
aead_get.h File Reference

The AEAD ITS transform module API. More...

#include <zephyr/secure_storage/its/common.h>
#include <psa/crypto_types.h>

Go to the source code of this file.

Functions

void secure_storage_its_transform_aead_get_scheme (psa_key_type_t *key_type, psa_algorithm_t *alg)
 Returns the key type and algorithm to use for the AEAD operations.
 
psa_status_t secure_storage_its_transform_aead_get_key (secure_storage_its_uid_t uid, uint8_t key[static CONFIG_SECURE_STORAGE_ITS_TRANSFORM_AEAD_KEY_SIZE])
 Returns the encryption key to use for an ITS entry's AEAD operations.
 
psa_status_t secure_storage_its_transform_aead_get_nonce (uint8_t nonce[static CONFIG_SECURE_STORAGE_ITS_TRANSFORM_AEAD_NONCE_SIZE])
 Generates a nonce for an AEAD operation.
 

Detailed Description

The AEAD ITS transform module API.

The functions declared in this header allow customization of the AEAD implementation of the ITS transform module. They are not meant to be called directly other than by the AEAD ITS transform module. This header may be included when providing a custom implementation of one or more of these functions (

CONFIG_SECURE_STORAGE_ITS_TRANSFORM_AEAD_*_CUSTOM 

).

Function Documentation

◆ secure_storage_its_transform_aead_get_key()

psa_status_t secure_storage_its_transform_aead_get_key ( secure_storage_its_uid_t uid,
uint8_t key[static CONFIG_SECURE_STORAGE_ITS_TRANSFORM_AEAD_KEY_SIZE] )

Returns the encryption key to use for an ITS entry's AEAD operations.

Parameters
[in]uidThe UID of the ITS entry for whom the returned key is used.
[out]keyThe encryption key.
Returns
PSA_SUCCESS on success, anything else on failure.

◆ secure_storage_its_transform_aead_get_nonce()

psa_status_t secure_storage_its_transform_aead_get_nonce ( uint8_t nonce[static CONFIG_SECURE_STORAGE_ITS_TRANSFORM_AEAD_NONCE_SIZE])

Generates a nonce for an AEAD operation.

Parameters
[out]nonceThe generated nonce.
Returns
PSA_SUCCESS on success, anything else on failure.

◆ secure_storage_its_transform_aead_get_scheme()

void secure_storage_its_transform_aead_get_scheme ( psa_key_type_t * key_type,
psa_algorithm_t * alg )

Returns the key type and algorithm to use for the AEAD operations.

Parameters
[out]key_typeThe key type to use.
[out]algThe algorithm to use.