AESCMAC.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.
 */
#ifndef ti_drivers_AESCMAC__include
#define ti_drivers_AESCMAC__include

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

#include <ti/drivers/AESCommon.h>
#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>

#ifdef __cplusplus
extern "C" {
#endif

#define AESCMAC_STATUS_RESERVED AES_STATUS_RESERVED

#define AESCMAC_STATUS_SUCCESS AES_STATUS_SUCCESS

#define AESCMAC_STATUS_ERROR AES_STATUS_ERROR

#define AESCMAC_STATUS_RESOURCE_UNAVAILABLE AES_STATUS_RESOURCE_UNAVAILABLE

#define AESCMAC_STATUS_MAC_INVALID AES_STATUS_MAC_INVALID

#define AESCMAC_STATUS_CANCELED AES_STATUS_CANCELED

#define AESCMAC_STATUS_FEATURE_NOT_SUPPORTED AES_STATUS_FEATURE_NOT_SUPPORTED

#define AESCMAC_STATUS_KEYSTORE_INVALID_ID AES_STATUS_KEYSTORE_INVALID_ID

#define AESCMAC_STATUS_KEYSTORE_GENERIC_ERROR AES_STATUS_KEYSTORE_GENERIC_ERROR

#define AESCMAC_STATUS_UNALIGNED_IO_NOT_SUPPORTED AES_STATUS_UNALIGNED_IO_NOT_SUPPORTED

typedef AESCommon_Config AESCMAC_Config;

typedef AESCMAC_Config *AESCMAC_Handle;

typedef enum
{
    AESCMAC_RETURN_BEHAVIOR_CALLBACK = AES_RETURN_BEHAVIOR_CALLBACK,
    AESCMAC_RETURN_BEHAVIOR_BLOCKING = AES_RETURN_BEHAVIOR_BLOCKING,
    AESCMAC_RETURN_BEHAVIOR_POLLING  = AES_RETURN_BEHAVIOR_POLLING,
} AESCMAC_ReturnBehavior;

typedef enum
{
    AESCMAC_OPMODE_CMAC   = 1, 
    AESCMAC_OPMODE_CBCMAC = 2, 
} AESCMAC_OperationalMode;

typedef struct
{
    uint8_t *input;     
    uint8_t *mac;       
    size_t inputLength; 
    size_t macLength;   
} AESCMAC_Operation;

#define AESCMAC_OP_CODE_MASK 0x0F /* bits 0-3 */

typedef enum
{
    AESCMAC_OP_CODE_ONE_STEP = 0,
    AESCMAC_OP_CODE_SEGMENTED,
    AESCMAC_OP_CODE_FINALIZE
} AESCMAC_OperationCode;

#define AESCMAC_OP_FLAG_SIGN 0x10 /* bit 4 */

#define AESCMAC_OP_FLAGS_MASK (AESCMAC_OP_FLAG_SIGN | AESCMAC_OP_FLAG_VERIFY)

typedef enum
{
    AESCMAC_OP_TYPE_SIGN             = AESCMAC_OP_CODE_ONE_STEP | AESCMAC_OP_FLAG_SIGN,
    AESCMAC_OP_TYPE_VERIFY           = AESCMAC_OP_CODE_ONE_STEP,
    AESCMAC_OP_TYPE_SEGMENTED_SIGN   = AESCMAC_OP_CODE_SEGMENTED | AESCMAC_OP_FLAG_SIGN,
    AESCMAC_OP_TYPE_SEGMENTED_VERIFY = AESCMAC_OP_CODE_SEGMENTED,
    AESCMAC_OP_TYPE_FINALIZE_SIGN    = AESCMAC_OP_CODE_FINALIZE | AESCMAC_OP_FLAG_SIGN,
    AESCMAC_OP_TYPE_FINALIZE_VERIFY  = AESCMAC_OP_CODE_FINALIZE
} AESCMAC_OperationType;

typedef void (*AESCMAC_CallbackFxn)(AESCMAC_Handle handle,
                                    int_fast16_t returnValue,
                                    AESCMAC_Operation *operation,
                                    AESCMAC_OperationType operationType);

typedef struct
{
    AESCMAC_ReturnBehavior returnBehavior;   
    AESCMAC_OperationalMode operationalMode; 
    AESCMAC_CallbackFxn callbackFxn;         
    uint32_t timeout;                        
    void *custom;                            
} AESCMAC_Params;

extern const AESCMAC_Params AESCMAC_defaultParams;

void AESCMAC_init(void);

void AESCMAC_Params_init(AESCMAC_Params *params);

void AESCMAC_Operation_init(AESCMAC_Operation *operation);

AESCMAC_Handle AESCMAC_open(uint_least8_t index, const AESCMAC_Params *params);

void AESCMAC_close(AESCMAC_Handle handle);

int_fast16_t AESCMAC_setupSign(AESCMAC_Handle handle, const CryptoKey *key);

int_fast16_t AESCMAC_setupVerify(AESCMAC_Handle handle, const CryptoKey *key);

int_fast16_t AESCMAC_addData(AESCMAC_Handle handle, AESCMAC_Operation *operation);

int_fast16_t AESCMAC_finalize(AESCMAC_Handle handle, AESCMAC_Operation *operation);

int_fast16_t AESCMAC_oneStepSign(AESCMAC_Handle handle, AESCMAC_Operation *operation, CryptoKey *key);

int_fast16_t AESCMAC_oneStepVerify(AESCMAC_Handle handle, AESCMAC_Operation *operation, CryptoKey *key);

int_fast16_t AESCMAC_cancelOperation(AESCMAC_Handle handle);

AESCMAC_Handle AESCMAC_construct(AESCMAC_Config *config, const AESCMAC_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_AESCMAC__include */