Files
mbedtls/tf-psa-crypto/include/psa/crypto_compat.h

75 lines
2.6 KiB
C

/**
* \file psa/crypto_compat.h
*
* \brief PSA cryptography module: Backward compatibility aliases
*
* This header declares alternative names for macro and functions.
* New application code should not use these names.
* These names may be removed in a future version of Mbed TLS.
*
* \note This file may not be included directly. Applications must
* include psa/crypto.h.
*/
/*
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
*/
#ifndef PSA_CRYPTO_COMPAT_H
#define PSA_CRYPTO_COMPAT_H
#ifdef __cplusplus
extern "C" {
#endif
/* This function is not a TF-PSA-Crypto API and may be removed without notice.
*
* Dummy version of a function removed in
* https://github.com/Mbed-TLS/TF-PSA-Crypto/pull/466
*
* The function needs to remain available during a transition period
* for the sake of the PSA simulator, which lives in Mbed TLS.
* Once TF-PSA-Crypto no longer needs the function,
* `tests/psa-client-server/psasim/src/psa_sim_crypto_server.c` will
* need to be updated to no longer need the function, and it will be
* possible to remove the corresponding RPC call altogether.
*/
int psa_can_do_hash(psa_algorithm_t hash_alg);
/* This defition is required to provide compatibility with the PSA arch
* tests. Without it building the tests will fail. To remove it we would
* need to change the tests to remove all references to this symbol.
*/
#define PSA_KEY_TYPE_DES ((psa_key_type_t) 0x2301)
/** The beta encoding of JPAKE algorithms, with no hash.
*
* This came from the beta version of the PSA Crypto PAKE 1.2 extension,
* which is what Mbed TLS 3.x implemented.
* Since TF-PSA-Crypto 1.0.0, we no longer support the beta version of
* specification, so this algorithm encoding is no longer supported in
* JPAKE cipher suites. Use #PSA_ALG_JPAKE instead.
*
* \note It is unspecified whether a key with #PSA_ALG_JPAKE_BETA
* in its policy may be used to perform a JPAKE operation.
*/
/* TF-PSA-Crypto 1.x still supports using persistent keys whose policy uses
* this legacy encoding. As of TF-PSA-Crypto 1.0.0, we also allow this
* algorithm encoding in the policy of newly created keys, because it makes
* our implementation simpler. This may change without notice. */
#define PSA_ALG_JPAKE_BETA PSA_ALG_JPAKE_BASE
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
/** Old non-standard name for #PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE.
* \deprecated Please use #PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE instead.
*/
#define PSA_EXPORT_KEY_PAIR_OR_PUBLIC_MAX_SIZE \
((size_t) MBEDTLS_DEPRECATED_NUMERIC_CONSTANT(PSA_EXPORT_ASYMMETRIC_KEY_MAX_SIZE))
#endif
#ifdef __cplusplus
}
#endif
#endif /* PSA_CRYPTO_COMPAT_H */