mbed TLS v2.28.0
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
19 *
20 * Licensed under the Apache License, Version 2.0 (the "License"); you may
21 * not use this file except in compliance with the License.
22 * You may obtain a copy of the License at
23 *
24 * http://www.apache.org/licenses/LICENSE-2.0
25 *
26 * Unless required by applicable law or agreed to in writing, software
27 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29 * See the License for the specific language governing permissions and
30 * limitations under the License.
31 */
32
33#ifndef PSA_CRYPTO_TYPES_H
34#define PSA_CRYPTO_TYPES_H
35
36#include "crypto_platform.h"
37
38/* If MBEDTLS_PSA_CRYPTO_C is defined, make sure MBEDTLS_PSA_CRYPTO_CLIENT
39 * is defined as well to include all PSA code.
40 */
41#if defined(MBEDTLS_PSA_CRYPTO_C)
42#define MBEDTLS_PSA_CRYPTO_CLIENT
43#endif /* MBEDTLS_PSA_CRYPTO_C */
44
45#include <stdint.h>
46
57/* If #PSA_SUCCESS is already defined, it means that #psa_status_t
58 * is also defined in an external header, so prevent its multiple
59 * definition.
60 */
61#ifndef PSA_SUCCESS
62typedef int32_t psa_status_t;
63#endif
64
73typedef uint16_t psa_key_type_t;
74
84typedef uint8_t psa_ecc_family_t;
85
95typedef uint8_t psa_dh_family_t;
96
105typedef uint32_t psa_algorithm_t;
106
146typedef uint32_t psa_key_lifetime_t;
147
177typedef uint8_t psa_key_persistence_t;
178
213typedef uint32_t psa_key_location_t;
214
224typedef uint32_t psa_key_id_t;
225
226#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
228
229#else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
230/* Implementation-specific: The Mbed Cryptography library can be built as
231 * part of a multi-client service that exposes the PSA Cryptograpy API in each
232 * client and encodes the client identity in the key identifier argument of
233 * functions such as psa_open_key().
234 */
235typedef struct
236{
237 psa_key_id_t key_id;
238 mbedtls_key_owner_id_t owner;
240
241#endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */
242
250typedef uint32_t psa_key_usage_t;
251
360
361
362#ifndef __DOXYGEN_ONLY__
363#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
364/* Mbed Crypto defines this type in crypto_types.h because it is also
365 * visible to applications through an implementation-specific extension.
366 * For the PSA Cryptography specification, this type is only visible
367 * via crypto_se_driver.h. */
368typedef uint64_t psa_key_slot_number_t;
369#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
370#endif /* !__DOXYGEN_ONLY__ */
371
380
383#endif /* PSA_CRYPTO_TYPES_H */
PSA cryptography module: Mbed TLS platform definitions.
uint16_t psa_key_type_t
Encoding of a key type.
Definition: crypto_types.h:73
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: crypto_types.h:105
uint8_t psa_ecc_family_t
Definition: crypto_types.h:84
uint8_t psa_dh_family_t
Definition: crypto_types.h:95
uint16_t psa_key_derivation_step_t
Encoding of the step of a key derivation.
Definition: crypto_types.h:379
int32_t psa_status_t
Function return status.
Definition: crypto_types.h:62
uint32_t psa_key_id_t
Definition: crypto_types.h:224
uint8_t psa_key_persistence_t
Definition: crypto_types.h:177
uint32_t psa_key_location_t
Definition: crypto_types.h:213
uint32_t psa_key_lifetime_t
Definition: crypto_types.h:146
psa_key_id_t mbedtls_svc_key_id_t
Definition: crypto_types.h:227
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
Definition: crypto_types.h:250
uint64_t psa_key_slot_number_t