crypto_types.h

Go to the documentation of this file.

/*
 *  Copyright The Mbed TLS Contributors
 *  Copyright 2023-2024, Texas Instruments Incorporated
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may
 *  not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  Modified by Texas Instruments to:
 *  - Support 'TFM_ENABLED' builds for SimpleLink devices
 *  - Change header file includes
 *  - Remove MBEDTLS_PRIVATE() usage
 *  - Add MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER define
 */

#ifndef PSA_CRYPTO_TYPES_H
#define PSA_CRYPTO_TYPES_H

/* clang-format off */

/* Enable key identifiers that encode a key owner identifiers */
#if (TFM_ENABLED == 0) || defined(TFM_BUILD)
#ifndef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
#endif
#endif

#if 0 /* Texas Instruments modification */
/* Make sure the Mbed TLS configuration is visible. */
#include "mbedtls/build_info.h"
/* Define the MBEDTLS_PRIVATE macro. */
#include "mbedtls/private_access.h"

#if defined(MBEDTLS_PSA_CRYPTO_PLATFORM_FILE)
#include MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
#else
#include "crypto_platform.h"
#endif
#endif

#include <stdint.h>

/* If #PSA_SUCCESS is already defined, it means that #psa_status_t
 * is also defined in an external header, so prevent its multiple
 * definition.
 */
#ifndef PSA_SUCCESS
typedef int32_t psa_status_t;
#endif

typedef uint16_t psa_key_type_t;

typedef uint8_t psa_ecc_family_t;

typedef uint8_t psa_dh_family_t;

typedef uint32_t psa_algorithm_t;

typedef uint32_t psa_key_lifetime_t;

typedef uint8_t psa_key_persistence_t;

typedef uint32_t psa_key_location_t;

typedef uint32_t psa_key_id_t;

#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
#if (TFM_ENABLED == 0) || defined(TFM_BUILD)
/* For S-only builds or building into TFM, the core key attributes should store
 * the key ID with the owner encoded.
 */
#error "MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER must be defined for S-only builds or building into TFM"
#endif
typedef psa_key_id_t mbedtls_svc_key_id_t;
#else /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */

/* Building for the PSA Crypto service on a PSA platform, a key owner is a PSA
 * partition identifier.
 *
 * The function psa_its_identifier_of_slot() in psa_crypto_storage.c that
 * translates a key identifier to a key storage file name assumes that
 * mbedtls_key_owner_id_t is a 32-bit integer. This function thus needs
 * reworking if mbedtls_key_owner_id_t is not defined as a 32-bit integer
 * here anymore.
 */
typedef int32_t mbedtls_key_owner_id_t;

static inline int mbedtls_key_owner_id_equal(mbedtls_key_owner_id_t id1,
                                             mbedtls_key_owner_id_t id2)
{
    return id1 == id2;
}

/* Implementation-specific: The Mbed TLS library can be built as
 * part of a multi-client service that exposes the PSA Cryptography API in each
 * client and encodes the client identity in the key identifier argument of
 * functions such as psa_open_key().
 */
typedef struct
{
    psa_key_id_t key_id;
    mbedtls_key_owner_id_t owner;
} mbedtls_svc_key_id_t;

#endif /* !MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER */

typedef uint32_t psa_key_usage_t;

#if (TFM_ENABLED == 0) || defined(TFM_BUILD)
/* For S-only builds, always use the full key attributes. If the PSA Crypto API
 * Wrapper is built into the S side when TFM is enabled, the full internal
 * version of the key attributes from mbedTLS should be used. The Crypto secure
 * service will translate the client key attributes into the full internal key
 * attributes before calling the PSA Crypto API Wrapper.
 */
typedef struct psa_key_attributes_s psa_key_attributes_t;
#else
/* When building the NS application for TFM-enabled builds, use client key
 * attributes.
 */
typedef struct psa_client_key_attributes_s psa_key_attributes_t;
#endif /* (TFM_ENABLED == 0) || defined(TFM_BUILD) */

#ifndef __DOXYGEN_ONLY__
#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
/* Mbed TLS defines this type in crypto_types.h because it is also
 * visible to applications through an implementation-specific extension.
 * For the PSA Cryptography specification, this type is only visible
 * via crypto_se_driver.h. */
typedef uint64_t psa_key_slot_number_t;
#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
#endif /* !__DOXYGEN_ONLY__ */

typedef uint16_t psa_key_derivation_step_t;

#endif /* PSA_CRYPTO_TYPES_H */