AESGCM.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, 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_AESGCM__include
#define ti_drivers_AESGCM__include

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

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

#ifdef __cplusplus
extern "C" {
#endif

#define AESGCM_STATUS_RESERVED        (-32)

#define AESGCM_STATUS_SUCCESS         (0)

#define AESGCM_STATUS_ERROR           (-1)

#define AESGCM_STATUS_RESOURCE_UNAVAILABLE (-2)

#define AESGCM_STATUS_MAC_INVALID (-3)

#define AESGCM_STATUS_CANCELED (-4)

typedef struct AESGCM_Config_    *AESGCM_Handle;

typedef enum AESGCM_ReturnBehavior_ {
    AESGCM_RETURN_BEHAVIOR_CALLBACK = 1,    
    AESGCM_RETURN_BEHAVIOR_BLOCKING = 2,    
    AESGCM_RETURN_BEHAVIOR_POLLING  = 4,    
} AESGCM_ReturnBehavior;

typedef enum AESGCM_Mode_ {
    AESGCM_MODE_ENCRYPT = 1,
    AESGCM_MODE_DECRYPT = 2,
} AESGCM_Mode;

typedef struct AESGCM_Operation_ {
   CryptoKey                *key;                       
   uint8_t                  *aad;                       
   uint8_t                  *input;                     
   uint8_t                  *output;                    
   uint8_t                  *iv;                        
   uint8_t                  *mac;                       
   size_t                   aadLength;                  
   size_t                   inputLength;                
   uint8_t                  ivLength;                   
   uint8_t                  macLength;                  
   bool                     ivInternallyGenerated;      
} AESGCM_Operation;

typedef enum AESGCM_OperationType_ {
    AESGCM_OPERATION_TYPE_ENCRYPT = 1,
    AESGCM_OPERATION_TYPE_DECRYPT = 2,
} AESGCM_OperationType;

typedef struct AESGCM_Config_ {
    void               *object;

    void         const *hwAttrs;
} AESGCM_Config;

typedef void (*AESGCM_CallbackFxn) (AESGCM_Handle handle,
                                    int_fast16_t returnValue,
                                    AESGCM_Operation *operation,
                                    AESGCM_OperationType operationType);

typedef struct AESGCM_Params_ {
    AESGCM_ReturnBehavior   returnBehavior;             
    AESGCM_CallbackFxn      callbackFxn;                
    uint32_t                timeout;                    
    void                   *custom;                     
} AESGCM_Params;

extern const AESGCM_Params AESGCM_defaultParams;

void AESGCM_init(void);

void AESGCM_Params_init(AESGCM_Params *params);

AESGCM_Handle AESGCM_open(uint_least8_t index, AESGCM_Params *params);

void AESGCM_close(AESGCM_Handle handle);

void AESGCM_Operation_init(AESGCM_Operation *operationStruct);

int_fast16_t AESGCM_oneStepEncrypt(AESGCM_Handle handle, AESGCM_Operation *operationStruct);

int_fast16_t AESGCM_oneStepDecrypt(AESGCM_Handle handle, AESGCM_Operation *operationStruct);

int_fast16_t AESGCM_cancelOperation(AESGCM_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_AESGCM__include */