crypto_sha.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 Texas Instruments Incorporated
 *
 *  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 CRYPTO_SHA_H_
#define CRYPTO_SHA_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <security/crypto.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define CRYPTO_SHA_AUTHMODE_NULL            (0U)
 
#define CRYPTO_SHA_AUTHMODE_SHA1            (1U)
 
#define CRYPTO_SHA_AUTHMODE_SHA2_224        (2U)
 
#define CRYPTO_SHA_AUTHMODE_SHA2_256        (3U)
 
#define CRYPTO_SHA_AUTHMODE_SHA2_384        (4U)
 
#define CRYPTO_SHA_AUTHMODE_SHA2_512        (5U)
 
#define CRYPTO_SHA_AUTHMODE_HMAC_SHA1       (6U)
 
#define CRYPTO_SHA_AUTHMODE_HMAC_SHA2_224   (7U)
 
#define CRYPTO_SHA_AUTHMODE_HMAC_SHA2_256   (8U)
 
#define CRYPTO_SHA_AUTHMODE_HMAC_SHA2_384   (9U)
 
#define CRYPTO_SHA_AUTHMODE_HMAC_SHA2_512   (10U)
 
/* Key length for HMAC-SHA Process */
#define CRYPTO_HMAC_SHA_SW_MAX_KEYLEN_BYTES       (128U)
 
typedef void *Crypto_ShaHandle;
 
typedef struct Crypto_ShaContext_s Crypto_ShaContext;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct Crypto_ShaParams_s
{
    uint32_t                authMode;
    uint32_t                type;
    uint8_t                 key[CRYPTO_HMAC_SHA_SW_MAX_KEYLEN_BYTES];
    uint32_t                keySizeInBits;
} Crypto_ShaParams;
 
typedef int32_t (*Crypto_ShaOpenFxn)(Crypto_ShaContext *ctx, const Crypto_ShaParams *params);
typedef int32_t (*Crypto_ShaCloseFxn)(Crypto_ShaContext *ctx);
typedef int32_t (*Crypto_ShaStartFxn)(Crypto_ShaContext *ctx);
typedef int32_t (*Crypto_ShaUpdateFxn)(Crypto_ShaContext *ctx, const uint8_t *input, uint32_t ilen);
typedef int32_t (*Crypto_ShaFinishFxn)(Crypto_ShaContext *ctx, uint8_t *output);
typedef int32_t (*Crypto_ShaSingleShotFxn)(Crypto_ShaContext *ctx, const uint8_t *input, uint32_t ilen, uint8_t *output);
typedef int32_t (*Crypto_hmacShaFxn)(Crypto_ShaContext *ctx, const uint8_t *input, uint32_t ilen, uint8_t *output);
 
typedef struct Crypto_ShaFxns_s
{
    Crypto_ShaOpenFxn       openFxn;
    Crypto_ShaCloseFxn      closeFxn;
    Crypto_ShaStartFxn      startFxn;
    Crypto_ShaUpdateFxn     updateFxn;
    Crypto_ShaFinishFxn     finishFxn;
    Crypto_ShaSingleShotFxn singleShotFxn;
    Crypto_hmacShaFxn       hmacShaFxn;
} Crypto_ShaFxns;
 
struct Crypto_ShaContext_s
{
    Crypto_ShaParams    params;
    Crypto_ShaFxns     *fxns;
    void               *drvHandle;
    uintptr_t          rsv[60U];
};
 
typedef struct
{
    Crypto_ShaFxns     *fxns;
} Crypto_ShaConfig;
 
extern Crypto_ShaConfig gCryptoShaConfig[CRYPTO_NUM_TYPE];
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Crypto_ShaParams_init(Crypto_ShaParams *params);
 
Crypto_ShaHandle Crypto_shaOpen(Crypto_ShaContext *ctx, const Crypto_ShaParams *params);
 
int32_t Crypto_shaClose(Crypto_ShaHandle handle);
 
int32_t Crypto_shaStarts(Crypto_ShaHandle handle);
 
int32_t Crypto_shaUpdate(Crypto_ShaHandle handle, const uint8_t *input, uint32_t ilen);
 
int32_t Crypto_shaFinish(Crypto_ShaHandle handle, uint8_t *output);
 
int32_t Crypto_shaSingleShot(Crypto_ShaHandle handle, const uint8_t *input, uint32_t ilen, uint8_t *output);
 
int32_t Crypto_hmacSha(Crypto_ShaHandle handle, const uint8_t *input, uint32_t ilen, uint8_t *output);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* CRYPTO_SHA_H_ */