xref: /aosp_15_r20/external/mbedtls/library/md_psa.h (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf Ebrahimi /**
2*62c56f98SSadaf Ebrahimi  * Translation between MD and PSA identifiers (algorithms, errors).
3*62c56f98SSadaf Ebrahimi  *
4*62c56f98SSadaf Ebrahimi  *  Note: this internal module will go away when everything becomes based on
5*62c56f98SSadaf Ebrahimi  *  PSA Crypto; it is a helper for the transition period.
6*62c56f98SSadaf Ebrahimi  *
7*62c56f98SSadaf Ebrahimi  *  Copyright The Mbed TLS Contributors
8*62c56f98SSadaf Ebrahimi  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9*62c56f98SSadaf Ebrahimi  */
10*62c56f98SSadaf Ebrahimi #ifndef MBEDTLS_MD_PSA_H
11*62c56f98SSadaf Ebrahimi #define MBEDTLS_MD_PSA_H
12*62c56f98SSadaf Ebrahimi 
13*62c56f98SSadaf Ebrahimi #include "common.h"
14*62c56f98SSadaf Ebrahimi 
15*62c56f98SSadaf Ebrahimi #include "mbedtls/md.h"
16*62c56f98SSadaf Ebrahimi #include "psa/crypto.h"
17*62c56f98SSadaf Ebrahimi 
18*62c56f98SSadaf Ebrahimi /**
19*62c56f98SSadaf Ebrahimi  * \brief           This function returns the PSA algorithm identifier
20*62c56f98SSadaf Ebrahimi  *                  associated with the given digest type.
21*62c56f98SSadaf Ebrahimi  *
22*62c56f98SSadaf Ebrahimi  * \param md_type   The type of digest to search for. Must not be NONE.
23*62c56f98SSadaf Ebrahimi  *
24*62c56f98SSadaf Ebrahimi  * \warning         If \p md_type is \c MBEDTLS_MD_NONE, this function will
25*62c56f98SSadaf Ebrahimi  *                  not return \c PSA_ALG_NONE, but an invalid algorithm.
26*62c56f98SSadaf Ebrahimi  *
27*62c56f98SSadaf Ebrahimi  * \warning         This function does not check if the algorithm is
28*62c56f98SSadaf Ebrahimi  *                  supported, it always returns the corresponding identifier.
29*62c56f98SSadaf Ebrahimi  *
30*62c56f98SSadaf Ebrahimi  * \return          The PSA algorithm identifier associated with \p md_type,
31*62c56f98SSadaf Ebrahimi  *                  regardless of whether it is supported or not.
32*62c56f98SSadaf Ebrahimi  */
mbedtls_md_psa_alg_from_type(mbedtls_md_type_t md_type)33*62c56f98SSadaf Ebrahimi static inline psa_algorithm_t mbedtls_md_psa_alg_from_type(mbedtls_md_type_t md_type)
34*62c56f98SSadaf Ebrahimi {
35*62c56f98SSadaf Ebrahimi     return PSA_ALG_CATEGORY_HASH | (psa_algorithm_t) md_type;
36*62c56f98SSadaf Ebrahimi }
37*62c56f98SSadaf Ebrahimi 
38*62c56f98SSadaf Ebrahimi /**
39*62c56f98SSadaf Ebrahimi  * \brief           This function returns the given digest type
40*62c56f98SSadaf Ebrahimi  *                  associated with the PSA algorithm identifier.
41*62c56f98SSadaf Ebrahimi  *
42*62c56f98SSadaf Ebrahimi  * \param psa_alg   The PSA algorithm identifier to search for.
43*62c56f98SSadaf Ebrahimi  *
44*62c56f98SSadaf Ebrahimi  * \warning         This function does not check if the algorithm is
45*62c56f98SSadaf Ebrahimi  *                  supported, it always returns the corresponding identifier.
46*62c56f98SSadaf Ebrahimi  *
47*62c56f98SSadaf Ebrahimi  * \return          The MD type associated with \p psa_alg,
48*62c56f98SSadaf Ebrahimi  *                  regardless of whether it is supported or not.
49*62c56f98SSadaf Ebrahimi  */
mbedtls_md_type_from_psa_alg(psa_algorithm_t psa_alg)50*62c56f98SSadaf Ebrahimi static inline mbedtls_md_type_t mbedtls_md_type_from_psa_alg(psa_algorithm_t psa_alg)
51*62c56f98SSadaf Ebrahimi {
52*62c56f98SSadaf Ebrahimi     return (mbedtls_md_type_t) (psa_alg & PSA_ALG_HASH_MASK);
53*62c56f98SSadaf Ebrahimi }
54*62c56f98SSadaf Ebrahimi 
55*62c56f98SSadaf Ebrahimi /** Convert PSA status to MD error code.
56*62c56f98SSadaf Ebrahimi  *
57*62c56f98SSadaf Ebrahimi  * \param status    PSA status.
58*62c56f98SSadaf Ebrahimi  *
59*62c56f98SSadaf Ebrahimi  * \return          The corresponding MD error code,
60*62c56f98SSadaf Ebrahimi  */
61*62c56f98SSadaf Ebrahimi int mbedtls_md_error_from_psa(psa_status_t status);
62*62c56f98SSadaf Ebrahimi 
63*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_MD_PSA_H */
64