SHA2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-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_SHA2__include
#define ti_drivers_SHA2__include

#ifdef __cplusplus
extern "C" {
#endif

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

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

#define SHA2_CMD_RESERVED           (32)

#define SHA2_STATUS_RESERVED        (-32)

#define SHA2_STATUS_SUCCESS         (0)

#define SHA2_STATUS_ERROR           (-1)

#define SHA2_STATUS_UNDEFINEDCMD    (-2)

#define SHA2_STATUS_RESOURCE_UNAVAILABLE (-3)


/* Add SHA2_CMD_<commands> here */

typedef struct SHA2_Config_    *SHA2_Handle;

typedef enum SHA2_ReturnBehavior_ {
    SHA2_RETURN_BEHAVIOR_CALLBACK = 1,      
    SHA2_RETURN_BEHAVIOR_BLOCKING = 2,      
    SHA2_RETURN_BEHAVIOR_POLLING  = 4,      
} SHA2_ReturnBehavior;

typedef enum SHA2_HashSize_ {
    SHA2_HASH_SIZE_224 = 0,
    SHA2_HASH_SIZE_256 = 1,
    SHA2_HASH_SIZE_384 = 2,
    SHA2_HASH_SIZE_512 = 3,
} SHA2_HashSize;

typedef enum SHA2_DigestLengthBytes_ {
    SHA2_DIGEST_LENGTH_BYTES_224 = 28,
    SHA2_DIGEST_LENGTH_BYTES_256 = 32,
    SHA2_DIGEST_LENGTH_BYTES_384 = 48,
    SHA2_DIGEST_LENGTH_BYTES_512 = 64,
} SHA2_DigestLengthBytes;

typedef enum SHA2_BlockSizeBytes_ {
    SHA2_BLOCK_SIZE_BYTES_224 = 64,
    SHA2_BLOCK_SIZE_BYTES_256 = 64,
    SHA2_BLOCK_SIZE_BYTES_384 = 128,
    SHA2_BLOCK_SIZE_BYTES_512 = 128,
} SHA2_BlockSizeBytes;

typedef struct SHA2_OperationOneStep_ {
   SHA2_HashSize        hashSize;       
   size_t               totalLength;    
   const uint8_t        *message;       
   uint8_t              *digest;        
} SHA2_OperationOneStepHash;

typedef struct SHA2_OperationStartHash_ {
   SHA2_HashSize        hashSize;               
   size_t               length;                 
   const uint8_t        *message;               
   uint8_t              *intermediateDigest;    
} SHA2_OperationStartHash;



typedef struct SHA2_OperationProcessHash_ {
   SHA2_HashSize        hashSize;               
   size_t               length;                 
   const uint8_t        *message;               
   uint8_t              *intermediateDigest;    
} SHA2_OperationProcessHash;

typedef struct SHA2_OperationFinishlHash_ {
   SHA2_HashSize        hashSize;               
   size_t               segmentLength;          
   size_t               totalLength;            
   const uint8_t        *message;               
   const uint8_t        *intermediateDigest;    
   uint8_t              *finalDigest;           
} SHA2_OperationFinishHash;

typedef union SHA2_Operation_ {
    SHA2_OperationStartHash         *startHash;     
    SHA2_OperationProcessHash       *processHash;   
    SHA2_OperationFinishHash        *finishHash;    
    SHA2_OperationOneStepHash       *oneStepHash;   
} SHA2_Operation;

typedef enum SHA2_OperationType_ {
    SHA2_OPERATION_TYPE_START_HASH = 1,
    SHA2_OPERATION_TYPE_PROCESS_HASH = 2,
    SHA2_OPERATION_TYPE_FINISH_HASH = 3,
    SHA2_OPERATION_TYPE_ONE_STEP_HASH = 4,
} SHA2_OperationType;

typedef struct SHA2_Config_ {
    void               *object;

    void         const *hwAttrs;
} SHA2_Config;

typedef void (*SHA2_CallbackFxn) (SHA2_Handle handle,
                                  int_fast16_t returnStatus,
                                  SHA2_Operation operation,
                                  SHA2_OperationType operationType);

typedef struct SHA2_Params_ {
    SHA2_ReturnBehavior     returnBehavior;             
    SHA2_CallbackFxn        callbackFxn;                
    uint32_t                timeout;                    
    void                   *custom;                     
} SHA2_Params;

extern const SHA2_Params SHA2_defaultParams;

void SHA2_init(void);

void SHA2_Params_init(SHA2_Params *params);

SHA2_Handle SHA2_open(uint_least8_t index, SHA2_Params *params);

void SHA2_close(SHA2_Handle handle);

int_fast16_t SHA2_control(SHA2_Handle handle, uint32_t cmd, void *args);

void SHA2_OperationStartHash_init(SHA2_OperationStartHash *operation);

void SHA2_OperationProcessHash_init(SHA2_OperationProcessHash *operation);

void SHA2_OperationFinishHash_init(SHA2_OperationFinishHash *operation);

void SHA2_OperationOneStepHash_init(SHA2_OperationOneStepHash *operation);

int_fast16_t SHA2_startHash(SHA2_Handle handle, SHA2_OperationStartHash *operation);

int_fast16_t SHA2_processHash(SHA2_Handle handle, SHA2_OperationProcessHash *operation);

int_fast16_t SHA2_finishHash(SHA2_Handle handle, SHA2_OperationFinishHash *operation);

int_fast16_t SHA2_oneStepHash(SHA2_Handle handle, SHA2_OperationOneStepHash *operation);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_SHA2__include */