AESCTRDRBGXX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-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.
 */
/*!****************************************************************************
 *  @file       AESCTRDRBGXX.h
 *
 *  @brief      Generic AESCTRDRBG implementation based on the AESCTR driver
 *
 * This file should only be included in the board file to fill the AESCTR_config
 * struct.
 *
 *  # Use of AESCTR #
 * This implementation uses the AESCTR driver to generate the random bitstream
 * required to mutate the internal AESCTRDRBG state and provide random output
 * bits. The driver will construct a dynamic instance of the AESCTR driver.
 * Mutual exclusion and hardware access are all handled by the AESCTR driver
 * instance.
 *
 *  # Implementation Limitations
 * - Only plaintext CryptoKeys are supported by this implementation.
 *
 *  # Runtime Parameter Validation #
 * The driver implementation does not perform runtime checks for most input
 * parameters. Only values that are likely to have a stochastic element to them
 * are checked (such as whether a driver is already open). Higher input
 * parameter validation coverage is achieved by turning on assertions when
 * compiling the driver.
 */

#ifndef ti_drivers_aesctrdrbg_AESCTRDRBGXX__include
#define ti_drivers_aesctrdrbg_AESCTRDRBGXX__include

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

#include <ti/drivers/AESCTRDRBG.h>
#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/aes.h)

#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0)
    #include <ti/drivers/aesctr/AESCTRLPF3.h>
#else
    #include <ti/drivers/aesctr/AESCTRCC26XX.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

#ifndef AESCTRDRBG_MAX_KEY_LENGTH
    #define AESCTRDRBG_MAX_KEY_LENGTH AESCTRDRBG_AES_KEY_LENGTH_256
#endif

#define AESCTRDRBG_MAX_SEED_LENGTH (AESCTRDRBG_MAX_KEY_LENGTH + AESCTRDRBG_AES_BLOCK_SIZE_BYTES)

#if (ENABLE_KEY_STORAGE == 1) || (TFM_ENABLED == 1)

    #define AESCTRDRBG_MAX_KEYSTORE_KEY_SIZE 64
#endif

typedef struct
{
    /*
     * Priority in HWAttrs will be passed to AESCTR instance upon construct
     */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0)
    AESCTRLPF3_HWAttrs aesctrHWAttrs;
#else
    AESCTRCC26XX_HWAttrs aesctrHWAttrs;
#endif
} AESCTRDRBGXX_HWAttrs;

typedef struct
{
    uint8_t keyingMaterial[AESCTRDRBG_AES_KEY_LENGTH_256];
    uint8_t counter[AESCTRDRBG_AES_BLOCK_SIZE_BYTES];
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0)
    AESCTRLPF3_Object aesctrObject;
#else
    AESCTRCC26XX_Object aesctrObject;
#endif
    AESCTR_Config ctrConfig;
    AESCTR_Handle ctrHandle;
    CryptoKey key;
    size_t seedLength;
    uint32_t reseedCounter;
    uint32_t reseedInterval;
    int_fast16_t returnStatus;
    bool isOpen;
    bool isInstantiated;
} AESCTRDRBGXX_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_aesctrdrbg_AESCTRDRBGXX__include */