10.4. Unauthenticated ciphers
Warning
The unauthenticated cipher API is provided to implement legacy protocols and for use cases where the data integrity and authenticity is guaranteed by noncryptographic means.
It is recommended that newer protocols use Authenticated encryption with associated data (AEAD).
10.4.1. Cipher algorithms
PSA_ALG_STREAM_CIPHER
(macro)
The stream cipher mode of a stream cipher algorithm.
#define PSA_ALG_STREAM_CIPHER ((psa_algorithm_t)0x04800100)
The underlying stream cipher is determined by the key type. The ARC4 and ChaCha20 ciphers use this algorithm identifier.
ARC4
To use ARC4, use a key type of PSA_KEY_TYPE_ARC4
and algorithm id PSA_ALG_STREAM_CIPHER
.
Warning
The ARC4 cipher is weak and deprecated and is only recommended for use in legacy protocols.
The ARC4 cipher does not use an initialization vector (IV). When using a multipart cipher operation with the PSA_ALG_STREAM_CIPHER
algorithm and an ARC4 key, psa_cipher_generate_iv()
and psa_cipher_set_iv()
must not be called.
ChaCha20
To use ChaCha20, use a key type of PSA_KEY_TYPE_CHACHA20
and algorithm id PSA_ALG_STREAM_CIPHER
.
Implementations must support the variant that is defined in ChaCha20 and Poly1305 for IETF Protocols [RFC7539] §2.4, which has a 96bit nonce and a 32bit counter. Implementations can optionally also support the original variant, as defined in ChaCha, a variant of Salsa20 [CHACHA20], which has a 64bit nonce and a 64bit counter. Except where noted, the [RFC7539] variant must be used.
ChaCha20 defines a nonce and an initial counter to be provided to the encryption and decryption operations. When using a ChaCha20 key with the PSA_ALG_STREAM_CIPHER
algorithm, these values are provided using the initialization vector (IV) functions in the following ways:
A call to
psa_cipher_encrypt()
will generate a random 12byte nonce, and set the counter value to zero. The random nonce is output as a 12byte IV value in the output.A call to
psa_cipher_decrypt()
will use first 12 bytes of the input buffer as the nonce and set the counter value to zero.A call to
psa_cipher_generate_iv()
on a multipart cipher operation will generate and return a random 12byte nonce and set the counter value to zero.A call to
psa_cipher_set_iv()
on a multipart cipher operation can support the following IV sizes:12 bytes: the provided IV is used as the nonce, and the counter value is set to zero.
16 bytes: the first four bytes of the IV are used as the counter value (encoded as littleendian), and the remaining 12 bytes is used as the nonce.
8 bytes: the cipher operation uses the original [CHACHA20] definition of ChaCha20: the provided IV is used as the 64bit nonce, and the 64bit counter value is set to zero.
It is recommended that implementations do not support other sizes of IV.
PSA_ALG_CTR
(macro)
A stream cipher built using the Counter (CTR) mode of a block cipher.
#define PSA_ALG_CTR ((psa_algorithm_t)0x04c01000)
CTR is a stream cipher which is built from a block cipher. The underlying block cipher is determined by the key type. For example, to use AES128CTR, use this algorithm with a key of type PSA_KEY_TYPE_AES
and a size of 128 bits (16 bytes).
The CTR block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A].
CTR mode requires a counter block which is the same size as the cipher block length. The counter block is updated for each block (or a partial final block) that is encrypted or decrypted.
A counter block value must only be used once across all messages encrypted using the same key value. This is typically achieved by splitting the counter block into a nonce, which is unique among all message encrypted with the key, and a counter which is incremented for each block of a message.
For example, when using AESCTR encryption, which uses a 16byte block, the application can provide a 12byte nonce when setting the IV. This leaves 4 bytes for the counter, allowing up to 2^32 blocks (64GB) of message data to be encrypted in each message.
The first counter block is constructed from the initialization vector (IV). The initial counter block is is constructed in the following ways:
A call to
psa_cipher_encrypt()
will generate a random counter block value. This is the first block of output.A call to
psa_cipher_decrypt()
will use first block of the input buffer as the initial counter block value.A call to
psa_cipher_generate_iv()
on a multipart cipher operation will generate and return a random counter block value.A call to
psa_cipher_set_iv()
on a multipart cipher operation requires an IV must be between1
and n bytes in length, where n is the cipher block length. The counter block is initialized using the IV, and padded with zero bytes up to the block length.
During the counter block update operation, the counter block is treated as a single bigendian encoded integer and the update operation increments this integer by 1
.
This scheme meets the recommendations in Appendix B of [SP80038A].
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
PSA_ALG_CFB
(macro)
A stream cipher built using the Cipher Feedback (CFB) mode of a block cipher.
#define PSA_ALG_CFB ((psa_algorithm_t)0x04c01100)
The underlying block cipher is determined by the key type. This is the variant of CFB where each iteration encrypts or decrypts a segment of the input that is the same length as the cipher block size. For example, using PSA_ALG_CFB
with a key of type PSA_KEY_TYPE_AES
will result in the AESCFB128 cipher.
CFB mode requires an initialization vector (IV) that is the same size as the cipher block length.
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
The CFB block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A], using a segment size s equal to the block size b. The definition in [SP80038A] is extended to allow an incomplete final block of input, in which case the algorithm discards the final bytes of the key stream when encrypting or decrypting the final partial block.
PSA_ALG_OFB
(macro)
A stream cipher built using the Output Feedback (OFB) mode of a block cipher.
#define PSA_ALG_OFB ((psa_algorithm_t)0x04c01200)
The underlying block cipher is determined by the key type.
OFB mode requires an initialization vector (IV) that is the same size as the cipher block length. OFB mode requires that the IV is a nonce, and must be unique for each use of the mode with the same key.
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
The OFB block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A].
PSA_ALG_XTS
(macro)
The XEX with Ciphertext Stealing (XTS) cipher mode of a block cipher.
#define PSA_ALG_XTS ((psa_algorithm_t)0x0440ff00)
XTS is a cipher mode which is built from a block cipher, designed for use in disk encryption. It requires at least one full cipher block length of input, but beyond this minimum the input does not need to be a whole number of blocks.
XTS mode uses two keys for the underlying block cipher. These are provided by using a key that is twice the normal key size for the cipher. For example, to use AES256XTS the application must create a key with type PSA_KEY_TYPE_AES
and bit size 512
.
XTS mode requires an initialization vector (IV) that is the same size as the cipher block length. The IV for XTS is typically defined to be the sector number of the disk block being encrypted or decrypted.
The XTS block cipher mode is defined in 16192018  IEEE Standard for Cryptographic Protection of Data on BlockOriented Storage Devices [IEEEXTS].
PSA_ALG_ECB_NO_PADDING
(macro)
The Electronic Codebook (ECB) mode of a block cipher, with no padding.
#define PSA_ALG_ECB_NO_PADDING ((psa_algorithm_t)0x04404400)
Warning
ECB mode does not protect the confidentiality of the encrypted data except in extremely narrow circumstances. It is recommended that applications only use ECB if they need to construct an operating mode that the implementation does not provide. Implementations are encouraged to provide the modes that applications need in preference to supporting direct access to ECB.
The underlying block cipher is determined by the key type.
This symmetric cipher mode can only be used with messages whose lengths are a multiple of the block size of the chosen block cipher.
ECB mode does not accept an initialization vector (IV). When using a multipart cipher operation with this algorithm, psa_cipher_generate_iv()
and psa_cipher_set_iv()
must not be called.
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
The ECB block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A].
PSA_ALG_CBC_NO_PADDING
(macro)
The Cipher Block Chaining (CBC) mode of a block cipher, with no padding.
#define PSA_ALG_CBC_NO_PADDING ((psa_algorithm_t)0x04404000)
The underlying block cipher is determined by the key type.
This symmetric cipher mode can only be used with messages whose lengths are a multiple of the block size of the chosen block cipher.
CBC mode requires an initialization vector (IV) that is the same size as the cipher block length.
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
The CBC block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A].
PSA_ALG_CBC_PKCS7
(macro)
The Cipher Block Chaining (CBC) mode of a block cipher, with PKCS#7 padding.
#define PSA_ALG_CBC_PKCS7 ((psa_algorithm_t)0x04404100)
The underlying block cipher is determined by the key type.
CBC mode requires an initialization vector (IV) that is the same size as the cipher block length.
Note
The cipher block length can be determined using PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.
The CBC block cipher mode is defined in NIST Special Publication 80038A: Recommendation for Block Cipher Modes of Operation: Methods and Techniques [SP80038A]. The padding operation is defined by PKCS #7: Cryptographic Message Syntax Version 1.5 [RFC2315] §10.3.
10.4.2. Singlepart cipher functions
psa_cipher_encrypt
(function)
Encrypt a message using a symmetric cipher.
psa_status_t psa_cipher_encrypt(psa_key_id_t key, psa_algorithm_t alg, const uint8_t * input, size_t input_length, uint8_t * output, size_t output_size, size_t * output_length);
Parameters

