AESCCM.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 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_AESCCM__include
#define ti_drivers_AESCCM__include

#ifdef __cplusplus
extern "C" {
#endif

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

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

#define AESCCM_CMD_RESERVED           (32)

#define AESCCM_STATUS_RESERVED        (-32)

#define AESCCM_STATUS_SUCCESS         (0)

#define AESCCM_STATUS_ERROR           (-1)

#define AESCCM_STATUS_UNDEFINEDCMD    (-2)

#define AESCCM_STATUS_RESOURCE_UNAVAILABLE (-3)

#define AESCCM_STATUS_MAC_INVALID (-4)


/* Add AESCCM_CMD_<commands> here */

typedef struct AESCCM_Config_    *AESCCM_Handle;

typedef void (*AESCCM_CallbackFxn) (AESCCM_Handle handle, CryptoKey *processedKey);

typedef enum AESCCM_ReturnBehavior_ {
    AESCCM_RETURN_BEHAVIOR_CALLBACK = 1,    
    AESCCM_RETURN_BEHAVIOR_BLOCKING = 2,    
    AESCCM_RETURN_BEHAVIOR_POLLING  = 4,    
} AESCCM_ReturnBehavior;

typedef enum AESCCM_Mode_ {
    AESCCM_MODE_ENCRYPT = 1,
    AESCCM_MODE_DECRYPT = 2,
} AESCCM_Mode;

typedef struct AESCCM_Params_ {
    AESCCM_ReturnBehavior   returnBehavior;             
    AESCCM_CallbackFxn      callbackFxn;                
    bool                    nonceInternallyGenerated;   
    uint32_t                timeout;
    void                   *custom;                     
} AESCCM_Params;



typedef struct AESCCM_Config_ {
    void               *object;

    void         const *hwAttrs;
} AESCCM_Config;

extern const AESCCM_Params AESCCM_defaultParams;

void AESCCM_init(void);

void AESCCM_Params_init(AESCCM_Params *params);

AESCCM_Handle AESCCM_open(uint_least8_t index, AESCCM_Params *params);

void AESCCM_close(AESCCM_Handle handle);

int_fast16_t AESCCM_control(AESCCM_Handle handle, uint32_t cmd, void *args);



int_fast16_t AESCCM_setupEncrypt(AESCCM_Handle handle,
                                 CryptoKey *key,
                                 uint8_t *nonce, uint8_t nonceLength,
                                 size_t aadTotalLength,
                                 size_t plaintextTotalLength,
                                 uint8_t macLength);

int_fast16_t AESCCM_setupDecrypt(AESCCM_Handle handle,
                                 CryptoKey *key,
                                 uint8_t *nonce, uint8_t nonceLength,
                                 size_t aadTotalLength,
                                 size_t ciphertextTotalLength,
                                 uint8_t macLength);

int_fast16_t AESCCM_processAAD(AESCCM_Handle handle, uint8_t *aad, size_t length);

int_fast16_t AESCCM_processPayload(AESCCM_Handle handle, uint8_t *input, size_t length, uint8_t *output);

int_fast16_t AESCCM_computeMAC(AESCCM_Handle handle, uint8_t *mac);

int_fast16_t AESCCM_verifyMAC(AESCCM_Handle handle, uint8_t *mac);

int_fast16_t AESCCM_oneStepEncrypt(AESCCM_Handle handle,
                                   CryptoKey *key,
                                   uint8_t *aad, size_t aadLength,
                                   uint8_t *plaintext, size_t plaintextLength,
                                   uint8_t *nonce, uint8_t nonceLength,
                                   uint8_t *mac, uint8_t macLength,
                                   uint8_t *ciphertext);

int_fast16_t AESCCM_oneStepDecrypt(AESCCM_Handle handle,
                                   CryptoKey *key,
                                   uint8_t *aad, size_t aadLength,
                                   uint8_t *ciphertext, size_t ciphertextLength,
                                   uint8_t *nonce, uint8_t nonceLength,
                                   uint8_t *mac, uint8_t macLength,
                                   uint8_t *plaintext);

int_fast16_t AESCCM_getMode(AESCCM_Handle handle, AESCCM_Mode *mode);

int_fast16_t AESCCM_getCryptoKey(AESCCM_Handle handle, CryptoKey **key);

int_fast16_t AESCCM_getNonce(AESCCM_Handle handle, uint8_t **nonce, uint8_t *nonceLength);

int_fast16_t AESCCM_getAAD(AESCCM_Handle handle, uint8_t **aad, size_t *aadLength);

int_fast16_t AESCCM_getInput(AESCCM_Handle handle, uint8_t **input, size_t *inputLength, size_t *totalInputLength);

int_fast16_t AESCCM_getOutput(AESCCM_Handle handle, uint8_t **output, size_t *outputLength, size_t *totalOutputLength);

int_fast16_t AESCCM_getMAC(AESCCM_Handle handle, uint8_t *mac, uint8_t *macLength);

int_fast16_t AESCCM_setMACReturnPointer(AESCCM_Handle handle, uint8_t *mac);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_AESCCM__include */