yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-12-23 18:35:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
mbedtls/include/psa/crypto.h

3782 lines
169 KiB
C
Raw Normal View History

Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
/**
* \file psa/crypto.h
* \brief Platform Security Architecture cryptography module
*/
psa: Add license header to crypto.h
2018-07-25 12:26:13 +00:00
/*
Update copyright notices to use Linux Foundation guidance As a result, the copyright of contributors other than Arm is now acknowledged, and the years of publishing are no longer tracked in the source files. Also remove the now-redundant lines declaring that the files are part of MbedTLS. This commit was generated using the following script: # ======================== #!/bin/sh # Find files find '(' -path './.git' -o -path './3rdparty' ')' -prune -o -type f -print | xargs sed -bi ' # Replace copyright attribution line s/Copyright.*Arm.*/Copyright The Mbed TLS Contributors/I # Remove redundant declaration and the preceding line $!N /This file is part of Mbed TLS/Id P D ' # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
2020-08-07 11:07:28 +00:00
* Copyright The Mbed TLS Contributors
psa: Add license header to crypto.h
2018-07-25 12:26:13 +00:00
* 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.
*/
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
#ifndef PSA_CRYPTO_H
#define PSA_CRYPTO_H
#include "crypto_platform.h"
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
#include <stddef.h>
Add a Doxygen-only section This is intended to document platform-specific definitions in PSA.
2018-02-07 20:54:47 +00:00
#ifdef __DOXYGEN_ONLY__
Documentation clarifications Clarify or add the documentation of some functions and constants. Add a note about what the __DOXYGEN_ONLY__ section is for.
2018-03-07 15:40:18 +00:00
/* This __DOXYGEN_ONLY__ block contains mock definitions for things that
* must be defined in the crypto_platform.h header. These mock definitions
* are present in this file as a convenience to generate pretty-printed
* documentation that includes those definitions. */
Add a Doxygen-only section This is intended to document platform-specific definitions in PSA.
2018-02-07 20:54:47 +00:00
/** \defgroup platform Implementation-specific definitions
* @{
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
/** \brief Key handle.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* This type represents open handles to keys. It must be an unsigned integral
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* type. The choice of type is implementation-dependent.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
*
Update some documentation related to key slots Some of the documentation is obsolete in its reference to key slots when it should discuss key handles. This may require a further pass, possibly with some reorganization of error codes. Update the documentation of functions that modify key slots (key material creation and psa_set_key_policy()) to discuss how they affect storage.
2018-12-11 14:51:32 +00:00
* 0 is not a valid key handle. How other handle values are assigned is
* implementation-dependent.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
typedef _unsigned_integral_type_ psa_key_handle_t;
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
Add a Doxygen-only section This is intended to document platform-specific definitions in PSA.
2018-02-07 20:54:47 +00:00
/**@}*/
Documentation clarifications Clarify or add the documentation of some functions and constants. Add a note about what the __DOXYGEN_ONLY__ section is for.
2018-03-07 15:40:18 +00:00
#endif /* __DOXYGEN_ONLY__ */
Add a Doxygen-only section This is intended to document platform-specific definitions in PSA.
2018-02-07 20:54:47 +00:00
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
#ifdef __cplusplus
extern "C" {
#endif
Move integral types and associated macros to their own header Some parts of the library, and crypto drivers, need to see key types, algorithms, policies, etc. but not API functions. Move portable integral types and macros to build and analyze values of these types to a separate headers crypto_types.h and crypto_values.h. No functional changes, code was only moved from crypto.h to the new headers.
2018-12-12 12:38:31 +00:00
/* The file "crypto_types.h" declares types that encode errors,
* algorithms, key types, policies, etc. */
#include "crypto_types.h"
PSA Crypto error code definitions Removed the psa_status_t enum and defined error codes as defines. Conditionally defining PSA_SUCCESS and psa_status_t.
2018-06-18 13:20:16 +00:00
Fix defgroup syntax for API version section
2019-10-02 08:32:21 +00:00
/** \defgroup version API version
Add API versioning
2019-09-19 12:32:57 +00:00
* @{
*/
/**
* The major version of this implementation of the PSA Crypto API
*/
#define PSA_CRYPTO_API_VERSION_MAJOR 1
/**
* The minor version of this implementation of the PSA Crypto API
*/
#define PSA_CRYPTO_API_VERSION_MINOR 0
/**@}*/
Move integral types and associated macros to their own header Some parts of the library, and crypto drivers, need to see key types, algorithms, policies, etc. but not API functions. Move portable integral types and macros to build and analyze values of these types to a separate headers crypto_types.h and crypto_values.h. No functional changes, code was only moved from crypto.h to the new headers.
2018-12-12 12:38:31 +00:00
/* The file "crypto_values.h" declares macros to build and analyze values
* of integral types defined in "crypto_types.h". */
#include "crypto_values.h"
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
Move integral types and associated macros to their own header Some parts of the library, and crypto drivers, need to see key types, algorithms, policies, etc. but not API functions. Move portable integral types and macros to build and analyze values of these types to a separate headers crypto_types.h and crypto_values.h. No functional changes, code was only moved from crypto.h to the new headers.
2018-12-12 12:38:31 +00:00
/** \defgroup initialization Library initialization
* @{
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*/
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
/**
* \brief Library initialization.
*
* Applications must call this function before calling any other
* function in this module.
*
* Applications may call this function more than once. Once a call
* succeeds, subsequent calls are guaranteed to succeed.
*
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* If the application calls other functions before calling psa_crypto_init(),
* the behavior is undefined. Implementations are encouraged to either perform
* the operation as if the library had been initialized or to return
* #PSA_ERROR_BAD_STATE or some other applicable error. In particular,
* implementations should not return a success status if the lack of
* initialization may have security implications, for example due to improper
* seeding of the random number generator.
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
*/
psa_status_t psa_crypto_init(void);
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
/**@}*/
Move the definition of psa_key_attributes_t to crypto_types.h psa_key_attributes_t is used in the SE driver HAL, so it must be defined in a common header, not in the API-only header crypto.h.
2019-07-23 16:16:05 +00:00
/** \addtogroup attributes
Rename functions that inject key material to an allocated handle This commit starts a migration to a new interface for key creation. Today, the application allocates a handle, then fills its metadata, and finally injects key material. The new interface fills metadata into a temporary structure, and a handle is allocated at the same time it gets filled with both metadata and key material. This commit was obtained by moving the declaration of the old-style functions to crypto_extra.h and renaming them with the to_handle suffix, adding declarations for the new-style functions in crypto.h under their new name, and running perl -i -pe 's/\bpsa_(import|copy|generator_import|generate)_key\b/$&_to_handle/g' library/*.c tests/suites/*.function programs/psa/*.c perl -i -pe 's/\bpsa_get_key_lifetime\b/$&_from_handle/g' library/*.c tests/suites/*.function programs/psa/*.c Many functions that are specific to the old interface, and which will not remain under the same name with the new interface, are still in crypto.h for now. All functional tests should still pass. The documentation may have some broken links.
2019-04-17 10:28:25 +00:00
* @{
*/
Add missing declarations to the API document PSA_KEY_ATTRIBUTES_INIT and psa_key_attributes_init weren't declared in the API document, only defined in our implementation, but they are referenced in the API document.
2019-05-21 13:54:54 +00:00
/** \def PSA_KEY_ATTRIBUTES_INIT
*
* This macro returns a suitable initializer for a key attribute structure
* of type #psa_key_attributes_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_KEY_ATTRIBUTES_INIT {0}
#endif
/** Return an initial value for a key attributes structure.
*/
static psa_key_attributes_t psa_key_attributes_init(void);
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
/** Declare a key as persistent and set its key identifier.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*
Minor documentation improvements
2019-05-16 14:10:59 +00:00
* If the attribute structure currently declares the key as volatile (which
* is the default content of an attribute structure), this function sets
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
* the lifetime attribute to #PSA_KEY_LIFETIME_PERSISTENT.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*
Minor documentation improvements
2019-05-16 14:10:59 +00:00
* This function does not access storage, it merely stores the given
* value in the structure.
* The persistent key will be written to storage when the attribute
* structure is passed to a key creation function such as
Rename psa_generate_random_key back to psa_generate_key generate_key is a more classical name. The longer name was only introduced to avoid confusion with getting a key from a generator, which is key derivation, but we no longer use the generator terminology so this reason no longer applies. perl -i -pe 's/psa_generate_random_key/psa_generate_key/g' $(git ls-files)
2019-05-16 17:42:05 +00:00
* psa_import_key(), psa_generate_key(),
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
* psa_key_derivation_output_key() or psa_copy_key().
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
* \param id The persistent identifier for the key.
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
*/
static void psa_set_key_id(psa_key_attributes_t *attributes,
psa_key_id_t id);
/** Set the location of a persistent key.
*
* To make a key persistent, you must give it a persistent key identifier
Minor documentation improvements
2019-05-16 14:10:59 +00:00
* with psa_set_key_id(). By default, a key that has a persistent identifier
* is stored in the default storage area identifier by
* #PSA_KEY_LIFETIME_PERSISTENT. Call this function to choose a storage
* area, or to explicitly declare the key as volatile.
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
*
Minor documentation improvements
2019-05-16 14:10:59 +00:00
* This function does not access storage, it merely stores the given
* value in the structure.
* The persistent key will be written to storage when the attribute
* structure is passed to a key creation function such as
Rename psa_generate_random_key back to psa_generate_key generate_key is a more classical name. The longer name was only introduced to avoid confusion with getting a key from a generator, which is key derivation, but we no longer use the generator terminology so this reason no longer applies. perl -i -pe 's/psa_generate_random_key/psa_generate_key/g' $(git ls-files)
2019-05-16 17:42:05 +00:00
* psa_import_key(), psa_generate_key(),
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
* psa_key_derivation_output_key() or psa_copy_key().
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param lifetime The lifetime for the key.
* If this is #PSA_KEY_LIFETIME_VOLATILE, the
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
* key will be volatile, and the key identifier
* attribute is reset to 0.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*/
Replace psa_make_key_persistent by id/lifetime setters Use individual setters for the id and lifetime fields of an attribute structure, like the other attributes. This commit updates the specification and adds an implementation of the new setters.
2019-05-15 14:11:15 +00:00
static void psa_set_key_lifetime(psa_key_attributes_t *attributes,
psa_key_lifetime_t lifetime);
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the key identifier from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The persistent identifier stored in the attribute structure.
* This value is unspecified if the attribute structure declares
* the key as volatile.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static psa_key_id_t psa_get_key_id(const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the lifetime from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The lifetime value stored in the attribute structure.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static psa_key_lifetime_t psa_get_key_lifetime(
const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Declare usage flags for a key.
*
* Usage flags are part of a key's usage policy. They encode what
* kind of operations are permitted on the key. For more details,
* refer to the documentation of the type #psa_key_usage_t.
*
* This function overwrites any usage flags
* previously set in \p attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
* \param usage_flags The usage flags to write.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static void psa_set_key_usage_flags(psa_key_attributes_t *attributes,
psa_key_usage_t usage_flags);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the usage flags from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The usage flags stored in the attribute structure.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static psa_key_usage_t psa_get_key_usage_flags(
const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Declare the permitted algorithm policy for a key.
*
* The permitted algorithm policy of a key encodes which algorithm or
Clarify how key creation functions use attributes and what 0 means Clarify how key creation functions use attributes. Explain the meaning of attribute values, espcially what 0 means in each field where it has a special meaning. Explain what an algorithm usage policy can be (an algorithm, a wildcard with ANY_HASH, or 0).
2019-09-12 14:59:37 +00:00
* algorithms are permitted to be used with this key. The following
* algorithm policies are supported:
* - 0 does not allow any cryptographic operation with the key. The key
* may be used for non-cryptographic actions such as exporting (if
* permitted by the usage flags).
* - An algorithm value permits this particular algorithm.
* - An algorithm wildcard built from #PSA_ALG_ANY_HASH allows the specified
* signature scheme with any hash algorithm.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*
* This function overwrites any algorithm policy
* previously set in \p attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
* \param alg The permitted algorithm policy to write.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static void psa_set_key_algorithm(psa_key_attributes_t *attributes,
psa_algorithm_t alg);
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the algorithm policy from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The algorithm stored in the attribute structure.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static psa_algorithm_t psa_get_key_algorithm(
const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Declare the type of a key.
*
Remove domain parameters from the official API Move psa_get_key_domain_parameters() and psa_set_key_domain_parameters() out of the official API and declare them to be implementation-specific extensions. Expand the documentation of psa_set_key_domain_parameters() a bit to explain how domain parameters are used. Remove all mentions of domain parameters from the documentation of API functions. This leaves DH and DSA effectively unusable.
2019-05-16 10:18:32 +00:00
* This function overwrites any key type
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* previously set in \p attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
* \param type The key type to write.
Clarify how key creation functions use attributes and what 0 means Clarify how key creation functions use attributes. Explain the meaning of attribute values, espcially what 0 means in each field where it has a special meaning. Explain what an algorithm usage policy can be (an algorithm, a wildcard with ANY_HASH, or 0).
2019-09-12 14:59:37 +00:00
* If this is 0, the key type in \p attributes
* becomes unspecified.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static void psa_set_key_type(psa_key_attributes_t *attributes,
psa_key_type_t type);
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
Set the key size as an attribute Instead of passing a separate parameter for the key size to psa_generate_key and psa_generator_import_key, set it through the attributes, like the key type and other metadata.
2019-04-26 11:49:28 +00:00
/** Declare the size of a key.
*
* This function overwrites any key size previously set in \p attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate each of its arguments exactly once.
*
* \param[out] attributes The attribute structure to write to.
* \param bits The key size in bits.
Clarify how key creation functions use attributes and what 0 means Clarify how key creation functions use attributes. Explain the meaning of attribute values, espcially what 0 means in each field where it has a special meaning. Explain what an algorithm usage policy can be (an algorithm, a wildcard with ANY_HASH, or 0).
2019-09-12 14:59:37 +00:00
* If this is 0, the key size in \p attributes
Forbid keys of size 0 Keys of size 0 generally don't make sense: a key is supposed to be secret. There is one edge case which is "raw data" keys, which are useful to store non-key objects in the same storage location as keys. However those are also problematic because they involve a zero-length buffer. Manipulating zero-length buffers in C requires special cases with functions like malloc() and memcpy(). Additionally, 0 as a key size already has a meaning "unspecified", which does not always overlap seamlessly with the meaning "0". Therefore, forbid keys of size 0. No implementation may accept them.
2019-09-12 16:29:43 +00:00
* becomes unspecified. Keys of size 0 are
* not supported.
Set the key size as an attribute Instead of passing a separate parameter for the key size to psa_generate_key and psa_generator_import_key, set it through the attributes, like the key type and other metadata.
2019-04-26 11:49:28 +00:00
*/
static void psa_set_key_bits(psa_key_attributes_t *attributes,
size_t bits);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the key type from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The key type stored in the attribute structure.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static psa_key_type_t psa_get_key_type(const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the key size from key attributes.
*
* This function may be declared as `static` (i.e. without external
* linkage). This function may be provided as a function-like macro,
* but in this case it must evaluate its argument exactly once.
*
* \param[in] attributes The key attribute structure to query.
*
* \return The key size stored in the attribute structure, in bits.
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
static size_t psa_get_key_bits(const psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Retrieve the attributes of a key.
*
* This function first resets the attribute structure as with
Improve documentation of key attributes
2019-04-28 09:36:21 +00:00
* psa_reset_key_attributes(). It then copies the attributes of
* the given key into the given attribute structure.
*
* \note This function may allocate memory or other resources.
* Once you have called this function on an attribute structure,
* you must call psa_reset_key_attributes() to free these resources.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*
* \param[in] handle Handle to the key to query.
* \param[in,out] attributes On success, the attributes of the key.
* On failure, equivalent to a
* freshly-initialized structure.
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
Added missing return codes to get_key_attributes Note that PSA_ERROR_NOT_PERMITTED is not included because I can't think of a scenario where you have a valid key handle but aren't allowed to read the attributes
2019-08-06 15:02:12 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
*/
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
psa_status_t psa_get_key_attributes(psa_key_handle_t handle,
psa_key_attributes_t *attributes);
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
/** Reset a key attribute structure to a freshly initialized state.
*
* You must initialize the attribute structure as described in the
* documentation of the type #psa_key_attributes_t before calling this
* function. Once the structure has been initialized, you may call this
* function at any time.
*
* This function frees any auxiliary resources that the structure
* may contain.
*
* \param[in,out] attributes The attribute structure to reset.
*/
Implement psa_get_key_attributes Implement attribute querying. Test attribute getters and setters. Use psa_get_key_attributes instead of the deprecated functions psa_get_key_policy or psa_get_key_information in most tests.
2019-04-18 19:44:46 +00:00
void psa_reset_key_attributes(psa_key_attributes_t *attributes);
Implement atomic-creation psa_import_key Implement the new, attribute-based psa_import_key and some basic functions to access psa_key_attributes_t. Replace psa_import_key_to_handle by psa_import_key in a few test functions. This commit does not handle persistence attributes yet.
2019-04-17 13:05:45 +00:00
Rename functions that inject key material to an allocated handle This commit starts a migration to a new interface for key creation. Today, the application allocates a handle, then fills its metadata, and finally injects key material. The new interface fills metadata into a temporary structure, and a handle is allocated at the same time it gets filled with both metadata and key material. This commit was obtained by moving the declaration of the old-style functions to crypto_extra.h and renaming them with the to_handle suffix, adding declarations for the new-style functions in crypto.h under their new name, and running perl -i -pe 's/\bpsa_(import|copy|generator_import|generate)_key\b/$&_to_handle/g' library/*.c tests/suites/*.function programs/psa/*.c perl -i -pe 's/\bpsa_get_key_lifetime\b/$&_from_handle/g' library/*.c tests/suites/*.function programs/psa/*.c Many functions that are specific to the old interface, and which will not remain under the same name with the new interface, are still in crypto.h for now. All functional tests should still pass. The documentation may have some broken links.
2019-04-17 10:28:25 +00:00
/**@}*/
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
/** \defgroup key_management Key management
* @{
*/
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
/** Open a handle to an existing persistent key.
*
Improve description of psa_open_key() Remove obsolete reference to psa_make_key_persistent().
2019-05-21 13:56:29 +00:00
* Open a handle to a persistent key. A key is persistent if it was created
* with a lifetime other than #PSA_KEY_LIFETIME_VOLATILE. A persistent key
* always has a nonzero key identifier, set with psa_set_key_id() when
* creating the key. Implementations may provide additional pre-provisioned
Remove duplicated information in psa_open_key The information about implmementation keys is duplicated.
2019-08-21 16:55:30 +00:00
* keys that can be opened with psa_open_key(). Such keys have a key identifier
* in the vendor range, as documented in the description of #psa_key_id_t.
Improve description of psa_open_key() Remove obsolete reference to psa_make_key_persistent().
2019-05-21 13:56:29 +00:00
*
Update the behavior of key handles * open output distinct key handles * each handle must be closed * destroying a key does not invalidate other handles * closing a key can/might fail an active operation (but not required)
2019-09-05 08:38:06 +00:00
* The application must eventually close the handle with psa_close_key() or
* psa_destroy_key() to release associated resources. If the application dies
* without calling one of these functions, the implementation should perform
* the equivalent of a call to psa_close_key().
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*
Update psa_open_key documentation - Describe the implementation defined behavior for opening multiple keys, and provide a reference to the relevant section. - Describe the use of INSUFFICENT_MEMORY error to indicate additional implementation resource constaints. - Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE error conditions.
2019-08-21 17:20:41 +00:00
* Some implementations permit an application to open the same key multiple
Update the behavior of key handles * open output distinct key handles * each handle must be closed * destroying a key does not invalidate other handles * closing a key can/might fail an active operation (but not required)
2019-09-05 08:38:06 +00:00
* times. If this is successful, each call to psa_open_key() will return a
* different key handle.
*
* \note Applications that rely on opening a key multiple times will not be
* portable to implementations that only permit a single key handle to be
* opened. See also :ref:\`key-handles\`.
Update psa_open_key documentation - Describe the implementation defined behavior for opening multiple keys, and provide a reference to the relevant section. - Describe the use of INSUFFICENT_MEMORY error to indicate additional implementation resource constaints. - Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE error conditions.
2019-08-21 17:20:41 +00:00
*
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \param id The persistent identifier of the key.
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
* \param[out] handle On success, a handle to the key.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*
* \retval #PSA_SUCCESS
* Success. The application can now use the value of `*handle`
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
* to access the key.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Update psa_open_key documentation - Describe the implementation defined behavior for opening multiple keys, and provide a reference to the relevant section. - Describe the use of INSUFFICENT_MEMORY error to indicate additional implementation resource constaints. - Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE error conditions.
2019-08-21 17:20:41 +00:00
* The implementation does not have sufficient resources to open the
* key. This can be due to reaching an implementation limit on the
* number of open keys, the number of open key handles, or available
* memory.
Replace PSA error code definitions with the ones defined in PSA spec
2019-02-14 11:48:10 +00:00
* \retval #PSA_ERROR_DOES_NOT_EXIST
Update psa_open_key documentation - Describe the implementation defined behavior for opening multiple keys, and provide a reference to the relevant section. - Describe the use of INSUFFICENT_MEMORY error to indicate additional implementation resource constaints. - Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE error conditions.
2019-08-21 17:20:41 +00:00
* There is no persistent key with key identifier \p id.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
Update psa_open_key documentation - Describe the implementation defined behavior for opening multiple keys, and provide a reference to the relevant section. - Describe the use of INSUFFICENT_MEMORY error to indicate additional implementation resource constaints. - Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE error conditions.
2019-08-21 17:20:41 +00:00
* \p id is not a valid persistent key identifier.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* The specified key exists, but the application does not have the
* permission to access it. Note that this specification does not
* define any way to create such a key, but it may be possible
* through implementation-specific means.
Remove lifetime parameter from psa_open_key Change the scope of key identifiers to be global, rather than per lifetime. As a result, you now need to specify the lifetime of a key only when creating it.
2019-05-06 16:44:55 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
Added a few more return codes
2019-08-12 14:06:48 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Remove lifetime parameter from psa_open_key Change the scope of key identifiers to be global, rather than per lifetime. As a result, you now need to specify the lifetime of a key only when creating it.
2019-05-06 16:44:55 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*/
Remove lifetime parameter from psa_open_key Change the scope of key identifiers to be global, rather than per lifetime. As a result, you now need to specify the lifetime of a key only when creating it.
2019-05-06 16:44:55 +00:00
psa_status_t psa_open_key(psa_key_id_t id,
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
psa_key_handle_t *handle);
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
/** Close a key handle.
*
Update documentation for psa_close_key Adjust the wording to permit multiple handles to a single key - closing a handle does not necessarily release volatile memory associated with the key, that only occurs when the last handle is closed.
2019-08-21 21:46:56 +00:00
* If the handle designates a volatile key, this will destroy the key material
* and free all associated resources, just like psa_destroy_key().
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*
Update documentation for psa_close_key Adjust the wording to permit multiple handles to a single key - closing a handle does not necessarily release volatile memory associated with the key, that only occurs when the last handle is closed.
2019-08-21 21:46:56 +00:00
* If this is the last open handle to a persistent key, then closing the handle
* will free all resources associated with the key in volatile memory. The key
* data in persistent storage is not affected and can be opened again later
* with a call to psa_open_key().
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*
Update documentation for psa_close_key Adjust the wording to permit multiple handles to a single key - closing a handle does not necessarily release volatile memory associated with the key, that only occurs when the last handle is closed.
2019-08-21 21:46:56 +00:00
* Closing the key handle makes the handle invalid, and the key handle
Editorial fixes.
2019-08-22 14:04:48 +00:00
* must not be used again by the application.
Update documentation for psa_close_key Adjust the wording to permit multiple handles to a single key - closing a handle does not necessarily release volatile memory associated with the key, that only occurs when the last handle is closed.
2019-08-21 21:46:56 +00:00
*
Fix grammar.
2019-09-09 08:56:34 +00:00
* \note If the key handle was used to set up an active
Update the behavior of key handles * open output distinct key handles * each handle must be closed * destroying a key does not invalidate other handles * closing a key can/might fail an active operation (but not required)
2019-09-05 08:38:06 +00:00
* :ref:\`multipart operation <multipart-operations>\`, then closing the
* key handle can cause the multipart operation to fail. Applications should
* maintain the key handle until after the multipart operation has finished.
Document that destroying a key aborts any ongoing operation Document that psa_close_key() and psa_destroy_key() abort any ongoing multipart operation that is using the key. This is not implemented yet.
2019-01-14 17:24:53 +00:00
*
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \param handle The key handle to close.
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* If this is \c 0, do nothing and return \c PSA_SUCCESS.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*
* \retval #PSA_SUCCESS
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* \p handle was a valid handle or \c 0. It is now closed.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* \p handle is not a valid handle nor \c 0.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
Add CORRUPTION_DETECTED to psa_close_key
2019-08-15 12:27:12 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare the new slot management functions in crypto.h No changes to existing functions.
2018-11-30 13:08:36 +00:00
*/
psa_status_t psa_close_key(psa_key_handle_t handle);
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
/** Make a copy of a key.
*
* Copy key material from one location to another.
*
* This function is primarily useful to copy a key from one location
* to another, since it populates a key using the material from
* another key which may have a different lifetime.
*
* This function may be used to share a key with a different party,
* subject to implementation-defined restrictions on key sharing.
*
* The policy on the source key must have the usage flag
* #PSA_KEY_USAGE_COPY set.
* This flag is sufficient to permit the copy if the key has the lifetime
* #PSA_KEY_LIFETIME_VOLATILE or #PSA_KEY_LIFETIME_PERSISTENT.
* Some secure elements do not provide a way to copy a key without
* making it extractable from the secure element. If a key is located
* in such a secure element, then the key must have both usage flags
* #PSA_KEY_USAGE_COPY and #PSA_KEY_USAGE_EXPORT in order to make
* a copy of the key outside the secure element.
*
* The resulting key may only be used in a way that conforms to
* both the policy of the original key and the policy specified in
* the \p attributes parameter:
* - The usage flags on the resulting key are the bitwise-and of the
* usage flags on the source policy and the usage flags in \p attributes.
* - If both allow the same algorithm or wildcard-based
* algorithm policy, the resulting key has the same algorithm policy.
* - If either of the policies allows an algorithm and the other policy
* allows a wildcard-based algorithm policy that includes this algorithm,
* the resulting key allows the same algorithm.
* - If the policies do not allow any algorithm in common, this function
* fails with the status #PSA_ERROR_INVALID_ARGUMENT.
*
* The effect of this function on implementation-defined attributes is
* implementation-defined.
*
* \param source_handle The key to copy. It must be a valid key handle.
* \param[in] attributes The attributes for the new key.
* They are used as follows:
* - The key type and size may be 0. If either is
* nonzero, it must match the corresponding
* attribute of the source key.
* - The key location (the lifetime and, for
* persistent keys, the key identifier) is
* used directly.
* - The policy constraints (usage flags and
* algorithm policy) are combined from
* the source key and \p attributes so that
* both sets of restrictions apply, as
* described in the documentation of this function.
* \param[out] target_handle On success, a handle to the newly created key.
* \c 0 on failure.
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_INVALID_HANDLE
* \p source_handle is invalid.
* \retval #PSA_ERROR_ALREADY_EXISTS
* This is an attempt to create a persistent key, and there is
* already a persistent key with the given identifier.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The lifetime or identifier in \p attributes are invalid.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The policy constraints on the source and specified in
* \p attributes are incompatible.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \p attributes specifies a key type or key size
* which does not match the attributes of the source key.
* \retval #PSA_ERROR_NOT_PERMITTED
* The source key does not have the #PSA_KEY_USAGE_COPY usage flag.
* \retval #PSA_ERROR_NOT_PERMITTED
* The source key is not exportable and its lifetime does not
* allow copying it to the target's lifetime.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_INSUFFICIENT_STORAGE
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
* \retval #PSA_ERROR_STORAGE_FAILURE
* \retval #PSA_ERROR_CORRUPTION_DETECTED
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_copy_key(psa_key_handle_t source_handle,
const psa_key_attributes_t *attributes,
psa_key_handle_t *target_handle);
/**
* \brief Destroy a key.
*
* This function destroys a key from both volatile
* memory and, if applicable, non-volatile storage. Implementations shall
* make a best effort to ensure that that the key material cannot be recovered.
*
* This function also erases any metadata such as policies and frees
* resources associated with the key. To free all resources associated with
* the key, all handles to the key must be closed or destroyed.
*
* Destroying the key makes the handle invalid, and the key handle
* must not be used again by the application. Using other open handles to the
* destroyed key in a cryptographic operation will result in an error.
*
* If a key is currently in use in a multipart operation, then destroying the
* key will cause the multipart operation to fail.
*
* \param handle Handle to the key to erase.
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* If this is \c 0, do nothing and return \c PSA_SUCCESS.
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
*
* \retval #PSA_SUCCESS
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* \p handle was a valid handle and the key material that it
* referred to has been erased.
* Alternatively, \p handle is \c 0.
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* The key cannot be erased because it is
* read-only, either due to a policy or due to physical restrictions.
* \retval #PSA_ERROR_INVALID_HANDLE
Document that psa_close_key(0) and psa_destroy_key(0) succeed Document that passing 0 to a close/destroy function does nothing and returns PSA_SUCCESS. Although this was not written explicitly, the specification strongly suggested that this would return PSA_ERROR_INVALID_HANDLE. While returning INVALID_HANDLE makes sense, it was awkward for a very common programming style where applications can store 0 in a handle variable to indicate that the handle has been closed or has never been open: applications had to either check if (handle != 0) before calling psa_close_key(handle) or psa_destroy_key(handle), or ignore errors from the close/destroy function. Now applications following this style can just call psa_close_key(handle) or psa_destroy_key(handle).
2019-10-08 13:43:13 +00:00
* \p handle is not a valid handle nor \c 0.
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* There was an failure in communication with the cryptoprocessor.
* The key material may still be present in the cryptoprocessor.
* \retval #PSA_ERROR_STORAGE_FAILURE
* The storage is corrupted. Implementations shall make a best effort
* to erase key material even in this stage, however applications
* should be aware that it may be impossible to guarantee that the
* key material is not recoverable in such cases.
* \retval #PSA_ERROR_CORRUPTION_DETECTED
* An unexpected condition which is not a storage corruption or
* a communication failure occurred. The cryptoprocessor may have
* been compromised.
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_destroy_key(psa_key_handle_t handle);
Move declarations related to lifetimes further up in crypto.h No content change. This is in preparation for declaring the slot management functions, which need the type psa_key_lifetime_t.
2018-11-30 13:07:45 +00:00
/**@}*/
/** \defgroup import_export Key import and export
* @{
*/
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
/**
* \brief Import a key in binary format.
*
Documentation clarifications Clarify or add the documentation of some functions and constants. Add a note about what the __DOXYGEN_ONLY__ section is for.
2018-03-07 15:40:18 +00:00
* This function supports any output from psa_export_key(). Refer to the
Expand the documentation of import/export formats Clarify that the key type determines the syntax of the input. Clarify the constraints on implementations that support extra import formats.
2018-10-31 13:07:52 +00:00
* documentation of psa_export_public_key() for the format of public keys
* and to the documentation of psa_export_key() for the format for
* other key types.
*
Forbid keys of size 0 Keys of size 0 generally don't make sense: a key is supposed to be secret. There is one edge case which is "raw data" keys, which are useful to store non-key objects in the same storage location as keys. However those are also problematic because they involve a zero-length buffer. Manipulating zero-length buffers in C requires special cases with functions like malloc() and memcpy(). Additionally, 0 as a key size already has a meaning "unspecified", which does not always overlap seamlessly with the meaning "0". Therefore, forbid keys of size 0. No implementation may accept them.
2019-09-12 16:29:43 +00:00
* The key data determines the key size. The attributes may optionally
* specify a key size; in this case it must match the size determined
* from the key data. A key size of 0 in \p attributes indicates that
* the key size is solely determined by the key data.
*
* Implementations must reject an attempt to import a key of size 0.
*
Expand the documentation of import/export formats Clarify that the key type determines the syntax of the input. Clarify the constraints on implementations that support extra import formats.
2018-10-31 13:07:52 +00:00
* This specification supports a single format for each key type.
* Implementations may support other formats as long as the standard
* format is supported. Implementations that support other formats
* should ensure that the formats are clearly unambiguous so as to
* minimize the risk that an invalid input is accidentally interpreted
* according to a different format.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param[in] attributes The attributes for the new key.
Check unused attributes in import and copy In psa_import_key and psa_copy_key, some information comes from the key data (input buffer or source key) rather than from the attributes: key size for import, key size and type and domain parameters for copy. If an unused attribute is nonzero in the attribute structure, check that it matches the correct value. This protects against application errors.
2019-05-03 14:57:15 +00:00
* The key size is always determined from the
* \p data buffer.
* If the key size in \p attributes is nonzero,
* it must be equal to the size from \p data.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param[out] handle On success, a handle to the newly created key.
* \c 0 on failure.
Expand the documentation of import/export formats Clarify that the key type determines the syntax of the input. Clarify the constraints on implementations that support extra import formats.
2018-10-31 13:07:52 +00:00
* \param[in] data Buffer containing the key data. The content of this
Remove domain parameters from the official API Move psa_get_key_domain_parameters() and psa_set_key_domain_parameters() out of the official API and declare them to be implementation-specific extensions. Expand the documentation of psa_set_key_domain_parameters() a bit to explain how domain parameters are used. Remove all mentions of domain parameters from the documentation of API functions. This leaves DH and DSA effectively unusable.
2019-05-16 10:18:32 +00:00
* buffer is interpreted according to the type declared
* in \p attributes.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* All implementations must support at least the format
* described in the documentation
Expand the documentation of import/export formats Clarify that the key type determines the syntax of the input. Clarify the constraints on implementations that support extra import formats.
2018-10-31 13:07:52 +00:00
* of psa_export_key() or psa_export_public_key() for
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* the chosen type. Implementations may allow other
* formats, but should be conservative: implementations
* should err on the side of rejecting content if it
* may be erroneous (e.g. wrong type or truncated data).
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param data_length Size of the \p data buffer in bytes.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* Success.
Update some documentation related to key slots Some of the documentation is obsolete in its reference to key slots when it should discuss key handles. This may require a further pass, possibly with some reorganization of error codes. Update the documentation of functions that modify key slots (key material creation and psa_set_key_policy()) to discuss how they affect storage.
2018-12-11 14:51:32 +00:00
* If the key is persistent, the key material and the key's metadata
* have been saved to persistent storage.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \retval #PSA_ERROR_ALREADY_EXISTS
* This is an attempt to create a persistent key, and there is
* already a persistent key with the given identifier.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Expand the description of error codes
2018-04-19 06:28:58 +00:00
* The key type or key size is not supported, either by the
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* implementation in general or in this particular persistent location.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
Check unused attributes in import and copy In psa_import_key and psa_copy_key, some information comes from the key data (input buffer or source key) rather than from the attributes: key size for import, key size and type and domain parameters for copy. If an unused attribute is nonzero in the attribute structure, check that it matches the correct value. This protects against application errors.
2019-05-03 14:57:15 +00:00
* The key attributes, as a whole, are invalid.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The key data is not correctly formatted.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The size in \p attributes is nonzero and does not match the size
* of the key data.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_INSUFFICIENT_STORAGE
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
psa: Implement persistent keys Allow use of persistent keys, including configuring them, importing and exporting them, and destroying them. When getting a slot using psa_get_key_slot, there are 3 scenarios that can occur if the keys lifetime is persistent: 1. Key type is PSA_KEY_TYPE_NONE, no persistent storage entry: - The key slot is treated as a standard empty key slot 2. Key type is PSA_KEY_TYPE_NONE, persistent storage entry exists: - Attempt to load the key from persistent storage 3. Key type is not PSA_KEY_TYPE_NONE: - As checking persistent storage on every use of the key could be expensive, the persistent key is assumed to be saved in persistent storage, the in-memory key is continued to be used.
2018-06-18 16:27:26 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*/
Rename functions that inject key material to an allocated handle This commit starts a migration to a new interface for key creation. Today, the application allocates a handle, then fills its metadata, and finally injects key material. The new interface fills metadata into a temporary structure, and a handle is allocated at the same time it gets filled with both metadata and key material. This commit was obtained by moving the declaration of the old-style functions to crypto_extra.h and renaming them with the to_handle suffix, adding declarations for the new-style functions in crypto.h under their new name, and running perl -i -pe 's/\bpsa_(import|copy|generator_import|generate)_key\b/$&_to_handle/g' library/*.c tests/suites/*.function programs/psa/*.c perl -i -pe 's/\bpsa_get_key_lifetime\b/$&_from_handle/g' library/*.c tests/suites/*.function programs/psa/*.c Many functions that are specific to the old interface, and which will not remain under the same name with the new interface, are still in crypto.h for now. All functional tests should still pass. The documentation may have some broken links.
2019-04-17 10:28:25 +00:00
psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
const uint8_t *data,
Put handle parameter last: psa_import_key In psa_import_key, change the order of parameters to pass the pointer where the newly created handle will be stored last. This is consistent with most other library functions that put inputs before outputs.
2019-05-15 18:15:10 +00:00
size_t data_length,
psa_key_handle_t *handle);
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
/**
* \brief Export a key in binary format.
*
* The output of this function can be passed to psa_import_key() to
* create an equivalent object.
*
Expand the documentation of import/export formats Clarify that the key type determines the syntax of the input. Clarify the constraints on implementations that support extra import formats.
2018-10-31 13:07:52 +00:00
* If the implementation of psa_import_key() supports other formats
* beyond the format specified here, the output from psa_export_key()
* must use the representation specified here, not the original
* representation.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* For standard key types, the output format is as follows:
*
* - For symmetric keys (including MAC keys), the format is the
* raw bytes of the key.
* - For DES, the key data consists of 8 bytes. The parity bits must be
* correct.
* - For Triple-DES, the format is the concatenation of the
* two or three DES keys.
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* - For RSA key pairs (#PSA_KEY_TYPE_RSA_KEY_PAIR), the format
Define the encoding of ECC and DSA keys
2018-08-10 16:57:40 +00:00
* is the non-encrypted DER encoding of the representation defined by
* PKCS\#1 (RFC 8017) as `RSAPrivateKey`, version 0.
* ```
* RSAPrivateKey ::= SEQUENCE {
fixup format spec
2018-08-10 23:17:53 +00:00
* version INTEGER, -- must be 0
Define the encoding of ECC and DSA keys
2018-08-10 16:57:40 +00:00
* modulus INTEGER, -- n
* publicExponent INTEGER, -- e
* privateExponent INTEGER, -- d
* prime1 INTEGER, -- p
* prime2 INTEGER, -- q
* exponent1 INTEGER, -- d mod (p-1)
* exponent2 INTEGER, -- d mod (q-1)
* coefficient INTEGER, -- (inverse of q) mod p
* }
* ```
* - For elliptic curve key pairs (key types for which
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* #PSA_KEY_TYPE_IS_ECC_KEY_PAIR is true), the format is
More tweaks on EC-related wording Use m for the bit size of the field order, not q which is traditionally the field order. Correct and clarify the private key representation format as has been done for the private key and ECDH shared secret formats.
2018-11-15 16:44:43 +00:00
* a representation of the private value as a `ceiling(m/8)`-byte string
* where `m` is the bit size associated with the curve, i.e. the bit size
* of the order of the curve's coordinate field. This byte string is
* in little-endian order for Montgomery curves (curve types
Rename ECC Family Macros According to PSA Spec Rename PSA_ECC_CURVE_xxx to PSA_ECC_FAMILY_xxx, also rename PSA_KEY_TYPE_GET_CURVE to PSA_KEY_TYPE_ECC_GET_FAMILY and rename psa_ecc_curve_t to psa_ecc_family_t. Old defines are provided in include/crypto_compat.h for backward compatibility. Signed-off-by: Paul Elliott <paul.elliott@arm.com>
2020-06-02 16:19:28 +00:00
* `PSA_ECC_FAMILY_CURVEXXX`), and in big-endian order for Weierstrass
* curves (curve types `PSA_ECC_FAMILY_SECTXXX`, `PSA_ECC_FAMILY_SECPXXX`
* and `PSA_ECC_FAMILY_BRAINPOOL_PXXX`).
Document masking of Montgomery private keys in psa_export_key Follow the PSA Crypto specification which was updated between 1.0 beta3 and 1.0.0. Add corresponding test cases. Signed-off-by: Steven Cooreman <steven.cooreman@silabs.com>
2020-06-11 14:40:41 +00:00
* For Weierstrass curves, this is the content of the `privateKey` field of
* the `ECPrivateKey` format defined by RFC 5915. For Montgomery curves,
* the format is defined by RFC 7748, and output is masked according to §5.
Parametrize Diffie-Hellman keys by a group identifier Parametrize finite-field Diffie-Hellman key types with a DH group identifier, in the same way elliptic curve keys are parametrized with an EC curve identifier. Define the DH groups from the TLS registry (these are the groups from RFC 7919). Replicate the macro definitions and the metadata tests from elliptic curve identifiers to DH group identifiers. Define PSA_DH_GROUP_CUSTOM as an implementation-specific extension for which domain parameters are used to specify the group.
2019-05-16 10:55:35 +00:00
* - For Diffie-Hellman key exchange key pairs (key types for which
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* #PSA_KEY_TYPE_IS_DH_KEY_PAIR is true), the
psa: Add DH key exchange keys Add the ability to specify Diffie-Hellman key exchange keys. Specify the import/export format as well, even though importing and exporting isn't implemented yet.
2019-01-11 14:20:03 +00:00
* format is the representation of the private key `x` as a big-endian byte
* string. The length of the byte string is the private key size in bytes
* (leading zeroes are not stripped).
Define the encoding of ECC and DSA keys
2018-08-10 16:57:40 +00:00
* - For public keys (key types for which #PSA_KEY_TYPE_IS_PUBLIC_KEY is
* true), the format is the same as for psa_export_public_key().
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
psa_export_key, psa_export_public_key: document the EXPORT flag
2019-05-14 12:23:32 +00:00
* The policy on the key must have the usage flag #PSA_KEY_USAGE_EXPORT set.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to export.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] data Buffer where the key data is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param data_size Size of the \p data buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] data_length On success, the number of bytes
* that make up the key data.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
psa_export_key, psa_export_public_key: document the EXPORT flag
2019-05-14 12:23:32 +00:00
* The key does not have the #PSA_KEY_USAGE_EXPORT flag.
Add ifdefs for psa_internal_export_key function MBEDTLS_PK_WRITE_C only requires either MBEDTLS_RSA_C or MBEDTLS_ECP_C to be defined. Added wrappers to handle the cases where only one has been defined. Moved mbedtls_pk_init to be within the ifdefs, so it's only called if appropriate.
2018-07-24 15:33:30 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
New macro PSA_KEY_EXPORT_MAX_SIZE Sufficient buffer size for psa_export_key() and psa_export_public_key().
2018-08-10 17:06:59 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p data buffer is too small. You can determine a
* sufficient buffer size by calling
* #PSA_KEY_EXPORT_MAX_SIZE(\c type, \c bits)
* where \c type is the key type
* and \c bits is the key size in bits.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added PSA_ERROR_STORAGE_FAILURE to psa_export_key It may be possible that an implementation does not fetch key material until a command like this is called and such an error may occur if an off-chip secure storage dependency may have been wiped.
2019-08-06 15:21:00 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Add PSA_ERROR_INSUFFICIENT_MEMORY to psa_export_key It may be possible that the implementation runs out of memory when exporting a key from storage or a secure element. For example, it may not be possible to directly move the data from storage to the caller, so the implementation will have to buffer the material temporarily (an issue if dynamic memory allocation scheme is used). For a large key this is more likely to return.
2019-08-06 15:34:44 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_export_key(psa_key_handle_t handle,
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
uint8_t *data,
size_t data_size,
size_t *data_length);
Basic interface for key policies Get/set the policy of a key slot. Opaque structure for key policies and field access functions.
2018-03-03 20:30:44 +00:00
/**
* \brief Export a public key or the public part of a key pair in binary format.
*
* The output of this function can be passed to psa_import_key() to
* create an object that is equivalent to the public key.
*
psa: Document requirements for psa_export_public_key() Copy the nice and clear documentation from psa_export_key() as to what implementations are allowed to do regarding key export formats, as the same applies to public keys.
2019-01-11 17:15:56 +00:00
* This specification supports a single format for each key type.
* Implementations may support other formats as long as the standard
* format is supported. Implementations that support other formats
* should ensure that the formats are clearly unambiguous so as to
* minimize the risk that an invalid input is accidentally interpreted
* according to a different format.
*
psa: Simplify RSA public key format Remove pkcs-1 and rsaEncryption front matter from RSA public keys. Move code that was shared between RSA and other key types (like EC keys) to be used only with non-RSA keys.
2019-01-10 10:23:21 +00:00
* For standard key types, the output format is as follows:
* - For RSA public keys (#PSA_KEY_TYPE_RSA_PUBLIC_KEY), the DER encoding of
* the representation defined by RFC 3279 &sect;2.3.1 as `RSAPublicKey`.
* ```
* RSAPublicKey ::= SEQUENCE {
* modulus INTEGER, -- n
* publicExponent INTEGER } -- e
* ```
psa: Simplify EC public key format Remove front matter from our EC key format, to make it just the contents of an ECPoint as defined by SEC1 section 2.3.3. As a consequence of the simplification, remove the restriction on not being able to use an ECDH key with ECDSA. There is no longer any OID specified when importing a key, so we can't reject importing of an ECDH key for the purpose of ECDSA based on the OID.
2019-01-10 11:42:27 +00:00
* - For elliptic curve public keys (key types for which
* #PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY is true), the format is the uncompressed
* representation defined by SEC1 &sect;2.3.3 as the content of an ECPoint.
* Let `m` be the bit size associated with the curve, i.e. the bit size of
* `q` for a curve over `F_q`. The representation consists of:
* - The byte 0x04;
* - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
* - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
Parametrize Diffie-Hellman keys by a group identifier Parametrize finite-field Diffie-Hellman key types with a DH group identifier, in the same way elliptic curve keys are parametrized with an EC curve identifier. Define the DH groups from the TLS registry (these are the groups from RFC 7919). Replicate the macro definitions and the metadata tests from elliptic curve identifiers to DH group identifiers. Define PSA_DH_GROUP_CUSTOM as an implementation-specific extension for which domain parameters are used to specify the group.
2019-05-16 10:55:35 +00:00
* - For Diffie-Hellman key exchange public keys (key types for which
* #PSA_KEY_TYPE_IS_DH_PUBLIC_KEY is true),
psa: Add DH key exchange keys Add the ability to specify Diffie-Hellman key exchange keys. Specify the import/export format as well, even though importing and exporting isn't implemented yet.
2019-01-11 14:20:03 +00:00
* the format is the representation of the public key `y = g^x mod p` as a
* big-endian byte string. The length of the byte string is the length of the
* base prime `p` in bytes.
Basic interface for key policies Get/set the policy of a key slot. Opaque structure for key policies and field access functions.
2018-03-03 20:30:44 +00:00
*
psa_export_key, psa_export_public_key: document the EXPORT flag
2019-05-14 12:23:32 +00:00
* Exporting a public key object or the public part of a key pair is
* always permitted, regardless of the key's usage flags.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to export.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] data Buffer where the key data is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param data_size Size of the \p data buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] data_length On success, the number of bytes
* that make up the key data.
Basic interface for key policies Get/set the policy of a key slot. Opaque structure for key policies and field access functions.
2018-03-03 20:30:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
New macro PSA_KEY_EXPORT_MAX_SIZE Sufficient buffer size for psa_export_key() and psa_export_public_key().
2018-08-10 17:06:59 +00:00
* The key is neither a public key nor a key pair.
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p data buffer is too small. You can determine a
* sufficient buffer size by calling
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* #PSA_KEY_EXPORT_MAX_SIZE(#PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(\c type), \c bits)
New macro PSA_KEY_EXPORT_MAX_SIZE Sufficient buffer size for psa_export_key() and psa_export_public_key().
2018-08-10 17:06:59 +00:00
* where \c type is the key type
* and \c bits is the key size in bits.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_export_public_key The same reason that it is included in psa_export_key
2019-08-06 16:22:41 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added PSA_ERROR_INSUFFICIENT_MEMORY to psa_export_public_key For the same reasons that psa_export_key can fail with this error
2019-08-06 16:09:33 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Basic interface for key policies Get/set the policy of a key slot. Opaque structure for key policies and field access functions.
2018-03-03 20:30:44 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_export_public_key(psa_key_handle_t handle,
Basic interface for key policies Get/set the policy of a key slot. Opaque structure for key policies and field access functions.
2018-03-03 20:30:44 +00:00
uint8_t *data,
size_t data_size,
size_t *data_length);
Move psa_destroy_key and psa_copy_key to Key Management section
2019-09-11 13:40:51 +00:00
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
/**@}*/
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
/** \defgroup hash Message digests
* @{
*/
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
/** Calculate the hash (digest) of a message.
*
* \note To verify the hash of a message against an
* expected value, use psa_hash_compare() instead.
*
* \param alg The hash algorithm to compute (\c PSA_ALG_XXX value
* such that #PSA_ALG_IS_HASH(\p alg) is true).
* \param[in] input Buffer containing the message to hash.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] hash Buffer where the hash is to be written.
* \param hash_size Size of the \p hash buffer in bytes.
* \param[out] hash_length On success, the number of bytes
* that make up the hash value. This is always
Fix some copypasta in one-shot hash and MAC function descriptions
2019-02-15 12:01:41 +00:00
* #PSA_HASH_SIZE(\p alg).
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a hash algorithm.
Fix warnings
2019-09-03 15:51:19 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
Added PSA_ERROR_BUFFER_TOO_SMALL to psa_hash_compute
2019-08-06 16:50:26 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \p hash_size is too small
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_INSUFFICIENT_MEMORY to psa_export_key It may be possible that the implementation runs out of memory when exporting a key from storage or a secure element. For example, it may not be possible to directly move the data from storage to the caller, so the implementation will have to buffer the material temporarily (an issue if dynamic memory allocation scheme is used). For a large key this is more likely to return.
2019-08-06 15:34:44 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*/
psa_status_t psa_hash_compute(psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
uint8_t *hash,
size_t hash_size,
size_t *hash_length);
/** Calculate the hash (digest) of a message and compare it with a
* reference value.
*
* \param alg The hash algorithm to compute (\c PSA_ALG_XXX value
* such that #PSA_ALG_IS_HASH(\p alg) is true).
* \param[in] input Buffer containing the message to hash.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] hash Buffer containing the expected hash value.
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
* \param hash_length Size of the \p hash buffer in bytes.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*
* \retval #PSA_SUCCESS
* The expected hash is identical to the actual hash of the input.
* \retval #PSA_ERROR_INVALID_SIGNATURE
* The hash of the message was calculated successfully, but it
* differs from the expected hash.
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a hash algorithm.
Add PSA_ERROR_INVALID_ARGUMENT to psa_hash_compare
2019-08-13 10:36:29 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \p input_length or \p hash_length do not match the hash size for \p alg
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added PSA_ERROR_INSUFFICIENT_MEMORY to psa_export_public_key For the same reasons that psa_export_key can fail with this error
2019-08-06 16:09:33 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*/
psa_status_t psa_hash_compare(psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
const uint8_t *hash,
Don't declare a parameter as const Whether a parameter should be const is an implementation detail of the function, so don't declare a parameter of psa_hash_compare as const. (This only applies to parameters themselves, not to objects that pointer parameters points to.)
2019-12-02 13:31:48 +00:00
size_t hash_length);
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
/** The type of the state data structure for multipart hash operations.
psa: Add initializers for hash operation objects Add new initializers for hash operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:47:44 +00:00
*
* Before calling any function on a hash operation object, the application must
* initialize it by any of the following means:
* - Set the structure to all-bits-zero, for example:
* \code
* psa_hash_operation_t operation;
* memset(&operation, 0, sizeof(operation));
* \endcode
* - Initialize the structure to logical zero values, for example:
* \code
* psa_hash_operation_t operation = {0};
* \endcode
* - Initialize the structure to the initializer #PSA_HASH_OPERATION_INIT,
* for example:
* \code
* psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
* \endcode
* - Assign the result of the function psa_hash_operation_init()
* to the structure, for example:
* \code
* psa_hash_operation_t operation;
* operation = psa_hash_operation_init();
* \endcode
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Minor documentation fixes
2018-03-03 20:29:30 +00:00
* This is an implementation-defined \c struct. Applications should not
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
typedef struct psa_hash_operation_s psa_hash_operation_t;
psa: Add initializers for hash operation objects Add new initializers for hash operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:47:44 +00:00
/** \def PSA_HASH_OPERATION_INIT
*
* This macro returns a suitable initializer for a hash operation object
* of type #psa_hash_operation_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_HASH_OPERATION_INIT {0}
#endif
/** Return an initial value for a hash operation object.
*/
static psa_hash_operation_t psa_hash_operation_init(void);
Copyedit the documentation of multipart operation functions Finish changing "start" to "set up". Correct the way to set an IV for decryption: it's set_iv(), not update(). When decrypting, the IV is given, not random.
2019-01-14 17:29:18 +00:00
/** Set up a multipart hash operation.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
* The sequence of operations to calculate a hash (message digest)
* is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
psa: Add initializers for hash operation objects Add new initializers for hash operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:47:44 +00:00
* -# Initialize the operation object with one of the methods described in the
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* documentation for #psa_hash_operation_t, e.g. #PSA_HASH_OPERATION_INIT.
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* -# Call psa_hash_setup() to specify the algorithm.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* -# Call psa_hash_update() zero, one or more times, passing a fragment
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* of the message each time. The hash that is calculated is the hash
* of the concatenation of these messages in order.
* -# To calculate the hash, call psa_hash_finish().
* To compare the hash with an expected value, call psa_hash_verify().
*
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* If an error occurs at any step after a call to psa_hash_setup(), the
* operation will need to be reset by a call to psa_hash_abort(). The
* application may call psa_hash_abort() at any time after the operation
psa: Add initializers for hash operation objects Add new initializers for hash operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:47:44 +00:00
* has been initialized.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* After a successful call to psa_hash_setup(), the application must
Clarify how multipart operations get terminated
2018-03-20 16:54:15 +00:00
* eventually terminate the operation. The following events terminate an
* operation:
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* - A successful call to psa_hash_finish() or psa_hash_verify().
* - A call to psa_hash_abort().
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
psa: Add initializers for hash operation objects Add new initializers for hash operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:47:44 +00:00
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_hash_operation_t and not yet in use.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg The hash algorithm to compute (\c PSA_ALG_XXX value
* such that #PSA_ALG_IS_HASH(\p alg) is true).
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* Success.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Separate return codes for unsupported and invalid algorithms
2019-08-15 12:34:51 +00:00
* \p alg is not a supported hash algorithm.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \p alg is not a hash algorithm.
Document BAD_STATE errors for multipart operation setup functions Future commits will implement this and add tests.
2019-01-10 10:51:17 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The operation state is not valid (it must be inactive).
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*/
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
psa_algorithm_t alg);
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
/** Add a message fragment to a multipart hash operation.
*
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* The application must call psa_hash_setup() before calling this function.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_hash_abort().
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active hash operation.
* \param[in] input Buffer containing the message fragment to hash.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param input_length Size of the \p input buffer in bytes.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* Success.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The operation state is not valid (it muct be active).
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*/
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
psa_status_t psa_hash_update(psa_hash_operation_t *operation,
const uint8_t *input,
size_t input_length);
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
/** Finish the calculation of the hash of a message.
*
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* The application must call psa_hash_setup() before calling this function.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* This function calculates the hash of the message formed by concatenating
* the inputs passed to preceding calls to psa_hash_update().
*
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_hash_abort().
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
* \warning Applications should not call this function if they expect
* a specific value for the hash. Call psa_hash_verify() instead.
* Beware that comparing integrity or authenticity data such as
* hash values with a function such as \c memcmp is risky
* because the time taken by the comparison may leak information
* about the hashed data which could allow an attacker to guess
* a valid hash and thereby bypass security controls.
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active hash operation.
* \param[out] hash Buffer where the hash is to be written.
* \param hash_size Size of the \p hash buffer in bytes.
* \param[out] hash_length On success, the number of bytes
* that make up the hash value. This is always
Doxygen: use \c foo in preference to `foo` for consistency
2018-07-13 12:38:15 +00:00
* #PSA_HASH_SIZE(\c alg) where \c alg is the
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* hash algorithm that is calculated.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* Success.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The operation state is not valid (it must be active).
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of the \p hash buffer is too small. You can determine a
Doc: fix formatting of some macro arguments in explanations
2018-07-11 22:34:26 +00:00
* sufficient buffer size by calling #PSA_HASH_SIZE(\c alg)
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* where \c alg is the hash algorithm that is calculated.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*/
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
uint8_t *hash,
size_t hash_size,
size_t *hash_length);
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
/** Finish the calculation of the hash of a message and compare it with
* an expected value.
*
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* The application must call psa_hash_setup() before calling this function.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* This function calculates the hash of the message formed by concatenating
* the inputs passed to preceding calls to psa_hash_update(). It then
* compares the calculated hash with the expected hash passed as a
* parameter to this function.
*
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_hash_abort().
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Fix some typos and copypasta
2018-03-20 16:54:53 +00:00
* \note Implementations shall make the best effort to ensure that the
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* comparison between the actual hash and the expected hash is performed
* in constant time.
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active hash operation.
* \param[in] hash Buffer containing the expected hash value.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param hash_length Size of the \p hash buffer in bytes.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* The expected hash is identical to the actual hash of the message.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INVALID_SIGNATURE
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* The hash of the message was calculated successfully, but it
* differs from the expected hash.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The operation state is not valid (it must be active).
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*/
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
const uint8_t *hash,
size_t hash_length);
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
/** Abort a hash operation.
*
* Aborting an operation frees all associated resources except for the
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* \p operation structure itself. Once aborted, the operation object
* can be reused for another operation by calling
* psa_hash_setup() again.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* You may call this function any time after the operation object has
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* been initialized by one of the methods described in #psa_hash_operation_t.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* In particular, calling psa_hash_abort() after the operation has been
* terminated by a call to psa_hash_abort(), psa_hash_finish() or
* psa_hash_verify() is safe and has no effect.
*
* \param[in,out] operation Initialized hash operation.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*/
psa_status_t psa_hash_abort(psa_hash_operation_t *operation);
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
New function psa_hash_clone Clone a hash operation. Test good cases as part as multipart tests. Add new test functions for the state machine.
2019-01-19 11:03:41 +00:00
/** Clone a hash operation.
hash_clone: Fix copypasta and add a functional description
2019-01-21 13:50:37 +00:00
*
* This function copies the state of an ongoing hash operation to
* a new operation object. In other words, this function is equivalent
* to calling psa_hash_setup() on \p target_operation with the same
* algorithm that \p source_operation was set up for, then
* psa_hash_update() on \p target_operation with the same input that
* that was passed to \p source_operation. After this function returns, the
* two objects are independent, i.e. subsequent calls involving one of
* the objects do not affect the other object.
New function psa_hash_clone Clone a hash operation. Test good cases as part as multipart tests. Add new test functions for the state machine.
2019-01-19 11:03:41 +00:00
*
* \param[in] source_operation The active hash operation to clone.
* \param[in,out] target_operation The operation object to set up.
* It must be initialized but not active.
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The \p source_operation state is not valid (it must be active).
New function psa_hash_clone Clone a hash operation. Test good cases as part as multipart tests. Add new test functions for the state machine.
2019-01-19 11:03:41 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart hash operations
2019-09-11 21:53:21 +00:00
* The \p target_operation state is not valid (it must be inactive).
New function psa_hash_clone Clone a hash operation. Test good cases as part as multipart tests. Add new test functions for the state machine.
2019-01-19 11:03:41 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added a few more return codes
2019-08-12 14:06:48 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New function psa_hash_clone Clone a hash operation. Test good cases as part as multipart tests. Add new test functions for the state machine.
2019-01-19 11:03:41 +00:00
*/
psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
psa_hash_operation_t *target_operation);
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
/**@}*/
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
/** \defgroup MAC Message authentication codes
* @{
*/
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
/** Calculate the MAC (message authentication code) of a message.
*
* \note To verify the MAC of a message against an
* expected value, use psa_mac_verify() instead.
* Beware that comparing integrity or authenticity data such as
* MAC values with a function such as \c memcmp is risky
* because the time taken by the comparison may leak information
* about the MAC value which could allow an attacker to guess
* a valid MAC and thereby bypass security controls.
*
* \param handle Handle to the key to use for the operation.
* \param alg The MAC algorithm to compute (\c PSA_ALG_XXX value
Doxygen: fix missing markup indicator that was causing broken links
2019-02-15 12:01:17 +00:00
* such that #PSA_ALG_IS_MAC(\p alg) is true).
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \param[in] input Buffer containing the input message.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] mac Buffer where the MAC value is to be written.
* \param mac_size Size of the \p mac buffer in bytes.
* \param[out] mac_length On success, the number of bytes
Fix some copypasta in one-shot hash and MAC function descriptions
2019-02-15 12:01:41 +00:00
* that make up the MAC value.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a MAC algorithm.
Add PSA_ERROR_BUFFER_TOO_SMALL to psa_mac_compute
2019-08-07 14:59:33 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \p mac_size is too small
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added PSA_ERROR_STORAGE_FAILURE to psa_mac_compute In case the key could not be retrieved from storage.
2019-08-07 09:47:47 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
* The key could not be retrieved from storage.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_mac_compute(psa_key_handle_t handle,
psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
uint8_t *mac,
size_t mac_size,
size_t *mac_length);
/** Calculate the MAC of a message and compare it with a reference value.
*
* \param handle Handle to the key to use for the operation.
* \param alg The MAC algorithm to compute (\c PSA_ALG_XXX value
Doxygen: fix missing markup indicator that was causing broken links
2019-02-15 12:01:17 +00:00
* such that #PSA_ALG_IS_MAC(\p alg) is true).
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \param[in] input Buffer containing the input message.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] mac Buffer containing the expected MAC value.
* \param mac_length Size of the \p mac buffer in bytes.
*
* \retval #PSA_SUCCESS
* The expected MAC is identical to the actual MAC of the input.
* \retval #PSA_ERROR_INVALID_SIGNATURE
* The MAC of the message was calculated successfully, but it
* differs from the expected value.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a MAC algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
* The key could not be retrieved from storage.
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*/
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
psa_status_t psa_mac_verify(psa_key_handle_t handle,
psa_algorithm_t alg,
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
const uint8_t *input,
size_t input_length,
const uint8_t *mac,
Don't declare a parameter as const An earlier commit fixed this for psa_hash_compare. psa_mac_verify had the same flaw.
2020-01-30 15:32:21 +00:00
size_t mac_length);
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
/** The type of the state data structure for multipart MAC operations.
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
*
* Before calling any function on a MAC operation object, the application must
* initialize it by any of the following means:
* - Set the structure to all-bits-zero, for example:
* \code
* psa_mac_operation_t operation;
* memset(&operation, 0, sizeof(operation));
* \endcode
* - Initialize the structure to logical zero values, for example:
* \code
* psa_mac_operation_t operation = {0};
* \endcode
* - Initialize the structure to the initializer #PSA_MAC_OPERATION_INIT,
* for example:
* \code
* psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
* \endcode
* - Assign the result of the function psa_mac_operation_init()
* to the structure, for example:
* \code
* psa_mac_operation_t operation;
* operation = psa_mac_operation_init();
* \endcode
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
Minor documentation fixes
2018-03-03 20:29:30 +00:00
* This is an implementation-defined \c struct. Applications should not
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
typedef struct psa_mac_operation_s psa_mac_operation_t;
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
/** \def PSA_MAC_OPERATION_INIT
*
* This macro returns a suitable initializer for a MAC operation object of type
* #psa_mac_operation_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_MAC_OPERATION_INIT {0}
#endif
/** Return an initial value for a MAC operation object.
*/
static psa_mac_operation_t psa_mac_operation_init(void);
Copyedit the documentation of multipart operation functions Finish changing "start" to "set up". Correct the way to set an IV for decryption: it's set_iv(), not update(). When decrypting, the IV is given, not random.
2019-01-14 17:29:18 +00:00
/** Set up a multipart MAC calculation operation.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* This function sets up the calculation of the MAC
* (message authentication code) of a byte string.
* To verify the MAC of a message against an
* expected value, use psa_mac_verify_setup() instead.
*
* The sequence of operations to calculate a MAC is as follows:
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* -# Allocate an operation object which will be passed to all the functions
* listed here.
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* -# Initialize the operation object with one of the methods described in the
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* documentation for #psa_mac_operation_t, e.g. #PSA_MAC_OPERATION_INIT.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* -# Call psa_mac_sign_setup() to specify the algorithm and key.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* -# Call psa_mac_update() zero, one or more times, passing a fragment
* of the message each time. The MAC that is calculated is the MAC
* of the concatenation of these messages in order.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* -# At the end of the message, call psa_mac_sign_finish() to finish
* calculating the MAC value and retrieve it.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* If an error occurs at any step after a call to psa_mac_sign_setup(), the
* operation will need to be reset by a call to psa_mac_abort(). The
* application may call psa_mac_abort() at any time after the operation
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* has been initialized.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* After a successful call to psa_mac_sign_setup(), the application must
* eventually terminate the operation through one of the following methods:
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* - A successful call to psa_mac_sign_finish().
* - A call to psa_mac_abort().
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
*
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_mac_operation_t and not yet in use.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document that destroying a key aborts any ongoing operation Document that psa_close_key() and psa_destroy_key() abort any ongoing multipart operation that is using the key. This is not implemented yet.
2019-01-14 17:24:53 +00:00
* It must remain valid until the operation
* terminates.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg The MAC algorithm to compute (\c PSA_ALG_XXX value
Doxygen: fix missing markup indicator that was causing broken links
2019-02-15 12:01:17 +00:00
* such that #PSA_ALG_IS_MAC(\p alg) is true).
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \p alg is not supported or is not a MAC algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added PSA_ERROR_STORAGE_FAILURE to psa_mac_sign_setup
2019-08-07 15:05:06 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Remove trailing whitespace
2019-08-12 15:43:30 +00:00
* The key could not be retrieved from storage.
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* The operation state is not valid (it must be inactive).
Document BAD_STATE errors for multipart operation setup functions Future commits will implement this and add tests.
2019-01-10 10:51:17 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
*/
psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_key_handle_t handle,
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
psa_algorithm_t alg);
Copyedit the documentation of multipart operation functions Finish changing "start" to "set up". Correct the way to set an IV for decryption: it's set_iv(), not update(). When decrypting, the IV is given, not random.
2019-01-14 17:29:18 +00:00
/** Set up a multipart MAC verification operation.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
*
* This function sets up the verification of the MAC
* (message authentication code) of a byte string against an expected value.
*
* The sequence of operations to verify a MAC is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* -# Initialize the operation object with one of the methods described in the
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* documentation for #psa_mac_operation_t, e.g. #PSA_MAC_OPERATION_INIT.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
* -# Call psa_mac_verify_setup() to specify the algorithm and key.
* -# Call psa_mac_update() zero, one or more times, passing a fragment
* of the message each time. The MAC that is calculated is the MAC
* of the concatenation of these messages in order.
* -# At the end of the message, call psa_mac_verify_finish() to finish
* calculating the actual MAC of the message and verify it against
* the expected value.
*
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* If an error occurs at any step after a call to psa_mac_verify_setup(), the
* operation will need to be reset by a call to psa_mac_abort(). The
* application may call psa_mac_abort() at any time after the operation
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* has been initialized.
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
*
* After a successful call to psa_mac_verify_setup(), the application must
* eventually terminate the operation through one of the following methods:
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* - A successful call to psa_mac_verify_finish().
* - A call to psa_mac_abort().
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
psa: Add initializers for MAC operation objects Add new initializers for MAC operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:03 +00:00
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_mac_operation_t and not yet in use.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document that destroying a key aborts any ongoing operation Document that psa_close_key() and psa_destroy_key() abort any ongoing multipart operation that is using the key. This is not implemented yet.
2019-01-14 17:24:53 +00:00
* It must remain valid until the operation
* terminates.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg The MAC algorithm to compute (\c PSA_ALG_XXX value
* such that #PSA_ALG_IS_MAC(\p alg) is true).
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* \c key is not compatible with \c alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
* \c alg is not supported or is not a MAC algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_mac_verify_setup
2019-08-07 15:18:18 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
* The key could not be retrieved from storage
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* The operation state is not valid (it must be inactive).
Document BAD_STATE errors for multipart operation setup functions Future commits will implement this and add tests.
2019-01-10 10:51:17 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Document some MAC functions: psa_mac_start Adapt the documentation of hash functions. State that the key object does not need to remain valid throughout the operation.
2018-02-16 20:24:11 +00:00
*/
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_key_handle_t handle,
Split psa_mac_setup -> psa_mac_{sign,verify}_setup Make function names for multipart operations more consistent (MAC setup edition). Split psa_mac_setup into two functions psa_mac_sign_setup and psa_mac_verify_setup. These functions behave identically except that they require different usage flags on the key. The goal of the split is to enforce the key policy during setup rather than at the end of the operation (which was a bit of a hack). In psa_mac_sign_finish and psa_mac_verify_finish, if the operation is of the wrong type, abort the operation before returning BAD_STATE.
2018-07-08 18:12:23 +00:00
psa_algorithm_t alg);
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Add a message fragment to a multipart MAC operation.
*
* The application must call psa_mac_sign_setup() or psa_mac_verify_setup()
* before calling this function.
*
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_mac_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active MAC operation.
* \param[in] input Buffer containing the message fragment to add to
* the MAC calculation.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param input_length Size of the \p input buffer in bytes.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* The operation state is not valid (it must be active).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added a few more return codes
2019-08-12 14:06:48 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
psa_status_t psa_mac_update(psa_mac_operation_t *operation,
const uint8_t *input,
size_t input_length);
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Finish the calculation of the MAC of a message.
*
* The application must call psa_mac_sign_setup() before calling this function.
* This function calculates the MAC of the message formed by concatenating
* the inputs passed to preceding calls to psa_mac_update().
*
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_mac_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \warning Applications should not call this function if they expect
* a specific value for the MAC. Call psa_mac_verify_finish() instead.
* Beware that comparing integrity or authenticity data such as
* MAC values with a function such as \c memcmp is risky
* because the time taken by the comparison may leak information
* about the MAC value which could allow an attacker to guess
* a valid MAC and thereby bypass security controls.
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active MAC operation.
* \param[out] mac Buffer where the MAC value is to be written.
* \param mac_size Size of the \p mac buffer in bytes.
* \param[out] mac_length On success, the number of bytes
* that make up the MAC value. This is always
Doc: Minor formatting and copy fixes
2018-07-12 17:40:46 +00:00
* #PSA_MAC_FINAL_SIZE(\c key_type, \c key_bits, \c alg)
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* where \c key_type and \c key_bits are the type and
Doc: Minor formatting and copy fixes
2018-07-12 17:40:46 +00:00
* bit-size respectively of the key and \c alg is the
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* MAC algorithm that is calculated.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* The operation state is not valid (it must be an active mac sign
* operation).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of the \p mac buffer is too small. You can determine a
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* sufficient buffer size by calling PSA_MAC_FINAL_SIZE().
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to psa_mac_sign_finish
2019-08-13 10:43:40 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Rename psa_mac_{finish,verify} -> psa_mac_{sign,verify}_finish Make function names for multipart operations more consistent (MAC finish edition).
2018-07-08 17:56:25 +00:00
psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
uint8_t *mac,
size_t mac_size,
size_t *mac_length);
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Finish the calculation of the MAC of a message and compare it with
* an expected value.
*
* The application must call psa_mac_verify_setup() before calling this function.
* This function calculates the MAC of the message formed by concatenating
* the inputs passed to preceding calls to psa_mac_update(). It then
* compares the calculated MAC with the expected MAC passed as a
* parameter to this function.
*
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_mac_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \note Implementations shall make the best effort to ensure that the
* comparison between the actual MAC and the expected MAC is performed
* in constant time.
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active MAC operation.
* \param[in] mac Buffer containing the expected MAC value.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param mac_length Size of the \p mac buffer in bytes.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* The expected MAC is identical to the actual MAC of the message.
* \retval #PSA_ERROR_INVALID_SIGNATURE
* The MAC of the message was calculated successfully, but it
* differs from the expected MAC.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* The operation state is not valid (it must be an active mac verify
* operation).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to psa_mac_verify_finish
2019-08-13 10:44:30 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Rename psa_mac_{finish,verify} -> psa_mac_{sign,verify}_finish Make function names for multipart operations more consistent (MAC finish edition).
2018-07-08 17:56:25 +00:00
psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
const uint8_t *mac,
size_t mac_length);
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Abort a MAC operation.
*
* Aborting an operation frees all associated resources except for the
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* \p operation structure itself. Once aborted, the operation object
* can be reused for another operation by calling
* psa_mac_sign_setup() or psa_mac_verify_setup() again.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* You may call this function any time after the operation object has
Update documentation for multipart mac operations
2019-09-11 22:04:42 +00:00
* been initialized by one of the methods described in #psa_mac_operation_t.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* In particular, calling psa_mac_abort() after the operation has been
* terminated by a call to psa_mac_abort(), psa_mac_sign_finish() or
* psa_mac_verify_finish() is safe and has no effect.
*
* \param[in,out] operation Initialized MAC operation.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
PSA: Implement MAC functions Implement psa_mac_start, psa_mac_update and psa_mac_final. Implement HMAC anc CMAC. Smoke tests.
2018-02-08 09:02:12 +00:00
psa_status_t psa_mac_abort(psa_mac_operation_t *operation);
/**@}*/
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
/** \defgroup cipher Symmetric ciphers
* @{
*/
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
/** Encrypt a message using a symmetric cipher.
*
* This function encrypts a message with a random IV (initialization
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* vector). Use the multipart operation interface with a
* #psa_cipher_operation_t object to provide other forms of IV.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*
* \param handle Handle to the key to use for the operation.
* It must remain valid until the operation
* terminates.
* \param alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true).
* \param[in] input Buffer containing the message to encrypt.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] output Buffer where the output is to be written.
* The output contains the IV followed by
* the ciphertext proper.
* \param output_size Size of the \p output buffer in bytes.
* \param[out] output_length On success, the number of bytes
* that make up the output.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a cipher algorithm.
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added PSA_ERROR_STORAGE_FAILURE to psa_cipher_(encrypt/decrypt)
2019-08-08 13:51:49 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*/
psa_status_t psa_cipher_encrypt(psa_key_handle_t handle,
psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
uint8_t *output,
size_t output_size,
size_t *output_length);
/** Decrypt a message using a symmetric cipher.
*
* This function decrypts a message encrypted with a symmetric cipher.
*
* \param handle Handle to the key to use for the operation.
* It must remain valid until the operation
* terminates.
* \param alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true).
* \param[in] input Buffer containing the message to decrypt.
* This consists of the IV followed by the
* ciphertext proper.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] output Buffer where the plaintext is to be written.
* \param output_size Size of the \p output buffer in bytes.
* \param[out] output_length On success, the number of bytes
* that make up the output.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not a cipher algorithm.
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Added PSA_ERROR_STORAGE_FAILURE to psa_cipher_(encrypt/decrypt)
2019-08-08 13:51:49 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Fix erroneous cut and paste
2019-08-23 15:17:43 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
Added missing return codes to get_key_attributes Note that PSA_ERROR_NOT_PERMITTED is not included because I can't think of a scenario where you have a valid key handle but aren't allowed to read the attributes
2019-08-06 15:02:12 +00:00
* results in this error code.
Declare one-shot hash, MAC and cipher functions Declare and document one-shot hash, MAC and cipher functions. This commit does not contain any implementation or tests.
2019-01-14 19:18:12 +00:00
*/
psa_status_t psa_cipher_decrypt(psa_key_handle_t handle,
psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
uint8_t *output,
size_t output_size,
size_t *output_length);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
/** The type of the state data structure for multipart cipher operations.
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
*
* Before calling any function on a cipher operation object, the application
* must initialize it by any of the following means:
* - Set the structure to all-bits-zero, for example:
* \code
* psa_cipher_operation_t operation;
* memset(&operation, 0, sizeof(operation));
* \endcode
* - Initialize the structure to logical zero values, for example:
* \code
* psa_cipher_operation_t operation = {0};
* \endcode
* - Initialize the structure to the initializer #PSA_CIPHER_OPERATION_INIT,
* for example:
* \code
* psa_cipher_operation_t operation = PSA_CIPHER_OPERATION_INIT;
* \endcode
* - Assign the result of the function psa_cipher_operation_init()
* to the structure, for example:
* \code
* psa_cipher_operation_t operation;
* operation = psa_cipher_operation_init();
* \endcode
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
* This is an implementation-defined \c struct. Applications should not
* make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */
typedef struct psa_cipher_operation_s psa_cipher_operation_t;
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
/** \def PSA_CIPHER_OPERATION_INIT
*
* This macro returns a suitable initializer for a cipher operation object of
* type #psa_cipher_operation_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_CIPHER_OPERATION_INIT {0}
#endif
/** Return an initial value for a cipher operation object.
*/
static psa_cipher_operation_t psa_cipher_operation_init(void);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
/** Set the key for a multipart symmetric encryption operation.
*
* The sequence of operations to encrypt a message with a symmetric cipher
* is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* -# Initialize the operation object with one of the methods described in the
* documentation for #psa_cipher_operation_t, e.g.
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* #PSA_CIPHER_OPERATION_INIT.
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
* -# Call psa_cipher_encrypt_setup() to specify the algorithm and key.
Update documentation due to function renaming
2018-08-02 11:19:33 +00:00
* -# Call either psa_cipher_generate_iv() or psa_cipher_set_iv() to
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
* generate or set the IV (initialization vector). You should use
Update documentation due to function renaming
2018-08-02 11:19:33 +00:00
* psa_cipher_generate_iv() unless the protocol you are implementing
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
* requires a specific IV value.
* -# Call psa_cipher_update() zero, one or more times, passing a fragment
* of the message each time.
* -# Call psa_cipher_finish().
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* If an error occurs at any step after a call to psa_cipher_encrypt_setup(),
* the operation will need to be reset by a call to psa_cipher_abort(). The
* application may call psa_cipher_abort() at any time after the operation
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* has been initialized.
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
* After a successful call to psa_cipher_encrypt_setup(), the application must
Clarify how multipart operations get terminated
2018-03-20 16:54:15 +00:00
* eventually terminate the operation. The following events terminate an
* operation:
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* - A successful call to psa_cipher_finish().
* - A call to psa_cipher_abort().
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_cipher_operation_t and not yet in use.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document that destroying a key aborts any ongoing operation Document that psa_close_key() and psa_destroy_key() abort any ongoing multipart operation that is using the key. This is not implemented yet.
2019-01-14 17:24:53 +00:00
* It must remain valid until the operation
* terminates.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true).
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \p alg is not supported or is not a cipher algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to (encrypt/decrypt)_setup
2019-08-13 10:46:09 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be inactive).
Document BAD_STATE errors for multipart operation setup functions Future commits will implement this and add tests.
2019-01-10 10:51:17 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*/
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_key_handle_t handle,
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_algorithm_t alg);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
/** Set the key for a multipart symmetric decryption operation.
*
* The sequence of operations to decrypt a message with a symmetric cipher
* is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* -# Initialize the operation object with one of the methods described in the
* documentation for #psa_cipher_operation_t, e.g.
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* #PSA_CIPHER_OPERATION_INIT.
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
* -# Call psa_cipher_decrypt_setup() to specify the algorithm and key.
Copyedit the documentation of multipart operation functions Finish changing "start" to "set up". Correct the way to set an IV for decryption: it's set_iv(), not update(). When decrypting, the IV is given, not random.
2019-01-14 17:29:18 +00:00
* -# Call psa_cipher_set_iv() with the IV (initialization vector) for the
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
* decryption. If the IV is prepended to the ciphertext, you can call
* psa_cipher_update() on a buffer containing the IV followed by the
* beginning of the message.
* -# Call psa_cipher_update() zero, one or more times, passing a fragment
* of the message each time.
* -# Call psa_cipher_finish().
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* If an error occurs at any step after a call to psa_cipher_decrypt_setup(),
* the operation will need to be reset by a call to psa_cipher_abort(). The
* application may call psa_cipher_abort() at any time after the operation
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* has been initialized.
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
* After a successful call to psa_cipher_decrypt_setup(), the application must
Clarify how multipart operations get terminated
2018-03-20 16:54:15 +00:00
* eventually terminate the operation. The following events terminate an
* operation:
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* - A successful call to psa_cipher_finish().
* - A call to psa_cipher_abort().
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
psa: Add initializers for cipher operation objects Add new initializers for cipher operation objects and use them in our tests and library code. Prefer using the macro initializers due to their straightforwardness.
2019-01-04 11:48:27 +00:00
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_cipher_operation_t and not yet in use.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document that destroying a key aborts any ongoing operation Document that psa_close_key() and psa_destroy_key() abort any ongoing multipart operation that is using the key. This is not implemented yet.
2019-01-14 17:24:53 +00:00
* It must remain valid until the operation
* terminates.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true).
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \p alg is not supported or is not a cipher algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to (encrypt/decrypt)_setup
2019-08-13 10:46:09 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be inactive).
Document BAD_STATE errors for multipart operation setup functions Future commits will implement this and add tests.
2019-01-10 10:51:17 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
*/
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_key_handle_t handle,
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_algorithm_t alg);
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Generate an IV for a symmetric encryption operation.
*
* This function generates a random IV (initialization vector), nonce
* or initial counter value for the encryption operation as appropriate
* for the chosen algorithm, key type and key size.
*
* The application must call psa_cipher_encrypt_setup() before
* calling this function.
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_cipher_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active cipher operation.
* \param[out] iv Buffer where the generated IV is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param iv_size Size of the \p iv buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] iv_length On success, the number of bytes of the
* generated IV.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be active, with no IV set).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Minor formatting and copy fixes
2018-07-12 17:40:46 +00:00
* The size of the \p iv buffer is too small.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_cipher_generate_iv
2019-08-15 12:30:57 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Use stdint.h types Follow MISRA C 2012 rules by using exact width types from stdint.h.
2019-03-22 11:24:17 +00:00
uint8_t *iv,
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
size_t iv_size,
size_t *iv_length);
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Set the IV for a symmetric encryption or decryption operation.
*
Copyedit the documentation of multipart operation functions Finish changing "start" to "set up". Correct the way to set an IV for decryption: it's set_iv(), not update(). When decrypting, the IV is given, not random.
2019-01-14 17:29:18 +00:00
* This function sets the IV (initialization vector), nonce
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* or initial counter value for the encryption or decryption operation.
*
* The application must call psa_cipher_encrypt_setup() before
* calling this function.
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_cipher_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \note When encrypting, applications should use psa_cipher_generate_iv()
* instead of this function, unless implementing a protocol that requires
* a non-random IV.
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active cipher operation.
* \param[in] iv Buffer containing the IV to use.
* \param iv_length Size of the IV in bytes.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be an active cipher
* encrypt operation, with no IV set).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of \p iv is not acceptable for the chosen algorithm,
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* or the chosen algorithm does not use an IV.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to psa_mac_sign_finish
2019-08-13 10:43:40 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Use stdint.h types Follow MISRA C 2012 rules by using exact width types from stdint.h.
2019-03-22 11:24:17 +00:00
const uint8_t *iv,
Rename psa cipher functions to psa_cipher_xxx Make function names for multipart operations more consistent (cipher edition). Rename symmetric cipher multipart operation functions so that they all start with psa_cipher_: * psa_encrypt_setup -> psa_cipher_encrypt_setup * psa_decrypt_setup -> psa_cipher_decrypt_setup * psa_encrypt_set_iv -> psa_cipher_set_iv * psa_encrypt_generate_iv -> psa_cipher_generate_iv
2018-07-08 19:39:34 +00:00
size_t iv_length);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Encrypt or decrypt a message fragment in an active cipher operation.
*
Doc: clarify the preconditions for psa_cipher_update
2018-07-12 18:15:32 +00:00
* Before calling this function, you must:
* 1. Call either psa_cipher_encrypt_setup() or psa_cipher_decrypt_setup().
* The choice of setup function determines whether this function
* encrypts or decrypts its input.
* 2. If the algorithm requires an IV, call psa_cipher_generate_iv()
* (recommended when encrypting) or psa_cipher_set_iv().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_cipher_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active cipher operation.
* \param[in] input Buffer containing the message fragment to
* encrypt or decrypt.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param input_length Size of the \p input buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output Buffer where the output is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param output_size Size of the \p output buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be active, with an IV set
* if required for the algorithm).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p output buffer is too small.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
const uint8_t *input,
initial implementation for PSA symmetric APIs - missing tests and documentations
2018-03-12 13:59:30 +00:00
size_t input_length,
Use stdint.h types Follow MISRA C 2012 rules by using exact width types from stdint.h.
2019-03-22 11:24:17 +00:00
uint8_t *output,
Normalize whitespace Normalize whitespace to Mbed TLS standards. There are only whitespace changes in this commit.
2018-06-18 13:41:12 +00:00
size_t output_size,
initial implementation for PSA symmetric APIs - missing tests and documentations
2018-03-12 13:59:30 +00:00
size_t *output_length);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Finish encrypting or decrypting a message in a cipher operation.
*
* The application must call psa_cipher_encrypt_setup() or
* psa_cipher_decrypt_setup() before calling this function. The choice
* of setup function determines whether this function encrypts or
* decrypts its input.
*
* This function finishes the encryption or decryption of the message
* formed by concatenating the inputs passed to preceding calls to
* psa_cipher_update().
*
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_cipher_abort().
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in,out] operation Active cipher operation.
* \param[out] output Buffer where the output is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param output_size Size of the \p output buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* Success.
Document more error codes
2019-07-18 11:52:30 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total input size passed to this operation is not valid for
* this particular algorithm. For example, the algorithm is a based
* on block cipher and requires a whole number of blocks, but the
* total input size is not a multiple of the block size.
* \retval #PSA_ERROR_INVALID_PADDING
* This is a decryption operation for an algorithm that includes
* padding, and the ciphertext does not contain valid padding.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* The operation state is not valid (it must be active, with an IV set
* if required for the algorithm).
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p output buffer is too small.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add storage failure to psa_mac_verify_finish
2019-08-13 10:44:30 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
initial implementation for PSA symmetric APIs - missing tests and documentations
2018-03-12 13:59:30 +00:00
uint8_t *output,
add missing parameter output_size on psa_cipher_finish
2018-04-22 17:16:58 +00:00
size_t output_size,
initial implementation for PSA symmetric APIs - missing tests and documentations
2018-03-12 13:59:30 +00:00
size_t *output_length);
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
/** Abort a cipher operation.
*
* Aborting an operation frees all associated resources except for the
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
* \p operation structure itself. Once aborted, the operation object
* can be reused for another operation by calling
* psa_cipher_encrypt_setup() or psa_cipher_decrypt_setup() again.
*
* You may call this function any time after the operation object has
Update documentation for multipart cipher operations
2019-09-11 22:33:30 +00:00
* been initialized as described in #psa_cipher_operation_t.
Improve documentation of abort functions Explicitly state that calling abort is safe after initializing to zero. Explicitly state that calling abort on an inactive operation is safe, and replace "active" by "initialized" in the description of the parameter. Get rid of the recommendation for implementers to try to handle uninitialized structures safely. It's good advice in principle but cannot be achieved in a robust way and the wording was confusing.
2018-07-13 13:33:43 +00:00
*
* In particular, calling psa_cipher_abort() after the operation has been
* terminated by a call to psa_cipher_abort() or psa_cipher_finish()
* is safe and has no effect.
*
* \param[in,out] operation Initialized cipher operation.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc: write documentation for many macros and functions As of this commit, all #identifier links in the documentation are resolved.
2018-07-11 22:30:52 +00:00
*/
Prototypes for symmetric cipher functions
2018-03-03 20:27:18 +00:00
psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation);
/**@}*/
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
/** \defgroup aead Authenticated encryption with associated data (AEAD)
* @{
*/
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
/** Process an authenticated encryption operation.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* \param alg The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that
Doc: fix formatting of some macro arguments in explanations
2018-07-11 22:34:26 +00:00
* #PSA_ALG_IS_AEAD(\p alg) is true).
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] nonce Nonce or IV to use.
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* \param nonce_length Size of the \p nonce buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] additional_data Additional data that will be authenticated
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* but not encrypted.
* \param additional_data_length Size of \p additional_data in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] plaintext Data that will be authenticated and
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* encrypted.
* \param plaintext_length Size of \p plaintext in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] ciphertext Output buffer for the authenticated and
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* 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 ciphertext_size Size of the \p ciphertext buffer in bytes.
* This must be at least
* #PSA_AEAD_ENCRYPT_OUTPUT_SIZE(\p alg,
* \p plaintext_length).
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] ciphertext_length On success, the size of the output
Fix typos in doxygen formatting commands
2019-02-08 10:22:39 +00:00
* in the \p ciphertext buffer.
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \p alg is not supported or is not an AEAD algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \p ciphertext_size is too small
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_aead_*_setup functions
2019-08-08 14:10:33 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_aead_encrypt(psa_key_handle_t handle,
Fix nonstandard whitespace
2018-07-19 13:51:49 +00:00
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);
Change AEAD APIs to integrated AEAD APIs. Change AEAD APIs to integrated AEAD APIs, this will allow t support CCM and GCM algorithms.
2018-04-25 21:51:02 +00:00
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
/** Process an authenticated decryption operation.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* \param alg The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that
Doc: fix formatting of some macro arguments in explanations
2018-07-11 22:34:26 +00:00
* #PSA_ALG_IS_AEAD(\p alg) is true).
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] nonce Nonce or IV to use.
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* \param nonce_length Size of the \p nonce buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] additional_data Additional data that has been authenticated
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* but not encrypted.
* \param additional_data_length Size of \p additional_data in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] ciphertext Data that has been authenticated and
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* 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 ciphertext_length Size of \p ciphertext in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] plaintext Output buffer for the decrypted data.
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* \param plaintext_size Size of the \p plaintext buffer in bytes.
* This must be at least
* #PSA_AEAD_DECRYPT_OUTPUT_SIZE(\p alg,
* \p ciphertext_length).
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] plaintext_length On success, the size of the output
Fix typos in doxygen formatting commands
2019-02-08 10:22:39 +00:00
* in the \p plaintext buffer.
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
* Success.
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INVALID_SIGNATURE
Document AEAD functions Write documentation for psa_aead_encrypt and psa_aead_decrypt. Define macros PSA_AEAD_ENCRYPT_OUTPUT_SIZE and PSA_AEAD_DECRYPT_OUTPUT_SIZE (untested).
2018-06-01 14:29:38 +00:00
* The ciphertext is not authentic.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \p alg is not supported or is not an AEAD algorithm.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Added missing return codes to psa_aead_decrypt
2019-08-08 09:55:38 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \p plaintext_size or \p nonce_length is too small
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added missing return codes to psa_aead_decrypt
2019-08-08 09:55:38 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_aead_decrypt(psa_key_handle_t handle,
Fix nonstandard whitespace
2018-07-19 13:51:49 +00:00
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);
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
/** The type of the state data structure for multipart AEAD operations.
*
* Before calling any function on an AEAD operation object, the application
* must initialize it by any of the following means:
* - Set the structure to all-bits-zero, for example:
* \code
* psa_aead_operation_t operation;
* memset(&operation, 0, sizeof(operation));
* \endcode
* - Initialize the structure to logical zero values, for example:
* \code
* psa_aead_operation_t operation = {0};
* \endcode
* - Initialize the structure to the initializer #PSA_AEAD_OPERATION_INIT,
* for example:
* \code
* psa_aead_operation_t operation = PSA_AEAD_OPERATION_INIT;
* \endcode
* - Assign the result of the function psa_aead_operation_init()
* to the structure, for example:
* \code
* psa_aead_operation_t operation;
* operation = psa_aead_operation_init();
* \endcode
*
* This is an implementation-defined \c struct. Applications should not
* make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */
typedef struct psa_aead_operation_s psa_aead_operation_t;
/** \def PSA_AEAD_OPERATION_INIT
*
* This macro returns a suitable initializer for an AEAD operation object of
* type #psa_aead_operation_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_AEAD_OPERATION_INIT {0}
#endif
/** Return an initial value for an AEAD operation object.
*/
static psa_aead_operation_t psa_aead_operation_init(void);
/** Set the key for a multipart authenticated encryption operation.
*
* The sequence of operations to encrypt a message with authentication
* is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
* -# Initialize the operation object with one of the methods described in the
* documentation for #psa_aead_operation_t, e.g.
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* #PSA_AEAD_OPERATION_INIT.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* -# Call psa_aead_encrypt_setup() to specify the algorithm and key.
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* -# If needed, call psa_aead_set_lengths() to specify the length of the
* inputs to the subsequent calls to psa_aead_update_ad() and
* psa_aead_update(). See the documentation of psa_aead_set_lengths()
* for details.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* -# Call either psa_aead_generate_nonce() or psa_aead_set_nonce() to
* generate or set the nonce. You should use
* psa_aead_generate_nonce() unless the protocol you are implementing
* requires a specific nonce value.
* -# Call psa_aead_update_ad() zero, one or more times, passing a fragment
* of the non-encrypted additional authenticated data each time.
* -# Call psa_aead_update() zero, one or more times, passing a fragment
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
* of the message to encrypt each time.
Remove errorneous insert
2019-08-15 09:53:47 +00:00
* -# Call psa_aead_finish().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If an error occurs at any step after a call to psa_aead_encrypt_setup(),
* the operation will need to be reset by a call to psa_aead_abort(). The
* application may call psa_aead_abort() at any time after the operation
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* has been initialized.
*
* After a successful call to psa_aead_encrypt_setup(), the application must
* eventually terminate the operation. The following events terminate an
* operation:
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* - A successful call to psa_aead_finish().
* - A call to psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_aead_operation_t and not yet in use.
* \param handle Handle to the key to use for the operation.
* It must remain valid until the operation
* terminates.
* \param alg The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_AEAD(\p alg) is true).
*
* \retval #PSA_SUCCESS
* Success.
Fix PSA_ERROR_BAD_STATE messages Remove some duplicated entries and added some missing ones.
2019-09-11 20:33:41 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* The operation state is not valid (it must be inactive).
Fix PSA_ERROR_BAD_STATE messages Remove some duplicated entries and added some missing ones.
2019-09-11 20:33:41 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not an AEAD algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_aead_*_setup functions
2019-08-08 14:10:33 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
psa_key_handle_t handle,
psa_algorithm_t alg);
/** Set the key for a multipart authenticated decryption operation.
*
* The sequence of operations to decrypt a message with authentication
* is as follows:
* -# Allocate an operation object which will be passed to all the functions
* listed here.
* -# Initialize the operation object with one of the methods described in the
* documentation for #psa_aead_operation_t, e.g.
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* #PSA_AEAD_OPERATION_INIT.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* -# Call psa_aead_decrypt_setup() to specify the algorithm and key.
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* -# If needed, call psa_aead_set_lengths() to specify the length of the
* inputs to the subsequent calls to psa_aead_update_ad() and
* psa_aead_update(). See the documentation of psa_aead_set_lengths()
* for details.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* -# Call psa_aead_set_nonce() with the nonce for the decryption.
* -# Call psa_aead_update_ad() zero, one or more times, passing a fragment
* of the non-encrypted additional authenticated data each time.
* -# Call psa_aead_update() zero, one or more times, passing a fragment
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
* of the ciphertext to decrypt each time.
* -# Call psa_aead_verify().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If an error occurs at any step after a call to psa_aead_decrypt_setup(),
* the operation will need to be reset by a call to psa_aead_abort(). The
* application may call psa_aead_abort() at any time after the operation
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* has been initialized.
*
* After a successful call to psa_aead_decrypt_setup(), the application must
* eventually terminate the operation. The following events terminate an
* operation:
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* - A successful call to psa_aead_verify().
* - A call to psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for
* #psa_aead_operation_t and not yet in use.
* \param handle Handle to the key to use for the operation.
* It must remain valid until the operation
* terminates.
* \param alg The AEAD algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_AEAD(\p alg) is true).
*
* \retval #PSA_SUCCESS
* Success.
Fix PSA_ERROR_BAD_STATE messages Remove some duplicated entries and added some missing ones.
2019-09-11 20:33:41 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* The operation state is not valid (it must be inactive).
Fix PSA_ERROR_BAD_STATE messages Remove some duplicated entries and added some missing ones.
2019-09-11 20:33:41 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* \p handle is not compatible with \p alg.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported or is not an AEAD algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add PSA_ERROR_STORAGE_FAILURE to psa_aead_*_setup functions
2019-08-08 14:10:33 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
psa_key_handle_t handle,
psa_algorithm_t alg);
/** Generate a random nonce for an authenticated encryption operation.
*
* This function generates a random nonce for the authenticated encryption
* operation with an appropriate size for the chosen algorithm, key type
* and key size.
*
* The application must call psa_aead_encrypt_setup() before
* calling this function.
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \param[in,out] operation Active AEAD operation.
* \param[out] nonce Buffer where the generated nonce is to be
* written.
* \param nonce_size Size of the \p nonce buffer in bytes.
* \param[out] nonce_length On success, the number of bytes of the
* generated nonce.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* The operation state is not valid (it must be an active aead encrypt
operation, with no nonce set).
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p nonce buffer is too small.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
Use stdint.h types in multipart AEAD functions No implementation yet.
2019-05-15 11:34:01 +00:00
uint8_t *nonce,
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
size_t nonce_size,
size_t *nonce_length);
/** Set the nonce for an authenticated encryption or decryption operation.
*
* This function sets the nonce for the authenticated
* encryption or decryption operation.
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* The application must call psa_aead_encrypt_setup() or
* psa_aead_decrypt_setup() before calling this function.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
* \note When encrypting, applications should use psa_aead_generate_nonce()
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* instead of this function, unless implementing a protocol that requires
* a non-random IV.
*
* \param[in,out] operation Active AEAD operation.
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
* \param[in] nonce Buffer containing the nonce to use.
* \param nonce_length Size of the nonce in bytes.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* The operation state is not valid (it must be active, with no nonce
* set).
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The size of \p nonce is not acceptable for the chosen algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
Use stdint.h types in multipart AEAD functions No implementation yet.
2019-05-15 11:34:01 +00:00
const uint8_t *nonce,
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
size_t nonce_length);
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
/** Declare the lengths of the message and additional data for AEAD.
*
* The application must call this function before calling
* psa_aead_update_ad() or psa_aead_update() if the algorithm for
* the operation requires it. If the algorithm does not require it,
* calling this function is optional, but if this function is called
* then the implementation must enforce the lengths.
*
* You may call this function before or after setting the nonce with
* psa_aead_set_nonce() or psa_aead_generate_nonce().
*
* - For #PSA_ALG_CCM, calling this function is required.
* - For the other AEAD algorithms defined in this specification, calling
* this function is not required.
* - For vendor-defined algorithm, refer to the vendor documentation.
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
*
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \param[in,out] operation Active AEAD operation.
* \param ad_length Size of the non-encrypted additional
* authenticated data in bytes.
* \param plaintext_length Size of the plaintext to encrypt in bytes.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* The operation state is not valid (it must be active, and
* psa_aead_update_ad() and psa_aead_update() must not have been
* called yet).
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* At least one of the lengths is not acceptable for the chosen
* algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
*/
psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
size_t ad_length,
size_t plaintext_length);
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
/** Pass additional data to an active AEAD operation.
*
* Additional data is authenticated, but not encrypted.
*
* You may call this function multiple times to pass successive fragments
* of the additional data. You may not call this function after passing
* data to encrypt or decrypt with psa_aead_update().
*
* Before calling this function, you must:
* 1. Call either psa_aead_encrypt_setup() or psa_aead_decrypt_setup().
* 2. Set the nonce with psa_aead_generate_nonce() or psa_aead_set_nonce().
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \warning When decrypting, until psa_aead_verify() has returned #PSA_SUCCESS,
* there is no guarantee that the input is valid. Therefore, until
* you have called psa_aead_verify() and it has returned #PSA_SUCCESS,
* treat the input as untrusted and prepare to undo any action that
* depends on the input if psa_aead_verify() returns an error status.
*
* \param[in,out] operation Active AEAD operation.
* \param[in] input Buffer containing the fragment of
* additional data.
* \param input_length Size of the \p input buffer in bytes.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* The operation state is not valid (it must be active, have a nonce
* set, have lengths set if required by the algorithm, and
* psa_aead_update() must not have been called yet).
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total input length overflows the additional data length that
* was previously specified with psa_aead_set_lengths().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
const uint8_t *input,
size_t input_length);
/** Encrypt or decrypt a message fragment in an active AEAD operation.
*
* Before calling this function, you must:
* 1. Call either psa_aead_encrypt_setup() or psa_aead_decrypt_setup().
* The choice of setup function determines whether this function
* encrypts or decrypts its input.
* 2. Set the nonce with psa_aead_generate_nonce() or psa_aead_set_nonce().
* 3. Call psa_aead_update_ad() to pass all the additional data.
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \warning When decrypting, until psa_aead_verify() has returned #PSA_SUCCESS,
* there is no guarantee that the input is valid. Therefore, until
* you have called psa_aead_verify() and it has returned #PSA_SUCCESS:
* - Do not use the output in any way other than storing it in a
* confidential location. If you take any action that depends
* on the tentative decrypted data, this action will need to be
* undone if the input turns out not to be valid. Furthermore,
* if an adversary can observe that this action took place
* (for example through timing), they may be able to use this
* fact as an oracle to decrypt any message encrypted with the
* same key.
* - In particular, do not copy the output anywhere but to a
* memory or storage space that you have exclusive access to.
*
Allow AEAD update output to be delayed Do not require finish() to have empty output for any algorithm. Some hardware does not support immediate stream processing.
2019-05-06 13:42:54 +00:00
* This function does not require the input to be aligned to any
* particular block boundary. If the implementation can only process
Documentation improvements
2019-05-14 14:10:53 +00:00
* a whole block at a time, it must consume all the input provided, but
* it may delay the end of the corresponding output until a subsequent
* call to psa_aead_update(), psa_aead_finish() or psa_aead_verify()
* provides sufficient input. The amount of data that can be delayed
* in this way is bounded by #PSA_AEAD_UPDATE_OUTPUT_SIZE.
Allow AEAD update output to be delayed Do not require finish() to have empty output for any algorithm. Some hardware does not support immediate stream processing.
2019-05-06 13:42:54 +00:00
*
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[in,out] operation Active AEAD operation.
* \param[in] input Buffer containing the message fragment to
* encrypt or decrypt.
* \param input_length Size of the \p input buffer in bytes.
* \param[out] output Buffer where the output is to be written.
* \param output_size Size of the \p output buffer in bytes.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* This must be at least
* #PSA_AEAD_UPDATE_OUTPUT_SIZE(\c alg,
* \p input_length) where \c alg is the
* algorithm that is being calculated.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* The operation state is not valid (it must be active, have a nonce
* set, and have lengths set if required by the algorithm).
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p output buffer is too small.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* You can determine a sufficient buffer size by calling
* #PSA_AEAD_UPDATE_OUTPUT_SIZE(\c alg, \p input_length)
* where \c alg is the algorithm that is being calculated.
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total length of input to psa_aead_update_ad() so far is
* less than the additional data length that was previously
* specified with psa_aead_set_lengths().
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total input length overflows the plaintext length that
* was previously specified with psa_aead_set_lengths().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_update(psa_aead_operation_t *operation,
const uint8_t *input,
size_t input_length,
Use stdint.h types in multipart AEAD functions No implementation yet.
2019-05-15 11:34:01 +00:00
uint8_t *output,
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
size_t output_size,
size_t *output_length);
/** Finish encrypting a message in an AEAD operation.
*
* The operation must have been set up with psa_aead_encrypt_setup().
*
* This function finishes the authentication of the additional data
* formed by concatenating the inputs passed to preceding calls to
* psa_aead_update_ad() with the plaintext formed by concatenating the
* inputs passed to preceding calls to psa_aead_update().
*
* This function has two output buffers:
* - \p ciphertext contains trailing ciphertext that was buffered from
Allow AEAD update output to be delayed Do not require finish() to have empty output for any algorithm. Some hardware does not support immediate stream processing.
2019-05-06 13:42:54 +00:00
* preceding calls to psa_aead_update().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* - \p tag contains the authentication tag. Its length is always
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* #PSA_AEAD_TAG_LENGTH(\c alg) where \c alg is the AEAD algorithm
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* that the operation performs.
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \param[in,out] operation Active AEAD operation.
* \param[out] ciphertext Buffer where the last part of the ciphertext
* is to be written.
* \param ciphertext_size Size of the \p ciphertext buffer in bytes.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* This must be at least
* #PSA_AEAD_FINISH_OUTPUT_SIZE(\c alg) where
* \c alg is the algorithm that is being
* calculated.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[out] ciphertext_length On success, the number of bytes of
* returned ciphertext.
* \param[out] tag Buffer where the authentication tag is
* to be written.
* \param tag_size Size of the \p tag buffer in bytes.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* This must be at least
* #PSA_AEAD_TAG_LENGTH(\c alg) where \c alg is
* the algorithm that is being calculated.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[out] tag_length On success, the number of bytes
* that make up the returned tag.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_BAD_STATE
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* The operation state is not valid (it must be an active encryption
* operation with a nonce set).
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* The size of the \p ciphertext or \p tag buffer is too small.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* You can determine a sufficient buffer size for \p ciphertext by
* calling #PSA_AEAD_FINISH_OUTPUT_SIZE(\c alg)
* where \c alg is the algorithm that is being calculated.
* You can determine a sufficient buffer size for \p tag by
* calling #PSA_AEAD_TAG_LENGTH(\c alg).
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total length of input to psa_aead_update_ad() so far is
* less than the additional data length that was previously
* specified with psa_aead_set_lengths().
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total length of input to psa_aead_update() so far is
* less than the plaintext length that was previously
* specified with psa_aead_set_lengths().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
Fix typos in recently-added documentation
2019-01-17 14:25:52 +00:00
uint8_t *ciphertext,
size_t ciphertext_size,
size_t *ciphertext_length,
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
uint8_t *tag,
size_t tag_size,
size_t *tag_length);
/** Finish authenticating and decrypting a message in an AEAD operation.
*
* The operation must have been set up with psa_aead_decrypt_setup().
*
Add missing error case to psa_aead_verify
2019-09-12 08:44:33 +00:00
* This function finishes the authenticated decryption of the message
* components:
*
* - The additional data consisting of the concatenation of the inputs
* passed to preceding calls to psa_aead_update_ad().
* - The ciphertext consisting of the concatenation of the inputs passed to
* preceding calls to psa_aead_update().
* - The tag passed to this function call.
*
* If the authentication tag is correct, this function outputs any remaining
* plaintext and reports success. If the authentication tag is not correct,
* this function returns #PSA_ERROR_INVALID_SIGNATURE.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* When this function returns successfuly, the operation becomes inactive.
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_aead_abort().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
Add missing error case to psa_aead_verify
2019-09-12 08:44:33 +00:00
* \note Implementations shall make the best effort to ensure that the
* comparison between the actual tag and the expected tag is performed
* in constant time.
*
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[in,out] operation Active AEAD operation.
Add output parameter for psa_aead_verify Like psa_aead_finish(), psa_aead_verify() needs to produce output from the last partial block of input if psa_aead_update() cannot produce output byte by byte.
2019-05-06 13:56:05 +00:00
* \param[out] plaintext Buffer where the last part of the plaintext
Documentation improvements
2019-05-14 14:10:53 +00:00
* is to be written. This is the remaining data
Add output parameter for psa_aead_verify Like psa_aead_finish(), psa_aead_verify() needs to produce output from the last partial block of input if psa_aead_update() cannot produce output byte by byte.
2019-05-06 13:56:05 +00:00
* from previous calls to psa_aead_update()
* that could not be processed until the end
* of the input.
* \param plaintext_size Size of the \p plaintext buffer in bytes.
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* This must be at least
* #PSA_AEAD_VERIFY_OUTPUT_SIZE(\c alg) where
* \c alg is the algorithm that is being
* calculated.
Add output parameter for psa_aead_verify Like psa_aead_finish(), psa_aead_verify() needs to produce output from the last partial block of input if psa_aead_update() cannot produce output byte by byte.
2019-05-06 13:56:05 +00:00
* \param[out] plaintext_length On success, the number of bytes of
* returned plaintext.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \param[in] tag Buffer containing the authentication tag.
* \param tag_length Size of the \p tag buffer in bytes.
*
* \retval #PSA_SUCCESS
* Success.
Add missing error case to psa_aead_verify
2019-09-12 08:44:33 +00:00
* \retval #PSA_ERROR_INVALID_SIGNATURE
* The calculations were successful, but the authentication tag is
* not correct.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_BAD_STATE
Clarify valid state descriptions
2019-09-18 16:47:25 +00:00
* The operation state is not valid (it must be an active decryption
* operation with a nonce set).
Add size macros for multipart AEAD New macros PSA_AEAD_UPDATE_OUTPUT_SIZE, PSA_AEAD_FINISH_OUTPUT_SIZE and PSA_AEAD_VERIFY_OUTPUT_SIZE to determine the output buffer sizes for psa_aead_update(), psa_aead_finish() and psa_aead_verify().
2019-05-06 13:16:19 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p plaintext buffer is too small.
* You can determine a sufficient buffer size for \p plaintext by
* calling #PSA_AEAD_VERIFY_OUTPUT_SIZE(\c alg)
* where \c alg is the algorithm that is being calculated.
Doc only: Add psa_aead_set_lengths() for the sake of CCM
2019-01-17 14:26:08 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total length of input to psa_aead_update_ad() so far is
* less than the additional data length that was previously
* specified with psa_aead_set_lengths().
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The total length of input to psa_aead_update() so far is
* less than the plaintext length that was previously
* specified with psa_aead_set_lengths().
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
Add output parameter for psa_aead_verify Like psa_aead_finish(), psa_aead_verify() needs to produce output from the last partial block of input if psa_aead_update() cannot produce output byte by byte.
2019-05-06 13:56:05 +00:00
uint8_t *plaintext,
size_t plaintext_size,
size_t *plaintext_length,
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
const uint8_t *tag,
size_t tag_length);
/** Abort an AEAD operation.
*
* Aborting an operation frees all associated resources except for the
* \p operation structure itself. Once aborted, the operation object
* can be reused for another operation by calling
* psa_aead_encrypt_setup() or psa_aead_decrypt_setup() again.
*
* You may call this function any time after the operation object has
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* been initialized as described in #psa_aead_operation_t.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* In particular, calling psa_aead_abort() after the operation has been
Update documentation for multipart aead operations
2019-09-11 23:02:45 +00:00
* terminated by a call to psa_aead_abort(), psa_aead_finish() or
* psa_aead_verify() is safe and has no effect.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*
* \param[in,out] operation Initialized AEAD operation.
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Declare multipart AEAD functions Declare and document multipart AEAD functions. This commit does not contain any implementation or tests.
2019-01-14 17:36:12 +00:00
*/
psa_status_t psa_aead_abort(psa_aead_operation_t *operation);
Prototypes for AEAD functions This is still tentative.
2018-03-03 20:27:57 +00:00
/**@}*/
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
/** \defgroup asymmetric Asymmetric cryptography
* @{
*/
/**
* \brief Sign a hash or short message with a private key.
*
Clarify that asymmetric_{sign,verify} operate on a hash
2018-06-26 14:14:46 +00:00
* Note that to perform a hash-and-sign signature algorithm, you must
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* first calculate the hash by calling psa_hash_setup(), psa_hash_update()
Clarify that asymmetric_{sign,verify} operate on a hash
2018-06-26 14:14:46 +00:00
* and psa_hash_finish(). Then pass the resulting hash as the \p hash
* parameter to this function. You can use #PSA_ALG_SIGN_GET_HASH(\p alg)
* to determine the hash algorithm to use.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
* It must be an asymmetric key pair.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg A signature algorithm that is compatible with
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* the type of \p handle.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] hash The hash or message to sign.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param hash_length Size of the \p hash buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] signature Buffer where the signature is to be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param signature_size Size of the \p signature buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] signature_length On success, the number of bytes
* that make up the returned signature value.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Add missing parameters to psa_asymmetric_sign
2019-08-08 10:10:32 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of the \p signature buffer is too small. You can
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* determine a sufficient buffer size by calling
Rename some signature-related identifiers Rename some macros and functions related to signature which are changing as part of the addition of psa_sign_message and psa_verify_message. perl -i -pe '%t = ( PSA_KEY_USAGE_SIGN => PSA_KEY_USAGE_SIGN_HASH, PSA_KEY_USAGE_VERIFY => PSA_KEY_USAGE_VERIFY_HASH, PSA_ASYMMETRIC_SIGNATURE_MAX_SIZE => PSA_SIGNATURE_MAX_SIZE, PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE => PSA_SIGN_OUTPUT_SIZE, psa_asymmetric_sign => psa_sign_hash, psa_asymmetric_verify => psa_verify_hash, ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files . ':!:**/crypto_compat.h')
2019-11-26 16:01:59 +00:00
* #PSA_SIGN_OUTPUT_SIZE(\c key_type, \c key_bits, \p alg)
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* where \c key_type and \c key_bits are the type and bit-size
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* respectively of \p handle.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing parameters to psa_asymmetric_sign
2019-08-08 10:10:32 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
*/
Rename some signature-related identifiers Rename some macros and functions related to signature which are changing as part of the addition of psa_sign_message and psa_verify_message. perl -i -pe '%t = ( PSA_KEY_USAGE_SIGN => PSA_KEY_USAGE_SIGN_HASH, PSA_KEY_USAGE_VERIFY => PSA_KEY_USAGE_VERIFY_HASH, PSA_ASYMMETRIC_SIGNATURE_MAX_SIZE => PSA_SIGNATURE_MAX_SIZE, PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE => PSA_SIGN_OUTPUT_SIZE, psa_asymmetric_sign => psa_sign_hash, psa_asymmetric_verify => psa_verify_hash, ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files . ':!:**/crypto_compat.h')
2019-11-26 16:01:59 +00:00
psa_status_t psa_sign_hash(psa_key_handle_t handle,
psa_algorithm_t alg,
const uint8_t *hash,
size_t hash_length,
uint8_t *signature,
size_t signature_size,
size_t *signature_length);
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
/**
* \brief Verify the signature a hash or short message using a public key.
*
Clarify that asymmetric_{sign,verify} operate on a hash
2018-06-26 14:14:46 +00:00
* Note that to perform a hash-and-sign signature algorithm, you must
Rename psa_hash_start -> psa_hash_setup Make function names for multipart operations more consistent (hash edition).
2018-07-08 17:46:38 +00:00
* first calculate the hash by calling psa_hash_setup(), psa_hash_update()
Clarify that asymmetric_{sign,verify} operate on a hash
2018-06-26 14:14:46 +00:00
* and psa_hash_finish(). Then pass the resulting hash as the \p hash
* parameter to this function. You can use #PSA_ALG_SIGN_GET_HASH(\p alg)
* to determine the hash algorithm to use.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
* It must be a public key or an asymmetric key pair.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* \param alg A signature algorithm that is compatible with
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* the type of \p handle.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] hash The hash or message whose signature is to be
Clarify that asymmetric_{sign,verify} operate on a hash
2018-06-26 14:14:46 +00:00
* verified.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param hash_length Size of the \p hash buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] signature Buffer containing the signature to verify.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param signature_length Size of the \p signature buffer in bytes.
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* The signature is valid.
Add missing return codes to psa_asymmetric_verify
2019-08-08 10:11:43 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INVALID_SIGNATURE
Wrote documentation for several functions, macros and types Document key import/export functions, hash functions, and asymmetric sign/verify, as well as some related macros and types. Nicer formatting for return values: use \retval.
2018-02-08 08:47:44 +00:00
* The calculation was perfomed successfully, but the passed
* signature is not a valid signature.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing return codes to psa_asymmetric_verify
2019-08-08 10:11:43 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
*/
Rename some signature-related identifiers Rename some macros and functions related to signature which are changing as part of the addition of psa_sign_message and psa_verify_message. perl -i -pe '%t = ( PSA_KEY_USAGE_SIGN => PSA_KEY_USAGE_SIGN_HASH, PSA_KEY_USAGE_VERIFY => PSA_KEY_USAGE_VERIFY_HASH, PSA_ASYMMETRIC_SIGNATURE_MAX_SIZE => PSA_SIGNATURE_MAX_SIZE, PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE => PSA_SIGN_OUTPUT_SIZE, psa_asymmetric_sign => psa_sign_hash, psa_asymmetric_verify => psa_verify_hash, ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files . ':!:**/crypto_compat.h')
2019-11-26 16:01:59 +00:00
psa_status_t psa_verify_hash(psa_key_handle_t handle,
psa_algorithm_t alg,
const uint8_t *hash,
size_t hash_length,
const uint8_t *signature,
size_t signature_length);
PSA crypto: asymmetric signature (RSA PKCS#1v1.5 only) Define hash algorithms and RSA signature algorithms. New function psa_asymmetric_sign. Implement psa_asymmetric_sign for RSA PKCS#1 v1.5.
2018-02-03 21:44:14 +00:00
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
/**
* \brief Encrypt a short message with a public key.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
* It must be a public key or an asymmetric
* key pair.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg An asymmetric encryption algorithm that is
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* compatible with the type of \p handle.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] input The message to encrypt.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param input_length Size of the \p input buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] salt A salt or label, if supported by the
* encryption algorithm.
* If the algorithm does not support a
* salt, pass \c NULL.
* If the algorithm supports an optional
* salt and you do not want to pass a salt,
* pass \c NULL.
*
* - For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
* supported.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param salt_length Size of the \p salt buffer in bytes.
* If \p salt is \c NULL, pass 0.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output Buffer where the encrypted message is to
* be written.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param output_size Size of the \p output buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Add missing return codes to psa_asymmetric_encrypt
2019-08-08 09:27:50 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of the \p output buffer is too small. You can
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
* determine a sufficient buffer size by calling
Doc: fix formatting of some macro arguments in explanations
2018-07-11 22:34:26 +00:00
* #PSA_ASYMMETRIC_ENCRYPT_OUTPUT_SIZE(\c key_type, \c key_bits, \p alg)
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
* where \c key_type and \c key_bits are the type and bit-size
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* respectively of \p handle.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing return codes to psa_asymmetric_encrypt
2019-08-08 09:27:50 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_asymmetric_encrypt(psa_key_handle_t handle,
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
const uint8_t *salt,
size_t salt_length,
uint8_t *output,
size_t output_size,
size_t *output_length);
/**
* \brief Decrypt a short message with a private key.
*
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
* \param handle Handle to the key to use for the operation.
* It must be an asymmetric key pair.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param alg An asymmetric encryption algorithm that is
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* compatible with the type of \p handle.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] input The message to decrypt.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param input_length Size of the \p input buffer in bytes.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[in] salt A salt or label, if supported by the
* encryption algorithm.
* If the algorithm does not support a
* salt, pass \c NULL.
* If the algorithm supports an optional
* salt and you do not want to pass a salt,
* pass \c NULL.
*
* - For #PSA_ALG_RSA_PKCS1V15_CRYPT, no salt is
* supported.
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* \param salt_length Size of the \p salt buffer in bytes.
* If \p salt is \c NULL, pass 0.
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output Buffer where the decrypted message is to
* be written.
* \param output_size Size of the \c output buffer in bytes.
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Add missing return codes to psa_asymmetric_decrypt
2019-08-08 09:30:58 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
Doc: Fix some \c name that should have been \p name
2018-07-12 17:23:03 +00:00
* The size of the \p output buffer is too small. You can
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
* determine a sufficient buffer size by calling
Doc: Minor formatting and copy fixes
2018-07-12 17:40:46 +00:00
* #PSA_ASYMMETRIC_DECRYPT_OUTPUT_SIZE(\c key_type, \c key_bits, \p alg)
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
* where \c key_type and \c key_bits are the type and bit-size
Fix some copypasta in references to parameter names Validated by perl -ne 'if (/^\/\*\*/) {%param=(); @p=()} if (/\\param.*? (\w+)/) {$param{$1}=1} while (/\\p \*?(\w+)/g) {push @p,[$1,ARGV->input_line_number()]} if (/^\ \*\//) {foreach (@p) {if (!$param{$_->[0]}) {printf "%s:%d: bad \\p %s\n", $ARGV, $_->[1], $_->[0]}}} close ARGV if eof' include/psa/*.h
2019-03-05 18:32:26 +00:00
* respectively of \p handle.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing return codes to psa_asymmetric_decrypt
2019-08-08 09:30:58 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
* \retval #PSA_ERROR_INVALID_PADDING
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
*/
Switch function declarations from key slots to key handles Replace `psa_key_slot_t key` by `psa_key_handle_t` in function declarations. This is a transition period during which handles are key slot numbers and the whole library can still be used by accessing a key slot number without allocating a handle.
2018-11-30 13:39:32 +00:00
psa_status_t psa_asymmetric_decrypt(psa_key_handle_t handle,
New functions: asymmetric encrypt/decrypt
2018-03-28 12:18:39 +00:00
psa_algorithm_t alg,
const uint8_t *input,
size_t input_length,
const uint8_t *salt,
size_t salt_length,
uint8_t *output,
size_t output_size,
size_t *output_length);
Add key management functions Define psa_key_type_t and a first stab at a few values. New functions psa_import_key, psa_export_key, psa_destroy_key, psa_get_key_information. Implement them for raw data and RSA. Under the hood, create an in-memory, fixed-size keystore with room for MBEDTLS_PSA_KEY_SLOT_COUNT - 1 keys.
2018-01-28 12:16:24 +00:00
/**@}*/
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** \defgroup key_derivation Key derivation and pseudorandom generation
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* @{
*/
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** The type of the state data structure for key derivation operations.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* Before calling any function on a key derivation operation object, the
* application must initialize it by any of the following means:
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* - Set the structure to all-bits-zero, for example:
* \code
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* psa_key_derivation_operation_t operation;
* memset(&operation, 0, sizeof(operation));
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* \endcode
* - Initialize the structure to logical zero values, for example:
* \code
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* psa_key_derivation_operation_t operation = {0};
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* \endcode
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
* - Initialize the structure to the initializer #PSA_KEY_DERIVATION_OPERATION_INIT,
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* for example:
* \code
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* psa_key_derivation_operation_t operation = PSA_KEY_DERIVATION_OPERATION_INIT;
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* \endcode
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
* - Assign the result of the function psa_key_derivation_operation_init()
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* to the structure, for example:
* \code
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* psa_key_derivation_operation_t operation;
* operation = psa_key_derivation_operation_init();
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* \endcode
*
* This is an implementation-defined \c struct. Applications should not
* make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation.
*/
Rename generator-related internal identifiers perl -pe 's/crypto_generator/key_derivation/gi' $(git ls-files) perl -pe 's/_generator/_key_derivation/gi' $(git ls-files)
2019-05-16 14:59:18 +00:00
typedef struct psa_key_derivation_s psa_key_derivation_operation_t;
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
/** \def PSA_KEY_DERIVATION_OPERATION_INIT
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* This macro returns a suitable initializer for a key derivation operation
* object of type #psa_key_derivation_operation_t.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
#define PSA_KEY_DERIVATION_OPERATION_INIT {0}
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
#endif
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Return an initial value for a key derivation operation object.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
Rename generator functions to psa_key_derivation_xxx Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. Call a generator a key derivation operation structure, since it behaves like other multipart operation structures. Furthermore, the function names are not fully consistent. In this commit, I rename the functions to consistently have the prefix "psa_key_derivation_". I used the following command: perl -i -pe '%t = ( psa_crypto_generator_t => "psa_key_derivation_operation_t", psa_crypto_generator_init => "psa_key_derivation_init", psa_key_derivation_setup => "psa_key_derivation_setup", psa_key_derivation_input_key => "psa_key_derivation_input_key", psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes", psa_key_agreement => "psa_key_derivation_key_agreement", psa_set_generator_capacity => "psa_key_derivation_set_capacity", psa_get_generator_capacity => "psa_key_derivation_get_capacity", psa_generator_read => "psa_key_derivation_output_bytes", psa_generate_derived_key => "psa_key_derivation_output_key", psa_generator_abort => "psa_key_derivation_abort", PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT", PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY", ); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 13:28:51 +00:00
static psa_key_derivation_operation_t psa_key_derivation_operation_init(void);
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
/** Set up a key derivation operation.
*
* A key derivation algorithm takes some inputs and uses them to generate
* a byte stream in a deterministic way.
* This byte stream can be used to produce keys and other
* cryptographic material.
*
* To derive a key:
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* -# Start with an initialized object of type #psa_key_derivation_operation_t.
* -# Call psa_key_derivation_setup() to select the algorithm.
* -# Provide the inputs for the key derivation by calling
* psa_key_derivation_input_bytes() or psa_key_derivation_input_key()
* as appropriate. Which inputs are needed, in what order, and whether
* they may be keys and if so of what type depends on the algorithm.
* -# Optionally set the operation's maximum capacity with
* psa_key_derivation_set_capacity(). You may do this before, in the middle
* of or after providing inputs. For some algorithms, this step is mandatory
* because the output depends on the maximum capacity.
* -# To derive a key, call psa_key_derivation_output_key().
* To derive a byte string for a different purpose, call
* psa_key_derivation_output_bytes().
* Successive calls to these functions use successive output bytes
* calculated by the key derivation algorithm.
* -# Clean up the key derivation operation object with
* psa_key_derivation_abort().
*
* If this function returns an error, the key derivation operation object is
* not changed.
*
* If an error occurs at any step after a call to psa_key_derivation_setup(),
* the operation will need to be reset by a call to psa_key_derivation_abort().
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
*
Forbid keys of size 0 Keys of size 0 generally don't make sense: a key is supposed to be secret. There is one edge case which is "raw data" keys, which are useful to store non-key objects in the same storage location as keys. However those are also problematic because they involve a zero-length buffer. Manipulating zero-length buffers in C requires special cases with functions like malloc() and memcpy(). Additionally, 0 as a key size already has a meaning "unspecified", which does not always overlap seamlessly with the meaning "0". Therefore, forbid keys of size 0. No implementation may accept them.
2019-09-12 16:29:43 +00:00
* Implementations must reject an attempt to derive a key of size 0.
*
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \param[in,out] operation The key derivation operation object
* to set up. It must
* have been initialized but not set up yet.
* \param alg The key derivation algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_KEY_DERIVATION(\p alg) is true).
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c alg is not a key derivation algorithm.
* \retval #PSA_ERROR_NOT_SUPPORTED
* \c alg is not supported or is not a key derivation algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Fix warnings
2019-09-03 15:51:19 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid (it must be inactive).
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
*/
psa_status_t psa_key_derivation_setup(
psa_key_derivation_operation_t *operation,
psa_algorithm_t alg);
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Retrieve the current capacity of a key derivation operation.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* The capacity of a key derivation is the maximum number of bytes that it can
* return. When you get *N* bytes of output from a key derivation operation,
* this reduces its capacity by *N*.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \param[in] operation The operation to query.
* \param[out] capacity On success, the capacity of the operation.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid (it must be active).
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_HARDWARE_FAILURE
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
psa_status_t psa_key_derivation_get_capacity(
const psa_key_derivation_operation_t *operation,
size_t *capacity);
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Set the maximum capacity of a key derivation operation.
*
* The capacity of a key derivation operation is the maximum number of bytes
* that the key derivation operation can return from this point onwards.
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \param[in,out] operation The key derivation operation object to modify.
* \param capacity The new capacity of the operation.
* It must be less or equal to the operation's
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
* current capacity.
*
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_INVALID_ARGUMENT
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \p capacity is larger than the operation's current capacity.
* In this case, the operation object remains valid and its capacity
* remains unchanged.
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid (it must be active).
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_HARDWARE_FAILURE
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
*/
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
psa_status_t psa_key_derivation_set_capacity(
psa_key_derivation_operation_t *operation,
size_t capacity);
Key derivation by small input steps: proof-of-concept Document the new API. Keep the old one. Implement for HKDF. Use it in a few test cases. Key agreement is still unchanged.
2019-01-07 21:59:38 +00:00
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
/** Use the maximum possible capacity for a key derivation operation.
*
* Use this value as the capacity argument when setting up a key derivation
* to indicate that the operation should have the maximum possible capacity.
* The value of the maximum possible capacity depends on the key derivation
* algorithm.
*/
#define PSA_KEY_DERIVATION_UNLIMITED_CAPACITY ((size_t)(-1))
/** Provide an input for key derivation or key agreement.
*
* Which inputs are required and in what order depends on the algorithm.
* Refer to the documentation of each key derivation or key agreement
* algorithm for information.
*
Key derivation: allow both keys and direct inputs (function doc) Update the documentation of psa_key_derivation_input_key() and psa_key_derivation_input_bytes() now that the key/buffer distinction is not mandatory.
2019-09-24 15:15:58 +00:00
* This function passes direct inputs, which is usually correct for
* non-secret inputs. To pass a secret input, which should be in a key
* object, call psa_key_derivation_input_key() instead of this function.
* Refer to the documentation of individual step types
* (`PSA_KEY_DERIVATION_INPUT_xxx` values of type ::psa_key_derivation_step_t)
* for more information.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_key_derivation_abort().
*
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \param[in,out] operation The key derivation operation object to use.
* It must have been set up with
* psa_key_derivation_setup() and must not
* have produced any output yet.
* \param step Which step the input data is for.
* \param[in] data Input data to use.
* \param data_length Size of the \p data buffer in bytes.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c step is not compatible with the operation's algorithm.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c step does not allow direct inputs.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid for this input \p step.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_key_derivation_input_bytes(
psa_key_derivation_operation_t *operation,
psa_key_derivation_step_t step,
const uint8_t *data,
size_t data_length);
/** Provide an input for key derivation in the form of a key.
*
* Which inputs are required and in what order depends on the algorithm.
* Refer to the documentation of each key derivation or key agreement
* algorithm for information.
*
Key derivation: allow both keys and direct inputs (function doc) Update the documentation of psa_key_derivation_input_key() and psa_key_derivation_input_bytes() now that the key/buffer distinction is not mandatory.
2019-09-24 15:15:58 +00:00
* This function obtains input from a key object, which is usually correct for
* secret inputs or for non-secret personalization strings kept in the key
* store. To pass a non-secret parameter which is not in the key store,
* call psa_key_derivation_input_bytes() instead of this function.
* Refer to the documentation of individual step types
* (`PSA_KEY_DERIVATION_INPUT_xxx` values of type ::psa_key_derivation_step_t)
* for more information.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_key_derivation_abort().
*
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \param[in,out] operation The key derivation operation object to use.
* It must have been set up with
* psa_key_derivation_setup() and must not
* have produced any output yet.
* \param step Which step the input data is for.
* \param handle Handle to the key. It must have an
* appropriate type for \p step and must
* allow the usage #PSA_KEY_USAGE_DERIVE.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c step is not compatible with the operation's algorithm.
* \retval #PSA_ERROR_INVALID_ARGUMENT
Key derivation: allow both keys and direct inputs Allow a direct input as the SECRET input step in a key derivation, in addition to allowing DERIVE keys. This makes it easier for applications to run a key derivation where the "secret" input is obtained from somewhere else. This makes it possible for the "secret" input to be empty (keys cannot be empty), which some protocols do (for example the IV derivation in EAP-TLS). Conversely, allow a RAW_DATA key as the INFO/LABEL/SALT/SEED input to a key derivation, in addition to allowing direct inputs. This doesn't improve security, but removes a step when a personalization parameter is stored in the key store, and allows this personalization parameter to remain opaque. Add test cases that explore step/key-type-and-keyhood combinations.
2019-09-23 16:13:17 +00:00
* \c step does not allow key inputs of the given type
* or does not allow key inputs at all.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid for this input \p step.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
*/
psa_status_t psa_key_derivation_input_key(
psa_key_derivation_operation_t *operation,
psa_key_derivation_step_t step,
psa_key_handle_t handle);
/** Perform a key agreement and use the shared secret as input to a key
* derivation.
*
* A key agreement algorithm takes two inputs: a private key \p private_key
* a public key \p peer_key.
* The result of this function is passed as input to a key derivation.
* The output of this key derivation can be extracted by reading from the
* resulting operation to produce keys and other cryptographic material.
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* If this function returns an error status, the operation enters an error
* state and must be aborted by calling psa_key_derivation_abort().
*
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \param[in,out] operation The key derivation operation object to use.
* It must have been set up with
* psa_key_derivation_setup() with a
* key agreement and derivation algorithm
* \c alg (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_KEY_AGREEMENT(\c alg) is true
* and #PSA_ALG_IS_RAW_KEY_AGREEMENT(\c alg)
* is false).
* The operation must be ready for an
* input of the type given by \p step.
* \param step Which step the input data is for.
* \param private_key Handle to the private key to use.
* \param[in] peer_key Public key of the peer. The peer key must be in the
* same format that psa_import_key() accepts for the
* public key type corresponding to the type of
* private_key. That is, this function performs the
* equivalent of
* #psa_import_key(...,
* `peer_key`, `peer_key_length`) where
* with key attributes indicating the public key
* type corresponding to the type of `private_key`.
* For example, for EC keys, this means that peer_key
* is interpreted as a point on the curve that the
* private key is on. The standard formats for public
* keys are documented in the documentation of
* psa_export_public_key().
* \param peer_key_length Size of \p peer_key in bytes.
*
* \retval #PSA_SUCCESS
* Success.
Fix PSA_ERROR_BAD_STATE messages Remove some duplicated entries and added some missing ones.
2019-09-11 20:33:41 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid for this key agreement \p step.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c private_key is not compatible with \c alg,
* or \p peer_key is not valid for \c alg or not compatible with
* \c private_key.
* \retval #PSA_ERROR_NOT_SUPPORTED
* \c alg is not supported or is not a key derivation algorithm.
Key derivation: allow both keys and direct inputs Allow a direct input as the SECRET input step in a key derivation, in addition to allowing DERIVE keys. This makes it easier for applications to run a key derivation where the "secret" input is obtained from somewhere else. This makes it possible for the "secret" input to be empty (keys cannot be empty), which some protocols do (for example the IV derivation in EAP-TLS). Conversely, allow a RAW_DATA key as the INFO/LABEL/SALT/SEED input to a key derivation, in addition to allowing direct inputs. This doesn't improve security, but removes a step when a personalization parameter is stored in the key store, and allows this personalization parameter to remain opaque. Add test cases that explore step/key-type-and-keyhood combinations.
2019-09-23 16:13:17 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \c step does not allow an input resulting from a key agreement.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Reorder key derivation functions in the header file Present key derivation functions in a more logical order, corresponding roughly to the order in which an application would call them.
2019-05-16 15:56:47 +00:00
*/
psa_status_t psa_key_derivation_key_agreement(
psa_key_derivation_operation_t *operation,
psa_key_derivation_step_t step,
psa_key_handle_t private_key,
const uint8_t *peer_key,
size_t peer_key_length);
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Read some data from a key derivation operation.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* This function calculates output bytes from a key derivation algorithm and
* return those bytes.
* If you view the key derivation's output as a stream of bytes, this
* function destructively reads the requested number of bytes from the
* stream.
* The operation's capacity decreases by the number of bytes read.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Resolve inconsistent descipriton of operation state after exhausting a key derivation operation
2019-09-18 16:50:01 +00:00
* If this function returns an error status other than
* #PSA_ERROR_INSUFFICIENT_DATA, the operation enters an error
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* state and must be aborted by calling psa_key_derivation_abort().
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \param[in,out] operation The key derivation operation object to read from.
* \param[out] output Buffer where the output will be written.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* \param output_length Number of bytes to output.
*
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_SUCCESS
Replace PSA error code definitions with the ones defined in PSA spec
2019-02-14 11:48:10 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_DATA
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* The operation's capacity was less than
* \p output_length bytes. Note that in this case,
* no output is written to the output buffer.
* The operation's capacity is set to 0, thus
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* subsequent calls to this function will not
* succeed, even with a smaller output buffer.
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid (it must be active and completed
* all required input steps).
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
psa_status_t psa_key_derivation_output_bytes(
psa_key_derivation_operation_t *operation,
uint8_t *output,
size_t output_length);
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Derive a key from an ongoing key derivation operation.
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* This function calculates output bytes from a key derivation algorithm
* and uses those bytes to generate a key deterministically.
Clarify how key creation functions use attributes and what 0 means Clarify how key creation functions use attributes. Explain the meaning of attribute values, espcially what 0 means in each field where it has a special meaning. Explain what an algorithm usage policy can be (an algorithm, a wildcard with ANY_HASH, or 0).
2019-09-12 14:59:37 +00:00
* The key's location, usage policy, type and size are taken from
* \p attributes.
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* If you view the key derivation's output as a stream of bytes, this
* function destructively reads as many bytes as required from the
* stream.
* The operation's capacity decreases by the number of bytes read.
*
Resolve inconsistent descipriton of operation state after exhausting a key derivation operation
2019-09-18 16:50:01 +00:00
* If this function returns an error status other than
* #PSA_ERROR_INSUFFICIENT_DATA, the operation enters an error
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* state and must be aborted by calling psa_key_derivation_abort().
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* How much output is produced and consumed from the operation, and how
* the key is derived, depends on the key type:
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
*
* - For key types for which the key is an arbitrary sequence of bytes
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
* of a given size, this function is functionally equivalent to
* calling #psa_key_derivation_output_bytes
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* and passing the resulting output to #psa_import_key.
* However, this function has a security benefit:
* if the implementation provides an isolation boundary then
* the key material is not exposed outside the isolation boundary.
* As a consequence, for these key types, this function always consumes
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* exactly (\p bits / 8) bytes from the operation.
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* The following key types defined in this specification follow this scheme:
*
* - #PSA_KEY_TYPE_AES;
* - #PSA_KEY_TYPE_ARC4;
* - #PSA_KEY_TYPE_CAMELLIA;
* - #PSA_KEY_TYPE_DERIVE;
* - #PSA_KEY_TYPE_HMAC.
*
* - For ECC keys on a Montgomery elliptic curve
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* (#PSA_KEY_TYPE_ECC_KEY_PAIR(\c curve) where \c curve designates a
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* Montgomery curve), this function always draws a byte string whose
* length is determined by the curve, and sets the mandatory bits
* accordingly. That is:
*
Rename ECC Family Macros According to PSA Spec Rename PSA_ECC_CURVE_xxx to PSA_ECC_FAMILY_xxx, also rename PSA_KEY_TYPE_GET_CURVE to PSA_KEY_TYPE_ECC_GET_FAMILY and rename psa_ecc_curve_t to psa_ecc_family_t. Old defines are provided in include/crypto_compat.h for backward compatibility. Signed-off-by: Paul Elliott <paul.elliott@arm.com>
2020-06-02 16:19:28 +00:00
* - Curve25519 (#PSA_ECC_FAMILY_MONTGOMERY, 255 bits): draw a 32-byte
Define EC curve family constants Define constants for ECC curve families and DH group families. These constants have 0x0000 in the lower 16 bits of the key type. Support these constants in the implementation and in the PSA metadata tests. Switch the slot management and secure element driver HAL tests to the new curve encodings. This requires SE driver code to become slightly more clever when figuring out the bit-size of an imported EC key since it now needs to take the data size into account. Switch some documentation to the new encodings. Remove the macro PSA_ECC_CURVE_BITS which can no longer be implemented.
2019-12-03 16:24:19 +00:00
* string and process it as specified in RFC 7748 &sect;5.
Rename ECC Family Macros According to PSA Spec Rename PSA_ECC_CURVE_xxx to PSA_ECC_FAMILY_xxx, also rename PSA_KEY_TYPE_GET_CURVE to PSA_KEY_TYPE_ECC_GET_FAMILY and rename psa_ecc_curve_t to psa_ecc_family_t. Old defines are provided in include/crypto_compat.h for backward compatibility. Signed-off-by: Paul Elliott <paul.elliott@arm.com>
2020-06-02 16:19:28 +00:00
* - Curve448 (#PSA_ECC_FAMILY_MONTGOMERY, 448 bits): draw a 56-byte
Define EC curve family constants Define constants for ECC curve families and DH group families. These constants have 0x0000 in the lower 16 bits of the key type. Support these constants in the implementation and in the PSA metadata tests. Switch the slot management and secure element driver HAL tests to the new curve encodings. This requires SE driver code to become slightly more clever when figuring out the bit-size of an imported EC key since it now needs to take the data size into account. Switch some documentation to the new encodings. Remove the macro PSA_ECC_CURVE_BITS which can no longer be implemented.
2019-12-03 16:24:19 +00:00
* string and process it as specified in RFC 7748 &sect;5.
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
*
* - For key types for which the key is represented by a single sequence of
* \p bits bits with constraints as to which bit sequences are acceptable,
* this function draws a byte string of length (\p bits / 8) bytes rounded
* up to the nearest whole number of bytes. If the resulting byte string
* is acceptable, it becomes the key, otherwise the drawn bytes are discarded.
* This process is repeated until an acceptable byte string is drawn.
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* The byte string drawn from the operation is interpreted as specified
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* for the output produced by psa_export_key().
* The following key types defined in this specification follow this scheme:
*
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* - #PSA_KEY_TYPE_DES.
* Force-set the parity bits, but discard forbidden weak keys.
* For 2-key and 3-key triple-DES, the three keys are generated
* successively (for example, for 3-key triple-DES,
* if the first 8 bytes specify a weak key and the next 8 bytes do not,
* discard the first 8 bytes, use the next 8 bytes as the first key,
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* and continue reading output from the operation to derive the other
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* two keys).
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* - Finite-field Diffie-Hellman keys (#PSA_KEY_TYPE_DH_KEY_PAIR(\c group)
Move remaining text about DSA out of the specification
2019-05-16 11:58:24 +00:00
* where \c group designates any Diffie-Hellman group) and
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* ECC keys on a Weierstrass elliptic curve
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* (#PSA_KEY_TYPE_ECC_KEY_PAIR(\c curve) where \c curve designates a
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* Weierstrass curve).
* For these key types, interpret the byte string as integer
* in big-endian order. Discard it if it is not in the range
* [0, *N* - 2] where *N* is the boundary of the private key domain
* (the prime *p* for Diffie-Hellman, the subprime *q* for DSA,
psa_generator_import_key (ECC): minor corrections
2019-03-12 10:50:26 +00:00
* or the order of the curve's base point for ECC).
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* Add 1 to the resulting integer and use this as the private key *x*.
psa_generator_import_key (ECC): minor corrections
2019-03-12 10:50:26 +00:00
* This method allows compliance to NIST standards, specifically
* the methods titled "key-pair generation by testing candidates"
Clarify deterministic generation by re-drawing For DH, ECC (Weierstrass curves) and DSA, specify that the re-drawing method is the one defined by NIST as "key-pair generation by testing candidates", and describe it unambiguously. Also specify DES explicitly.
2019-03-11 16:59:16 +00:00
* in NIST SP 800-56A &sect;5.6.1.1.4 for Diffie-Hellman,
* in FIPS 186-4 &sect;B.1.2 for DSA, and
* in NIST SP 800-56A &sect;5.6.1.2.2 or
* FIPS 186-4 &sect;B.4.2 for elliptic curve keys.
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
*
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* - For other key types, including #PSA_KEY_TYPE_RSA_KEY_PAIR,
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* the way in which the operation output is consumed is
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* implementation-defined.
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* In all cases, the data that is read is discarded from the operation.
* The operation's capacity is decreased by the number of bytes read.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Key derivation: forbid output_key without input_key If none of the inputs to a key derivation is a PSA_KEY_DERIVATION_INPUT_SECRET passed with psa_key_derivation_input_key(), forbid psa_key_derivation_output_key(). It usually doesn't make sense to derive a key object if the secret isn't itself a proper key.
2019-09-24 16:21:06 +00:00
* For algorithms that take an input step #PSA_KEY_DERIVATION_INPUT_SECRET,
* the input to that step must be provided with psa_key_derivation_input_key().
* Future versions of this specification may include additional restrictions
* on the derived key based on the attributes and strength of the secret key.
*
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param[in] attributes The attributes for the new key.
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \param[in,out] operation The key derivation operation object to read from.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param[out] handle On success, a handle to the newly created key.
* \c 0 on failure.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_SUCCESS
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* Success.
Update some documentation related to key slots Some of the documentation is obsolete in its reference to key slots when it should discuss key handles. This may require a further pass, possibly with some reorganization of error codes. Update the documentation of functions that modify key slots (key material creation and psa_set_key_policy()) to discuss how they affect storage.
2018-12-11 14:51:32 +00:00
* If the key is persistent, the key material and the key's metadata
* have been saved to persistent storage.
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \retval #PSA_ERROR_ALREADY_EXISTS
* This is an attempt to create a persistent key, and there is
* already a persistent key with the given identifier.
Replace PSA error code definitions with the ones defined in PSA spec
2019-02-14 11:48:10 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_DATA
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* There was not enough data to create the desired key.
* Note that in this case, no output is written to the output buffer.
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* The operation's capacity is set to 0, thus subsequent calls to
Specify psa_generator_import_key for each key type psa_generator_import_key() was only specified for "symmetric keys", and there were some mistakes in the specification. Rewrite the specification and extend it to other key types. * For most private key types, specify that the function draws a byte string repeatedly until the byte string is suitable. * For DES, despite being a symmetric key type, re-drawing is necessary. * For Montgomery curves, despite being asymmetric, no re-drawing is necessary. * Specify the behavior for every standard key type other than RSA. An implementation doesn't have to support all key types, but if it does, it's better to have a standard.
2019-03-11 16:30:31 +00:00
* this function will not succeed, even with a smaller output buffer.
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
* The key type or key size is not supported, either by the
Remove remaining mentions of slots
2019-05-14 14:24:21 +00:00
* implementation in general or in this particular location.
Document new error type returned from the key derivation API
2019-08-15 17:01:59 +00:00
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The provided key attributes are not valid for the operation.
Key derivation: forbid output_key without input_key If none of the inputs to a key derivation is a PSA_KEY_DERIVATION_INPUT_SECRET passed with psa_key_derivation_input_key(), forbid psa_key_derivation_output_key(). It usually doesn't make sense to derive a key object if the secret isn't itself a proper key.
2019-09-24 16:21:06 +00:00
* \retval #PSA_ERROR_NOT_PERMITTED
* The #PSA_KEY_DERIVATION_INPUT_SECRET input was not provided through
* a key.
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_ERROR_BAD_STATE
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* The operation state is not valid (it must be active and completed
* all required input steps).
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_INSUFFICIENT_STORAGE
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add STORAGE_FAILURE everywhere + add missing codes
2019-08-13 13:41:52 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
psa_status_t psa_key_derivation_output_key(
const psa_key_attributes_t *attributes,
psa_key_derivation_operation_t *operation,
psa_key_handle_t *handle);
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
/** Abort a key derivation operation.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* Aborting an operation frees all associated resources except for the \c
* operation structure itself. Once aborted, the operation object can be reused
* for another operation by calling psa_key_derivation_setup() again.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* This function may be called at any time after the operation
* object has been initialized as described in #psa_key_derivation_operation_t.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Update documentation for multipart key derivation operations
2019-09-13 14:27:46 +00:00
* In particular, it is valid to call psa_key_derivation_abort() twice, or to
* call psa_key_derivation_abort() on an operation that has not been set up.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Terminology: say "key derivation operation", not "generator" Generators are mostly about key derivation (currently: only about key derivation). "Generator" is not a commonly used term in cryptography. So favor "derivation" as terminology. This commit updates the function descriptions.
2019-05-16 15:26:11 +00:00
* \param[in,out] operation The operation to abort.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*
Linkify some macros that were just typeset as text
2018-12-11 15:47:35 +00:00
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
*/
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
psa_status_t psa_key_derivation_abort(
psa_key_derivation_operation_t *operation);
Add generator API Add an API for byte generators: psa_crypto_generator_t, PSA_CRYPTO_GENERATOR_INIT, psa_crypto_generator_init, psa_get_generator_capacity, psa_generator_read, psa_generator_import_key, psa_generator_abort. This commit does not yet implement any generator algorithm, it only provides the framework. This code may not compile with -Wunused.
2018-07-12 15:12:33 +00:00
Correct the description of psa_raw_key_agreement There was some copypasta from the KA+KDF function's description.
2019-05-16 16:01:45 +00:00
/** Perform a key agreement and return the raw shared secret.
New function to get the raw shared secret from key agreement The normal way is to pass the shared secret to a key derivation. Having an ad hoc function will allow us to simplify the possible behaviors of key agreement and get rid of "key selection" algorithms which are a hard-to-understand invention of this API.
2019-01-18 15:42:29 +00:00
*
* \warning The raw result of a key agreement algorithm such as finite-field
* Diffie-Hellman or elliptic curve Diffie-Hellman has biases and should
* not be used directly as key material. It should instead be passed as
* input to a key derivation algorithm. To chain a key agreement with
Wrap and reindent some lines After renaming several identifiers, re-wrap and re-indent some lines to make the code prettier.
2019-05-16 15:53:40 +00:00
* a key derivation, use psa_key_derivation_key_agreement() and other
* functions from the key derivation interface.
New function to get the raw shared secret from key agreement The normal way is to pass the shared secret to a key derivation. Having an ad hoc function will allow us to simplify the possible behaviors of key agreement and get rid of "key selection" algorithms which are a hard-to-understand invention of this API.
2019-01-18 15:42:29 +00:00
*
Fix minor errors in key derivation and key agreement documentation
2019-02-08 10:24:59 +00:00
* \param alg The key agreement algorithm to compute
* (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_RAW_KEY_AGREEMENT(\p alg)
* is true).
New function to get the raw shared secret from key agreement The normal way is to pass the shared secret to a key derivation. Having an ad hoc function will allow us to simplify the possible behaviors of key agreement and get rid of "key selection" algorithms which are a hard-to-understand invention of this API.
2019-01-18 15:42:29 +00:00
* \param private_key Handle to the private key to use.
* \param[in] peer_key Public key of the peer. It must be
* in the same format that psa_import_key()
* accepts. The standard formats for public
* keys are documented in the documentation
* of psa_export_public_key().
* \param peer_key_length Size of \p peer_key in bytes.
* \param[out] output Buffer where the decrypted message is to
* be written.
* \param output_size Size of the \c output buffer in bytes.
* \param[out] output_length On success, the number of bytes
* that make up the returned output.
*
* \retval #PSA_SUCCESS
* Success.
* \retval #PSA_ERROR_INVALID_HANDLE
* \retval #PSA_ERROR_NOT_PERMITTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \p alg is not a key agreement algorithm
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \p private_key is not compatible with \p alg,
* or \p peer_key is not valid for \p alg or not compatible with
* \p private_key.
Add missing error codes for psa_raw_key_agreement
2019-08-08 14:07:07 +00:00
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
* \p output_size is too small
New function to get the raw shared secret from key agreement The normal way is to pass the shared secret to a key derivation. Having an ad hoc function will allow us to simplify the possible behaviors of key agreement and get rid of "key selection" algorithms which are a hard-to-understand invention of this API.
2019-01-18 15:42:29 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not a supported key agreement algorithm.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing error codes for psa_raw_key_agreement
2019-08-08 14:07:07 +00:00
* \retval #PSA_ERROR_STORAGE_FAILURE
Added the possibility of PSA_ERROR_BAD_STATE to all functions
2019-08-07 13:25:38 +00:00
* \retval #PSA_ERROR_BAD_STATE
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New function to get the raw shared secret from key agreement The normal way is to pass the shared secret to a key derivation. Having an ad hoc function will allow us to simplify the possible behaviors of key agreement and get rid of "key selection" algorithms which are a hard-to-understand invention of this API.
2019-01-18 15:42:29 +00:00
*/
Shorten the name of psa_key_agreement_raw_shared_secret There is less of a risk of confusion with the KA+KDF function now.
2019-05-16 16:00:41 +00:00
psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
psa_key_handle_t private_key,
const uint8_t *peer_key,
size_t peer_key_length,
uint8_t *output,
size_t output_size,
size_t *output_length);
New API function: psa_key_agreement Set up a generator from a key agreement.
2018-09-18 10:01:02 +00:00
Add framework for simple key derivation New key type PSA_KEY_TYPE_DERIVE. New usage flag PSA_KEY_USAGE_DERIVE. New function psa_key_derivation. No key derivation algorithm is implemented yet. The code may not compile with -Wunused. Write some unit test code for psa_key_derivation. Most of it cannot be used yet due to the lack of a key derivation algorithm.
2018-07-12 15:17:20 +00:00
/**@}*/
Fix doxygen warnings * Broken link #PSA_ALG_SHA_256 * Duplicate group name "generators" * Missing documentation in psa_generate_key_extra_rsa due to bad magic comment marker
2018-07-20 15:42:05 +00:00
/** \defgroup random Random generation
New function: generate key/random
2018-03-28 12:18:50 +00:00
* @{
*/
/**
* \brief Generate random bytes.
*
* \warning This function **can** fail! Callers MUST check the return status
* and MUST NOT use the content of the output buffer if the return
* status is not #PSA_SUCCESS.
*
Rename psa_generate_random_key back to psa_generate_key generate_key is a more classical name. The longer name was only introduced to avoid confusion with getting a key from a generator, which is key derivation, but we no longer use the generator terminology so this reason no longer applies. perl -i -pe 's/psa_generate_random_key/psa_generate_key/g' $(git ls-files)
2019-05-16 17:42:05 +00:00
* \note To generate a key, use psa_generate_key() instead.
New function: generate key/random
2018-03-28 12:18:50 +00:00
*
Doc: add [in] or [out] annotations to pointer arguments
2018-07-11 23:08:58 +00:00
* \param[out] output Output buffer for the generated data.
New function: generate key/random
2018-03-28 12:18:50 +00:00
* \param output_size Number of bytes to generate and output.
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
Add missing error codes to psa_generate_random
2019-08-08 14:07:57 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Ensure the module is initialized in psa_generate_random
2018-09-06 13:24:41 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New function: generate key/random
2018-03-28 12:18:50 +00:00
*/
psa_status_t psa_generate_random(uint8_t *output,
size_t output_size);
/**
* \brief Generate a key or key pair.
*
Remove `extra` parameter from psa_generate_key Read extra data from the domain parameters in the attribute structure instead of taking an argument on the function call. Implement this for RSA key generation, where the public exponent can be set as a domain parameter. Add tests that generate RSA keys with various public exponents.
2019-04-26 15:34:02 +00:00
* The key is generated randomly.
Clarify how key creation functions use attributes and what 0 means Clarify how key creation functions use attributes. Explain the meaning of attribute values, espcially what 0 means in each field where it has a special meaning. Explain what an algorithm usage policy can be (an algorithm, a wildcard with ANY_HASH, or 0).
2019-09-12 14:59:37 +00:00
* Its location, usage policy, type and size are taken from \p attributes.
Remove `extra` parameter from psa_generate_key Read extra data from the domain parameters in the attribute structure instead of taking an argument on the function call. Implement this for RSA key generation, where the public exponent can be set as a domain parameter. Add tests that generate RSA keys with various public exponents.
2019-04-26 15:34:02 +00:00
*
Forbid keys of size 0 Keys of size 0 generally don't make sense: a key is supposed to be secret. There is one edge case which is "raw data" keys, which are useful to store non-key objects in the same storage location as keys. However those are also problematic because they involve a zero-length buffer. Manipulating zero-length buffers in C requires special cases with functions like malloc() and memcpy(). Additionally, 0 as a key size already has a meaning "unspecified", which does not always overlap seamlessly with the meaning "0". Therefore, forbid keys of size 0. No implementation may accept them.
2019-09-12 16:29:43 +00:00
* Implementations must reject an attempt to generate a key of size 0.
Remove `extra` parameter from psa_generate_key Read extra data from the domain parameters in the attribute structure instead of taking an argument on the function call. Implement this for RSA key generation, where the public exponent can be set as a domain parameter. Add tests that generate RSA keys with various public exponents.
2019-04-26 15:34:02 +00:00
*
RSA key generation: require e=65537
2019-05-16 12:05:56 +00:00
* The following type-specific considerations apply:
Rename *KEYPAIR* to *KEY_PAIR* Be consistent with PUBLIC_KEY. perl -i -pe 's/KEYPAIR/KEY_PAIR/g' $(git ls-files)
2019-05-16 17:39:54 +00:00
* - For RSA keys (#PSA_KEY_TYPE_RSA_KEY_PAIR),
RSA key generation: require e=65537
2019-05-16 12:05:56 +00:00
* the public exponent is 65537.
* The modulus is a product of two probabilistic primes
* between 2^{n-1} and 2^n where n is the bit size specified in the
* attributes.
*
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* \param[in] attributes The attributes for the new key.
* \param[out] handle On success, a handle to the newly created key.
* \c 0 on failure.
New function: generate key/random
2018-03-28 12:18:50 +00:00
*
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_SUCCESS
Update some documentation related to key slots Some of the documentation is obsolete in its reference to key slots when it should discuss key handles. This may require a further pass, possibly with some reorganization of error codes. Update the documentation of functions that modify key slots (key material creation and psa_set_key_policy()) to discuss how they affect storage.
2018-12-11 14:51:32 +00:00
* Success.
* If the key is persistent, the key material and the key's metadata
* have been saved to persistent storage.
Replace PSA error code definitions with the ones defined in PSA spec
2019-02-14 11:48:10 +00:00
* \retval #PSA_ERROR_ALREADY_EXISTS
Document the new functions related to key attributes Also update the documentation of key creation functions that have been modified to use key attributes.
2019-04-19 17:29:50 +00:00
* This is an attempt to create a persistent key, and there is
* already a persistent key with the given identifier.
Doxygen: linkify references to macro names
2018-07-11 15:34:00 +00:00
* \retval #PSA_ERROR_NOT_SUPPORTED
* \retval #PSA_ERROR_INVALID_ARGUMENT
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
* \retval #PSA_ERROR_INSUFFICIENT_ENTROPY
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
* \retval #PSA_ERROR_HARDWARE_FAILURE
Rename PSA_ERROR_TAMPERING_DETECTED to ..._CORRUPTION_DETECTED “Tampering detected” was misleading because in the real world it can also arise due to a software bug. “Corruption detected” is neutral and more precisely reflects what can trigger the error. perl -i -pe 's/PSA_ERROR_TAMPERING_DETECTED/PSA_ERROR_CORRUPTION_DETECTED/gi' $(git ls-files)
2019-05-16 19:35:18 +00:00
* \retval #PSA_ERROR_CORRUPTION_DETECTED
Add missing return codes to psa_generate_key
2019-08-08 09:58:08 +00:00
* \retval #PSA_ERROR_INSUFFICIENT_STORAGE
* \retval #PSA_ERROR_STORAGE_FAILURE
Ensure the module is initialized in key based functions
2018-09-12 08:44:52 +00:00
* \retval #PSA_ERROR_BAD_STATE
Add documentation describing behavior of not calling psa_crypto_init
2018-09-16 09:22:41 +00:00
* The library has not been previously initialized by psa_crypto_init().
* It is implementation-dependent whether a failure to initialize
* results in this error code.
New function: generate key/random
2018-03-28 12:18:50 +00:00
*/
Rename psa_generate_random_key back to psa_generate_key generate_key is a more classical name. The longer name was only introduced to avoid confusion with getting a key from a generator, which is key derivation, but we no longer use the generator terminology so this reason no longer applies. perl -i -pe 's/psa_generate_random_key/psa_generate_key/g' $(git ls-files)
2019-05-16 17:42:05 +00:00
psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
Remove `extra` parameter from psa_generate_key Read extra data from the domain parameters in the attribute structure instead of taking an argument on the function call. Implement this for RSA key generation, where the public exponent can be set as a domain parameter. Add tests that generate RSA keys with various public exponents.
2019-04-26 15:34:02 +00:00
psa_key_handle_t *handle);
New function: generate key/random
2018-03-28 12:18:50 +00:00
/**@}*/
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
#ifdef __cplusplus
}
#endif
New header crypto_sizes.h This header will contain macros that calculate buffer sizes, whose semantics are standardized but whose definitions are implementation-specific because they depend on the available algorithms and on some permitted buffer size tolerances. Move size macros from crypto_struct.h to crypto_sizes.h, because these definitions need to be available both in the frontend and in the backend, whereas structures have different contents.
2018-06-27 17:49:02 +00:00
/* The file "crypto_sizes.h" contains definitions for size calculation
* macros whose definitions are implementation-specific. */
#include "crypto_sizes.h"
Implement hash functions New header file crypto_struct.h. The main file crypto.sh declares structures which are implementation-defined. These structures must be defined in crypto_struct.h, which is included at the end so that the structures can use types defined in crypto.h. Implement psa_hash_start, psa_hash_update and psa_hash_final. This should work for all hash algorithms supported by Mbed TLS, but has only been smoke-tested for SHA-256, and only in the nominal case.
2018-02-07 20:05:37 +00:00
/* The file "crypto_struct.h" contains definitions for
* implementation-specific structs that are declared above. */
#include "crypto_struct.h"
/* The file "crypto_extra.h" contains vendor-specific definitions. This
* can include vendor-defined algorithms, extra functions, etc. */
Add PSA crypto module New module psa_crypto.c (MBEDTLS_PSA_CRYPTO_C): Platform Security Architecture compatibility layer on top of libmedcrypto. Implement psa_crypto_init function which sets up a RNG. Add a mbedtls_psa_crypto_free function which deinitializes the library. Define a first batch of error codes.
2018-01-27 22:32:46 +00:00
#include "crypto_extra.h"
#endif /* PSA_CRYPTO_H */
Reference in a new issue Copy permalink