HSMBareMetal.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024-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       HSMBareMetal.h
 *
 *  @brief      Interface to The HSM IP in a BareMetal-based implementation.
 *
 *  This module provides cryptographic functions for use of the Hardware Security Module.
 *
 *  Summary and List of Features:
 *  - HSM initialization sequence.
 *      * Turn on the HSM Clock.
 *      * Initialize and link the designated HSM mailbox for token exchanges
 *      * Boot up the HSM by sending a boot operation to the HSM to initialize the HSM FW.
 *  - HSM un-init sequence.
 *  - HSM HUK provisioning.
 *  - HSM Asset-related Operations:
 *      * Dynamic Asset creation and plaintext-only load to the HSM internal AssetStore.
 *      * Support for AES and MAC keys including HMAC.
 *      * In-API key generation:
 *        (The user can request to generate key, create an asset, and load key in HSM AssetStore in one API)
 *      * Loading plaintext, returning an asset ID pair, and extracting a Key blob pair for AES operations.
 *        - Please use the HSM_KEYBLOB_SIZE() macro to determine the appropriate size of key blob buffers.
 *      * Importing a key blob pair for AES operations and returning an asset ID pair
 *  - HSM Cryptography-related Operations:
 *      * AES operations, (CCM, GCM, CTR, ECB, CBC).
 *      * MAC operations, (128-bit CMAC, 128-bit CBC-MAC, HMAC).
 *      * Hash operations, (SHA2-224, SHA2-256, SHA2-384, SHA2-512).
 *      * RNG operations, Deterministic (RECOMMENDED) and non-deterministic (Raw).
 *      * ECC operations, (ECDH, ECDSA).
 *  - HSM Support for plaintext or AssetStore formats for keys for AES operations.
 *      * (CCM, GCM, CTR, ECB, CBC):
 *          1. For plaintext, the symmetric key material can be provided as part of the AES operation.
 *          2. For AssetStore, the symmetric key material must be loaded as an HSM asset and the asset ID generated has
 *             to be provided as part of the AES operation.
 *      * (CMAC, CBC-MAC, and HMAC):
 *          1. MAC-based operations that require the symmetric key to be pre-loaded in the HSM AssetStore and provide
 * the asset ID as part of the MAC operation.
 *  - HSM Support for (CCM, GCM, CTR, ECB, CBC, CMAC, CBC-MAC) operations with the following key sizes:
 *      * 128-bit (16 Bytes).
 *      * 192-bit (24 Bytes).
 *      * 256-bit (32 Bytes).
 *  - HSM Support for HMAC Algorithms:
 *      * SHA2-224 with key sizes within range 14-64 Bytes.
 *      * SHA2-256 with key sizes within range 14-64 Bytes.
 *      * SHA2-384 with key sizes within range 24-128 Bytes.
 *      * SHA2-512 with key sizes within range 32-128 Bytes.
 *  - HSM Support for HASH Algorithms:
 *      * SHA2-224 with digest length 28 Bytes.
 *      * SHA2-256 with digest length 32 Bytes.
 *      * SHA2-384 with digest length 48 Bytes.
 *      * SHA2-512 with digest length 64 Bytes.
 *      * Multi-step hash operations are supported. To perform a multi-step hash operation, the user will need to create
 *      * a series of operations with the operation Type in the following order:
 *          - INIT_TO_CONT (once)
 *          - CONT_TO_CONT (as many times as necessary)
 *          - CONT_TO_FINAL (once)
 *      * Performing a CONT_TO_CONT or CONT_TO_FINAL hash operation before an INIT_TO_CONT hash operation will result
 *      * unexpected outputs.
 *      * Multi-step hash operations are supported for all digest lengths and sha2 algorithms.
 *  - HSM Support for RNG Operations:
 *      * Size must be 0 < x < (2^16 Bytes).
 *      * For DRBG data, size must be 32-bit aligned. (Multiple of 4 bytes).
 *      * For NRBG data, size can be anywhere between 1-256 bytes and multiple of 256 bytes if larger than 256 bytes.
 *  - HSM Support for ECC Operations:
 *      * ECDH public key generation.
 *      * ECDH shared secret generation.
 *      * ECDSA DS digest signature generation.
 *      * ECDSA DS digest signature verification.
 *  - HSM Support for ECC Curve types:
 *      * SEC_P_224_R1.
 *      * SEC_P_256_R1.
 *      * SEC_P_384_R1.
 *      * SEC_P_521_R1.
 *      * BRP_P_256_R1.
 *      * BRP_P_384_R1.
 *      * BRP_P_512_R1.
 *      * CURVE25519.
 *  - HSM limitations:
 *      * All buffer address must be word-aligned.
 *      * Input plaintext length for (CCM, GCM, CBC, CTR, ECB, CMAC, CBC-MAC, SHA2, HMAC) shall be upto 2^21 -1 Bytes
 *        and block-size aligned.
 *      * For non-final hash operations, the input data should be block-size aligned (128 bytes for SHA-2-384 and
 *        SHA-2-512 or 64 bytes for the other algorithms).
 *      * For segmented hashing, the user must maintain the intermediate digest buffer to be passed between operations.
 *      * Input for every ECC operation must be in big endian format.
 *      * Input and output buffers shall be a multiple of block length.
 *        Meaning that while the input data can be of any length, the buffers for the input and output data
 *        should be rounded up to the nearest size that is a multiple of block size.
 *          - For example, input data size of 24 Bytes must be in a buffer that is of size 32 bytes.
 *      * Additional Authenticated Data (AAD) for (CCM, GCM) length up to 2^16 - 2^8 Bytes.
 *      * The combined length of the input data and the AAD for (CCM, GCM) shall not be zero.
 *      * Nonce for (CCM) length for (7-13) Bytes.
 *      * Initialization Vector (IV) for (CCM, CBC, CTR) length IS EXACTLY 16 Bytes.
 *      * Tag length for AES-CCM shall be a multiple of 2 Bytes, [4, 6, 8, 10, 12, 14, 16].
 *      * Tag for AES-GCM length should be the following [4, 8, 12, 13, 14, 15, 16] Bytes.
 *      * MAC length (128-bit CMAC, 128-bit CBC-MAC) should be the following [2, 4, 6, 8, 10, 12, 14, 16] Bytes.
 *      * For ECC operations:
 *          - ECDSA sign and verify operations do not support curve type: CURVE25519.
 *          - All input keys must be supplied in plaintext.
 *          - ECC operations takes in a digest (not the input buffer).
 *              Therefore, the input buffer must be hashed using #HSMBareMetal_HASHOperation() API and supplying the
 * digest in the ECC operation.
 *          - Digest length must match curve length. Ex. for SEC_P_384_R1 and BRP_P_384_R1 curve types, the digest must
 * be generated using SHA2-384. For BRP_P_512_R1 and SEC_P_521_R1 curve types, the digest must be generated using
 * SHA2-512.
 *
 *  NOTE: The above features do not support segmented operations. All operations are performed as a 'one-shot'
 *  operation. NOTE: the above features and their APIs are synchonous and conduct their operations in a polling return
 *  behavior-like fashion.
 *
 *  # Usage #
 *
 *  ## Before starting a BareMetal operation #
 *
 *  Before starting a BareMetal operation
 *      - Call HSMBareMetal_init() to initialize the HSM IP and the SW architecture.
 *
 *      - Call HSMBareMetal_provisionHUK() to use any asset-related operations and specifically key blob-related
 * operations.
 *
 *  ## Starting a BareMetal operation #
 *
 *  The HSMBareMetal implementation provides a simplified approach to leverage the Hardware Security Module (HSM)
 *  functional capability while also bypassing the complex SW architecture of the HSM and the RTOS while offering a
 *  centralized suit of APIs to conduct all major cryptographic operations.
 *
 *  This implementation delivers multiple features in a switch-like approach. For example, it allows multiple
 *  modes of an Advanced Encryption Standard (AES) operations in one API by simply choosing from an Enum for
 *  all AEAD operations such as (CCM, GCM, CBC, CTR, ECB, CMAC, CBC-MAC), (ENC, DEC).
 *
 *  @anchor ti_sccm_HSMBareMetal_Synopsis
 *  ## Examples
 *  @code
 *
 *  // Import the HSMBareMetal definitions
 *  #include <ti/drivers/cryptoutils/hsm/HSMBareMetal.h>
 *
 *  int_fast16_t status;
 *  HSMBareMetal_AssetOperationStruct assetOperationStruct;
 *  HSMBareMetal_AESOperationStruct AESOperationStruct;
 *  HSMBareMetal_AESOperationMode aesOperationMode = HSMBareMetal_AES_MODE_CCM;
 *  HSMBareMetal_KeyInput keyInput = HSMBareMetal_KEY_INPUT_ASSETSTORE;
 *
 *  uint32_t encKeyAssetId   = 0U;
 *  uint32_t decKeyAssetId   = 0U;
 *  HSMBareMetal_AssetPairStruct assetPair;
 *  assetPair.encGenKeyAssetID = &encKeyAssetId;
 *  assetPair.decVrfyKeyAssetID = &decKeyAssetId;
 *  uint8_t nonce[] = "Thisisanonce";
 *  uint8_t aad[] = "This string will be authenticated but not encrypted.";
 *  uint8_t plaintext[] = "This string will be encrypted and authenticated.";
 *  uint8_t mac[16];
 *  uint8_t ciphertext[sizeof(plaintext)];
 *  uint8_t keyingMaterial[32] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
 *                                0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
 *                                0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
 *                                0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F};
 *
 *  status = HSMBareMetal_init();
 *
 *  if (status != HSMBAREMETAL_STATUS_SUCCESS)
 *  {
 *      // handle error
 *  }
 *
 *  if (keyInput == HSMBareMetal_KEY_INPUT_ASSETSTORE)
 *  {
 *      HSMBareMetal_AssetOperation_init(&assetOperationStruct);
 *
 *      assetOperationStruct.keyAssetIDs = assetPair;
 *      assetOperationStruct.isKeyGenerated = true;
 *      assetOperationStruct.key = &keyingMaterial[0];
 *      assetOperationStruct.keyLength = sizeof(keyingMaterial);
 *      assetOperationStruct.algorithm = HSMBareMetal_OPERATION_ALGO_AES;
 *      assetOperationStruct.aesOperationMode = aesOperationMode;
 *
 *      status = HSMBareMetal_AssetOperation(&assetOperationStruct);
 *
 *      if (status != HSMBAREMETAL_STATUS_SUCCESS)
 *      {
 *          // handle error
 *      }
 *  }
 *
 *  HSMBareMetal_AESOperation_init(&AESOperationStruct);
 *
 *  if (keyInput == HSMBareMetal_KEY_INPUT_ASSETSTORE)
 *  {
 *      AESOperationStruct.keyAssetID = encKeyAssetId;
 *  }
 *  else
 *  {
 *      AESOperationStruct.key = (uint8_t *)keyingMaterial;
 *  }
 *
 *  AESOperationStruct.keyLength = sizeof(keyingMaterial);
 *  AESOperationStruct.isKeyInAssetStore = keyInput;
 *  AESOperationStruct.input = plaintext;
 *  AESOperationStruct.inputLength = sizeof(plaintext);
 *  AESOperationStruct.aad = aad;
 *  AESOperationStruct.aadLength = sizeof(aad);
 *  AESOperationStruct.mac = mac;
 *  AESOperationStruct.macLength = sizeof(mac);
 *  AESOperationStruct.nonce = nonce;
 *  AESOperationStruct.nonceLength = sizeof(nonce);
 *  AESOperationStruct.output = ciphertext;
 *  AESOperationStruct.operationMode = aesOperationMode;
 *  AESOperationStruct.operationDirection = HSMBareMetal_OPERATION_DIR_ENC_GEN;
 *
 *  status = HSMBareMetal_AESOperation(&AESOperationStruct);
 *
 *  if (status != HSMBAREMETAL_STATUS_SUCCESS)
 *  {
 *      // handle error
 *  }
 *
 *  if (keyInput == HSMBareMetal_KEY_INPUT_ASSETSTORE)
 *  {
 *      status = HSMBareMetal_freeAssetPair(assetPair);
 *  }
 *
 *  HSMBareMetal_deInit();
 *
 *  @endcode
 *
 */

