text: /**
   * \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 Crypto.
   *
   * \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
   *
   *  Licensed under the Apache License, Version 2.0 (the "License"); you may
   *  not use this file except in compliance with the License.
   *  You may obtain a copy of the License at
   *
   *  http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   */
  
  #ifndef PSA_CRYPTO_COMPAT_H
  #define PSA_CRYPTO_COMPAT_H
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /*
   * To support both openless APIs and psa_open_key() temporarily, define
   * psa_key_handle_t to be equal to mbedtls_svc_key_id_t. Do not mark the
   * type and its utility macros and functions deprecated yet. This will be done
   * in a subsequent phase.
   */
  typedef mbedtls_svc_key_id_t psa_key_handle_t;
  
  #define PSA_KEY_HANDLE_INIT MBEDTLS_SVC_KEY_ID_INIT
  
  /** Check wether an handle is null.
   *
   * \param handle  Handle
   *
   * \return Non-zero if the handle is null, zero otherwise.
   */
  static inline int psa_key_handle_is_null( psa_key_handle_t handle )
  {
      return( mbedtls_svc_key_id_is_null( handle ) );
  }
  
  #if !defined(MBEDTLS_DEPRECATED_REMOVED)
  
  /*
   * Mechanism for declaring deprecated values
   */
  #if defined(MBEDTLS_DEPRECATED_WARNING) && !defined(MBEDTLS_PSA_DEPRECATED)
  #define MBEDTLS_PSA_DEPRECATED __attribute__((deprecated))
  #else
  #define MBEDTLS_PSA_DEPRECATED
  #endif
  
  typedef MBEDTLS_PSA_DEPRECATED size_t mbedtls_deprecated_size_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_status_t mbedtls_deprecated_psa_status_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_key_usage_t mbedtls_deprecated_psa_key_usage_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_ecc_family_t mbedtls_deprecated_psa_ecc_family_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_dh_family_t mbedtls_deprecated_psa_dh_family_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_ecc_family_t psa_ecc_curve_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_dh_family_t psa_dh_group_t;
  typedef MBEDTLS_PSA_DEPRECATED psa_algorithm_t mbedtls_deprecated_psa_algorithm_t;
  
  #define PSA_KEY_TYPE_GET_CURVE PSA_KEY_TYPE_ECC_GET_FAMILY
  #define PSA_KEY_TYPE_GET_GROUP PSA_KEY_TYPE_DH_GET_FAMILY
  
  #define MBEDTLS_DEPRECATED_CONSTANT( type, value )      \
      ( (mbedtls_deprecated_##type) ( value ) )
  
  /*
   * Deprecated PSA Crypto error code definitions (PSA Crypto API  <= 1.0 beta2)
   */
  #define PSA_ERROR_UNKNOWN_ERROR \
      MBEDTLS_DEPRECATED_CONSTANT( psa_status_t, PSA_ERROR_GENERIC_ERROR )
  #define PSA_ERROR_OCCUPIED_SLOT \
      MBEDTLS_DEPRECATED_CONSTANT( psa_status_t, PSA_ERROR_ALREADY_EXISTS )
  #define PSA_ERROR_EMPTY_SLOT \
      MBEDTLS_DEPRECATED_CONSTANT( psa_status_t, PSA_ERROR_DOES_NOT_EXIST )
  #define PSA_ERROR_INSUFFICIENT_CAPACITY \
      MBEDTLS_DEPRECATED_CONSTANT( psa_status_t, PSA_ERROR_INSUFFICIENT_DATA )
  #define PSA_ERROR_TAMPERING_DETECTED \
      MBEDTLS_DEPRECATED_CONSTANT( psa_status_t, PSA_ERROR_CORRUPTION_DETECTED )
  
  /*
   * Deprecated PSA Crypto numerical encodings (PSA Crypto API  <= 1.0 beta3)
   */
  #define PSA_KEY_USAGE_SIGN \
      MBEDTLS_DEPRECATED_CONSTANT( psa_key_usage_t, PSA_KEY_USAGE_SIGN_HASH )
  #define PSA_KEY_USAGE_VERIFY \
      MBEDTLS_DEPRECATED_CONSTANT( psa_key_usage_t, PSA_KEY_USAGE_VERIFY_HASH )
  
  /*
   * Deprecated PSA Crypto size calculation macros (PSA Crypto API  <= 1.0 beta3)
   */
  #define PSA_ASYMMETRIC_SIGNATURE_MAX_SIZE \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_SIGNATURE_MAX_SIZE )
  #define PSA_ASYMMETRIC_SIGN_OUTPUT_SIZE( key_type, key_bits, alg ) \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_SIGN_OUTPUT_SIZE( key_type, key_bits, alg ) )
  #define PSA_KEY_EXPORT_MAX_SIZE( key_type, key_bits ) \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_EXPORT_KEY_OUTPUT_SIZE( key_type, key_bits ) )
  #define PSA_BLOCK_CIPHER_BLOCK_SIZE( type ) \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_BLOCK_CIPHER_BLOCK_LENGTH( type ) )
  #define PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE )
  #define PSA_HASH_SIZE( alg ) \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_HASH_LENGTH( alg ) )
  #define PSA_MAC_FINAL_SIZE( key_type, key_bits, alg ) \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_MAC_LENGTH( key_type, key_bits, alg ) )
  #define PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN \
      MBEDTLS_DEPRECATED_CONSTANT( size_t, PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
  
  /*
   * Deprecated PSA Crypto function names (PSA Crypto API  <= 1.0 beta3)
   */
  MBEDTLS_PSA_DEPRECATED static inline psa_status_t psa_asymmetric_sign( psa_key_handle_t key,
                              psa_algorithm_t alg,
                              const uint8_t *hash,
                              size_t hash_length,
                              uint8_t *signature,
                              size_t signature_size,
                              size_t *signature_length )
  {
      return psa_sign_hash( key, alg, hash, hash_length, signature, signature_size, signature_length );
  }
  
  MBEDTLS_PSA_DEPRECATED static inline psa_status_t psa_asymmetric_verify( psa_key_handle_t key,
                                psa_algorithm_t alg,
                                const uint8_t *hash,
                                size_t hash_length,
                                const uint8_t *signature,
                                size_t signature_length )
  {
      return psa_verify_hash( key, alg, hash, hash_length, signature, signature_length );
  }
  
  /*
   * Size-specific elliptic curve families.
   */
  #define PSA_ECC_CURVE_SECP160K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_K1 )
  #define PSA_ECC_CURVE_SECP192K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_K1 )
  #define PSA_ECC_CURVE_SECP224K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_K1 )
  #define PSA_ECC_CURVE_SECP256K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_K1 )
  #define PSA_ECC_CURVE_SECP160R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP192R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP224R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP256R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP384R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP521R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP160R2 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R2 )
  #define PSA_ECC_CURVE_SECT163K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT233K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT239K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT283K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT409K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT571K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT163R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT193R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT233R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT283R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT409R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT571R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT163R2 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R2 )
  #define PSA_ECC_CURVE_SECT193R2 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R2 )
  #define PSA_ECC_CURVE_BRAINPOOL_P256R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_BRAINPOOL_P_R1 )
  #define PSA_ECC_CURVE_BRAINPOOL_P384R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_BRAINPOOL_P_R1 )
  #define PSA_ECC_CURVE_BRAINPOOL_P512R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_BRAINPOOL_P_R1 )
  #define PSA_ECC_CURVE_CURVE25519 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_MONTGOMERY )
  #define PSA_ECC_CURVE_CURVE448 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_MONTGOMERY )
  
  /*
   * Curves that changed name due to PSA specification.
   */
  #define PSA_ECC_CURVE_SECP_K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_K1 )
  #define PSA_ECC_CURVE_SECP_R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R1 )
  #define PSA_ECC_CURVE_SECP_R2 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECP_R2 )
  #define PSA_ECC_CURVE_SECT_K1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_K1 )
  #define PSA_ECC_CURVE_SECT_R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R1 )
  #define PSA_ECC_CURVE_SECT_R2 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_SECT_R2 )
  #define PSA_ECC_CURVE_BRAINPOOL_P_R1 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_BRAINPOOL_P_R1 )
  #define PSA_ECC_CURVE_MONTGOMERY \
      MBEDTLS_DEPRECATED_CONSTANT( psa_ecc_family_t, PSA_ECC_FAMILY_MONTGOMERY )
  
  /*
   * Finite-field Diffie-Hellman families.
   */
  #define PSA_DH_GROUP_FFDHE2048 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  #define PSA_DH_GROUP_FFDHE3072 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  #define PSA_DH_GROUP_FFDHE4096 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  #define PSA_DH_GROUP_FFDHE6144 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  #define PSA_DH_GROUP_FFDHE8192 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  
  /*
   * Diffie-Hellman families that changed name due to PSA specification.
   */
  #define PSA_DH_GROUP_RFC7919 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_RFC7919 )
  #define PSA_DH_GROUP_CUSTOM \
      MBEDTLS_DEPRECATED_CONSTANT( psa_dh_family_t, PSA_DH_FAMILY_CUSTOM )
  
  /*
   * Deprecated PSA Crypto stream cipher algorithms (PSA Crypto API  <= 1.0 beta3)
   */
  #define PSA_ALG_ARC4 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_algorithm_t, PSA_ALG_STREAM_CIPHER )
  #define PSA_ALG_CHACHA20 \
      MBEDTLS_DEPRECATED_CONSTANT( psa_algorithm_t, PSA_ALG_STREAM_CIPHER )
  
  /*
   * Renamed AEAD tag length macros (PSA Crypto API  <= 1.0 beta3)
   */
  #define PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH( aead_alg ) \
      MBEDTLS_DEPRECATED_CONSTANT( psa_algorithm_t, PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( aead_alg ) )
  #define PSA_ALG_AEAD_WITH_TAG_LENGTH( aead_alg, tag_length ) \
      MBEDTLS_DEPRECATED_CONSTANT( psa_algorithm_t, PSA_ALG_AEAD_WITH_SHORTENED_TAG( aead_alg, tag_length ) )
  
  #endif /* MBEDTLS_DEPRECATED_REMOVED */
  
  /** Open a handle to an existing persistent key.
   *
   * 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
   * keys that can be opened with psa_open_key(). Such keys have an application
   * key identifier in the vendor range, as documented in the description of
   * #psa_key_id_t.
   *
   * 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().
   *
   * Some implementations permit an application to open the same key multiple
   * times. If this is successful, each call to psa_open_key() will return a
   * different key handle.
   *
   * \note This API is not part of the PSA Cryptography API Release 1.0.0
   * specification. It was defined in the 1.0 Beta 3 version of the
   * specification but was removed in the 1.0.0 released version. This API is
   * kept for the time being to not break applications relying on it. It is not
   * deprecated yet but will be in the near future.
   *
   * \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\`.
   *
   *
   * \param key           The persistent identifier of the key.
   * \param[out] handle   On success, a handle to the key.
   *
   * \retval #PSA_SUCCESS
   *         Success. The application can now use the value of `*handle`
   *         to access the key.
   * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   *         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.
   * \retval #PSA_ERROR_DOES_NOT_EXIST
   *         There is no persistent key with key identifier \p id.
   * \retval #PSA_ERROR_INVALID_ARGUMENT
   *         \p id is not a valid persistent key identifier.
   * \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.
   * \retval #PSA_ERROR_COMMUNICATION_FAILURE
   * \retval #PSA_ERROR_CORRUPTION_DETECTED
   * \retval #PSA_ERROR_STORAGE_FAILURE
   * \retval #PSA_ERROR_DATA_INVALID
   * \retval #PSA_ERROR_DATA_CORRUPT
   * \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_open_key( mbedtls_svc_key_id_t key,
                             psa_key_handle_t *handle );
  
  /** Close a key handle.
   *
   * If the handle designates a volatile key, this will destroy the key material
   * and free all associated resources, just like psa_destroy_key().
   *
   * 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().
   *
   * Closing the key handle makes the handle invalid, and the key handle
   * must not be used again by the application.
   *
   * \note This API is not part of the PSA Cryptography API Release 1.0.0
   * specification. It was defined in the 1.0 Beta 3 version of the
   * specification but was removed in the 1.0.0 released version. This API is
   * kept for the time being to not break applications relying on it. It is not
   * deprecated yet but will be in the near future.
   *
   * \note If the key handle was used to set up an active
   * :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.
   *
   * \param handle        The key handle to close.
   *                      If this is \c 0, do nothing and return \c PSA_SUCCESS.
   *
   * \retval #PSA_SUCCESS
   *         \p handle was a valid handle or \c 0. It is now closed.
   * \retval #PSA_ERROR_INVALID_HANDLE
   *         \p handle is not a valid handle nor \c 0.
   * \retval #PSA_ERROR_COMMUNICATION_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_close_key(psa_key_handle_t handle);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* PSA_CRYPTO_COMPAT_H */
  