common/mbedtls/psa_crypto_invasive.h

   1 /**
   2  * \file psa_crypto_invasive.h
   3  *
   4  * \brief PSA cryptography module: invasive interfaces for test only.
   5  *
   6  * The interfaces in this file are intended for testing purposes only.
   7  * They MUST NOT be made available to clients over IPC in integrations
   8  * with isolation, and they SHOULD NOT be made available in library
   9  * integrations except when building the library for testing.
  10  */
  11 /*
  12  *  Copyright The Mbed TLS Contributors
  13  *  SPDX-License-Identifier: Apache-2.0
  14  *
  15  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  16  *  not use this file except in compliance with the License.
  17  *  You may obtain a copy of the License at
  18  *
  19  *  http://www.apache.org/licenses/LICENSE-2.0
  20  *
  21  *  Unless required by applicable law or agreed to in writing, software
  22  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  23  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  24  *  See the License for the specific language governing permissions and
  25  *  limitations under the License.
  26  */
  27
  28 #ifndef PSA_CRYPTO_INVASIVE_H
  29 #define PSA_CRYPTO_INVASIVE_H
  30
  31 #if defined(MBEDTLS_CONFIG_FILE)
  32 #include MBEDTLS_CONFIG_FILE
  33 #else
  34 #include "mbedtls/config.h"
  35 #endif
  36
  37 #include "psa/crypto.h"
  38 #include "common.h"
  39
  40 #include "mbedtls/entropy.h"
  41
  42 #if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
  43 /** \brief Configure entropy sources.
  44  *
  45  * This function may only be called before a call to psa_crypto_init(),
  46  * or after a call to mbedtls_psa_crypto_free() and before any
  47  * subsequent call to psa_crypto_init().
  48  *
  49  * This function is only intended for test purposes. The functionality
  50  * it provides is also useful for system integrators, but
  51  * system integrators should configure entropy drivers instead of
  52  * breaking through to the Mbed TLS API.
  53  *
  54  * \param entropy_init  Function to initialize the entropy context
  55  *                      and set up the desired entropy sources.
  56  *                      It is called by psa_crypto_init().
  57  *                      By default this is mbedtls_entropy_init().
  58  *                      This function cannot report failures directly.
  59  *                      To indicate a failure, set the entropy context
  60  *                      to a state where mbedtls_entropy_func() will
  61  *                      return an error.
  62  * \param entropy_free  Function to free the entropy context
  63  *                      and associated resources.
  64  *                      It is called by mbedtls_psa_crypto_free().
  65  *                      By default this is mbedtls_entropy_free().
  66  *
  67  * \retval #PSA_SUCCESS
  68  *         Success.
  69  * \retval #PSA_ERROR_NOT_PERMITTED
  70  *         The caller does not have the permission to configure
  71  *         entropy sources.
  72  * \retval #PSA_ERROR_BAD_STATE
  73  *         The library has already been initialized.
  74  */
  75 psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
  76     void (* entropy_init)(mbedtls_entropy_context *ctx),
  77     void (* entropy_free)(mbedtls_entropy_context *ctx));
  78 #endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
  79
  80 #if defined(MBEDTLS_TEST_HOOKS) && defined(MBEDTLS_PSA_CRYPTO_C)
  81 psa_status_t psa_mac_key_can_do(
  82     psa_algorithm_t algorithm,
  83     psa_key_type_t key_type);
  84 #endif /* MBEDTLS_TEST_HOOKS && MBEDTLS_PSA_CRYPTO_C */
  85
  86 #endif /* PSA_CRYPTO_INVASIVE_H */