key
Identifier of the key to use for the operation. It must allow the usage
PSA_KEY_USAGE_ENCRYPT
.
alg
The cipher algorithm to compute (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
input
Buffer containing the message to encrypt.

input_length
Size of the
input
buffer in bytes.
output
Buffer where the output is to be written. The output contains the IV followed by the ciphertext proper.

output_size
Size of the
output
buffer in bytes. This must be appropriate for the selected algorithm and key:A sufficient output size is
PSA_CIPHER_ENCRYPT_OUTPUT_SIZE
(
key_type
,
alg
,
input_length
)
wherekey_type
is the type ofkey
.PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE
(
input_length
)
evaluates to the maximum output size of any supported cipher encryption.

output_length
On success, the number of bytes that make up the output.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_INVALID_HANDLE

PSA_ERROR_NOT_PERMITTED
The key does not have the
PSA_KEY_USAGE_ENCRYPT
flag, or it does not permit the requested algorithm.
PSA_ERROR_INVALID_ARGUMENT
key
is not compatible withalg
.
PSA_ERROR_INVALID_ARGUMENT
The
input_length
is not valid for the algorithm and key type. For example, the algorithm is a based on block cipher and requires a whole number of blocks, but the total input size is not a multiple of the block size.
PSA_ERROR_NOT_SUPPORTED
alg
is not supported or is not a cipher algorithm.
PSA_ERROR_BUFFER_TOO_SMALL
output_size
is too small.PSA_CIPHER_ENCRYPT_OUTPUT_SIZE()
orPSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE()
can be used to determine the required buffer size.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
This function encrypts a message with a random initialization vector (IV).
The length of the IV is PSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
where key_type
is the type of key
.
The output of psa_cipher_encrypt()
is the IV followed by the ciphertext.
Use the multipart operation interface with a psa_cipher_operation_t
object to provide other forms of IV or to manage the IV and ciphertext independently.
psa_cipher_decrypt
(function)
Decrypt a message using a symmetric cipher.
psa_status_t psa_cipher_decrypt(psa_key_id_t key, psa_algorithm_t alg, const uint8_t * input, size_t input_length, uint8_t * output, size_t output_size, size_t * output_length);
Parameters

key
Identifier of the key to use for the operation. It must remain valid until the operation terminates. It must allow the usage
PSA_KEY_USAGE_DECRYPT
.
alg
The cipher algorithm to compute (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
input
Buffer containing the message to decrypt. This consists of the IV followed by the ciphertext proper.

input_length
Size of the
input
buffer in bytes.
output
Buffer where the plaintext is to be written.

output_size
Size of the
output
buffer in bytes. This must be appropriate for the selected algorithm and key:A sufficient output size is
PSA_CIPHER_DECRYPT_OUTPUT_SIZE
(
key_type
,
alg
,
input_length
)
wherekey_type
is the type ofkey
.PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE
(
input_length
)
evaluates to the maximum output size of any supported cipher decryption.

output_length
On success, the number of bytes that make up the output.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_INVALID_HANDLE

PSA_ERROR_NOT_PERMITTED
The key does not have the
PSA_KEY_USAGE_DECRYPT
flag, or it does not permit the requested algorithm.
PSA_ERROR_INVALID_ARGUMENT
key
is not compatible withalg
.
PSA_ERROR_INVALID_ARGUMENT
The
input_length
is not valid for the algorithm and key type. For example, the algorithm is a based on block cipher and requires a whole number of blocks, but the total input size is not a multiple of the block size.
PSA_ERROR_NOT_SUPPORTED
alg
is not supported or is not a cipher algorithm.
PSA_ERROR_BUFFER_TOO_SMALL
output_size
is too small.PSA_CIPHER_DECRYPT_OUTPUT_SIZE()
orPSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE()
can be used to determine the required buffer size.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
This function decrypts a message encrypted with a symmetric cipher.
The input to this function must contain the IV followed by the ciphertext, as output by psa_cipher_encrypt()
. The IV must be PSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
bytes in length, where key_type
is the type of key
.
Use the multipart operation interface with a psa_cipher_operation_t
object to decrypt data which is not in the expected input format.
10.4.3. Multipart cipher operations
psa_cipher_operation_t
(type)
The type of the state object for multipart cipher operations.
typedef /* implementationdefined type */ psa_cipher_operation_t;
Before calling any function on a cipher operation object, the application must initialize it by any of the following means:
Set the object to allbitszero, for example:
psa_cipher_operation_t operation; memset(&operation, 0, sizeof(operation));
Initialize the object to logical zero values by declaring the object as static or global without an explicit initializer, for example:
static psa_cipher_operation_t operation;
Initialize the object to the initializer
PSA_CIPHER_OPERATION_INIT
, for example:psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
Assign the result of the function
psa_cipher_operation_init()
to the object, for example:psa_cipher_operation_t operation; operation = psa_cipher_operation_init();
This is an implementationdefined type. Applications that make assumptions about the content of this object will result in in implementationspecific behavior, and are nonportable.
PSA_CIPHER_OPERATION_INIT
(macro)
This macro returns a suitable initializer for a cipher operation object of type psa_cipher_operation_t
.
#define PSA_CIPHER_OPERATION_INIT /* implementationdefined value */
psa_cipher_operation_init
(function)
Return an initial value for a cipher operation object.
psa_cipher_operation_t psa_cipher_operation_init(void);
Returns: psa_cipher_operation_t
psa_cipher_encrypt_setup
(function)
Set the key for a multipart symmetric encryption operation.
psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t * operation, psa_key_id_t key, psa_algorithm_t alg);
Parameters

operation
The operation object to set up. It must have been initialized as per the documentation for
psa_cipher_operation_t
and not yet in use.
key
Identifier of the key to use for the operation. It must remain valid until the operation terminates. It must allow the usage
PSA_KEY_USAGE_ENCRYPT
.
alg
The cipher algorithm to compute (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_INVALID_HANDLE

PSA_ERROR_NOT_PERMITTED
The key does not have the
PSA_KEY_USAGE_ENCRYPT
flag, or it does not permit the requested algorithm.
PSA_ERROR_INVALID_ARGUMENT
key
is not compatible withalg
.
PSA_ERROR_NOT_SUPPORTED
alg
is not supported or is not a cipher algorithm.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The operation state is not valid: it must be inactive.

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
The sequence of operations to encrypt a message with a symmetric cipher is as follows:
Allocate an operation object which will be passed to all the functions listed here.
Initialize the operation object with one of the methods described in the documentation for
psa_cipher_operation_t
, e.g.PSA_CIPHER_OPERATION_INIT
.Call
psa_cipher_encrypt_setup()
to specify the algorithm and key.Call either
psa_cipher_generate_iv()
orpsa_cipher_set_iv()
to generate or set the initialization vector (IV), if the algorithm requires one. It is recommended to usepsa_cipher_generate_iv()
unless the protocol being implemented requires a specific IV value.Call
psa_cipher_update()
zero, one or more times, passing a fragment of the message each time.Call
psa_cipher_finish()
.
If an error occurs at any step after a call to psa_cipher_encrypt_setup()
, the operation will need to be reset by a call to psa_cipher_abort()
. The application can call psa_cipher_abort()
at any time after the operation has been initialized.
After a successful call to psa_cipher_encrypt_setup()
, the application must eventually terminate the operation. The following events terminate an operation:
A successful call to
psa_cipher_finish()
.A call to
psa_cipher_abort()
.
psa_cipher_decrypt_setup
(function)
Set the key for a multipart symmetric decryption operation.
psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t * operation, psa_key_id_t key, psa_algorithm_t alg);
Parameters

operation
The operation object to set up. It must have been initialized as per the documentation for
psa_cipher_operation_t
and not yet in use.
key
Identifier of the key to use for the operation. It must remain valid until the operation terminates. It must allow the usage
PSA_KEY_USAGE_DECRYPT
.
alg
The cipher algorithm to compute (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_INVALID_HANDLE

PSA_ERROR_NOT_PERMITTED
The key does not have the
PSA_KEY_USAGE_DECRYPT
flag, or it does not permit the requested algorithm.
PSA_ERROR_INVALID_ARGUMENT
key
is not compatible withalg
.
PSA_ERROR_NOT_SUPPORTED
alg
is not supported or is not a cipher algorithm.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The operation state is not valid: it must be inactive.

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
The sequence of operations to decrypt a message with a symmetric cipher is as follows:
Allocate an operation object which will be passed to all the functions listed here.
Initialize the operation object with one of the methods described in the documentation for
psa_cipher_operation_t
, e.g.PSA_CIPHER_OPERATION_INIT
.Call
psa_cipher_decrypt_setup()
to specify the algorithm and key.Call
psa_cipher_set_iv()
with the initialization vector (IV) for the decryption, if the algorithm requires one. This must match the IV used for the encryption.Call
psa_cipher_update()
zero, one or more times, passing a fragment of the message each time.Call
psa_cipher_finish()
.
If an error occurs at any step after a call to psa_cipher_decrypt_setup()
, the operation will need to be reset by a call to psa_cipher_abort()
. The application can call psa_cipher_abort()
at any time after the operation has been initialized.
After a successful call to psa_cipher_decrypt_setup()
, the application must eventually terminate the operation. The following events terminate an operation:
A successful call to
psa_cipher_finish()
.A call to
psa_cipher_abort()
.
psa_cipher_generate_iv
(function)
Generate an initialization vector (IV) for a symmetric encryption operation.
psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t * operation, uint8_t * iv, size_t iv_size, size_t * iv_length);
Parameters

operation
Active cipher operation.

iv
Buffer where the generated IV is to be written.

iv_size
Size of the
iv
buffer in bytes. This must be at leastPSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
wherekey_type
andalg
are type of key and the algorithm respectively that were used to set up the cipher operation.
iv_length
On success, the number of bytes of the generated IV.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_BAD_STATE
Either:
The cipher algorithm does not use an IV.
The operation state is not valid: it must be active, with no IV set.

PSA_ERROR_BUFFER_TOO_SMALL
The size of the
iv
buffer is too small.PSA_CIPHER_IV_LENGTH()
orPSA_CIPHER_IV_MAX_SIZE
can be used to determine the required buffer size.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
This function generates a random IV, nonce or initial counter value for the encryption operation as appropriate for the chosen algorithm, key type and key size.
The generated IV is always the default length for the key and algorithm: PSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
, where key_type
is the type of key and alg
is the algorithm that were used to set up the operation. To generate different lengths of IV, use psa_generate_random()
and psa_cipher_set_iv()
.
If the cipher algorithm does not use an IV, calling this function returns a PSA_ERROR_BAD_STATE
error. For these algorithms, PSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
will be zero.
The application must call psa_cipher_encrypt_setup()
before calling this function.
If this function returns an error status, the operation enters an error state and must be aborted by calling psa_cipher_abort()
.
psa_cipher_set_iv
(function)
Set the initialization vector (IV) for a symmetric encryption or decryption operation.
psa_status_t psa_cipher_set_iv(psa_cipher_operation_t * operation, const uint8_t * iv, size_t iv_length);
Parameters

operation
Active cipher operation.

iv
Buffer containing the IV to use.

iv_length
Size of the IV in bytes.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_BAD_STATE
Either:
The cipher algorithm does not use an IV.
The operation state is not valid: it must be an active cipher encrypt operation, with no IV set.

PSA_ERROR_INVALID_ARGUMENT
The size of
iv
is not acceptable for the chosen algorithm, or the chosen algorithm does not use an IV.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
This function sets the IV, nonce or initial counter value for the encryption or decryption operation.
If the cipher algorithm does not use an IV, calling this function returns a PSA_ERROR_BAD_STATE
error. For these algorithms, PSA_CIPHER_IV_LENGTH
(
key_type
,
alg
)
will be zero.
The application must call psa_cipher_encrypt_setup()
or psa_cipher_decrypt_setup()
before calling this function.
If this function returns an error status, the operation enters an error state and must be aborted by calling psa_cipher_abort()
.
Note
When encrypting, psa_cipher_generate_iv()
is recommended instead of using this function, unless implementing a protocol that requires a nonrandom IV.
psa_cipher_update
(function)
Encrypt or decrypt a message fragment in an active cipher operation.
psa_status_t psa_cipher_update(psa_cipher_operation_t * operation, const uint8_t * input, size_t input_length, uint8_t * output, size_t output_size, size_t * output_length);
Parameters

operation
Active cipher operation.

input
Buffer containing the message fragment to encrypt or decrypt.

input_length
Size of the
input
buffer in bytes.
output
Buffer where the output is to be written.

output_size
Size of the
output
buffer in bytes. This must be appropriate for the selected algorithm and key:A sufficient output size is
PSA_CIPHER_UPDATE_OUTPUT_SIZE
(
key_type
,
alg
,
input_length
)
wherekey_type
is the type of key andalg
is the algorithm that were used to set up the operation.PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE
(
input_length
)
evaluates to the maximum output size of any supported cipher algorithm.

output_length
On success, the number of bytes that make up the returned output.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_BAD_STATE
The operation state is not valid: it must be active, with an IV set if required for the algorithm.

PSA_ERROR_BUFFER_TOO_SMALL
The size of the
output
buffer is too small.PSA_CIPHER_UPDATE_OUTPUT_SIZE()
orPSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE()
can be used to determine the required buffer size.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
The following must occur before calling this function:
Call either
psa_cipher_encrypt_setup()
orpsa_cipher_decrypt_setup()
. The choice of setup function determines whether this function encrypts or decrypts its input.If the algorithm requires an IV, call
psa_cipher_generate_iv()
orpsa_cipher_set_iv()
.psa_cipher_generate_iv()
is recommended when encrypting.
If this function returns an error status, the operation enters an error state and must be aborted by calling psa_cipher_abort()
.
psa_cipher_finish
(function)
Finish encrypting or decrypting a message in a cipher operation.
psa_status_t psa_cipher_finish(psa_cipher_operation_t * operation, uint8_t * output, size_t output_size, size_t * output_length);
Parameters

operation
Active cipher operation.

output
Buffer where the output is to be written.

output_size
Size of the
output
buffer in bytes. This must be appropriate for the selected algorithm and key:A sufficient output size is
PSA_CIPHER_FINISH_OUTPUT_SIZE
(
key_type
,
alg
)
wherekey_type
is the type of key andalg
is the algorithm that were used to set up the operation.PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE
evaluates to the maximum output size of any supported cipher algorithm.

output_length
On success, the number of bytes that make up the returned output.
Returns: psa_status_t

PSA_SUCCESS
Success.

PSA_ERROR_INVALID_ARGUMENT
The total input size passed to this operation is not valid for this particular algorithm. For example, the algorithm is a based on block cipher and requires a whole number of blocks, but the total input size is not a multiple of the block size.

PSA_ERROR_INVALID_PADDING
This is a decryption operation for an algorithm that includes padding, and the ciphertext does not contain valid padding.

PSA_ERROR_BAD_STATE
The operation state is not valid: it must be active, with an IV set if required for the algorithm.

PSA_ERROR_BUFFER_TOO_SMALL
The size of the
output
buffer is too small.PSA_CIPHER_FINISH_OUTPUT_SIZE()
orPSA_CIPHER_FINISH_OUTPUT_MAX_SIZE
can be used to determine the required buffer size.
PSA_ERROR_INSUFFICIENT_MEMORY

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_STORAGE_FAILURE

PSA_ERROR_DATA_CORRUPT

PSA_ERROR_DATA_INVALID

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
The application must call psa_cipher_encrypt_setup()
or psa_cipher_decrypt_setup()
before calling this function. The choice of setup function determines whether this function encrypts or decrypts its input.
This function finishes the encryption or decryption of the message formed by concatenating the inputs passed to preceding calls to psa_cipher_update()
.
When this function returns successfully, the operation becomes inactive. If this function returns an error status, the operation enters an error state and must be aborted by calling psa_cipher_abort()
.
psa_cipher_abort
(function)
Abort a cipher operation.
psa_status_t psa_cipher_abort(psa_cipher_operation_t * operation);
Parameters

operation
Initialized cipher operation.
Returns: psa_status_t

PSA_SUCCESS

PSA_ERROR_COMMUNICATION_FAILURE

PSA_ERROR_HARDWARE_FAILURE

PSA_ERROR_CORRUPTION_DETECTED

PSA_ERROR_BAD_STATE
The library has not been previously initialized by
psa_crypto_init()
. It is implementationdependent whether a failure to initialize results in this error code.
Description
Aborting an operation frees all associated resources except for the operation
object itself. Once aborted, the operation object can be reused for another operation by calling psa_cipher_encrypt_setup()
or psa_cipher_decrypt_setup()
again.
This function can be called any time after the operation object has been initialized as described in psa_cipher_operation_t
.
In particular, calling psa_cipher_abort()
after the operation has been terminated by a call to psa_cipher_abort()
or psa_cipher_finish()
is safe and has no effect.
10.4.4. Support macros
PSA_ALG_IS_STREAM_CIPHER
(macro)
Whether the specified algorithm is a stream cipher.
#define PSA_ALG_IS_STREAM_CIPHER(alg) /* specificationdefined value */
Parameters

alg
An algorithm identifier (value of type
psa_algorithm_t
).
Returns
1
if alg
is a stream cipher algorithm, 0
otherwise. This macro can return either 0
or 1
if alg
is not a supported algorithm identifier or if it is not a symmetric cipher algorithm.
Description
A stream cipher is a symmetric cipher that encrypts or decrypts messages by applying a bitwisexor with a stream of bytes that is generated from a key.
PSA_CIPHER_ENCRYPT_OUTPUT_SIZE
(macro)
The maximum size of the output of psa_cipher_encrypt()
, in bytes.
#define PSA_CIPHER_ENCRYPT_OUTPUT_SIZE(key_type, alg, input_length) \ /* implementationdefined value */
Parameters

key_type
A symmetric key type that is compatible with algorithm
alg
.
alg
A cipher algorithm (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
input_length
Size of the input in bytes.
Returns
A sufficient output size for the specified key type and algorithm. If the key type or cipher algorithm is not recognized, or the parameters are incompatible, return 0
. An implementation can return either 0
or a correct size for a key type and cipher algorithm that it recognizes, but does not support.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_encrypt()
will not fail due to an insufficient buffer size. Depending on the algorithm, the actual size of the output might be smaller.
See also PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE
.
PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE
(macro)
A sufficient output buffer size for psa_cipher_encrypt()
, for any of the supported key types and cipher algorithms.
#define PSA_CIPHER_ENCRYPT_OUTPUT_MAX_SIZE(input_length) \ /* implementationdefined value */
Parameters

input_length
Size of the input in bytes.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_encrypt()
will not fail due to an insufficient buffer size.
See also PSA_CIPHER_ENCRYPT_OUTPUT_SIZE()
.
PSA_CIPHER_DECRYPT_OUTPUT_SIZE
(macro)
The maximum size of the output of psa_cipher_decrypt()
, in bytes.
#define PSA_CIPHER_DECRYPT_OUTPUT_SIZE(key_type, alg, input_length) \ /* implementationdefined value */
Parameters

key_type
A symmetric key type that is compatible with algorithm
alg
.
alg
A cipher algorithm (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
input_length
Size of the input in bytes.
Returns
A sufficient output size for the specified key type and algorithm. If the key type or cipher algorithm is not recognized, or the parameters are incompatible, return 0
. An implementation can return either 0
or a correct size for a key type and cipher algorithm that it recognizes, but does not support.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_decrypt()
will not fail due to an insufficient buffer size. Depending on the algorithm, the actual size of the output might be smaller.
See also PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE
.
PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE
(macro)
A sufficient output buffer size for psa_cipher_decrypt()
, for any of the supported key types and cipher algorithms.
#define PSA_CIPHER_DECRYPT_OUTPUT_MAX_SIZE(input_length) \ /* implementationdefined value */
Parameters

input_length
Size of the input in bytes.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_decrypt()
will not fail due to an insufficient buffer size.
See also PSA_CIPHER_DECRYPT_OUTPUT_SIZE()
.
PSA_CIPHER_IV_LENGTH
(macro)
The default IV size for a cipher algorithm, in bytes.
#define PSA_CIPHER_IV_LENGTH(key_type, alg) /* implementationdefined value */
Parameters

key_type
A symmetric key type that is compatible with algorithm
alg
.
alg
A cipher algorithm (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
Returns
The default IV size for the specified key type and algorithm.
If the algorithm does not use an IV, return 0
.
If the key type or cipher algorithm is not recognized, or the parameters are incompatible, return 0
.
An implementation can return either 0
or a correct size for a key type and cipher algorithm that it recognizes, but does not support.
Description
The IV that is generated as part of a call to psa_cipher_encrypt()
is always the default IV length for the algorithm.
This macro can be used to allocate a buffer of sufficient size to store the IV output from psa_cipher_generate_iv()
when using a multipart cipher operation.
See also PSA_CIPHER_IV_MAX_SIZE
.
PSA_CIPHER_IV_MAX_SIZE
(macro)
The maximum IV size for all supported cipher algorithms, in bytes.
#define PSA_CIPHER_IV_MAX_SIZE /* implementationdefined value */
See also PSA_CIPHER_IV_LENGTH()
.
PSA_CIPHER_UPDATE_OUTPUT_SIZE
(macro)
A sufficient output buffer size for psa_cipher_update()
.
#define PSA_CIPHER_UPDATE_OUTPUT_SIZE(key_type, alg, input_length) \ /* implementationdefined value */
Parameters

key_type
A symmetric key type that is compatible with algorithm
alg
.
alg
A cipher algorithm (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
input_length
Size of the input in bytes.
Returns
A sufficient output size for the specified key type and algorithm. If the key type or cipher algorithm is not recognized, or the parameters are incompatible, return 0
. An implementation can return either 0
or a correct size for a key type and cipher algorithm that it recognizes, but does not support.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_update()
will not fail due to an insufficient buffer size. The actual size of the output might be smaller in any given call.
See also PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE
.
PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE
(macro)
A sufficient output buffer size for psa_cipher_update()
, for any of the supported key types and cipher algorithms.
#define PSA_CIPHER_UPDATE_OUTPUT_MAX_SIZE(input_length) \ /* implementationdefined value */
Parameters

input_length
Size of the input in bytes.
Description
If the size of the output buffer is at least this large, it is guaranteed that psa_cipher_update()
will not fail due to an insufficient buffer size.
See also PSA_CIPHER_UPDATE_OUTPUT_SIZE()
.
PSA_CIPHER_FINISH_OUTPUT_SIZE
(macro)
A sufficient ciphertext buffer size for psa_cipher_finish()
.
#define PSA_CIPHER_FINISH_OUTPUT_SIZE(key_type, alg) \ /* implementationdefined value */
Parameters

key_type
A symmetric key type that is compatible with algorithm
alg
.
alg
A cipher algorithm (
PSA_ALG_XXX
value such thatPSA_ALG_IS_CIPHER
(
alg
)
is true).
Returns
A sufficient output size for the specified key type and algorithm. If the key type or cipher algorithm is not recognized, or the parameters are incompatible, return 0
. An implementation can return either 0
or a correct size for a key type and cipher algorithm that it recognizes, but does not support.
Description
If the size of the ciphertext buffer is at least this large, it is guaranteed that psa_cipher_finish()
will not fail due to an insufficient ciphertext buffer size. The actual size of the output might be smaller in any given call.
See also PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE
.
PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE
(macro)
A sufficient ciphertext buffer size for psa_cipher_finish()
, for any of the supported key types and cipher algorithms.
#define PSA_CIPHER_FINISH_OUTPUT_MAX_SIZE /* implementationdefined value */
See also PSA_CIPHER_FINISH_OUTPUT_SIZE()
.
PSA_BLOCK_CIPHER_BLOCK_LENGTH
(macro)
The block size of a block cipher.
#define PSA_BLOCK_CIPHER_BLOCK_LENGTH(type) /* specificationdefined value */
Parameters

type
A cipher key type (value of type
psa_key_type_t
).
Returns
The block size for a block cipher, or 1
for a stream cipher. The return value is undefined if type
is not a supported cipher key type.
Description
Note
It is possible to build stream cipher algorithms on top of a block cipher, for example CTR mode (PSA_ALG_CTR
). This macro only takes the key type into account, so it cannot be used to determine the size of the data that psa_cipher_update()
might buffer for future processing in general.
Note
This macro expression is a compiletime constant if type
is a compiletime constant.
Warning
This macro is permitted to evaluate its argument multiple times.
See also PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE
.
PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE
(macro)
The maximum size of a block cipher supported by the implementation.
#define PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE /* implementationdefined value */
See also PSA_BLOCK_CIPHER_BLOCK_LENGTH()
.