Mbed TLS v3.5.2
Loading...
Searching...
No Matches
crypto_types.h
Go to the documentation of this file.
1
16/*
17 * Copyright The Mbed TLS Contributors
18 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
19 */
20
21#ifndef PSA_CRYPTO_TYPES_H
22#define PSA_CRYPTO_TYPES_H
23
24/* Make sure the Mbed TLS configuration is visible. */
25#include "mbedtls/build_info.h"
26/* Define the MBEDTLS_PRIVATE macro. */
28
29#if defined(MBEDTLS_PSA_CRYPTO_PLATFORM_FILE)
30#include MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
31#else
32#include "crypto_platform.h"
33#endif
34
35#include <stdint.h>
36
47/* If #PSA_SUCCESS is already defined, it means that #psa_status_t
48 * is also defined in an external header, so prevent its multiple
49 * definition.
50 */
51#ifndef PSA_SUCCESS
52typedef int32_t psa_status_t;
53#endif
54
71typedef uint16_t psa_key_type_t;
72
90typedef uint8_t psa_ecc_family_t;
91
109typedef uint8_t psa_dh_family_t;
110
127typedef uint32_t psa_algorithm_t;
128
176typedef uint32_t psa_key_lifetime_t;
177
212typedef uint8_t psa_key_persistence_t;
213
253typedef uint32_t psa_key_location_t;
254
268typedef uint32_t psa_key_id_t;
269
284#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
286
287#else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
288/* Implementation-specific: The Mbed TLS library can be built as
289 * part of a multi-client service that exposes the PSA Cryptography API in each
290 * client and encodes the client identity in the key identifier argument of
291 * functions such as psa_open_key().
292 */
293typedef struct {
295 mbedtls_key_owner_id_t MBEDTLS_PRIVATE(owner);
297
298#endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
299
316typedef uint32_t psa_key_usage_t;
317
426
427
428#ifndef __DOXYGEN_ONLY__
429#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
430/* Mbed TLS defines this type in crypto_types.h because it is also
431 * visible to applications through an implementation-specific extension.
432 * For the PSA Cryptography specification, this type is only visible
433 * via crypto_se_driver.h. */
434typedef uint64_t psa_key_slot_number_t;
435#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
436#endif /* !__DOXYGEN_ONLY__ */
437
450
453#endif /* PSA_CRYPTO_TYPES_H */
PSA cryptography module: Mbed TLS platform definitions.
uint16_t psa_key_type_t
Encoding of a key type.
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
uint8_t psa_ecc_family_t
uint8_t psa_dh_family_t
uint16_t psa_key_derivation_step_t
Encoding of the step of a key derivation.
int32_t psa_status_t
Function return status.
uint32_t psa_key_id_t
uint8_t psa_key_persistence_t
uint32_t psa_key_location_t
uint32_t psa_key_lifetime_t
psa_key_id_t mbedtls_svc_key_id_t
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
uint64_t psa_key_slot_number_t
Build-time configuration info.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)