CryptoKeyKeyStore_PSA_helpers.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2025, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*!*****************************************************************************
 *  @file       CryptoKeyKeyStore_PSA_helpers.h
 *  @brief      CryptoKeyKeyStore driver header
 *
 *  @anchor ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_helpers_Overview
 *  # Overview
 *      The CryptoKeyKeyStore driver provides API to initialize keys and get plaintext
 *      keys from KeyStore. This file provides definitions that are only available to the
 *      the secure side, in both TF-M disabled and TF-M enabled environments.
 *
 *******************************************************************************
 */

#ifndef ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_helpers__include
#define ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_helpers__include

#include <stddef.h>
#include <stdint.h>

#include <ti/drivers/cryptoutils/cryptokey/CryptoKeyKeyStore_PSA.h>

#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/devices/DeviceFamily.h>

#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)
    #include <third_party/mbedtls/library/psa_crypto_core.h>
    #include <third_party/mbedtls/library/psa_crypto_slot_management.h>
    #include <third_party/mbedtls/library/psa_crypto_storage.h>
#elif ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX))
    #include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>
#else
    #error "Unsupported DeviceFamily_Parent for CryptoKeyKeyStore_PSA_helpers"
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef struct
{
    SemaphoreP_Struct KeyStore_accessSemaphore;
    bool isInitialized;
    bool isAcquired;
} KeyStore_accessSemaphoreObject;

extern KeyStore_accessSemaphoreObject KeyStore_semaphoreObject;

#define FLETCHER_CHECKSUM_ALGORITHM 32 /* FLETCHER-32 */

int_fast16_t KeyStore_PSA_getKey(KeyStore_PSA_KeyFileId key,
                                 uint8_t *data,
                                 size_t dataSize,
                                 size_t *dataLength,
                                 KeyStore_PSA_Algorithm alg,
                                 KeyStore_PSA_KeyUsage usage);

#if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX))

bool KeyStore_acquireLock(void);

void KeyStore_releaseLock(void);

int_fast16_t KeyStore_PSA_retrieveFromKeyStore(const CryptoKey *key,
                                               uint8_t *keyBuffer,
                                               size_t keyBufferSize,
                                               uint32_t *keyAssetID,
                                               KeyStore_PSA_Algorithm targetAlg,
                                               KeyStore_PSA_KeyUsage targetUsage);

int_fast16_t KeyStore_PSA_getKeyAssetId(KeyStore_PSA_KeyFileId key,
                                        uint32_t *const pAssetId,
                                        KeyStore_PSA_Algorithm targetAlg,
                                        KeyStore_PSA_KeyUsage targetUsage);

int_fast16_t KeyStore_PSA_assetPostProcessing(KeyStore_PSA_KeyFileId key);
#endif /* #if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == \
          DeviceFamily_PARENT_CC35XX)) */

int_fast16_t KeyStore_PSA_init(void);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_helpers__include */