#ifndef HSMBAREMETAL_H
#define HSMBAREMETAL_H

#ifdef __cplusplus
extern "C" {
#endif

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

#define HSMBAREMETAL_STATUS_SUCCESS ((int_fast16_t)0)

#define HSMBAREMETAL_STATUS_ERROR ((int_fast16_t)-1)

#define HSMBAREMETAL_STATUS_HSM_NOT_INITIALIZED ((int_fast16_t)-2)

#define HSMBAREMETAL_STATUS_HW_ERROR ((int_fast16_t)-3)

#define HSMBAREMETAL_STATUS_HSM_ALREADY_INITIALIZED ((int_fast16_t)-4)

#define HSMBAREMETAL_STATUS_INVALID_MAC ((int_fast16_t)-5)

#define HSMBAREMETAL_STATUS_INVALID_INPUT_PARAMETERS ((int_fast16_t)-6)

#define HSMBAREMETAL_STATUS_NRBG_ALREADY_IN_MODE ((int_fast16_t)-7)

#define HSMBAREMETAL_STATUS_INVALID_PRIVATE_KEY_SIZE ((int_fast16_t)-8)

#define HSMBAREMETAL_STATUS_INVALID_PUBLIC_KEY_SIZE ((int_fast16_t)-9)

#define HSMBAREMETAL_STATUS_INVALID_PUBLIC_KEY_OCTET_VALUE ((int_fast16_t)-10)

#define HSMBAREMETAL_STATUS_INVALID_SHARED_SECRET_KEY_SIZE ((int_fast16_t)-11)

#define HSMBAREMETAL_STATUS_HUK_ALREADY_PROVISIONED ((int_fast16_t)-12)

#define HSMBAREMETAL_STATUS_FEATURE_NOT_SUPPORTED ((int_fast16_t)-13)

#define HSMBAREMETAL_STATUS_INVALID_INPUT_DATA_LENGTH ((int_fast16_t)-14)

#define HSMBAREMETAL_STATUS_INVALID_MAC_LENGTH ((int_fast16_t)-15)

#define HSMBareMetal_WAIT_FOREVER ~(0)

#define HSMBAREMETAL_HUK_ASSET_NUMBER 0x61

#define HSMBAREMETAL_AES_BLOCK_SIZE 16

#define HSMBAREMETAL_PRIVATE_KEY_VHEADER_SIZE 4

#define HSMBAREMEATL_KEYBLOB_ELEM_SIZE(keyLength) (HSMBAREMETAL_AES_BLOCK_SIZE + keyLength)

#define HSMBAREMETAL_GET_KEYBLOB_BUF_SIZE(keyLength, direction)                                                       \
    ((direction) == HSMBareMetal_OPERATION_DIR_ENC_GEN_AND_DEC_VRFY ? (2 * HSMBAREMEATL_KEYBLOB_ELEM_SIZE(keyLength)) \
                                                                    : HSMBAREMEATL_KEYBLOB_ELEM_SIZE(keyLength))

#define HSMBAREMETAL_GET_PRIVATE_KEY_KEYBLOB_BUF_SIZE(keyLength) \
    HSMBAREMEATL_KEYBLOB_ELEM_SIZE((HSMBAREMETAL_PRIVATE_KEY_VHEADER_SIZE + keyLength))

typedef enum
{
    ENTROPY_TYPE_DRBG = 0x0000,
    ENTROPY_TYPE_CRNG = 0x7264,
    ENTROPY_TYPE_TRNG = 0x5244,
} HSMBareMetal_entropyType;

typedef enum
{
    NRBG_TYPE_CRNG = 1,
    NRBG_TYPE_TRNG = 0,
} HSMBareMetal_NRBGMode;

typedef enum
{
    HSMBareMetal_OPERATION_ALGO_AES  = 1,
    HSMBareMetal_OPERATION_ALGO_MAC  = 2,
    HSMBareMetal_OPERATION_ALGO_HASH = 3,
    HSMBareMetal_OPERATION_ALGO_ECC  = 4,
} HSMBareMetal_operationAlgorithm;

typedef enum
{
    HSMBareMetal_OPERATION_DIR_ENC_GEN_AND_DEC_VRFY = 0, /* Intended for use by asset operations ONLY. */
    HSMBareMetal_OPERATION_DIR_ENC_GEN              = 1,
    HSMBareMetal_OPERATION_DIR_DEC_VRFY             = 2,
} HSMBareMetal_operationDirection;

typedef enum
{
    HSMBareMetal_AES_MODE_ECB = 0,
    HSMBareMetal_AES_MODE_CBC = 1,
    HSMBareMetal_AES_MODE_CTR = 2,
    HSMBareMetal_AES_MODE_CCM = 5,
    HSMBareMetal_AES_MODE_GCM = 7,
} HSMBareMetal_AESOperationMode;

typedef enum
{
    HSMBareMetal_MAC_MODE_HMAC_224 = 2,
    HSMBareMetal_MAC_MODE_HMAC_256 = 3,
    HSMBareMetal_MAC_MODE_HMAC_384 = 4,
    HSMBareMetal_MAC_MODE_HMAC_512 = 5,
    HSMBareMetal_MAC_MODE_CMAC     = 8,
    HSMBareMetal_MAC_MODE_CBC_MAC  = 9,
} HSMBareMetal_MACOperationMode;

typedef enum
{
    HSMBareMetal_HASH_MODE_SHA2_224 = 2,
    HSMBareMetal_HASH_MODE_SHA2_256 = 3,
    HSMBareMetal_HASH_MODE_SHA2_384 = 4,
    HSMBareMetal_HASH_MODE_SHA2_512 = 5,
} HSMBareMetal_HASHOperationMode;

typedef enum
{
    HSMBareMetal_HASH_TYPE_INIT_TO_FINAL = 0,
    HSMBareMetal_HASH_TYPE_CONT_TO_FINAL = 1,
    HSMBareMetal_HASH_TYPE_INIT_TO_CONT  = 2,
    HSMBareMetal_HASH_TYPE_CONT_TO_CONT  = 3,
} HSMBareMetal_HASHOperationType;

typedef enum
{
    HSMBareMetal_PK_CURVE_TYPE_SEC_P_224_R1 = 1,
    HSMBareMetal_PK_CURVE_TYPE_SEC_P_256_R1 = 2,
    HSMBareMetal_PK_CURVE_TYPE_SEC_P_384_R1 = 3,
    HSMBareMetal_PK_CURVE_TYPE_SEC_P_521_R1 = 4,
    HSMBareMetal_PK_CURVE_TYPE_BRP_P_256_R1 = 5,
    HSMBareMetal_PK_CURVE_TYPE_BRP_P_384_R1 = 6,
    HSMBareMetal_PK_CURVE_TYPE_BRP_P_512_R1 = 7,
    HSMBareMetal_PK_CURVE_TYPE_25519 = 8, /* Only applicable for ECDH generate public key and compute shared secret
                                             operations. */
} HSMBareMetal_ECCOperationCurveType;

typedef enum
{
    HSMBareMetal_PK_CURVE_LENGTH_224 = 224,
    HSMBareMetal_PK_CURVE_LENGTH_255 = 255,
    HSMBareMetal_PK_CURVE_LENGTH_256 = 256,
    HSMBareMetal_PK_CURVE_LENGTH_384 = 384,
    HSMBareMetal_PK_CURVE_LENGTH_512 = 512,
    HSMBareMetal_PK_CURVE_LENGTH_521 = 521,
} HSMBareMetal_ECCOperationCurveLength;

typedef enum
{
    HSMBareMetal_PK_DIGEST_LENGTH_224 = 224,
    HSMBareMetal_PK_DIGEST_LENGTH_256 = 256,
    HSMBareMetal_PK_DIGEST_LENGTH_384 = 384,
    HSMBareMetal_PK_DIGEST_LENGTH_512 = 512,
} HSMBareMetal_ECCOperationDigestLength;

typedef enum
{
    HSMBareMetal_PK_MODE_ECDH_GEN_PUB_KEY   = 1,
    HSMBareMetal_PK_MODE_ECDH_GEN_SHRD_SCRT = 2,
    HSMBareMetal_PK_MODE_ECDSA_SIGN         = 3,
    HSMBareMetal_PK_MODE_ECDSA_VERIFY       = 4,
} HSMBareMetal_ECCOperationMode;

typedef enum
{
    HSMBareMetal_ECC_ASSET_TYPE_PRIVATE_KEY = 1,
    HSMBareMetal_ECC_ASSET_TYPE_PUBLIC_KEY  = 2,
} HSMBareMetal_ECCKeyType;

typedef enum
{
    HSMBareMetal_KEY_INPUT_PLAINTEXT  = 0,
    HSMBareMetal_KEY_INPUT_ASSETSTORE = 1,
} HSMBareMetal_KeyInput;

typedef enum
{
    HSMBareMetal_ASSET_OPERATION_TYPE_LOAD_PLAINTEXT       = 0,
    HSMBareMetal_ASSET_OPERATION_TYPE_LOAD_IMPORT_KEY_BLOB = 1,
    HSMBareMetal_ASSET_OPERATION_TYPE_LOAD_EXPORT_KEY_BLOB = 2,
} HSMBareMetal_AssetOperationType;

/* Operation Structures */

typedef struct
{
    uint8_t patch;
    uint8_t minor;
    uint8_t major;
} HSMBareMetal_systemInfoVersionStruct;

typedef struct
{
    uint8_t *key;
    uint8_t keyLength;
    uint8_t *aad;        
    uint8_t *input;      
    uint8_t *output;     
    uint8_t *nonce;      
    uint8_t *iv;         
    uint8_t *mac;        
    size_t aadLength;    
    size_t inputLength;  
    uint8_t nonceLength; 
    uint8_t ivLength;    
    uint8_t macLength;   
    uint32_t keyAssetID; /* Asset ID for a previously-allocated asset. */
    HSMBareMetal_KeyInput isKeyInAssetStore;
    HSMBareMetal_operationDirection operationDirection;
    HSMBareMetal_AESOperationMode operationMode;
} HSMBareMetal_AESOperationStruct;

typedef struct
{
    uint32_t keyAssetID; 
    uint8_t keyLength;
    uint8_t *input;     
    uint8_t *mac;       
    size_t inputLength; 
    size_t macLength;   
    HSMBareMetal_MACOperationMode operationMode;
    HSMBareMetal_operationDirection operationDirection;
} HSMBareMetal_MACOperationStruct;

typedef struct
{
    uint32_t *encGenKeyAssetID;  /* Asset ID for symmetric encryption/ MAC generation */
    uint32_t *decVrfyKeyAssetID; /* Asset ID for symmetric decryption/ MAC Verification */
    uint32_t *privateKeyAssetID; /* Asset ID for asymmetric private key */
    uint32_t *publicKeyAssetID;  /* Asset ID for asymmetric private key */
} HSMBareMetal_AssetPairStruct;

typedef struct
{
    uint8_t *key;        /* Plaintext key buffer. */
    uint8_t *keyblob;    /* Keyblob buffer. */
    uint8_t keyLength;   /* Key length. Must be the plaintext key length such as 128, 192, or 256. */
    bool isKeyGenerated; /* When set, HSMBareMetal will leverage the #HSMBareMetal_RNGOperation to generate a DRBG key
                            internally and return the AssetIDPair only. */
    HSMBareMetal_AssetPairStruct keyAssetIDs; /* In a symmetric operation, for every key there exists two key Asset IDs.
                                                 One for ENC/GEN and the other for DEC/VRFY. */
    HSMBareMetal_operationAlgorithm algorithm;     /* AES or MAC. */
    HSMBareMetal_AssetOperationType operationType; /* Load plaintext, load plaintext and export key blobs, or import key
                                                      blobs. */
    HSMBareMetal_AESOperationMode aesOperationMode;
    HSMBareMetal_MACOperationMode macOperationMode;
    HSMBareMetal_ECCOperationMode eccOperationMode;
    HSMBareMetal_ECCOperationCurveType eccCurveType;
    HSMBareMetal_operationDirection operationDirection;
    HSMBareMetal_ECCKeyType eccKeyType;
} HSMBareMetal_AssetOperationStruct;

typedef struct
{
    uint8_t *input;
    size_t inputLength;
    uint8_t *digest;
    HSMBareMetal_HASHOperationMode operationMode;
    HSMBareMetal_HASHOperationType operationType;
    size_t totalInputLength;
} HSMBareMetal_HASHOperationStruct;

typedef struct
{
    uint8_t *random;
    size_t randomLength;
    HSMBareMetal_entropyType entropyType;
} HSMBareMetal_RNGOperationStruct;

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

typedef struct
{
    uint32_t *assetId;
    uint32_t keyLength;
} HSMBareMetal_CryptoKeyAssetStoreStruct;

typedef struct
{
    HSMBareMetal_KeyInput keyInputType;
    union
    {
        HSMBareMetal_CryptoKeyPlaintextStruct plaintext;
        HSMBareMetal_CryptoKeyAssetStoreStruct assetStore;
    } u;
} HSMBareMetal_CryptoKeyStruct;

typedef struct
{
    HSMBareMetal_CryptoKeyStruct *privateKey;
    HSMBareMetal_CryptoKeyStruct *publicKey;
    HSMBareMetal_CryptoKeyStruct *sharedSecret; /* Only applicable for ECDH generate public key or compute shared secret
                                                   operations */
    uint8_t *hashDigest;                        /* Only applicable for ECDSA sign and verify operations */
    uint8_t *signatureR;                        /* Only applicable for ECDSA sign and verify operations */
    uint8_t *signatureS;                        /* Only applicable for ECDSA sign and verify operations */
    HSMBareMetal_ECCOperationMode operationMode;
    HSMBareMetal_ECCOperationCurveType operationCurveType;
} HSMBareMetal_ECCOperationStruct;

int_fast16_t HSMBareMetal_init(void);

int_fast16_t HSMBareMetal_deInit(void);

int_fast16_t HSMBareMetal_checkHSMStatus(void);

int_fast16_t HSMBareMetal_provisionHUK(void);

int_fast16_t HSMBareMetal_sleep(void);

int_fast16_t HSMBareMetal_wakeup(void);

int_fast16_t HSMBareMetal_searchStaticAsset(uint32_t assetNumber, uint32_t *assetId);

int_fast16_t HSMBareMetal_getHSMFirmwareVersion(HSMBareMetal_systemInfoVersionStruct *firmwareVersionStruct);

void HSMBareMetal_CryptoKeyPlaintext_initKey(HSMBareMetal_CryptoKeyStruct *cryptoKey, uint8_t *key, size_t keyLength);

void HSMBareMetal_CryptoKeyAssetStore_initKey(HSMBareMetal_CryptoKeyStruct *cryptoKey,
                                              uint32_t *assetId,
                                              size_t keyLength);

void HSMBareMetal_RNGOperation_init(HSMBareMetal_RNGOperationStruct *operationStruct);

void HSMBareMetal_AssetOperation_init(HSMBareMetal_AssetOperationStruct *operationStruct);

void HSMBareMetal_HASHOperation_init(HSMBareMetal_HASHOperationStruct *operationStruct);

void HSMBareMetal_AESOperation_init(HSMBareMetal_AESOperationStruct *operationStruct);

void HSMBareMetal_MACOperation_init(HSMBareMetal_MACOperationStruct *operationStruct);

void HSMBareMetal_ECCOperation_init(HSMBareMetal_ECCOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_RNGOperation(HSMBareMetal_RNGOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_RNGSwitchNRBGMode(HSMBareMetal_NRBGMode NRBGMode);

int_fast16_t HSMBareMetal_AssetOperation(HSMBareMetal_AssetOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_freeAssetPair(HSMBareMetal_AssetPairStruct keyAssetPair);

int_fast16_t HSMBareMetal_freeKeyAsset(uint32_t *keyAssetID);

int_fast16_t HSMBareMetal_AESOperation(HSMBareMetal_AESOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_MACOperation(HSMBareMetal_MACOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_HASHOperation(HSMBareMetal_HASHOperationStruct *operationStruct);

int_fast16_t HSMBareMetal_ECCOperation(HSMBareMetal_ECCOperationStruct *operationStruct);

#ifdef __cplusplus
}
#endif

#endif /* HSMBAREMETAL_H */