mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-02-26 12:39:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve alignment in comments

Browse Source
This commit is contained in:
Gilles Peskine 2019-07-25 10:56:39 +02:00
parent f77a6acf83
commit 6a3dd89a64
1 changed files with 65 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
include/psa/crypto_se_driver.h
View File

@ -59,7 +59,7 @@ typedef struct {
* session to the next. * session to the next.
* *
* The core allocates a memory buffer for the persistent data. * The core allocates a memory buffer for the persistent data.
* The pointer is guaranteed to be suitably alignedfor any data type, * The pointer is guaranteed to be suitably aligned for any data type,
* like a pointer returned by `malloc` (but the core can use any * like a pointer returned by `malloc` (but the core can use any
* method to allocate the buffer, not necessarily `malloc`). * method to allocate the buffer, not necessarily `malloc`).
* *
@ -164,7 +164,7 @@ typedef psa_status_t (*psa_drv_se_mac_setup_t)(psa_drv_se_context_t *drv_context
* updated * updated
* \param[in] p_input A buffer containing the message to be appended * \param[in] p_input A buffer containing the message to be appended
* to the MAC operation * to the MAC operation
* \param[in] input_length The size in bytes of the input message buffer * \param[in] input_length The size in bytes of the input message buffer
*/ */
typedef psa_status_t (*psa_drv_se_mac_update_t)(void *op_context, typedef psa_status_t (*psa_drv_se_mac_update_t)(void *op_context,
const uint8_t *p_input, const uint8_t *p_input,
@ -195,10 +195,10 @@ typedef psa_status_t (*psa_drv_se_mac_finish_t)(void *op_context,
* operation by comparing the resulting MAC against a provided value * operation by comparing the resulting MAC against a provided value
* *
* \param[in,out] op_context A hardware-specific structure for the previously * \param[in,out] op_context A hardware-specific structure for the previously
* started MAC operation to be fiinished * started MAC operation to be fiinished
* \param[in] p_mac The MAC value against which the resulting MAC will * \param[in] p_mac The MAC value against which the resulting MAC
* be compared against * will be compared against
* \param[in] mac_length The size in bytes of the value stored in `p_mac` * \param[in] mac_length The size in bytes of the value stored in `p_mac`
* *
* \retval PSA_SUCCESS * \retval PSA_SUCCESS
* The operation completed successfully and the MACs matched each * The operation completed successfully and the MACs matched each
@ -215,14 +215,14 @@ typedef psa_status_t (*psa_drv_se_mac_finish_verify_t)(void *op_context,
* operation * operation
* *
* \param[in,out] op_context A hardware-specific structure for the previously * \param[in,out] op_context A hardware-specific structure for the previously
* started MAC operation to be aborted * started MAC operation to be aborted
*/ */
typedef psa_status_t (*psa_drv_se_mac_abort_t)(void *op_context); typedef psa_status_t (*psa_drv_se_mac_abort_t)(void *op_context);
/** \brief A function that performs a secure element MAC operation in one /** \brief A function that performs a secure element MAC operation in one
* command and returns the calculated MAC * command and returns the calculated MAC
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] p_input A buffer containing the message to be MACed * \param[in] p_input A buffer containing the message to be MACed
* \param[in] input_length The size in bytes of `p_input` * \param[in] input_length The size in bytes of `p_input`
* \param[in] key_slot The slot of the key to be used * \param[in] key_slot The slot of the key to be used
@ -344,7 +344,7 @@ typedef struct {
/** \brief A function that provides the cipher setup function for a /** \brief A function that provides the cipher setup function for a
* secure element driver * secure element driver
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in,out] op_context A structure that will contain the * \param[in,out] op_context A structure that will contain the
* hardware-specific cipher context. * hardware-specific cipher context.
* \param[in] key_slot The slot of the key to be used for the * \param[in] key_slot The slot of the key to be used for the
@ -440,19 +440,19 @@ typedef psa_status_t (*psa_drv_se_cipher_abort_t)(void *op_context);
* Note: this function should only be used with implementations that do not * Note: this function should only be used with implementations that do not
* provide a needed higher-level operation. * provide a needed higher-level operation.
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot The slot of the key to be used for the operation * \param[in] key_slot The slot of the key to be used for the operation
* \param[in] algorithm The algorithm to be used in the cipher operation * \param[in] algorithm The algorithm to be used in the cipher operation
* \param[in] direction Indicates whether the operation is an encrypt or * \param[in] direction Indicates whether the operation is an encrypt or
* decrypt * decrypt
* \param[in] p_input A buffer containing the data to be * \param[in] p_input A buffer containing the data to be
* encrypted/decrypted * encrypted/decrypted
* \param[in] input_size The size in bytes of the buffer pointed to by * \param[in] input_size The size in bytes of the buffer pointed to by
* `p_input` * `p_input`
* \param[out] p_output The caller-allocated buffer where the output will * \param[out] p_output The caller-allocated buffer where the output
* be placed * will be placed
* \param[in] output_size The allocated size in bytes of the `p_output` * \param[in] output_size The allocated size in bytes of the `p_output`
* buffer * buffer
* *
* \retval PSA_SUCCESS * \retval PSA_SUCCESS
* \retval PSA_ERROR_NOT_SUPPORTED * \retval PSA_ERROR_NOT_SUPPORTED
@ -538,7 +538,7 @@ typedef psa_status_t (*psa_drv_se_asymmetric_sign_t)(psa_drv_se_context_t *drv_c
* \brief A function that verifies the signature a hash or short message using * \brief A function that verifies the signature a hash or short message using
* an asymmetric public key in a secure element * an asymmetric public key in a secure element
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Key slot of a public key or an asymmetric key * \param[in] key_slot Key slot of a public key or an asymmetric key
* pair * pair
* \param[in] alg A signature algorithm that is compatible with * \param[in] alg A signature algorithm that is compatible with
@ -563,7 +563,7 @@ typedef psa_status_t (*psa_drv_se_asymmetric_verify_t)(psa_drv_se_context_t *drv
* \brief A function that encrypts a short message with an asymmetric public * \brief A function that encrypts a short message with an asymmetric public
* key in a secure element * key in a secure element
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Key slot of a public key or an asymmetric key * \param[in] key_slot Key slot of a public key or an asymmetric key
* pair * pair
* \param[in] alg An asymmetric encryption algorithm that is * \param[in] alg An asymmetric encryption algorithm that is
@ -604,7 +604,7 @@ typedef psa_status_t (*psa_drv_se_asymmetric_encrypt_t)(psa_drv_se_context_t *dr
* \brief A function that decrypts a short message with an asymmetric private * \brief A function that decrypts a short message with an asymmetric private
* key in a secure element. * key in a secure element.
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Key slot of an asymmetric key pair * \param[in] key_slot Key slot of an asymmetric key pair
* \param[in] alg An asymmetric encryption algorithm that is * \param[in] alg An asymmetric encryption algorithm that is
* compatible with the type of `key` * compatible with the type of `key`
@ -674,7 +674,7 @@ typedef struct {
/** \brief A function that performs a secure element authenticated encryption /** \brief A function that performs a secure element authenticated encryption
* operation * operation
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Slot containing the key to use. * \param[in] key_slot Slot containing the key to use.
* \param[in] algorithm The AEAD algorithm to compute * \param[in] algorithm The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that * (\c PSA_ALG_XXX value such that
@ -717,7 +717,7 @@ typedef psa_status_t (*psa_drv_se_aead_encrypt_t)(psa_drv_se_context_t *drv_cont
/** A function that peforms a secure element authenticated decryption operation /** A function that peforms a secure element authenticated decryption operation
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Slot containing the key to use * \param[in] key_slot Slot containing the key to use
* \param[in] algorithm The AEAD algorithm to compute * \param[in] algorithm The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that * (\c PSA_ALG_XXX value such that
@ -787,10 +787,10 @@ typedef struct {
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in,out] persistent_data A pointer to the persistent data * \param[in,out] persistent_data A pointer to the persistent data
* that allows writing. * that allows writing.
* \param[in] attributes Attributes of the key. * \param[in] attributes Attributes of the key.
* \param[out] key_slot Slot where the key will be stored. * \param[out] key_slot Slot where the key will be stored.
* This must be a valid slot for a key of the * This must be a valid slot for a key of the
* chosen type. It must be unoccupied. * chosen type. It must be unoccupied.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
@ -810,16 +810,16 @@ typedef psa_status_t (*psa_drv_se_allocate_key_t)(
* This function can support any output from psa_export_key(). Refer to the * This function can support any output from psa_export_key(). Refer to the
* documentation of psa_export_key() for the format for each key type. * documentation of psa_export_key() for the format for each key type.
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Slot where the key will be stored * \param[in] key_slot Slot where the key will be stored
* This must be a valid slot for a key of the chosen * This must be a valid slot for a key of the chosen
* type. It must be unoccupied. * type. It must be unoccupied.
* \param[in] lifetime The required lifetime of the key storage * \param[in] lifetime The required lifetime of the key storage
* \param[in] type Key type (a \c PSA_KEY_TYPE_XXX value) * \param[in] type Key type (a \c PSA_KEY_TYPE_XXX value)
* \param[in] algorithm Key algorithm (a \c PSA_ALG_XXX value) * \param[in] algorithm Key algorithm (a \c PSA_ALG_XXX value)
* \param[in] usage The allowed uses of the key * \param[in] usage The allowed uses of the key
* \param[in] p_data Buffer containing the key data * \param[in] p_data Buffer containing the key data
* \param[in] data_length Size of the `data` buffer in bytes * \param[in] data_length Size of the `data` buffer in bytes
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
@ -846,7 +846,7 @@ typedef psa_status_t (*psa_drv_se_import_key_t)(psa_drv_se_context_t *drv_contex
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in,out] persistent_data A pointer to the persistent data * \param[in,out] persistent_data A pointer to the persistent data
* that allows writing. * that allows writing.
* \param key_slot The key slot to erase. * \param key_slot The key slot to erase.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* The slot's content, if any, has been erased. * The slot's content, if any, has been erased.
@ -871,7 +871,7 @@ typedef psa_status_t (*psa_drv_se_destroy_key_t)(
* `psa_export_key()` does. Refer to the * `psa_export_key()` does. Refer to the
* documentation of `psa_export_key()` for the format for each key type. * documentation of `psa_export_key()` for the format for each key type.
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key Slot whose content is to be exported. This must * \param[in] key Slot whose content is to be exported. This must
* be an occupied key slot. * be an occupied key slot.
* \param[out] p_data Buffer where the key data is to be written. * \param[out] p_data Buffer where the key data is to be written.
@ -902,22 +902,23 @@ typedef psa_status_t (*psa_drv_se_export_key_t)(psa_drv_se_context_t *drv_contex
* The format of the public key information will match the format specified for * The format of the public key information will match the format specified for
* the psa_export_key() function for the key type. * the psa_export_key() function for the key type.
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in] key_slot Slot where the generated key will be placed * \param[in] key_slot Slot where the generated key will be placed
* \param[in] type The type of the key to be generated * \param[in] type The type of the key to be generated
* \param[in] usage The prescribed usage of the generated key * \param[in] usage The prescribed usage of the generated key
* Note: Not all Secure Elements support the same * Note: Not all Secure Elements support the same
* restrictions that PSA Crypto does (and vice versa). * restrictions that PSA Crypto does (and vice
* Driver developers should endeavor to match the * versa).
* usages as close as possible. * Driver developers should endeavor to match the
* \param[in] bits The size in bits of the key to be generated. * usages as close as possible.
* \param[in] extra Extra parameters for key generation. The * \param[in] bits The size in bits of the key to be generated.
* interpretation of this parameter should match the * \param[in] extra Extra parameters for key generation. The
* interpretation in the `extra` parameter is the * interpretation of this parameter should match
* `psa_generate_key` function * the interpretation in the `extra` parameter is
* \param[in] extra_size The size in bytes of the \p extra buffer * the `psa_generate_key` function
* \param[out] p_pubkey_out The buffer where the public key information will * \param[in] extra_size The size in bytes of the \p extra buffer
* be placed * \param[out] p_pubkey_out The buffer where the public key information will
* be placed
* \param[in] pubkey_out_size The size in bytes of the `p_pubkey_out` buffer * \param[in] pubkey_out_size The size in bytes of the `p_pubkey_out` buffer
* \param[out] p_pubkey_length Upon successful completion, will contain the * \param[out] p_pubkey_length Upon successful completion, will contain the
* size of the data placed in `p_pubkey_out`. * size of the data placed in `p_pubkey_out`.
@ -1011,12 +1012,12 @@ typedef struct {
/** \brief A function that Sets up a secure element key derivation operation by /** \brief A function that Sets up a secure element key derivation operation by
* specifying the algorithm and the source key sot * specifying the algorithm and the source key sot
* *
* \param[in,out] drv_context The driver context structure. * \param[in,out] drv_context The driver context structure.
* \param[in,out] op_context A hardware-specific structure containing any * \param[in,out] op_context A hardware-specific structure containing any
* context information for the implementation * context information for the implementation
* \param[in] kdf_alg The algorithm to be used for the key derivation * \param[in] kdf_alg The algorithm to be used for the key derivation
* \param[in] source_key The key to be used as the source material for the * \param[in] source_key The key to be used as the source material for
* key derivation * the key derivation
* *
* \retval PSA_SUCCESS * \retval PSA_SUCCESS
*/ */