CryptoKeyKeyStore_PSA_s.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2025, Texas Instruments Incorporated - http://www.ti.com
 * 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_s.h
 *  @brief      Secure Crypto Service
 *
 *  @anchor ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_s_Overview
 *  # Overview
 *      The Secure KeyStore driver is used to access all KeyStore functions
 *      when using the TF-M.
 *
 *******************************************************************************
 */
#ifndef ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_s__include
#define ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_s__include

#include <stdint.h>

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

#include <ti/devices/DeviceFamily.h>

#include <third_party/tfm/interface/include/psa/crypto.h>
#include <third_party/tfm/interface/include/psa/service.h>

/* For client side key attribute structure */
#include <third_party/tfm/interface/include/psa/crypto_client_struct.h>

#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)
    #include <ti/drivers/crypto/CryptoCC26X4_s.h>
    /*
     * Crypto Key Store secure message types
     */
    #define KEYSTORE_PSA_S_MSG_TYPE_GET_KEY              KEYSTORE_PSA_S_MSG_TYPE(0U)
    #define KEYSTORE_PSA_S_MSG_TYPE_GENERATE_KEY         KEYSTORE_PSA_S_MSG_TYPE(1U)
    #define KEYSTORE_PSA_S_MSG_TYPE_EXPORT_PUBLIC_KEY    KEYSTORE_PSA_S_MSG_TYPE(2U)
    #define KEYSTORE_PSA_S_MSG_TYPE_EXPORT_KEY           KEYSTORE_PSA_S_MSG_TYPE(3U)
    #define KEYSTORE_PSA_S_MSG_TYPE_DESTROY_KEY          KEYSTORE_PSA_S_MSG_TYPE(4U)
    #define KEYSTORE_PSA_S_MSG_TYPE_IMPORT_KEY           KEYSTORE_PSA_S_MSG_TYPE(5U)
    #define KEYSTORE_PSA_S_MSG_TYPE_PURGE_KEY            KEYSTORE_PSA_S_MSG_TYPE(6U)
    #define KEYSTORE_PSA_S_MSG_TYPE_GET_KEY_ATTRIBUTES   KEYSTORE_PSA_S_MSG_TYPE(7U)
    #define KEYSTORE_PSA_S_MSG_TYPE_RESET_KEY_ATTRIBUTES KEYSTORE_PSA_S_MSG_TYPE(8U)
#endif

/*
 * ============ KeyStore driver Secure Message Structs =========
 * These secure message structs correspond to the secure message types defined
 * above. Together, they are used by non-secure client to make PSA calls to the
 * KeyStore secure service. There is a single input vector for the PSA call
 * which is a pointer to secure message struct. If the underlying function
 * has a return value, there is a single output vector which is a pointer to
 * storage for the return value.
 */
typedef struct
{
    uint32_t key;
    uint8_t *data;
    size_t dataSize;
    size_t *dataLength;
    KeyStore_PSA_Algorithm alg;
    KeyStore_PSA_KeyUsage usage;
} KeyStore_s_GetKeyMsg;

typedef struct
{
    struct psa_client_key_attributes_s *attributes;
    KeyStore_PSA_KeyFileId *key;
} KeyStore_s_GenerateKeyMsg;

/* Msg for KeyStore_PSA_exportKey() and KeyStore_PSA_exportPublicKey() */
typedef struct
{
    uint32_t key;
    uint8_t *data;
    size_t dataSize;
    size_t *dataLength;
} KeyStore_s_ExportMsg;

typedef struct
{
    struct psa_client_key_attributes_s *attributes;
    uint8_t *data;
    size_t dataLength;
    uint32_t *key;
} KeyStore_s_ImportKeyMsg;

/* Msg for KeyStore_PSA_destroyKey() and KeyStore_PSA_purgeKey() */
typedef struct
{
    uint32_t key;
} KeyStore_s_DestroyPurgeKeyMsg;

typedef struct
{
    uint32_t key;
    struct psa_client_key_attributes_s *attributes;
} KeyStore_s_GetKeyAttributesMsg;

typedef struct
{
    struct psa_client_key_attributes_s *attributes;
} KeyStore_s_ResetKeyAttributesMsg;

psa_status_t KeyStore_s_handlePsaMsg(psa_msg_t *msg);

void KeyStore_s_init(void);

psa_status_t KeyStore_s_copyKeyAttributesFromClient(struct psa_client_key_attributes_s *clientKeyAttr,
                                                    int32_t clientId,
                                                    psa_key_attributes_t *keyAttributes);

void KeyStore_s_copyKeyIDFromClient(KeyStore_PSA_KeyFileId *keyID, int32_t clientId, uint32_t *clientKeyID);
#endif /* ti_drivers_cryptoutils_cryptokey_CryptoKeyKeyStore_PSA_s__include */