tof_security.h

Go to the documentation of this file.

/******************************************************************************

 @file  tof_security.h

 @brief This file contains methods to enable/disable and control TOF
 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2018 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef TOF_SECURITY_H_
#define TOF_SECURITY_H_

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */

#include <ti/drivers/TRNG.h>
#include <ti/drivers/AESECB.h>

#include <stdint.h>

/*********************************************************************
 * MACROS
 */
#define NUM_ELEMENTS(x)                 (sizeof(x)/sizeof(x[0]))

/*********************************************************************
 * CONSTANTS
 */

// CTR-DRBG definitions
#define CTR_DRBG_BLOCKLEN               16                                             
#define CTR_DRBG_SEEDLEN                (CTR_DRBG_BLOCKLEN + CTR_DRBG_BLOCKLEN)        
#define CTR_DRBG_INST_FLAG              0xAA                                           

#define TOF_SEC_FILL_BOTH_BUFFS         0x01                                           
#define TOF_SEC_FILL_1ST_BUFF           0x02                                           
#define TOF_SEC_FILL_2ND_BUFF           0x03                                           

#define TOF_SEC_SYNCWORD_SIZE           8                                              

#define TOF_SEC_DBL_BUFF_SIZE           16                                             

#define ENC_KEY_LEN                     16                                             
#define AES_BLOCK_LEN                   16                                             

/*********************************************************************
 * TYPEDEFS
 */

typedef enum
{
  TOF_MODE_SINGLE_BUF = 0,     
  TOF_MODE_DBL_BUF             
} tofSecMode_e;

typedef enum 
{
  TOF_SEC_SUCCESS_E = 0,       
  TOF_SEC_GEN_FAIL_E,          
  TOF_SEC_AES_FAIL_E,          
  TOF_SEC_ALLOC_FAIL_E,        
  TOF_SEC_INVALID_PRMS_FAIL_E  
} tofSecErrRes_t;

typedef struct 
{
  uint8_t             key[CTR_DRBG_BLOCKLEN];   
  uint8_t             v[CTR_DRBG_BLOCKLEN];     
  uint8_t             instantiatedFlag;         
} ctrDrbgState_t;

typedef struct
{
  uint8_t             bUseDoubleBuffer;           
  uint16_t            syncWordSize;               
  uint16_t            totalNumOfSyncWords;        
} tofSecCfgPrms_t;

typedef struct
{
  // Counting Deterministic Random Bit Generator
  ctrDrbgState_t      ctrDrbgState;                
  
  tofSecCfgPrms_t     tofSecCfgParams;             

  // Sync Words
  uint16_t            numOfSyncWordsPerBuffer;     
  uint8_t             *pSyncWordBuffer1;           
  uint8_t             *pSyncWordBuffer2;           

  //Seed
  uint8_t             seed[CTR_DRBG_SEEDLEN];      

  //TRNG
  TRNG_Handle         trngHandle;                  

  // Crypto
  AESECB_Handle       encHandleECB;                   
  AESECB_Params       encParamsECB;                   
  AESECB_Operation    operationECB;                   
  uint8_t             enckey[ENC_KEY_LEN];            
  CryptoKey           cryptoKey;                      

  
} tofSecHandle_t;

/*********************************************************************
 * PUBLIC FUNCTIONS
 */

int TOFSecurity_open(tofSecHandle_t *tofSecHandle, tofSecCfgPrms_t *tofSecCfgPrms);

int TOFSecurity_close(tofSecHandle_t *tofSecHandle);

int TOFSecurity_genSeed(tofSecHandle_t *tofSecHandle);

int TOFSecurity_genSyncWords(tofSecHandle_t *tofSecHandle, uint8_t bufferToFill);

int TOFSecurity_setSeed(tofSecHandle_t *tofSecHandle, uint8_t *newSeed);

/*********************************************************************
*********************************************************************/

#ifdef __cplusplus
}
#endif

#endif // TOF_SECURITY_H_