Merge pull request #240 from ARMmbed/psa-header_split
Split type definitions out of crypto.h and split crypto_driver.h
This commit is contained in:
Jaeden Amero
GitHub
commit
9e0feff117
11 changed files with 2587 additions and 2320 deletions
1485
include/psa/crypto.h
1485
include/psa/crypto.h
File diff suppressed because it is too large
Load diff
796
include/psa/crypto_accel_driver.h
Normal file
796
include/psa/crypto_accel_driver.h
Normal file
|
|
@ -0,0 +1,796 @@
|
||||||
|
/**
|
||||||
|
* \file psa/crypto_accel_driver.h
|
||||||
|
* \brief PSA cryptography accelerator driver module
|
||||||
|
*
|
||||||
|
* This header declares types and function signatures for cryptography
|
||||||
|
* drivers that access key material directly. This is meant for
|
||||||
|
* on-chip cryptography accelerators.
|
||||||
|
*
|
||||||
|
* This file is part of the PSA Crypto Driver Model, containing functions for
|
||||||
|
* driver developers to implement to enable hardware to be called in a
|
||||||
|
* standardized way by a PSA Cryptographic API implementation. The functions
|
||||||
|
* comprising the driver model, which driver authors implement, are not
|
||||||
|
* intended to be called by application developers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2018, ARM Limited, All Rights Reserved
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
#ifndef PSA_CRYPTO_ACCEL_DRIVER_H
|
||||||
|
#define PSA_CRYPTO_ACCEL_DRIVER_H
|
||||||
|
|
||||||
|
#include "crypto_driver_common.h"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/** \defgroup driver_digest Message Digests
|
||||||
|
*
|
||||||
|
* Generation and authentication of Message Digests (aka hashes) must be done
|
||||||
|
* in parts using the following sequence:
|
||||||
|
* - `psa_drv_hash_setup_t`
|
||||||
|
* - `psa_drv_hash_update_t`
|
||||||
|
* - ...
|
||||||
|
* - `psa_drv_hash_finish_t`
|
||||||
|
*
|
||||||
|
* If a previously started Message Digest operation needs to be terminated
|
||||||
|
* before the `psa_drv_hash_finish_t` operation is complete, it should be aborted
|
||||||
|
* by the `psa_drv_hash_abort_t`. Failure to do so may result in allocated
|
||||||
|
* resources not being freed or in other undefined behavior.
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
/** \brief The hardware-specific hash context structure
|
||||||
|
*
|
||||||
|
* The contents of this structure are implementation dependent and are
|
||||||
|
* therefore not described here
|
||||||
|
*/
|
||||||
|
typedef struct psa_drv_hash_context_s psa_drv_hash_context_t;
|
||||||
|
|
||||||
|
/** \brief The function prototype for the start operation of a hash (message
|
||||||
|
* digest) operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_hash_<ALGO>_setup
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying hash function
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A structure that will contain the
|
||||||
|
* hardware-specific hash context
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS Success.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_hash_setup_t)(psa_drv_hash_context_t *p_context);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the update operation of a hash (message
|
||||||
|
* digest) operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_hash_<ALGO>_update
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously-established hash operation to be
|
||||||
|
* continued
|
||||||
|
* \param[in] p_input A buffer containing the message to be appended
|
||||||
|
* to the hash operation
|
||||||
|
* \param[in] input_length The size in bytes of the input message buffer
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_hash_update_t)(psa_drv_hash_context_t *p_context,
|
||||||
|
const uint8_t *p_input,
|
||||||
|
size_t input_length);
|
||||||
|
|
||||||
|
/** \brief The prototype for the finish operation of a hash (message digest)
|
||||||
|
* operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_hash_<ALGO>_finish
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started hash operation to be
|
||||||
|
* fiinished
|
||||||
|
* \param[out] p_output A buffer where the generated digest will be
|
||||||
|
* placed
|
||||||
|
* \param[in] output_size The size in bytes of the buffer that has been
|
||||||
|
* allocated for the `p_output` buffer
|
||||||
|
* \param[out] p_output_length The number of bytes placed in `p_output` after
|
||||||
|
* success
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* Success.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_hash_finish_t)(psa_drv_hash_context_t *p_context,
|
||||||
|
uint8_t *p_output,
|
||||||
|
size_t output_size,
|
||||||
|
size_t *p_output_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the abort operation of a hash (message
|
||||||
|
* digest) operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_hash_<ALGO>_abort
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the previously
|
||||||
|
* started hash operation to be aborted
|
||||||
|
*/
|
||||||
|
typedef void (*psa_drv_hash_abort_t)(psa_drv_hash_context_t *p_context);
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup transparent_mac Transparent Message Authentication Code
|
||||||
|
* Generation and authentication of Message Authentication Codes (MACs) using
|
||||||
|
* transparent keys can be done either as a single function call (via the
|
||||||
|
* `psa_drv_mac_transparent_generate_t` or `psa_drv_mac_transparent_verify_t`
|
||||||
|
* functions), or in parts using the following sequence:
|
||||||
|
* - `psa_drv_mac_transparent_setup_t`
|
||||||
|
* - `psa_drv_mac_transparent_update_t`
|
||||||
|
* - `psa_drv_mac_transparent_update_t`
|
||||||
|
* - ...
|
||||||
|
* - `psa_drv_mac_transparent_finish_t` or `psa_drv_mac_transparent_finish_verify_t`
|
||||||
|
*
|
||||||
|
* If a previously started Transparent MAC operation needs to be terminated, it
|
||||||
|
* should be done so by the `psa_drv_mac_transparent_abort_t`. Failure to do so may
|
||||||
|
* result in allocated resources not being freed or in other undefined
|
||||||
|
* behavior.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
/** \brief The hardware-specific transparent-key MAC context structure
|
||||||
|
*
|
||||||
|
* The contents of this structure are implementation dependent and are
|
||||||
|
* therefore not described here.
|
||||||
|
*/
|
||||||
|
typedef struct psa_drv_mac_transparent_context_s psa_drv_mac_transparent_context_t;
|
||||||
|
|
||||||
|
/** \brief The function prototype for the setup operation of a
|
||||||
|
* transparent-key MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_setup
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying primitive, and `MAC_VARIANT`
|
||||||
|
* is the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A structure that will contain the
|
||||||
|
* hardware-specific MAC context
|
||||||
|
* \param[in] p_key A buffer containing the cleartext key material
|
||||||
|
* to be used in the operation
|
||||||
|
* \param[in] key_length The size in bytes of the key material
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* Success.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_setup_t)(psa_drv_mac_transparent_context_t *p_context,
|
||||||
|
const uint8_t *p_key,
|
||||||
|
size_t key_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the update operation of a
|
||||||
|
* transparent-key MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_update
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT`
|
||||||
|
* is the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously-established MAC operation to be
|
||||||
|
* continued
|
||||||
|
* \param[in] p_input A buffer containing the message to be appended
|
||||||
|
* to the MAC operation
|
||||||
|
* \param[in] input_length The size in bytes of the input message buffer
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_update_t)(psa_drv_mac_transparent_context_t *p_context,
|
||||||
|
const uint8_t *p_input,
|
||||||
|
size_t input_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the finish operation of a
|
||||||
|
* transparent-key MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_finish
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
||||||
|
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started MAC operation to be
|
||||||
|
* finished
|
||||||
|
* \param[out] p_mac A buffer where the generated MAC will be placed
|
||||||
|
* \param[in] mac_length The size in bytes of the buffer that has been
|
||||||
|
* allocated for the `p_mac` buffer
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* Success.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_finish_t)(psa_drv_mac_transparent_context_t *p_context,
|
||||||
|
uint8_t *p_mac,
|
||||||
|
size_t mac_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the finish and verify operation of a
|
||||||
|
* transparent-key MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_finish_verify
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
||||||
|
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started MAC operation to be
|
||||||
|
* verified and finished
|
||||||
|
* \param[in] p_mac A buffer containing the MAC that will be used
|
||||||
|
* for verification
|
||||||
|
* \param[in] mac_length The size in bytes of the data in the `p_mac`
|
||||||
|
* buffer
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* The operation completed successfully and the comparison matched
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_finish_verify_t)(psa_drv_mac_transparent_context_t *p_context,
|
||||||
|
const uint8_t *p_mac,
|
||||||
|
size_t mac_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the abort operation for a previously
|
||||||
|
* started transparent-key MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_abort
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
||||||
|
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started MAC operation to be
|
||||||
|
* aborted
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_abort_t)(psa_drv_mac_transparent_context_t *p_context);
|
||||||
|
|
||||||
|
/** \brief The function prototype for a one-shot operation of a transparent-key
|
||||||
|
* MAC operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
||||||
|
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in] p_input A buffer containing the data to be MACed
|
||||||
|
* \param[in] input_length The length in bytes of the `p_input` data
|
||||||
|
* \param[in] p_key A buffer containing the key material to be used
|
||||||
|
* for the MAC operation
|
||||||
|
* \param[in] key_length The length in bytes of the `p_key` data
|
||||||
|
* \param[in] alg The algorithm to be performed
|
||||||
|
* \param[out] p_mac The buffer where the resulting MAC will be placed
|
||||||
|
* upon success
|
||||||
|
* \param[in] mac_length The length in bytes of the `p_mac` buffer
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_t)(const uint8_t *p_input,
|
||||||
|
size_t input_length,
|
||||||
|
const uint8_t *p_key,
|
||||||
|
size_t key_length,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
uint8_t *p_mac,
|
||||||
|
size_t mac_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for a one-shot operation of a transparent-key
|
||||||
|
* MAC Verify operation
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_verify
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
||||||
|
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
||||||
|
*
|
||||||
|
* \param[in] p_input A buffer containing the data to be MACed
|
||||||
|
* \param[in] input_length The length in bytes of the `p_input` data
|
||||||
|
* \param[in] p_key A buffer containing the key material to be used
|
||||||
|
* for the MAC operation
|
||||||
|
* \param[in] key_length The length in bytes of the `p_key` data
|
||||||
|
* \param[in] alg The algorithm to be performed
|
||||||
|
* \param[in] p_mac The MAC data to be compared
|
||||||
|
* \param[in] mac_length The length in bytes of the `p_mac` buffer
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* The operation completed successfully and the comparison matched
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_mac_transparent_verify_t)(const uint8_t *p_input,
|
||||||
|
size_t input_length,
|
||||||
|
const uint8_t *p_key,
|
||||||
|
size_t key_length,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *p_mac,
|
||||||
|
size_t mac_length);
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup transparent_cipher Transparent Block Cipher
|
||||||
|
* Encryption and Decryption using transparent keys in block modes other than
|
||||||
|
* ECB must be done in multiple parts, using the following flow:
|
||||||
|
* - `psa_drv_cipher_transparent_setup_t`
|
||||||
|
* - `psa_drv_cipher_transparent_set_iv_t` (optional depending upon block mode)
|
||||||
|
* - `psa_drv_cipher_transparent_update_t`
|
||||||
|
* - ...
|
||||||
|
* - `psa_drv_cipher_transparent_finish_t`
|
||||||
|
|
||||||
|
* If a previously started Transparent Cipher operation needs to be terminated,
|
||||||
|
* it should be done so by the `psa_drv_cipher_transparent_abort_t`. Failure to do
|
||||||
|
* so may result in allocated resources not being freed or in other undefined
|
||||||
|
* behavior.
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
/** \brief The hardware-specific transparent-key Cipher context structure
|
||||||
|
*
|
||||||
|
* The contents of this structure are implementation dependent and are
|
||||||
|
* therefore not described here.
|
||||||
|
*/
|
||||||
|
typedef struct psa_drv_cipher_transparent_context_s psa_drv_cipher_transparent_context_t;
|
||||||
|
|
||||||
|
/** \brief The function prototype for the setup operation of transparent-key
|
||||||
|
* block cipher operations.
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* conventions:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_setup_<CIPHER_NAME>_<MODE>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where
|
||||||
|
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
||||||
|
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
||||||
|
* or for stream ciphers:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_setup_<CIPHER_NAME>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `CIPHER_NAME` is the name of a stream cipher (i.e. RC4)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A structure that will contain the
|
||||||
|
* hardware-specific cipher context
|
||||||
|
* \param[in] direction Indicates if the operation is an encrypt or a
|
||||||
|
* decrypt
|
||||||
|
* \param[in] p_key_data A buffer containing the cleartext key material
|
||||||
|
* to be used in the operation
|
||||||
|
* \param[in] key_data_size The size in bytes of the key material
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_cipher_transparent_setup_t)(psa_drv_cipher_transparent_context_t *p_context,
|
||||||
|
psa_encrypt_or_decrypt_t direction,
|
||||||
|
const uint8_t *p_key_data,
|
||||||
|
size_t key_data_size);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the set initialization vector operation
|
||||||
|
* of transparent-key block cipher operations
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_set_iv_<CIPHER_NAME>_<MODE>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where
|
||||||
|
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
||||||
|
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A structure that contains the previously setup
|
||||||
|
* hardware-specific cipher context
|
||||||
|
* \param[in] p_iv A buffer containing the initialization vecotr
|
||||||
|
* \param[in] iv_length The size in bytes of the contents of `p_iv`
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_cipher_transparent_set_iv_t)(psa_drv_cipher_transparent_context_t *p_context,
|
||||||
|
const uint8_t *p_iv,
|
||||||
|
size_t iv_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the update operation of transparent-key
|
||||||
|
* block cipher operations.
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_update_<CIPHER_NAME>_<MODE>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where
|
||||||
|
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
||||||
|
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started cipher operation
|
||||||
|
* \param[in] p_input A buffer containing the data to be
|
||||||
|
* encrypted or decrypted
|
||||||
|
* \param[in] input_size The size in bytes of the `p_input` buffer
|
||||||
|
* \param[out] p_output A caller-allocated buffer where the
|
||||||
|
* generated output will be placed
|
||||||
|
* \param[in] output_size The size in bytes of the `p_output` buffer
|
||||||
|
* \param[out] p_output_length After completion, will contain the number
|
||||||
|
* of bytes placed in the `p_output` buffer
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_cipher_transparent_update_t)(psa_drv_cipher_transparent_context_t *p_context,
|
||||||
|
const uint8_t *p_input,
|
||||||
|
size_t input_size,
|
||||||
|
uint8_t *p_output,
|
||||||
|
size_t output_size,
|
||||||
|
size_t *p_output_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the finish operation of transparent-key
|
||||||
|
* block cipher operations.
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_finish_<CIPHER_NAME>_<MODE>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where
|
||||||
|
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
||||||
|
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started cipher operation
|
||||||
|
* \param[out] p_output A caller-allocated buffer where the generated
|
||||||
|
* output will be placed
|
||||||
|
* \param[in] output_size The size in bytes of the `p_output` buffer
|
||||||
|
* \param[out] p_output_length After completion, will contain the number of
|
||||||
|
* bytes placed in the `p_output` buffer
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_cipher_transparent_finish_t)(psa_drv_cipher_transparent_context_t *p_context,
|
||||||
|
uint8_t *p_output,
|
||||||
|
size_t output_size,
|
||||||
|
size_t *p_output_length);
|
||||||
|
|
||||||
|
/** \brief The function prototype for the abort operation of transparent-key
|
||||||
|
* block cipher operations.
|
||||||
|
*
|
||||||
|
* Functions that implement the following prototype should be named in the
|
||||||
|
* following convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_cipher_transparent_abort_<CIPHER_NAME>_<MODE>
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where
|
||||||
|
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
||||||
|
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure for the
|
||||||
|
* previously started cipher operation
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_cipher_transparent_abort_t)(psa_drv_cipher_transparent_context_t *p_context);
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup aead_transparent AEAD Transparent
|
||||||
|
*
|
||||||
|
* Authenticated Encryption with Additional Data (AEAD) operations with
|
||||||
|
* transparent keys must be done in one function call. While this creates a
|
||||||
|
* burden for implementers as there must be sufficient space in memory for the
|
||||||
|
* entire message, it prevents decrypted data from being made available before
|
||||||
|
* the authentication operation is complete and the data is known to be
|
||||||
|
* authentic.
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
/** Process an authenticated encryption operation using an opaque key.
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_aead_<ALGO>_encrypt
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the AEAD algorithm
|
||||||
|
*
|
||||||
|
* \param[in] p_key A pointer to the key material
|
||||||
|
* \param[in] key_length The size in bytes of the key material
|
||||||
|
* \param[in] alg The AEAD algorithm to compute
|
||||||
|
* (\c PSA_ALG_XXX value such that
|
||||||
|
* #PSA_ALG_IS_AEAD(`alg`) is true)
|
||||||
|
* \param[in] nonce Nonce or IV to use
|
||||||
|
* \param[in] nonce_length Size of the `nonce` buffer in bytes
|
||||||
|
* \param[in] additional_data Additional data that will be MACed
|
||||||
|
* but not encrypted.
|
||||||
|
* \param[in] additional_data_length Size of `additional_data` in bytes
|
||||||
|
* \param[in] plaintext Data that will be MACed and
|
||||||
|
* encrypted.
|
||||||
|
* \param[in] plaintext_length Size of `plaintext` in bytes
|
||||||
|
* \param[out] ciphertext Output buffer for the authenticated and
|
||||||
|
* encrypted data. The additional data is
|
||||||
|
* not part of this output. For algorithms
|
||||||
|
* where the encrypted data and the
|
||||||
|
* authentication tag are defined as
|
||||||
|
* separate outputs, the authentication
|
||||||
|
* tag is appended to the encrypted data.
|
||||||
|
* \param[in] ciphertext_size Size of the `ciphertext` buffer in
|
||||||
|
* bytes
|
||||||
|
* This must be at least
|
||||||
|
* #PSA_AEAD_ENCRYPT_OUTPUT_SIZE(`alg`,
|
||||||
|
* `plaintext_length`).
|
||||||
|
* \param[out] ciphertext_length On success, the size of the output in
|
||||||
|
* the `ciphertext` buffer
|
||||||
|
*
|
||||||
|
* \retval #PSA_SUCCESS
|
||||||
|
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_aead_transparent_encrypt_t)(const uint8_t *p_key,
|
||||||
|
size_t key_length,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *nonce,
|
||||||
|
size_t nonce_length,
|
||||||
|
const uint8_t *additional_data,
|
||||||
|
size_t additional_data_length,
|
||||||
|
const uint8_t *plaintext,
|
||||||
|
size_t plaintext_length,
|
||||||
|
uint8_t *ciphertext,
|
||||||
|
size_t ciphertext_size,
|
||||||
|
size_t *ciphertext_length);
|
||||||
|
|
||||||
|
/** Process an authenticated decryption operation using an opaque key.
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_aead_<ALGO>_decrypt
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the AEAD algorithm
|
||||||
|
* \param[in] p_key A pointer to the key material
|
||||||
|
* \param[in] key_length The size in bytes of the key material
|
||||||
|
* \param[in] alg The AEAD algorithm to compute
|
||||||
|
* (\c PSA_ALG_XXX value such that
|
||||||
|
* #PSA_ALG_IS_AEAD(`alg`) is true)
|
||||||
|
* \param[in] nonce Nonce or IV to use
|
||||||
|
* \param[in] nonce_length Size of the `nonce` buffer in bytes
|
||||||
|
* \param[in] additional_data Additional data that has been MACed
|
||||||
|
* but not encrypted
|
||||||
|
* \param[in] additional_data_length Size of `additional_data` in bytes
|
||||||
|
* \param[in] ciphertext Data that has been MACed and
|
||||||
|
* encrypted
|
||||||
|
* For algorithms where the encrypted data
|
||||||
|
* and the authentication tag are defined
|
||||||
|
* as separate inputs, the buffer must
|
||||||
|
* contain the encrypted data followed by
|
||||||
|
* the authentication tag.
|
||||||
|
* \param[in] ciphertext_length Size of `ciphertext` in bytes
|
||||||
|
* \param[out] plaintext Output buffer for the decrypted data
|
||||||
|
* \param[in] plaintext_size Size of the `plaintext` buffer in
|
||||||
|
* bytes
|
||||||
|
* This must be at least
|
||||||
|
* #PSA_AEAD_DECRYPT_OUTPUT_SIZE(`alg`,
|
||||||
|
* `ciphertext_length`).
|
||||||
|
* \param[out] plaintext_length On success, the size of the output
|
||||||
|
* in the \b plaintext buffer
|
||||||
|
*
|
||||||
|
* \retval #PSA_SUCCESS
|
||||||
|
* Success.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_aead_transparent_decrypt_t)(const uint8_t *p_key,
|
||||||
|
size_t key_length,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *nonce,
|
||||||
|
size_t nonce_length,
|
||||||
|
const uint8_t *additional_data,
|
||||||
|
size_t additional_data_length,
|
||||||
|
const uint8_t *ciphertext,
|
||||||
|
size_t ciphertext_length,
|
||||||
|
uint8_t *plaintext,
|
||||||
|
size_t plaintext_size,
|
||||||
|
size_t *plaintext_length);
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup transparent_asymmetric Transparent Asymmetric Cryptography
|
||||||
|
*
|
||||||
|
* Since the amount of data that can (or should) be encrypted or signed using
|
||||||
|
* asymmetric keys is limited by the key size, asymmetric key operations using
|
||||||
|
* transparent keys must be done in single function calls.
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief A function that signs a hash or short message with a transparent
|
||||||
|
* asymmetric private key
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_asymmetric_<ALGO>_sign
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the signing algorithm
|
||||||
|
*
|
||||||
|
* \param[in] p_key A buffer containing the private key
|
||||||
|
* material
|
||||||
|
* \param[in] key_size The size in bytes of the `p_key` data
|
||||||
|
* \param[in] alg A signature algorithm that is compatible
|
||||||
|
* with the type of `p_key`
|
||||||
|
* \param[in] p_hash The hash or message to sign
|
||||||
|
* \param[in] hash_length Size of the `p_hash` buffer in bytes
|
||||||
|
* \param[out] p_signature Buffer where the signature is to be written
|
||||||
|
* \param[in] signature_size Size of the `p_signature` buffer in bytes
|
||||||
|
* \param[out] p_signature_length On success, the number of bytes
|
||||||
|
* that make up the returned signature value
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_asymmetric_transparent_sign_t)(const uint8_t *p_key,
|
||||||
|
size_t key_size,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *p_hash,
|
||||||
|
size_t hash_length,
|
||||||
|
uint8_t *p_signature,
|
||||||
|
size_t signature_size,
|
||||||
|
size_t *p_signature_length);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief A function that verifies the signature a hash or short message using
|
||||||
|
* a transparent asymmetric public key
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_asymmetric_<ALGO>_verify
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the signing algorithm
|
||||||
|
*
|
||||||
|
* \param[in] p_key A buffer containing the public key material
|
||||||
|
* \param[in] key_size The size in bytes of the `p_key` data
|
||||||
|
* \param[in] alg A signature algorithm that is compatible with
|
||||||
|
* the type of `key`
|
||||||
|
* \param[in] p_hash The hash or message whose signature is to be
|
||||||
|
* verified
|
||||||
|
* \param[in] hash_length Size of the `p_hash` buffer in bytes
|
||||||
|
* \param[in] p_signature Buffer containing the signature to verify
|
||||||
|
* \param[in] signature_length Size of the `p_signature` buffer in bytes
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
* The signature is valid.
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_asymmetric_transparent_verify_t)(const uint8_t *p_key,
|
||||||
|
size_t key_size,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *p_hash,
|
||||||
|
size_t hash_length,
|
||||||
|
const uint8_t *p_signature,
|
||||||
|
size_t signature_length);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief A function that encrypts a short message with a transparent
|
||||||
|
* asymmetric public key
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_asymmetric_<ALGO>_encrypt
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the encryption algorithm
|
||||||
|
*
|
||||||
|
* \param[in] p_key A buffer containing the public key material
|
||||||
|
* \param[in] key_size The size in bytes of the `p_key` data
|
||||||
|
* \param[in] alg An asymmetric encryption algorithm that is
|
||||||
|
* compatible with the type of `key`
|
||||||
|
* \param[in] p_input The message to encrypt
|
||||||
|
* \param[in] input_length Size of the `p_input` buffer in bytes
|
||||||
|
* \param[in] p_salt A salt or label, if supported by the
|
||||||
|
* encryption algorithm
|
||||||
|
* If the algorithm does not support a
|
||||||
|
* salt, pass `NULL`
|
||||||
|
* If the algorithm supports an optional
|
||||||
|
* salt and you do not want to pass a salt,
|
||||||
|
* pass `NULL`.
|
||||||
|
* For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
|
||||||
|
* supported.
|
||||||
|
* \param[in] salt_length Size of the `p_salt` buffer in bytes
|
||||||
|
* If `p_salt` is `NULL`, pass 0.
|
||||||
|
* \param[out] p_output Buffer where the encrypted message is to
|
||||||
|
* be written
|
||||||
|
* \param[in] output_size Size of the `p_output` buffer in bytes
|
||||||
|
* \param[out] p_output_length On success, the number of bytes
|
||||||
|
* that make up the returned output
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_asymmetric_transparent_encrypt_t)(const uint8_t *p_key,
|
||||||
|
size_t key_size,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *p_input,
|
||||||
|
size_t input_length,
|
||||||
|
const uint8_t *p_salt,
|
||||||
|
size_t salt_length,
|
||||||
|
uint8_t *p_output,
|
||||||
|
size_t output_size,
|
||||||
|
size_t *p_output_length);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Decrypt a short message with a transparent asymmetric private key
|
||||||
|
*
|
||||||
|
* Functions that implement the prototype should be named in the following
|
||||||
|
* convention:
|
||||||
|
* ~~~~~~~~~~~~~{.c}
|
||||||
|
* psa_drv_asymmetric_<ALGO>_decrypt
|
||||||
|
* ~~~~~~~~~~~~~
|
||||||
|
* Where `ALGO` is the name of the encryption algorithm
|
||||||
|
*
|
||||||
|
* \param[in] p_key A buffer containing the private key material
|
||||||
|
* \param[in] key_size The size in bytes of the `p_key` data
|
||||||
|
* \param[in] alg An asymmetric encryption algorithm that is
|
||||||
|
* compatible with the type of `key`
|
||||||
|
* \param[in] p_input The message to decrypt
|
||||||
|
* \param[in] input_length Size of the `p_input` buffer in bytes
|
||||||
|
* \param[in] p_salt A salt or label, if supported by the
|
||||||
|
* encryption algorithm
|
||||||
|
* If the algorithm does not support a
|
||||||
|
* salt, pass `NULL`.
|
||||||
|
* If the algorithm supports an optional
|
||||||
|
* salt and you do not want to pass a salt,
|
||||||
|
* pass `NULL`.
|
||||||
|
* For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
|
||||||
|
* supported
|
||||||
|
* \param[in] salt_length Size of the `p_salt` buffer in bytes
|
||||||
|
* If `p_salt` is `NULL`, pass 0
|
||||||
|
* \param[out] p_output Buffer where the decrypted message is to
|
||||||
|
* be written
|
||||||
|
* \param[in] output_size Size of the `p_output` buffer in bytes
|
||||||
|
* \param[out] p_output_length On success, the number of bytes
|
||||||
|
* that make up the returned output
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_asymmetric_transparent_decrypt_t)(const uint8_t *p_key,
|
||||||
|
size_t key_size,
|
||||||
|
psa_algorithm_t alg,
|
||||||
|
const uint8_t *p_input,
|
||||||
|
size_t input_length,
|
||||||
|
const uint8_t *p_salt,
|
||||||
|
size_t salt_length,
|
||||||
|
uint8_t *p_output,
|
||||||
|
size_t output_size,
|
||||||
|
size_t *p_output_length);
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* PSA_CRYPTO_ACCEL_DRIVER_H */
|
||||||
54
include/psa/crypto_driver_common.h
Normal file
54
include/psa/crypto_driver_common.h
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
/**
|
||||||
|
* \file psa/crypto_driver_common.h
|
||||||
|
* \brief Definitions for all PSA crypto drivers
|
||||||
|
*
|
||||||
|
* This file contains common definitions shared by all PSA crypto drivers.
|
||||||
|
* Do not include it directly: instead, include the header file(s) for
|
||||||
|
* the type(s) of driver that you are implementing. For example, if
|
||||||
|
* you are writing a driver for a chip that provides both a hardware
|
||||||
|
* random generator and an accelerator for some cryptographic algorithms,
|
||||||
|
* include `psa/crypto_entropy_driver.h` and `psa/crypto_accel_driver.h`.
|
||||||
|
*
|
||||||
|
* This file is part of the PSA Crypto Driver Model, containing functions for
|
||||||
|
* driver developers to implement to enable hardware to be called in a
|
||||||
|
* standardized way by a PSA Cryptographic API implementation. The functions
|
||||||
|
* comprising the driver model, which driver authors implement, are not
|
||||||
|
* intended to be called by application developers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2018, ARM Limited, All Rights Reserved
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
#ifndef PSA_CRYPTO_DRIVER_COMMON_H
|
||||||
|
#define PSA_CRYPTO_DRIVER_COMMON_H
|
||||||
|
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
|
||||||
|
/* Include type definitions (psa_status_t, psa_algorithm_t,
|
||||||
|
* psa_key_type_t, etc.) and macros to build and analyze values
|
||||||
|
* of these types. */
|
||||||
|
#include "crypto_types.h"
|
||||||
|
#include "crypto_values.h"
|
||||||
|
|
||||||
|
/** For encrypt-decrypt functions, whether the operation is an encryption
|
||||||
|
* or a decryption. */
|
||||||
|
typedef enum {
|
||||||
|
PSA_CRYPTO_DRIVER_DECRYPT,
|
||||||
|
PSA_CRYPTO_DRIVER_ENCRYPT
|
||||||
|
} psa_encrypt_or_decrypt_t;
|
||||||
|
|
||||||
|
#endif /* PSA_CRYPTO_DRIVER_COMMON_H */
|
||||||
111
include/psa/crypto_entropy_driver.h
Normal file
111
include/psa/crypto_entropy_driver.h
Normal file
|
|
@ -0,0 +1,111 @@
|
||||||
|
/**
|
||||||
|
* \file psa/crypto_entropy_driver.h
|
||||||
|
* \brief PSA entropy source driver module
|
||||||
|
*
|
||||||
|
* This header declares types and function signatures for entropy sources.
|
||||||
|
*
|
||||||
|
* This file is part of the PSA Crypto Driver Model, containing functions for
|
||||||
|
* driver developers to implement to enable hardware to be called in a
|
||||||
|
* standardized way by a PSA Cryptographic API implementation. The functions
|
||||||
|
* comprising the driver model, which driver authors implement, are not
|
||||||
|
* intended to be called by application developers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2018, ARM Limited, All Rights Reserved
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
#ifndef PSA_CRYPTO_ENTROPY_DRIVER_H
|
||||||
|
#define PSA_CRYPTO_ENTROPY_DRIVER_H
|
||||||
|
|
||||||
|
#include "crypto_driver_common.h"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/** \defgroup driver_rng Entropy Generation
|
||||||
|
*/
|
||||||
|
/**@{*/
|
||||||
|
|
||||||
|
/** \brief A hardware-specific structure for a entropy providing hardware
|
||||||
|
*/
|
||||||
|
typedef struct psa_drv_entropy_context_s psa_drv_entropy_context_t;
|
||||||
|
|
||||||
|
/** \brief Initialize an entropy driver
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure
|
||||||
|
* containing any context information for
|
||||||
|
* the implementation
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_entropy_init_t)(psa_drv_entropy_context_t *p_context);
|
||||||
|
|
||||||
|
/** \brief Get a specified number of bits from the entropy source
|
||||||
|
*
|
||||||
|
* It retrives `buffer_size` bytes of data from the entropy source. The entropy
|
||||||
|
* source will always fill the provided buffer to its full size, however, most
|
||||||
|
* entropy sources have biases, and the actual amount of entropy contained in
|
||||||
|
* the buffer will be less than the number of bytes.
|
||||||
|
* The driver will return the actual number of bytes of entropy placed in the
|
||||||
|
* buffer in `p_received_entropy_bytes`.
|
||||||
|
* A PSA Crypto API implementation will likely feed the output of this function
|
||||||
|
* into a Digital Random Bit Generator (DRBG), and typically has a minimum
|
||||||
|
* amount of entropy that it needs.
|
||||||
|
* To accomplish this, the PSA Crypto implementation should be designed to call
|
||||||
|
* this function multiple times until it has received the required amount of
|
||||||
|
* entropy from the entropy source.
|
||||||
|
*
|
||||||
|
* \param[in,out] p_context A hardware-specific structure
|
||||||
|
* containing any context information
|
||||||
|
* for the implementation
|
||||||
|
* \param[out] p_buffer A caller-allocated buffer for the
|
||||||
|
* retrieved entropy to be placed in
|
||||||
|
* \param[in] buffer_size The allocated size of `p_buffer`
|
||||||
|
* \param[out] p_received_entropy_bits The amount of entropy (in bits)
|
||||||
|
* actually provided in `p_buffer`
|
||||||
|
*
|
||||||
|
* \retval PSA_SUCCESS
|
||||||
|
*/
|
||||||
|
typedef psa_status_t (*psa_drv_entropy_get_bits_t)(psa_drv_entropy_context_t *p_context,
|
||||||
|
uint8_t *p_buffer,
|
||||||
|
uint32_t buffer_size,
|
||||||
|
uint32_t *p_received_entropy_bits);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief A struct containing all of the function pointers needed to interface
|
||||||
|
* to an entropy source
|
||||||
|
*
|
||||||
|
* PSA Crypto API implementations should populate instances of the table as
|
||||||
|
* appropriate upon startup.
|
||||||
|
*
|
||||||
|
* If one of the functions is not implemented, it should be set to NULL.
|
||||||
|
*/
|
||||||
|
typedef struct {
|
||||||
|
/** Function that performs initialization for the entropy source */
|
||||||
|
psa_drv_entropy_init_t *p_init;
|
||||||
|
/** Function that performs the get_bits operation for the entropy source
|
||||||
|
*/
|
||||||
|
psa_drv_entropy_get_bits_t *p_get_bits;
|
||||||
|
} psa_drv_entropy_t;
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* PSA_CRYPTO_ENTROPY_DRIVER_H */
|
||||||
|
|
@ -1,8 +1,14 @@
|
||||||
/**
|
/**
|
||||||
* \file psa/crypto_driver.h
|
* \file psa/crypto_se_driver.h
|
||||||
* \brief Platform Security Architecture cryptographic driver module
|
* \brief PSA external cryptoprocessor driver module
|
||||||
*
|
*
|
||||||
* This file describes the PSA Crypto Driver Model, containing functions for
|
* This header declares types and function signatures for cryptography
|
||||||
|
* drivers that access key material via opaque references. This is
|
||||||
|
* meant for cryptoprocessors that have a separate key storage from the
|
||||||
|
* space in which the PSA Crypto implementation runs, typically secure
|
||||||
|
* elements.
|
||||||
|
*
|
||||||
|
* This file is part of the PSA Crypto Driver Model, containing functions for
|
||||||
* driver developers to implement to enable hardware to be called in a
|
* driver developers to implement to enable hardware to be called in a
|
||||||
* standardized way by a PSA Cryptographic API implementation. The functions
|
* standardized way by a PSA Cryptographic API implementation. The functions
|
||||||
* comprising the driver model, which driver authors implement, are not
|
* comprising the driver model, which driver authors implement, are not
|
||||||
|
|
@ -25,29 +31,19 @@
|
||||||
* See the License for the specific language governing permissions and
|
* See the License for the specific language governing permissions and
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
#ifndef PSA_CRYPTO_DRIVER_H
|
#ifndef PSA_CRYPTO_SE_DRIVER_H
|
||||||
#define PSA_CRYPTO_DRIVER_H
|
#define PSA_CRYPTO_SE_DRIVER_H
|
||||||
|
|
||||||
#include <stddef.h>
|
#include "crypto_driver_common.h"
|
||||||
#include <stdint.h>
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/** The following types are redefinitions from the psa/crypto.h file.
|
/** An internal designation of a key slot between the core part of the
|
||||||
* It is intended that these will be moved to a new common header file to
|
* PSA Crypto implementation and the driver. The meaning of this value
|
||||||
* avoid duplication. They are included here for expediency in publication.
|
* is driver-dependent. */
|
||||||
*/
|
|
||||||
typedef uint32_t psa_status_t;
|
|
||||||
typedef uint32_t psa_algorithm_t;
|
|
||||||
typedef uint8_t psa_encrypt_or_decrypt_t;
|
|
||||||
typedef uint32_t psa_key_slot_t;
|
typedef uint32_t psa_key_slot_t;
|
||||||
typedef uint32_t psa_key_type_t;
|
|
||||||
typedef uint32_t psa_key_usage_t;
|
|
||||||
|
|
||||||
#define PSA_CRYPTO_DRIVER_ENCRYPT 1
|
|
||||||
#define PSA_CRYPTO_DRIVER_DECRYPT 0
|
|
||||||
|
|
||||||
/** \defgroup opaque_mac Opaque Message Authentication Code
|
/** \defgroup opaque_mac Opaque Message Authentication Code
|
||||||
* Generation and authentication of Message Authentication Codes (MACs) using
|
* Generation and authentication of Message Authentication Codes (MACs) using
|
||||||
|
|
@ -239,208 +235,6 @@ typedef struct {
|
||||||
} psa_drv_mac_opaque_t;
|
} psa_drv_mac_opaque_t;
|
||||||
/**@}*/
|
/**@}*/
|
||||||
|
|
||||||
/** \defgroup transparent_mac Transparent Message Authentication Code
|
|
||||||
* Generation and authentication of Message Authentication Codes (MACs) using
|
|
||||||
* transparent keys can be done either as a single function call (via the
|
|
||||||
* `psa_drv_mac_transparent_generate_t` or `psa_drv_mac_transparent_verify_t`
|
|
||||||
* functions), or in parts using the following sequence:
|
|
||||||
* - `psa_drv_mac_transparent_setup_t`
|
|
||||||
* - `psa_drv_mac_transparent_update_t`
|
|
||||||
* - `psa_drv_mac_transparent_update_t`
|
|
||||||
* - ...
|
|
||||||
* - `psa_drv_mac_transparent_finish_t` or `psa_drv_mac_transparent_finish_verify_t`
|
|
||||||
*
|
|
||||||
* If a previously started Transparent MAC operation needs to be terminated, it
|
|
||||||
* should be done so by the `psa_drv_mac_transparent_abort_t`. Failure to do so may
|
|
||||||
* result in allocated resources not being freed or in other undefined
|
|
||||||
* behavior.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/** \brief The hardware-specific transparent-key MAC context structure
|
|
||||||
*
|
|
||||||
* The contents of this structure are implementation dependent and are
|
|
||||||
* therefore not described here.
|
|
||||||
*/
|
|
||||||
typedef struct psa_drv_mac_transparent_context_s psa_drv_mac_transparent_context_t;
|
|
||||||
|
|
||||||
/** \brief The function prototype for the setup operation of a
|
|
||||||
* transparent-key MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_setup
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying primitive, and `MAC_VARIANT`
|
|
||||||
* is the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A structure that will contain the
|
|
||||||
* hardware-specific MAC context
|
|
||||||
* \param[in] p_key A buffer containing the cleartext key material
|
|
||||||
* to be used in the operation
|
|
||||||
* \param[in] key_length The size in bytes of the key material
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* Success.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_setup_t)(psa_drv_mac_transparent_context_t *p_context,
|
|
||||||
const uint8_t *p_key,
|
|
||||||
size_t key_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the update operation of a
|
|
||||||
* transparent-key MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_update
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT`
|
|
||||||
* is the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously-established MAC operation to be
|
|
||||||
* continued
|
|
||||||
* \param[in] p_input A buffer containing the message to be appended
|
|
||||||
* to the MAC operation
|
|
||||||
* \param[in] input_length The size in bytes of the input message buffer
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_update_t)(psa_drv_mac_transparent_context_t *p_context,
|
|
||||||
const uint8_t *p_input,
|
|
||||||
size_t input_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the finish operation of a
|
|
||||||
* transparent-key MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_finish
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
|
||||||
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started MAC operation to be
|
|
||||||
* finished
|
|
||||||
* \param[out] p_mac A buffer where the generated MAC will be placed
|
|
||||||
* \param[in] mac_length The size in bytes of the buffer that has been
|
|
||||||
* allocated for the `p_mac` buffer
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* Success.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_finish_t)(psa_drv_mac_transparent_context_t *p_context,
|
|
||||||
uint8_t *p_mac,
|
|
||||||
size_t mac_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the finish and verify operation of a
|
|
||||||
* transparent-key MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_finish_verify
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
|
||||||
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started MAC operation to be
|
|
||||||
* verified and finished
|
|
||||||
* \param[in] p_mac A buffer containing the MAC that will be used
|
|
||||||
* for verification
|
|
||||||
* \param[in] mac_length The size in bytes of the data in the `p_mac`
|
|
||||||
* buffer
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* The operation completed successfully and the comparison matched
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_finish_verify_t)(psa_drv_mac_transparent_context_t *p_context,
|
|
||||||
const uint8_t *p_mac,
|
|
||||||
size_t mac_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the abort operation for a previously
|
|
||||||
* started transparent-key MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_abort
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
|
||||||
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started MAC operation to be
|
|
||||||
* aborted
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_abort_t)(psa_drv_mac_transparent_context_t *p_context);
|
|
||||||
|
|
||||||
/** \brief The function prototype for a one-shot operation of a transparent-key
|
|
||||||
* MAC operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
|
||||||
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in] p_input A buffer containing the data to be MACed
|
|
||||||
* \param[in] input_length The length in bytes of the `p_input` data
|
|
||||||
* \param[in] p_key A buffer containing the key material to be used
|
|
||||||
* for the MAC operation
|
|
||||||
* \param[in] key_length The length in bytes of the `p_key` data
|
|
||||||
* \param[in] alg The algorithm to be performed
|
|
||||||
* \param[out] p_mac The buffer where the resulting MAC will be placed
|
|
||||||
* upon success
|
|
||||||
* \param[in] mac_length The length in bytes of the `p_mac` buffer
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_t)(const uint8_t *p_input,
|
|
||||||
size_t input_length,
|
|
||||||
const uint8_t *p_key,
|
|
||||||
size_t key_length,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
uint8_t *p_mac,
|
|
||||||
size_t mac_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for a one-shot operation of a transparent-key
|
|
||||||
* MAC Verify operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_mac_transparent_<ALGO>_<MAC_VARIANT>_verify
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm, and `MAC_VARIANT` is
|
|
||||||
* the specific variant of a MAC operation (such as HMAC or CMAC)
|
|
||||||
*
|
|
||||||
* \param[in] p_input A buffer containing the data to be MACed
|
|
||||||
* \param[in] input_length The length in bytes of the `p_input` data
|
|
||||||
* \param[in] p_key A buffer containing the key material to be used
|
|
||||||
* for the MAC operation
|
|
||||||
* \param[in] key_length The length in bytes of the `p_key` data
|
|
||||||
* \param[in] alg The algorithm to be performed
|
|
||||||
* \param[in] p_mac The MAC data to be compared
|
|
||||||
* \param[in] mac_length The length in bytes of the `p_mac` buffer
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* The operation completed successfully and the comparison matched
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_mac_transparent_verify_t)(const uint8_t *p_input,
|
|
||||||
size_t input_length,
|
|
||||||
const uint8_t *p_key,
|
|
||||||
size_t key_length,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *p_mac,
|
|
||||||
size_t mac_length);
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
/** \defgroup opaque_cipher Opaque Symmetric Ciphers
|
/** \defgroup opaque_cipher Opaque Symmetric Ciphers
|
||||||
*
|
*
|
||||||
* Encryption and Decryption using opaque keys in block modes other than ECB
|
* Encryption and Decryption using opaque keys in block modes other than ECB
|
||||||
|
|
@ -618,269 +412,6 @@ typedef struct {
|
||||||
|
|
||||||
/**@}*/
|
/**@}*/
|
||||||
|
|
||||||
/** \defgroup transparent_cipher Transparent Block Cipher
|
|
||||||
* Encryption and Decryption using transparent keys in block modes other than
|
|
||||||
* ECB must be done in multiple parts, using the following flow:
|
|
||||||
* - `psa_drv_cipher_transparent_setup_t`
|
|
||||||
* - `psa_drv_cipher_transparent_set_iv_t` (optional depending upon block mode)
|
|
||||||
* - `psa_drv_cipher_transparent_update_t`
|
|
||||||
* - ...
|
|
||||||
* - `psa_drv_cipher_transparent_finish_t`
|
|
||||||
|
|
||||||
* If a previously started Transparent Cipher operation needs to be terminated,
|
|
||||||
* it should be done so by the `psa_drv_cipher_transparent_abort_t`. Failure to do
|
|
||||||
* so may result in allocated resources not being freed or in other undefined
|
|
||||||
* behavior.
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/** \brief The hardware-specific transparent-key Cipher context structure
|
|
||||||
*
|
|
||||||
* The contents of this structure are implementation dependent and are
|
|
||||||
* therefore not described here.
|
|
||||||
*/
|
|
||||||
typedef struct psa_drv_cipher_transparent_context_s psa_drv_cipher_transparent_context_t;
|
|
||||||
|
|
||||||
/** \brief The function prototype for the setup operation of transparent-key
|
|
||||||
* block cipher operations.
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* conventions:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_setup_<CIPHER_NAME>_<MODE>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where
|
|
||||||
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
|
||||||
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
|
||||||
* or for stream ciphers:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_setup_<CIPHER_NAME>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `CIPHER_NAME` is the name of a stream cipher (i.e. RC4)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A structure that will contain the
|
|
||||||
* hardware-specific cipher context
|
|
||||||
* \param[in] direction Indicates if the operation is an encrypt or a
|
|
||||||
* decrypt
|
|
||||||
* \param[in] p_key_data A buffer containing the cleartext key material
|
|
||||||
* to be used in the operation
|
|
||||||
* \param[in] key_data_size The size in bytes of the key material
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_cipher_transparent_setup_t)(psa_drv_cipher_transparent_context_t *p_context,
|
|
||||||
psa_encrypt_or_decrypt_t direction,
|
|
||||||
const uint8_t *p_key_data,
|
|
||||||
size_t key_data_size);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the set initialization vector operation
|
|
||||||
* of transparent-key block cipher operations
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_set_iv_<CIPHER_NAME>_<MODE>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where
|
|
||||||
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
|
||||||
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A structure that contains the previously setup
|
|
||||||
* hardware-specific cipher context
|
|
||||||
* \param[in] p_iv A buffer containing the initialization vecotr
|
|
||||||
* \param[in] iv_length The size in bytes of the contents of `p_iv`
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_cipher_transparent_set_iv_t)(psa_drv_cipher_transparent_context_t *p_context,
|
|
||||||
const uint8_t *p_iv,
|
|
||||||
size_t iv_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the update operation of transparent-key
|
|
||||||
* block cipher operations.
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_update_<CIPHER_NAME>_<MODE>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where
|
|
||||||
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
|
||||||
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started cipher operation
|
|
||||||
* \param[in] p_input A buffer containing the data to be
|
|
||||||
* encrypted or decrypted
|
|
||||||
* \param[in] input_size The size in bytes of the `p_input` buffer
|
|
||||||
* \param[out] p_output A caller-allocated buffer where the
|
|
||||||
* generated output will be placed
|
|
||||||
* \param[in] output_size The size in bytes of the `p_output` buffer
|
|
||||||
* \param[out] p_output_length After completion, will contain the number
|
|
||||||
* of bytes placed in the `p_output` buffer
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_cipher_transparent_update_t)(psa_drv_cipher_transparent_context_t *p_context,
|
|
||||||
const uint8_t *p_input,
|
|
||||||
size_t input_size,
|
|
||||||
uint8_t *p_output,
|
|
||||||
size_t output_size,
|
|
||||||
size_t *p_output_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the finish operation of transparent-key
|
|
||||||
* block cipher operations.
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_finish_<CIPHER_NAME>_<MODE>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where
|
|
||||||
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
|
||||||
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started cipher operation
|
|
||||||
* \param[out] p_output A caller-allocated buffer where the generated
|
|
||||||
* output will be placed
|
|
||||||
* \param[in] output_size The size in bytes of the `p_output` buffer
|
|
||||||
* \param[out] p_output_length After completion, will contain the number of
|
|
||||||
* bytes placed in the `p_output` buffer
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_cipher_transparent_finish_t)(psa_drv_cipher_transparent_context_t *p_context,
|
|
||||||
uint8_t *p_output,
|
|
||||||
size_t output_size,
|
|
||||||
size_t *p_output_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the abort operation of transparent-key
|
|
||||||
* block cipher operations.
|
|
||||||
*
|
|
||||||
* Functions that implement the following prototype should be named in the
|
|
||||||
* following convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_cipher_transparent_abort_<CIPHER_NAME>_<MODE>
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where
|
|
||||||
* - `CIPHER_NAME` is the name of the underlying block cipher (i.e. AES or DES)
|
|
||||||
* - `MODE` is the block mode of the cipher operation (i.e. CBC or CTR)
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started cipher operation
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_cipher_transparent_abort_t)(psa_drv_cipher_transparent_context_t *p_context);
|
|
||||||
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
/** \defgroup driver_digest Message Digests
|
|
||||||
*
|
|
||||||
* Generation and authentication of Message Digests (aka hashes) must be done
|
|
||||||
* in parts using the following sequence:
|
|
||||||
* - `psa_drv_hash_setup_t`
|
|
||||||
* - `psa_drv_hash_update_t`
|
|
||||||
* - ...
|
|
||||||
* - `psa_drv_hash_finish_t`
|
|
||||||
*
|
|
||||||
* If a previously started Message Digest operation needs to be terminated
|
|
||||||
* before the `psa_drv_hash_finish_t` operation is complete, it should be aborted
|
|
||||||
* by the `psa_drv_hash_abort_t`. Failure to do so may result in allocated
|
|
||||||
* resources not being freed or in other undefined behavior.
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/** \brief The hardware-specific hash context structure
|
|
||||||
*
|
|
||||||
* The contents of this structure are implementation dependent and are
|
|
||||||
* therefore not described here
|
|
||||||
*/
|
|
||||||
typedef struct psa_drv_hash_context_s psa_drv_hash_context_t;
|
|
||||||
|
|
||||||
/** \brief The function prototype for the start operation of a hash (message
|
|
||||||
* digest) operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_hash_<ALGO>_setup
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying hash function
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A structure that will contain the
|
|
||||||
* hardware-specific hash context
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS Success.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_hash_setup_t)(psa_drv_hash_context_t *p_context);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the update operation of a hash (message
|
|
||||||
* digest) operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_hash_<ALGO>_update
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously-established hash operation to be
|
|
||||||
* continued
|
|
||||||
* \param[in] p_input A buffer containing the message to be appended
|
|
||||||
* to the hash operation
|
|
||||||
* \param[in] input_length The size in bytes of the input message buffer
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_hash_update_t)(psa_drv_hash_context_t *p_context,
|
|
||||||
const uint8_t *p_input,
|
|
||||||
size_t input_length);
|
|
||||||
|
|
||||||
/** \brief The prototype for the finish operation of a hash (message digest)
|
|
||||||
* operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_hash_<ALGO>_finish
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the
|
|
||||||
* previously started hash operation to be
|
|
||||||
* fiinished
|
|
||||||
* \param[out] p_output A buffer where the generated digest will be
|
|
||||||
* placed
|
|
||||||
* \param[in] output_size The size in bytes of the buffer that has been
|
|
||||||
* allocated for the `p_output` buffer
|
|
||||||
* \param[out] p_output_length The number of bytes placed in `p_output` after
|
|
||||||
* success
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* Success.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_hash_finish_t)(psa_drv_hash_context_t *p_context,
|
|
||||||
uint8_t *p_output,
|
|
||||||
size_t output_size,
|
|
||||||
size_t *p_output_length);
|
|
||||||
|
|
||||||
/** \brief The function prototype for the abort operation of a hash (message
|
|
||||||
* digest) operation
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_hash_<ALGO>_abort
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the underlying algorithm
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure for the previously
|
|
||||||
* started hash operation to be aborted
|
|
||||||
*/
|
|
||||||
typedef void (*psa_drv_hash_abort_t)(psa_drv_hash_context_t *p_context);
|
|
||||||
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
|
|
||||||
/** \defgroup opaque_asymmetric Opaque Asymmetric Cryptography
|
/** \defgroup opaque_asymmetric Opaque Asymmetric Cryptography
|
||||||
*
|
*
|
||||||
* Since the amount of data that can (or should) be encrypted or signed using
|
* Since the amount of data that can (or should) be encrypted or signed using
|
||||||
|
|
@ -1033,176 +564,6 @@ typedef struct {
|
||||||
|
|
||||||
/**@}*/
|
/**@}*/
|
||||||
|
|
||||||
/** \defgroup transparent_asymmetric Transparent Asymmetric Cryptography
|
|
||||||
*
|
|
||||||
* Since the amount of data that can (or should) be encrypted or signed using
|
|
||||||
* asymmetric keys is limited by the key size, asymmetric key operations using
|
|
||||||
* transparent keys must be done in single function calls.
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief A function that signs a hash or short message with a transparent
|
|
||||||
* asymmetric private key
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_asymmetric_<ALGO>_sign
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the signing algorithm
|
|
||||||
*
|
|
||||||
* \param[in] p_key A buffer containing the private key
|
|
||||||
* material
|
|
||||||
* \param[in] key_size The size in bytes of the `p_key` data
|
|
||||||
* \param[in] alg A signature algorithm that is compatible
|
|
||||||
* with the type of `p_key`
|
|
||||||
* \param[in] p_hash The hash or message to sign
|
|
||||||
* \param[in] hash_length Size of the `p_hash` buffer in bytes
|
|
||||||
* \param[out] p_signature Buffer where the signature is to be written
|
|
||||||
* \param[in] signature_size Size of the `p_signature` buffer in bytes
|
|
||||||
* \param[out] p_signature_length On success, the number of bytes
|
|
||||||
* that make up the returned signature value
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_asymmetric_transparent_sign_t)(const uint8_t *p_key,
|
|
||||||
size_t key_size,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *p_hash,
|
|
||||||
size_t hash_length,
|
|
||||||
uint8_t *p_signature,
|
|
||||||
size_t signature_size,
|
|
||||||
size_t *p_signature_length);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief A function that verifies the signature a hash or short message using
|
|
||||||
* a transparent asymmetric public key
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_asymmetric_<ALGO>_verify
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the signing algorithm
|
|
||||||
*
|
|
||||||
* \param[in] p_key A buffer containing the public key material
|
|
||||||
* \param[in] key_size The size in bytes of the `p_key` data
|
|
||||||
* \param[in] alg A signature algorithm that is compatible with
|
|
||||||
* the type of `key`
|
|
||||||
* \param[in] p_hash The hash or message whose signature is to be
|
|
||||||
* verified
|
|
||||||
* \param[in] hash_length Size of the `p_hash` buffer in bytes
|
|
||||||
* \param[in] p_signature Buffer containing the signature to verify
|
|
||||||
* \param[in] signature_length Size of the `p_signature` buffer in bytes
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
* The signature is valid.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_asymmetric_transparent_verify_t)(const uint8_t *p_key,
|
|
||||||
size_t key_size,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *p_hash,
|
|
||||||
size_t hash_length,
|
|
||||||
const uint8_t *p_signature,
|
|
||||||
size_t signature_length);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief A function that encrypts a short message with a transparent
|
|
||||||
* asymmetric public key
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_asymmetric_<ALGO>_encrypt
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the encryption algorithm
|
|
||||||
*
|
|
||||||
* \param[in] p_key A buffer containing the public key material
|
|
||||||
* \param[in] key_size The size in bytes of the `p_key` data
|
|
||||||
* \param[in] alg An asymmetric encryption algorithm that is
|
|
||||||
* compatible with the type of `key`
|
|
||||||
* \param[in] p_input The message to encrypt
|
|
||||||
* \param[in] input_length Size of the `p_input` buffer in bytes
|
|
||||||
* \param[in] p_salt A salt or label, if supported by the
|
|
||||||
* encryption algorithm
|
|
||||||
* If the algorithm does not support a
|
|
||||||
* salt, pass `NULL`
|
|
||||||
* If the algorithm supports an optional
|
|
||||||
* salt and you do not want to pass a salt,
|
|
||||||
* pass `NULL`.
|
|
||||||
* For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
|
|
||||||
* supported.
|
|
||||||
* \param[in] salt_length Size of the `p_salt` buffer in bytes
|
|
||||||
* If `p_salt` is `NULL`, pass 0.
|
|
||||||
* \param[out] p_output Buffer where the encrypted message is to
|
|
||||||
* be written
|
|
||||||
* \param[in] output_size Size of the `p_output` buffer in bytes
|
|
||||||
* \param[out] p_output_length On success, the number of bytes
|
|
||||||
* that make up the returned output
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_asymmetric_transparent_encrypt_t)(const uint8_t *p_key,
|
|
||||||
size_t key_size,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *p_input,
|
|
||||||
size_t input_length,
|
|
||||||
const uint8_t *p_salt,
|
|
||||||
size_t salt_length,
|
|
||||||
uint8_t *p_output,
|
|
||||||
size_t output_size,
|
|
||||||
size_t *p_output_length);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Decrypt a short message with a transparent asymmetric private key
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_asymmetric_<ALGO>_decrypt
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the encryption algorithm
|
|
||||||
*
|
|
||||||
* \param[in] p_key A buffer containing the private key material
|
|
||||||
* \param[in] key_size The size in bytes of the `p_key` data
|
|
||||||
* \param[in] alg An asymmetric encryption algorithm that is
|
|
||||||
* compatible with the type of `key`
|
|
||||||
* \param[in] p_input The message to decrypt
|
|
||||||
* \param[in] input_length Size of the `p_input` buffer in bytes
|
|
||||||
* \param[in] p_salt A salt or label, if supported by the
|
|
||||||
* encryption algorithm
|
|
||||||
* If the algorithm does not support a
|
|
||||||
* salt, pass `NULL`.
|
|
||||||
* If the algorithm supports an optional
|
|
||||||
* salt and you do not want to pass a salt,
|
|
||||||
* pass `NULL`.
|
|
||||||
* For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
|
|
||||||
* supported
|
|
||||||
* \param[in] salt_length Size of the `p_salt` buffer in bytes
|
|
||||||
* If `p_salt` is `NULL`, pass 0
|
|
||||||
* \param[out] p_output Buffer where the decrypted message is to
|
|
||||||
* be written
|
|
||||||
* \param[in] output_size Size of the `p_output` buffer in bytes
|
|
||||||
* \param[out] p_output_length On success, the number of bytes
|
|
||||||
* that make up the returned output
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_asymmetric_transparent_decrypt_t)(const uint8_t *p_key,
|
|
||||||
size_t key_size,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *p_input,
|
|
||||||
size_t input_length,
|
|
||||||
const uint8_t *p_salt,
|
|
||||||
size_t salt_length,
|
|
||||||
uint8_t *p_output,
|
|
||||||
size_t output_size,
|
|
||||||
size_t *p_output_length);
|
|
||||||
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
/** \defgroup aead_opaque AEAD Opaque
|
/** \defgroup aead_opaque AEAD Opaque
|
||||||
* Authenticated Encryption with Additional Data (AEAD) operations with opaque
|
* Authenticated Encryption with Additional Data (AEAD) operations with opaque
|
||||||
* keys must be done in one function call. While this creates a burden for
|
* keys must be done in one function call. While this creates a burden for
|
||||||
|
|
@ -1310,192 +671,6 @@ typedef struct {
|
||||||
} psa_drv_aead_opaque_t;
|
} psa_drv_aead_opaque_t;
|
||||||
/**@}*/
|
/**@}*/
|
||||||
|
|
||||||
/** \defgroup aead_transparent AEAD Transparent
|
|
||||||
*
|
|
||||||
* Authenticated Encryption with Additional Data (AEAD) operations with
|
|
||||||
* transparent keys must be done in one function call. While this creates a
|
|
||||||
* burden for implementers as there must be sufficient space in memory for the
|
|
||||||
* entire message, it prevents decrypted data from being made available before
|
|
||||||
* the authentication operation is complete and the data is known to be
|
|
||||||
* authentic.
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/** Process an authenticated encryption operation using an opaque key.
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_aead_<ALGO>_encrypt
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the AEAD algorithm
|
|
||||||
*
|
|
||||||
* \param[in] p_key A pointer to the key material
|
|
||||||
* \param[in] key_length The size in bytes of the key material
|
|
||||||
* \param[in] alg The AEAD algorithm to compute
|
|
||||||
* (\c PSA_ALG_XXX value such that
|
|
||||||
* #PSA_ALG_IS_AEAD(`alg`) is true)
|
|
||||||
* \param[in] nonce Nonce or IV to use
|
|
||||||
* \param[in] nonce_length Size of the `nonce` buffer in bytes
|
|
||||||
* \param[in] additional_data Additional data that will be MACed
|
|
||||||
* but not encrypted.
|
|
||||||
* \param[in] additional_data_length Size of `additional_data` in bytes
|
|
||||||
* \param[in] plaintext Data that will be MACed and
|
|
||||||
* encrypted.
|
|
||||||
* \param[in] plaintext_length Size of `plaintext` in bytes
|
|
||||||
* \param[out] ciphertext Output buffer for the authenticated and
|
|
||||||
* encrypted data. The additional data is
|
|
||||||
* not part of this output. For algorithms
|
|
||||||
* where the encrypted data and the
|
|
||||||
* authentication tag are defined as
|
|
||||||
* separate outputs, the authentication
|
|
||||||
* tag is appended to the encrypted data.
|
|
||||||
* \param[in] ciphertext_size Size of the `ciphertext` buffer in
|
|
||||||
* bytes
|
|
||||||
* This must be at least
|
|
||||||
* #PSA_AEAD_ENCRYPT_OUTPUT_SIZE(`alg`,
|
|
||||||
* `plaintext_length`).
|
|
||||||
* \param[out] ciphertext_length On success, the size of the output in
|
|
||||||
* the `ciphertext` buffer
|
|
||||||
*
|
|
||||||
* \retval #PSA_SUCCESS
|
|
||||||
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_aead_transparent_encrypt_t)(const uint8_t *p_key,
|
|
||||||
size_t key_length,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *nonce,
|
|
||||||
size_t nonce_length,
|
|
||||||
const uint8_t *additional_data,
|
|
||||||
size_t additional_data_length,
|
|
||||||
const uint8_t *plaintext,
|
|
||||||
size_t plaintext_length,
|
|
||||||
uint8_t *ciphertext,
|
|
||||||
size_t ciphertext_size,
|
|
||||||
size_t *ciphertext_length);
|
|
||||||
|
|
||||||
/** Process an authenticated decryption operation using an opaque key.
|
|
||||||
*
|
|
||||||
* Functions that implement the prototype should be named in the following
|
|
||||||
* convention:
|
|
||||||
* ~~~~~~~~~~~~~{.c}
|
|
||||||
* psa_drv_aead_<ALGO>_decrypt
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
* Where `ALGO` is the name of the AEAD algorithm
|
|
||||||
* \param[in] p_key A pointer to the key material
|
|
||||||
* \param[in] key_length The size in bytes of the key material
|
|
||||||
* \param[in] alg The AEAD algorithm to compute
|
|
||||||
* (\c PSA_ALG_XXX value such that
|
|
||||||
* #PSA_ALG_IS_AEAD(`alg`) is true)
|
|
||||||
* \param[in] nonce Nonce or IV to use
|
|
||||||
* \param[in] nonce_length Size of the `nonce` buffer in bytes
|
|
||||||
* \param[in] additional_data Additional data that has been MACed
|
|
||||||
* but not encrypted
|
|
||||||
* \param[in] additional_data_length Size of `additional_data` in bytes
|
|
||||||
* \param[in] ciphertext Data that has been MACed and
|
|
||||||
* encrypted
|
|
||||||
* For algorithms where the encrypted data
|
|
||||||
* and the authentication tag are defined
|
|
||||||
* as separate inputs, the buffer must
|
|
||||||
* contain the encrypted data followed by
|
|
||||||
* the authentication tag.
|
|
||||||
* \param[in] ciphertext_length Size of `ciphertext` in bytes
|
|
||||||
* \param[out] plaintext Output buffer for the decrypted data
|
|
||||||
* \param[in] plaintext_size Size of the `plaintext` buffer in
|
|
||||||
* bytes
|
|
||||||
* This must be at least
|
|
||||||
* #PSA_AEAD_DECRYPT_OUTPUT_SIZE(`alg`,
|
|
||||||
* `ciphertext_length`).
|
|
||||||
* \param[out] plaintext_length On success, the size of the output
|
|
||||||
* in the \b plaintext buffer
|
|
||||||
*
|
|
||||||
* \retval #PSA_SUCCESS
|
|
||||||
* Success.
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_aead_transparent_decrypt_t)(const uint8_t *p_key,
|
|
||||||
size_t key_length,
|
|
||||||
psa_algorithm_t alg,
|
|
||||||
const uint8_t *nonce,
|
|
||||||
size_t nonce_length,
|
|
||||||
const uint8_t *additional_data,
|
|
||||||
size_t additional_data_length,
|
|
||||||
const uint8_t *ciphertext,
|
|
||||||
size_t ciphertext_length,
|
|
||||||
uint8_t *plaintext,
|
|
||||||
size_t plaintext_size,
|
|
||||||
size_t *plaintext_length);
|
|
||||||
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
|
|
||||||
/** \defgroup driver_rng Entropy Generation
|
|
||||||
*/
|
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/** \brief A hardware-specific structure for a entropy providing hardware
|
|
||||||
*/
|
|
||||||
typedef struct psa_drv_entropy_context_s psa_drv_entropy_context_t;
|
|
||||||
|
|
||||||
/** \brief Initialize an entropy driver
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure
|
|
||||||
* containing any context information for
|
|
||||||
* the implementation
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_entropy_init_t)(psa_drv_entropy_context_t *p_context);
|
|
||||||
|
|
||||||
/** \brief Get a specified number of bits from the entropy source
|
|
||||||
*
|
|
||||||
* It retrives `buffer_size` bytes of data from the entropy source. The entropy
|
|
||||||
* source will always fill the provided buffer to its full size, however, most
|
|
||||||
* entropy sources have biases, and the actual amount of entropy contained in
|
|
||||||
* the buffer will be less than the number of bytes.
|
|
||||||
* The driver will return the actual number of bytes of entropy placed in the
|
|
||||||
* buffer in `p_received_entropy_bytes`.
|
|
||||||
* A PSA Crypto API implementation will likely feed the output of this function
|
|
||||||
* into a Digital Random Bit Generator (DRBG), and typically has a minimum
|
|
||||||
* amount of entropy that it needs.
|
|
||||||
* To accomplish this, the PSA Crypto implementation should be designed to call
|
|
||||||
* this function multiple times until it has received the required amount of
|
|
||||||
* entropy from the entropy source.
|
|
||||||
*
|
|
||||||
* \param[in,out] p_context A hardware-specific structure
|
|
||||||
* containing any context information
|
|
||||||
* for the implementation
|
|
||||||
* \param[out] p_buffer A caller-allocated buffer for the
|
|
||||||
* retrieved entropy to be placed in
|
|
||||||
* \param[in] buffer_size The allocated size of `p_buffer`
|
|
||||||
* \param[out] p_received_entropy_bits The amount of entropy (in bits)
|
|
||||||
* actually provided in `p_buffer`
|
|
||||||
*
|
|
||||||
* \retval PSA_SUCCESS
|
|
||||||
*/
|
|
||||||
typedef psa_status_t (*psa_drv_entropy_get_bits_t)(psa_drv_entropy_context_t *p_context,
|
|
||||||
uint8_t *p_buffer,
|
|
||||||
uint32_t buffer_size,
|
|
||||||
uint32_t *p_received_entropy_bits);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief A struct containing all of the function pointers needed to interface
|
|
||||||
* to an entropy source
|
|
||||||
*
|
|
||||||
* PSA Crypto API implementations should populate instances of the table as
|
|
||||||
* appropriate upon startup.
|
|
||||||
*
|
|
||||||
* If one of the functions is not implemented, it should be set to NULL.
|
|
||||||
*/
|
|
||||||
typedef struct {
|
|
||||||
/** Function that performs initialization for the entropy source */
|
|
||||||
psa_drv_entropy_init_t *p_init;
|
|
||||||
/** Function that performs the get_bits operation for the entropy source
|
|
||||||
*/
|
|
||||||
psa_drv_entropy_get_bits_t *p_get_bits;
|
|
||||||
} psa_drv_entropy_t;
|
|
||||||
/**@}*/
|
|
||||||
|
|
||||||
/** \defgroup driver_key_management Key Management
|
/** \defgroup driver_key_management Key Management
|
||||||
* Currently, key management is limited to importing keys in the clear,
|
* Currently, key management is limited to importing keys in the clear,
|
||||||
* destroying keys, and exporting keys in the clear.
|
* destroying keys, and exporting keys in the clear.
|
||||||
|
|
@ -1784,4 +959,4 @@ typedef struct {
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif /* PSA_CRYPTO_DRIVER_H */
|
#endif /* PSA_CRYPTO_SE_DRIVER_H */
|
||||||
|
|
@ -50,6 +50,42 @@
|
||||||
#include MBEDTLS_CONFIG_FILE
|
#include MBEDTLS_CONFIG_FILE
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#define PSA_BITS_TO_BYTES(bits) (((bits) + 7) / 8)
|
||||||
|
#define PSA_BYTES_TO_BITS(bytes) ((bytes) * 8)
|
||||||
|
|
||||||
|
/** The size of the output of psa_hash_finish(), in bytes.
|
||||||
|
*
|
||||||
|
* This is also the hash size that psa_hash_verify() expects.
|
||||||
|
*
|
||||||
|
* \param alg A hash algorithm (\c PSA_ALG_XXX value such that
|
||||||
|
* #PSA_ALG_IS_HASH(\p alg) is true), or an HMAC algorithm
|
||||||
|
* (#PSA_ALG_HMAC(\c hash_alg) where \c hash_alg is a
|
||||||
|
* hash algorithm).
|
||||||
|
*
|
||||||
|
* \return The hash size for the specified hash algorithm.
|
||||||
|
* If the hash algorithm is not recognized, return 0.
|
||||||
|
* An implementation may return either 0 or the correct size
|
||||||
|
* for a hash algorithm that it recognizes, but does not support.
|
||||||
|
*/
|
||||||
|
#define PSA_HASH_SIZE(alg) \
|
||||||
|
( \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_MD2 ? 16 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_MD4 ? 16 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_MD5 ? 16 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_RIPEMD160 ? 20 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_1 ? 20 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_224 ? 28 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_256 ? 32 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_384 ? 48 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512 ? 64 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_224 ? 28 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA_512_256 ? 32 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_224 ? 28 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_256 ? 32 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_384 ? 48 : \
|
||||||
|
PSA_ALG_HMAC_GET_HASH(alg) == PSA_ALG_SHA3_512 ? 64 : \
|
||||||
|
0)
|
||||||
|
|
||||||
/** \def PSA_HASH_MAX_SIZE
|
/** \def PSA_HASH_MAX_SIZE
|
||||||
*
|
*
|
||||||
* Maximum size of a hash.
|
* Maximum size of a hash.
|
||||||
|
|
@ -84,6 +120,26 @@
|
||||||
*/
|
*/
|
||||||
#define PSA_MAC_MAX_SIZE PSA_HASH_MAX_SIZE
|
#define PSA_MAC_MAX_SIZE PSA_HASH_MAX_SIZE
|
||||||
|
|
||||||
|
/** The tag size for an AEAD algorithm, in bytes.
|
||||||
|
*
|
||||||
|
* \param alg An AEAD algorithm
|
||||||
|
* (\c PSA_ALG_XXX value such that
|
||||||
|
* #PSA_ALG_IS_AEAD(\p alg) is true).
|
||||||
|
*
|
||||||
|
* \return The tag size for the specified algorithm.
|
||||||
|
* If the AEAD algorithm does not have an identified
|
||||||
|
* tag that can be distinguished from the rest of
|
||||||
|
* the ciphertext, return 0.
|
||||||
|
* If the AEAD algorithm is not recognized, return 0.
|
||||||
|
* An implementation may return either 0 or a
|
||||||
|
* correct size for an AEAD algorithm that it
|
||||||
|
* recognizes, but does not support.
|
||||||
|
*/
|
||||||
|
#define PSA_AEAD_TAG_LENGTH(alg) \
|
||||||
|
(PSA_ALG_IS_AEAD(alg) ? \
|
||||||
|
(((alg) & PSA_ALG_AEAD_TAG_LENGTH_MASK) >> PSA_AEAD_TAG_LENGTH_OFFSET) : \
|
||||||
|
0)
|
||||||
|
|
||||||
/* The maximum size of an RSA key on this implementation, in bits.
|
/* The maximum size of an RSA key on this implementation, in bits.
|
||||||
* This is a vendor-specific macro.
|
* This is a vendor-specific macro.
|
||||||
*
|
*
|
||||||
|
|
@ -236,6 +292,22 @@
|
||||||
(plaintext_length) - PSA_AEAD_TAG_LENGTH(alg) : \
|
(plaintext_length) - PSA_AEAD_TAG_LENGTH(alg) : \
|
||||||
0)
|
0)
|
||||||
|
|
||||||
|
#define PSA_RSA_MINIMUM_PADDING_SIZE(alg) \
|
||||||
|
(PSA_ALG_IS_RSA_OAEP(alg) ? \
|
||||||
|
2 * PSA_HASH_FINAL_SIZE(PSA_ALG_RSA_OAEP_GET_HASH(alg)) + 1 : \
|
||||||
|
11 /*PKCS#1v1.5*/)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief ECDSA signature size for a given curve bit size
|
||||||
|
*
|
||||||
|
* \param curve_bits Curve size in bits.
|
||||||
|
* \return Signature size in bytes.
|
||||||
|
*
|
||||||
|
* \note This macro returns a compile-time constant if its argument is one.
|
||||||
|
*/
|
||||||
|
#define PSA_ECDSA_SIGNATURE_SIZE(curve_bits) \
|
||||||
|
(PSA_BITS_TO_BYTES(curve_bits) * 2)
|
||||||
|
|
||||||
/** Safe signature buffer size for psa_asymmetric_sign().
|
/** Safe signature buffer size for psa_asymmetric_sign().
|
||||||
*
|
*
|
||||||
* This macro returns a safe buffer size for a signature using a key
|
* This macro returns a safe buffer size for a signature using a key
|
||||||
|
|
|
||||||
101
include/psa/crypto_types.h
Normal file
101
include/psa/crypto_types.h
Normal file
|
|
@ -0,0 +1,101 @@
|
||||||
|
/**
|
||||||
|
* \file psa/crypto_types.h
|
||||||
|
*
|
||||||
|
* \brief PSA cryptography module: type aliases.
|
||||||
|
*
|
||||||
|
* \note This file may not be included directly. Applications must
|
||||||
|
* include psa/crypto.h. Drivers must include the appropriate driver
|
||||||
|
* header file.
|
||||||
|
*
|
||||||
|
* This file contains portable definitions of integral types for properties
|
||||||
|
* of cryptographic keys, designations of cryptographic algorithms, and
|
||||||
|
* error codes returned by the library.
|
||||||
|
*
|
||||||
|
* This header file does not declare any function.
|
||||||
|
*/
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2018, ARM Limited, All Rights Reserved
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
* This file is part of mbed TLS (https://tls.mbed.org)
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef PSA_CRYPTO_TYPES_H
|
||||||
|
#define PSA_CRYPTO_TYPES_H
|
||||||
|
|
||||||
|
#include <stdint.h>
|
||||||
|
|
||||||
|
/** \defgroup error Error codes
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Function return status.
|
||||||
|
*
|
||||||
|
* This is either #PSA_SUCCESS (which is zero), indicating success,
|
||||||
|
* or a nonzero value indicating that an error occurred. Errors are
|
||||||
|
* encoded as one of the \c PSA_ERROR_xxx values defined here.
|
||||||
|
*/
|
||||||
|
typedef int32_t psa_status_t;
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup crypto_types Key and algorithm types
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** \brief Encoding of a key type.
|
||||||
|
*/
|
||||||
|
typedef uint32_t psa_key_type_t;
|
||||||
|
|
||||||
|
/** The type of PSA elliptic curve identifiers. */
|
||||||
|
typedef uint16_t psa_ecc_curve_t;
|
||||||
|
|
||||||
|
/** \brief Encoding of a cryptographic algorithm.
|
||||||
|
*
|
||||||
|
* For algorithms that can be applied to multiple key types, this type
|
||||||
|
* does not encode the key type. For example, for symmetric ciphers
|
||||||
|
* based on a block cipher, #psa_algorithm_t encodes the block cipher
|
||||||
|
* mode and the padding mode while the block cipher itself is encoded
|
||||||
|
* via #psa_key_type_t.
|
||||||
|
*/
|
||||||
|
typedef uint32_t psa_algorithm_t;
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup key_lifetimes Key lifetimes
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Encoding of key lifetimes.
|
||||||
|
*/
|
||||||
|
typedef uint32_t psa_key_lifetime_t;
|
||||||
|
|
||||||
|
/** Encoding of identifiers of persistent keys.
|
||||||
|
*/
|
||||||
|
typedef uint32_t psa_key_id_t;
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
/** \defgroup policy Key policies
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** \brief Encoding of permitted usage on a key. */
|
||||||
|
typedef uint32_t psa_key_usage_t;
|
||||||
|
|
||||||
|
/**@}*/
|
||||||
|
|
||||||
|
#endif /* PSA_CRYPTO_TYPES_H */
|
||||||
1420
include/psa/crypto_values.h
Normal file
1420
include/psa/crypto_values.h
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -103,7 +103,7 @@ EXTRA_GENERATED += psa/psa_constant_names_generated.c
|
||||||
endif
|
endif
|
||||||
|
|
||||||
psa/psa_constant_names$(EXEXT): psa/psa_constant_names_generated.c
|
psa/psa_constant_names$(EXEXT): psa/psa_constant_names_generated.c
|
||||||
psa/psa_constant_names_generated.c: ../scripts/generate_psa_constants.py ../include/psa/crypto.h
|
psa/psa_constant_names_generated.c: ../scripts/generate_psa_constants.py ../include/psa/crypto_values.h
|
||||||
../scripts/generate_psa_constants.py
|
../scripts/generate_psa_constants.py
|
||||||
|
|
||||||
aes/aescrypt2$(EXEXT): aes/aescrypt2.c $(DEP)
|
aes/aescrypt2$(EXEXT): aes/aescrypt2.c $(DEP)
|
||||||
|
|
|
||||||
|
|
@ -285,5 +285,5 @@ def generate_psa_constants(header_file_name, output_file_name):
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
if not os.path.isdir('programs') and os.path.isdir('../programs'):
|
if not os.path.isdir('programs') and os.path.isdir('../programs'):
|
||||||
os.chdir('..')
|
os.chdir('..')
|
||||||
generate_psa_constants('include/psa/crypto.h',
|
generate_psa_constants('include/psa/crypto_values.h',
|
||||||
'programs/psa/psa_constant_names_generated.c')
|
'programs/psa/psa_constant_names_generated.c')
|
||||||
|
|
|
||||||
|
|
@ -226,11 +226,16 @@
|
||||||
<ClInclude Include="..\..\include\mbedtls\x509_csr.h" />
|
<ClInclude Include="..\..\include\mbedtls\x509_csr.h" />
|
||||||
<ClInclude Include="..\..\include\mbedtls\xtea.h" />
|
<ClInclude Include="..\..\include\mbedtls\xtea.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto.h" />
|
<ClInclude Include="..\..\include\psa\crypto.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto_driver.h" />
|
<ClInclude Include="..\..\include\psa\crypto_accel_driver.h" />
|
||||||
|
<ClInclude Include="..\..\include\psa\crypto_driver_common.h" />
|
||||||
|
<ClInclude Include="..\..\include\psa\crypto_entropy_driver.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto_extra.h" />
|
<ClInclude Include="..\..\include\psa\crypto_extra.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto_platform.h" />
|
<ClInclude Include="..\..\include\psa\crypto_platform.h" />
|
||||||
|
<ClInclude Include="..\..\include\psa\crypto_se_driver.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto_sizes.h" />
|
<ClInclude Include="..\..\include\psa\crypto_sizes.h" />
|
||||||
<ClInclude Include="..\..\include\psa\crypto_struct.h" />
|
<ClInclude Include="..\..\include\psa\crypto_struct.h" />
|
||||||
|
<ClInclude Include="..\..\include\psa\crypto_types.h" />
|
||||||
|
<ClInclude Include="..\..\include\psa\crypto_values.h" />
|
||||||
<ClInclude Include="..\..\library/psa_crypto_core.h" />
|
<ClInclude Include="..\..\library/psa_crypto_core.h" />
|
||||||
<ClInclude Include="..\..\library/psa_crypto_invasive.h" />
|
<ClInclude Include="..\..\library/psa_crypto_invasive.h" />
|
||||||
<ClInclude Include="..\..\library/psa_crypto_slot_management.h" />
|
<ClInclude Include="..\..\library/psa_crypto_slot_management.h" />
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue