Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 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 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 12 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 13 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 14 | */ |
| 15 | |
| 16 | #ifndef PSA_CRYPTO_INVASIVE_H |
| 17 | #define PSA_CRYPTO_INVASIVE_H |
| 18 | |
Ronald Cron | 7871cb1 | 2023-10-10 08:51:39 +0200 | [diff] [blame] | 19 | /* |
| 20 | * Include the build-time configuration information header. Here, we do not |
| 21 | * include `"mbedtls/build_info.h"` directly but `"psa/build_info.h"`, which |
| 22 | * is basically just an alias to it. This is to ease the maintenance of the |
| 23 | * TF-PSA-Crypto repository which has a different build system and |
| 24 | * configuration. |
| 25 | */ |
| 26 | #include "psa/build_info.h" |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 27 | |
| 28 | #include "psa/crypto.h" |
Steven Cooreman | 58c94d3 | 2021-03-02 21:31:17 +0100 | [diff] [blame] | 29 | #include "common.h" |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 30 | |
| 31 | #include "mbedtls/entropy.h" |
| 32 | |
Gilles Peskine | 4fc21fd | 2020-11-13 18:47:18 +0100 | [diff] [blame] | 33 | #if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 34 | /** \brief Configure entropy sources. |
| 35 | * |
| 36 | * This function may only be called before a call to psa_crypto_init(), |
| 37 | * or after a call to mbedtls_psa_crypto_free() and before any |
| 38 | * subsequent call to psa_crypto_init(). |
| 39 | * |
| 40 | * This function is only intended for test purposes. The functionality |
| 41 | * it provides is also useful for system integrators, but |
| 42 | * system integrators should configure entropy drivers instead of |
| 43 | * breaking through to the Mbed TLS API. |
| 44 | * |
| 45 | * \param entropy_init Function to initialize the entropy context |
| 46 | * and set up the desired entropy sources. |
| 47 | * It is called by psa_crypto_init(). |
| 48 | * By default this is mbedtls_entropy_init(). |
| 49 | * This function cannot report failures directly. |
| 50 | * To indicate a failure, set the entropy context |
| 51 | * to a state where mbedtls_entropy_func() will |
| 52 | * return an error. |
| 53 | * \param entropy_free Function to free the entropy context |
| 54 | * and associated resources. |
| 55 | * It is called by mbedtls_psa_crypto_free(). |
| 56 | * By default this is mbedtls_entropy_free(). |
| 57 | * |
Ronald Cron | 9678355 | 2020-10-19 12:06:30 +0200 | [diff] [blame] | 58 | * \retval #PSA_SUCCESS |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 59 | * Success. |
Ronald Cron | 9678355 | 2020-10-19 12:06:30 +0200 | [diff] [blame] | 60 | * \retval #PSA_ERROR_NOT_PERMITTED |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 61 | * The caller does not have the permission to configure |
| 62 | * entropy sources. |
Ronald Cron | 9678355 | 2020-10-19 12:06:30 +0200 | [diff] [blame] | 63 | * \retval #PSA_ERROR_BAD_STATE |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 64 | * The library has already been initialized. |
| 65 | */ |
| 66 | psa_status_t mbedtls_psa_crypto_configure_entropy_sources( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 67 | void (* entropy_init)(mbedtls_entropy_context *ctx), |
| 68 | void (* entropy_free)(mbedtls_entropy_context *ctx)); |
Gilles Peskine | 4fc21fd | 2020-11-13 18:47:18 +0100 | [diff] [blame] | 69 | #endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */ |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 70 | |
Steven Cooreman | 58c94d3 | 2021-03-02 21:31:17 +0100 | [diff] [blame] | 71 | #if defined(MBEDTLS_TEST_HOOKS) && defined(MBEDTLS_PSA_CRYPTO_C) |
Steven Cooreman | f9f7fdf | 2021-03-03 19:04:05 +0100 | [diff] [blame] | 72 | psa_status_t psa_mac_key_can_do( |
| 73 | psa_algorithm_t algorithm, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 74 | psa_key_type_t key_type); |
Steven Cooreman | 58c94d3 | 2021-03-02 21:31:17 +0100 | [diff] [blame] | 75 | #endif /* MBEDTLS_TEST_HOOKS && MBEDTLS_PSA_CRYPTO_C */ |
| 76 | |
Gilles Peskine | 5e76952 | 2018-11-20 21:59:56 +0100 | [diff] [blame] | 77 | #endif /* PSA_CRYPTO_INVASIVE_H */ |