CryptoKey.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2023, 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.
 */
#ifndef ti_drivers_cryptoutils_cyptokey_CryptoKey__include
#define ti_drivers_cryptoutils_cyptokey_CryptoKey__include

#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

#define CryptoKey_STATUS_RESERVED (-32)

#define CryptoKey_STATUS_SUCCESS (0)

#define CryptoKey_STATUS_ERROR (-1)

#define CryptoKey_STATUS_UNDEFINED_ENCODING (-2)

/*
 * CRYPTOKEY_HSM is being used to mask bit 6 which determines which accelerator to use.
 * Any encoding that is ORed with CRYPTOKEY_HSM indicates that the HSM is the engine of choice for the operation
 */
#define CRYPTOKEY_HSM 0x20U

#define CRYPTOKEY_PLAINTEXT       0x02U
#define CRYPTOKEY_BLANK_PLAINTEXT 0x04U
#define CRYPTOKEY_KEYSTORE        0x08U
#define CRYPTOKEY_BLANK_KEYSTORE  0x10U

typedef uint8_t CryptoKey_Encoding;
static const CryptoKey_Encoding CryptoKey_PLAINTEXT       = CRYPTOKEY_PLAINTEXT;
static const CryptoKey_Encoding CryptoKey_BLANK_PLAINTEXT = CRYPTOKEY_BLANK_PLAINTEXT;
static const CryptoKey_Encoding CryptoKey_KEYSTORE        = CRYPTOKEY_KEYSTORE;
static const CryptoKey_Encoding CryptoKey_BLANK_KEYSTORE  = CRYPTOKEY_BLANK_KEYSTORE;
static const CryptoKey_Encoding CryptoKey_PLAINTEXT_HSM   = CRYPTOKEY_PLAINTEXT | CRYPTOKEY_HSM;

typedef struct
{
    uint8_t *keyMaterial;
    uint32_t keyLength;
} CryptoKey_Plaintext;

typedef struct
{
    uint32_t keyLength;
    uint32_t keyID;
    void *keyAttributes;
} CryptoKey_KeyStore;

typedef struct
{
    CryptoKey_Encoding encoding;
    union
    {
        CryptoKey_Plaintext plaintext;
        CryptoKey_KeyStore keyStore;
    } u;
} CryptoKey;

typedef struct CryptoKey_SecurityPolicy_ CryptoKey_SecurityPolicy;

int_fast16_t CryptoKey_getCryptoKeyType(const CryptoKey *keyHandle, CryptoKey_Encoding *keyType);

int_fast16_t CryptoKey_isBlank(const CryptoKey *keyHandle, bool *isBlank);

int_fast16_t CryptoKey_initSecurityPolicy(CryptoKey_SecurityPolicy *policy);

int_fast16_t CryptoKey_verifySecureInputKey(const CryptoKey *secureKey);

int_fast16_t CryptoKey_verifySecureOutputKey(const CryptoKey *secureKey);

int_fast16_t CryptoKey_copySecureInputKey(CryptoKey *dst, const CryptoKey **src);

int_fast16_t CryptoKey_copySecureOutputKey(CryptoKey *dst, CryptoKey **src);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_cryptoutils_cyptokey_CryptoKey__include */