luna - wolfssl/wolfcrypt/src/sha.c

   1/* sha.c
   2 *
   3 * Copyright (C) 2006-2026 wolfSSL Inc.
   4 *
   5 * This file is part of wolfSSL.
   6 *
   7 * wolfSSL is free software; you can redistribute it and/or modify
   8 * it under the terms of the GNU General Public License as published by
   9 * the Free Software Foundation; either version 3 of the License, or
  10 * (at your option) any later version.
  11 *
  12 * wolfSSL is distributed in the hope that it will be useful,
  13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 * GNU General Public License for more details.
  16 *
  17 * You should have received a copy of the GNU General Public License
  18 * along with this program; if not, write to the Free Software
  19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
  20 */
  21
  22/*
  23 * SHA-1 Build Options:
  24 *
  25 * Core:
  26 * NO_SHA:                   Disable SHA-1 support entirely        default: off
  27 * USE_SLOW_SHA:             Disable SHA-1 loop unrolling          default: off
  28 * WC_HASH_DATA_ALIGNMENT:   Required data alignment for hashing   default: off
  29 *
  30 * Hardware Acceleration (SHA-1-specific):
  31 * WC_ASYNC_ENABLE_SHA:      Enable async SHA-1 operations         default: off
  32 * WOLFSSL_PIC32MZ_HASH:     PIC32MZ hardware SHA                  default: off
  33 * WOLFSSL_PSA_NO_HASH:      Disable PSA hash                      default: off
  34 * WOLFSSL_TI_HASH:          TI hardware hash                      default: off
  35 * WOLFSSL_RENESAS_RX64_HASH: Renesas RX64 hardware hash           default: off
  36 * FREESCALE_LTC_SHA:        Freescale LTC SHA acceleration        default: off
  37 * FREESCALE_MMCAU_SHA:      Freescale MMCAU SHA acceleration      default: off
  38 * STM32_HASH:               STM32 hardware hash                   default: off
  39 * PSOC6_HASH_SHA1:          PSoC6 hardware SHA-1                  default: off
  40 */
  41
  42#include <wolfssl/wolfcrypt/libwolfssl_sources.h>
  43
  44#ifdef DEBUG_WOLFSSL_VERBOSE
  45    #if defined(WOLFSSL_ESPIDF)
  46        #include <esp_log.h>
  47    #endif
  48#endif
  49
  50#if !defined(NO_SHA)
  51
  52#if FIPS_VERSION3_GE(2,0,0)
  53    /* set NO_WRAPPERS before headers, use direct internal f()s not wrappers */
  54    #define FIPS_NO_WRAPPERS
  55
  56    #ifdef USE_WINDOWS_API
  57        #pragma code_seg(".fipsA$k")
  58        #pragma const_seg(".fipsB$k")
  59    #endif
  60#endif
  61
  62#include <wolfssl/wolfcrypt/sha.h>
  63#include <wolfssl/wolfcrypt/hash.h>
  64
  65#ifdef WOLF_CRYPTO_CB
  66    #include <wolfssl/wolfcrypt/cryptocb.h>
  67#endif
  68
  69#ifdef WOLFSSL_IMXRT1170_CAAM
  70#include <wolfssl/wolfcrypt/port/caam/wolfcaam_fsl_nxp.h>
  71#endif
  72
  73#if defined(WOLFSSL_PSOC6_CRYPTO)
  74    #include <wolfssl/wolfcrypt/port/cypress/psoc6_crypto.h>
  75#endif
  76
  77/* Assume no hash HW available until supporting HW found. */
  78#undef WOLFSSL_USE_ESP32_CRYPT_HASH_HW
  79
  80#if defined(WOLFSSL_ESP32_CRYPT) && \
  81    !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
  82    /* define a single keyword for simplicity & readability
  83     *
  84     * by default the HW acceleration is on for ESP32-WROOM32
  85     * but individual components can be turned off.
  86     */
  87    #define WOLFSSL_USE_ESP32_CRYPT_HASH_HW
  88    #include "wolfssl/wolfcrypt/port/Espressif/esp32-crypt.h"
  89
  90    /* Although we have hardware acceleration,
  91    ** we may need to fall back to software */
  92    #define USE_SHA_SOFTWARE_IMPL
  93
  94#elif defined(WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW)
  95    /* The ESP32C3 is different; HW crypto here. Not yet implemented.
  96    ** We'll be using software for RISC-V at this time */
  97#else
  98    #undef WOLFSSL_USE_ESP32_CRYPT_HASH_HW
  99#endif
 100
 101#undef WOLFSSL_USE_ESP32_CRYPT_HASH_HW
 102#if defined(WOLFSSL_ESP32_CRYPT) && \
 103    !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 104    /* define a single keyword for simplicity & readability
 105     *
 106     * by default the HW acceleration is on for ESP32-WROOM32
 107     * but individual components can be turned off.
 108     */
 109    #define WOLFSSL_USE_ESP32_CRYPT_HASH_HW
 110    #include "wolfssl/wolfcrypt/port/Espressif/esp32-crypt.h"
 111
 112    /* Although we have hardware acceleration,
 113    ** we may need to fall back to software */
 114    #define USE_SHA_SOFTWARE_IMPL
 115    static const char* TAG = "wc_sha";
 116#elif defined(WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW)
 117    /* The ESP32C3 is different; HW crypto here. Not yet implemented.
 118    ** We'll be using software for RISC-V at this time */
 119    static const char* TAG = "wc_sha-c3";
 120#else
 121    #undef WOLFSSL_USE_ESP32_CRYPT_HASH_HW
 122#endif
 123
 124#if defined(WOLFSSL_TI_HASH)
 125    /* #include <wolfcrypt/src/port/ti/ti-hash.c> included by wc_port.c */
 126
 127#else
 128
 129#ifdef NO_INLINE
 130    #include <wolfssl/wolfcrypt/misc.h>
 131#else
 132    #define WOLFSSL_MISC_INCLUDED
 133    #include <wolfcrypt/src/misc.c>
 134#endif
 135
 136#if FIPS_VERSION3_GE(6,0,0)
 137    const unsigned int wolfCrypt_FIPS_sha_ro_sanity[2] =
 138                                                     { 0x1a2b3c4d, 0x00000013 };
 139    int wolfCrypt_FIPS_SHA_sanity(void)
 140    {
 141        return 0;
 142    }
 143#endif
 144
 145/* Hardware Acceleration */
 146#if defined(WOLFSSL_PIC32MZ_HASH)
 147    #include <wolfssl/wolfcrypt/port/pic32/pic32mz-crypt.h>
 148
 149#elif defined(STM32_HASH)
 150
 151    /* Supports CubeMX HAL or Standard Peripheral Library */
 152    int wc_InitSha_ex(wc_Sha* sha, void* heap, int devId)
 153    {
 154        if (sha == NULL) {
 155            return BAD_FUNC_ARG;
 156        }
 157
 158        (void)devId;
 159        (void)heap;
 160
 161        wc_Stm32_Hash_Init(&sha->stmCtx);
 162
 163        return 0;
 164    }
 165
 166    int wc_ShaUpdate(wc_Sha* sha, const byte* data, word32 len)
 167    {
 168        int ret;
 169
 170        if (sha == NULL || (data == NULL && len > 0)) {
 171            return BAD_FUNC_ARG;
 172        }
 173
 174        ret = wolfSSL_CryptHwMutexLock();
 175        if (ret == 0) {
 176            ret = wc_Stm32_Hash_Update(&sha->stmCtx, HASH_AlgoSelection_SHA1,
 177                data, len, WC_SHA_BLOCK_SIZE);
 178            wolfSSL_CryptHwMutexUnLock();
 179        }
 180        return ret;
 181    }
 182
 183    int wc_ShaFinal(wc_Sha* sha, byte* hash)
 184    {
 185        int ret;
 186
 187        if (sha == NULL || hash == NULL) {
 188            return BAD_FUNC_ARG;
 189        }
 190
 191        ret = wolfSSL_CryptHwMutexLock();
 192        if (ret == 0) {
 193            ret = wc_Stm32_Hash_Final(&sha->stmCtx, HASH_AlgoSelection_SHA1,
 194                hash, WC_SHA_DIGEST_SIZE);
 195            wolfSSL_CryptHwMutexUnLock();
 196        }
 197
 198        (void)wc_InitSha(sha);  /* reset state */
 199
 200        return ret;
 201    }
 202
 203
 204#elif defined(FREESCALE_LTC_SHA)
 205
 206    #include "fsl_ltc.h"
 207    int wc_InitSha_ex(wc_Sha* sha, void* heap, int devId)
 208    {
 209        if (sha == NULL) {
 210            return BAD_FUNC_ARG;
 211        }
 212
 213        (void)devId;
 214        (void)heap;
 215
 216        LTC_HASH_Init(LTC_BASE, &sha->ctx, kLTC_Sha1, NULL, 0);
 217        return 0;
 218    }
 219
 220    int wc_ShaUpdate(wc_Sha* sha, const byte* data, word32 len)
 221    {
 222        LTC_HASH_Update(&sha->ctx, data, len);
 223        return 0;
 224    }
 225
 226    int wc_ShaFinal(wc_Sha* sha, byte* hash)
 227    {
 228        word32 hashlen = WC_SHA_DIGEST_SIZE;
 229        LTC_HASH_Finish(&sha->ctx, hash, &hashlen);
 230        return wc_InitSha(sha);  /* reset state */
 231    }
 232
 233
 234#elif defined(FREESCALE_MMCAU_SHA)
 235
 236    #ifdef FREESCALE_MMCAU_CLASSIC_SHA
 237        #include "cau_api.h"
 238    #else
 239        #include "fsl_mmcau.h"
 240    #endif
 241
 242    #define USE_SHA_SOFTWARE_IMPL /* Only for API's, actual transform is here */
 243
 244    #define XTRANSFORM(S,B)       Transform((S),(B))
 245    #define XTRANSFORM_LEN(S,B,L) Transform_Len((S),(B),(L))
 246
 247    #ifndef WC_HASH_DATA_ALIGNMENT
 248        /* these hardware API's require 4 byte (word32) alignment */
 249        #define WC_HASH_DATA_ALIGNMENT 4
 250    #endif
 251
 252    static int InitSha(wc_Sha* sha)
 253    {
 254        int ret = 0;
 255        ret = wolfSSL_CryptHwMutexLock();
 256        if (ret != 0) {
 257            return ret;
 258        }
 259    #ifdef FREESCALE_MMCAU_CLASSIC_SHA
 260        cau_sha1_initialize_output(sha->digest);
 261    #else
 262        MMCAU_SHA1_InitializeOutput((word32*)sha->digest);
 263    #endif
 264        wolfSSL_CryptHwMutexUnLock();
 265
 266        sha->buffLen = 0;
 267        sha->loLen   = 0;
 268        sha->hiLen   = 0;
 269
 270        return ret;
 271    }
 272
 273    static int Transform(wc_Sha* sha, const byte* data)
 274    {
 275        int ret = wolfSSL_CryptHwMutexLock();
 276        if (ret == 0) {
 277    #ifdef FREESCALE_MMCAU_CLASSIC_SHA
 278            cau_sha1_hash_n((byte*)data, 1, sha->digest);
 279    #else
 280            MMCAU_SHA1_HashN((byte*)data, 1, (word32*)sha->digest);
 281    #endif
 282            wolfSSL_CryptHwMutexUnLock();
 283        }
 284        return ret;
 285    }
 286
 287    static int Transform_Len(wc_Sha* sha, const byte* data, word32 len)
 288    {
 289        int ret = wolfSSL_CryptHwMutexLock();
 290        if (ret == 0) {
 291        #if defined(WC_HASH_DATA_ALIGNMENT) && WC_HASH_DATA_ALIGNMENT > 0
 292            if ((wc_ptr_t)data % WC_HASH_DATA_ALIGNMENT) {
 293                /* data pointer is NOT aligned,
 294                 * so copy and perform one block at a time */
 295                byte* local = (byte*)sha->buffer;
 296                while (len >= WC_SHA_BLOCK_SIZE) {
 297                    XMEMCPY(local, data, WC_SHA_BLOCK_SIZE);
 298                #ifdef FREESCALE_MMCAU_CLASSIC_SHA
 299                    cau_sha1_hash_n(local, 1, sha->digest);
 300                #else
 301                    MMCAU_SHA1_HashN(local, 1, sha->digest);
 302                #endif
 303                    data += WC_SHA_BLOCK_SIZE;
 304                    len  -= WC_SHA_BLOCK_SIZE;
 305                }
 306            }
 307            else
 308        #endif
 309            {
 310    #ifdef FREESCALE_MMCAU_CLASSIC_SHA
 311            cau_sha1_hash_n((byte*)data, len/WC_SHA_BLOCK_SIZE, sha->digest);
 312    #else
 313            MMCAU_SHA1_HashN((byte*)data, len/WC_SHA_BLOCK_SIZE,
 314                (word32*)sha->digest);
 315    #endif
 316            }
 317            wolfSSL_CryptHwMutexUnLock();
 318        }
 319        return ret;
 320    }
 321
 322#elif defined(WOLFSSL_IMX6_CAAM) && !defined(NO_IMX6_CAAM_HASH) && \
 323    !defined(WOLFSSL_QNX_CAAM)
 324    /* wolfcrypt/src/port/caam/caam_sha.c */
 325
 326#elif defined(MAX3266X_SHA)
 327    /* Already brought in by sha.h */
 328    /* #include <wolfssl/wolfcrypt/port/maxim/max3266x.h> */
 329
 330#elif defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW) || \
 331      defined(WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW)
 332
 333    /* This function initializes SHA.
 334    ** This is automatically called by wc_ShaHash */
 335    static int InitSha(wc_Sha* sha)
 336    {
 337        int ret = 0;
 338
 339        sha->digest[0] = 0x67452301L;
 340        sha->digest[1] = 0xEFCDAB89L;
 341        sha->digest[2] = 0x98BADCFEL;
 342        sha->digest[3] = 0x10325476L;
 343        sha->digest[4] = 0xC3D2E1F0L;
 344
 345        sha->buffLen = 0;
 346        sha->loLen   = 0;
 347        sha->hiLen   = 0;
 348
 349        /* HW needs to be carefully initialized, taking into account soft copy.
 350        ** If already in use; copy may revert to SW as needed. */
 351        ret = esp_sha_init(&(sha->ctx), WC_HASH_TYPE_SHA);
 352
 353        return ret;
 354    }
 355
 356#elif (defined(WOLFSSL_RENESAS_TSIP_TLS) || \
 357    defined(WOLFSSL_RENESAS_TSIP_CRYPTONLY)) && \
 358    !defined(NO_WOLFSSL_RENESAS_TSIP_CRYPT_HASH)
 359
 360    /* implemented in wolfcrypt/src/port/Renesas/renesas_tsip_sha.c */
 361
 362#elif defined(WOLFSSL_RENESAS_RSIP) && \
 363     !defined(NO_WOLFSSL_RENESAS_FSPSM_HASH)
 364
 365    /* implemented in wolfcrypt/src/port/Renesas/renesas_fspsm_sha.c */
 366
 367#elif defined(WOLFSSL_IMXRT_DCP)
 368    #include <wolfssl/wolfcrypt/port/nxp/dcp_port.h>
 369    /* implemented in wolfcrypt/src/port/nxp/dcp_port.c */
 370
 371#elif defined(WOLFSSL_NXP_HASHCRYPT_SHA)
 372    /* implemented in wolfcrypt/src/port/nxp/hashcrypt_port.c */
 373
 374#elif defined(WOLFSSL_SILABS_SE_ACCEL)
 375
 376    /* implemented in wolfcrypt/src/port/silabs/silabs_hash.c */
 377
 378#elif defined(WOLFSSL_RENESAS_RX64_HASH)
 379
 380/* implemented in wolfcrypt/src/port/Renesas/renesas_rx64_hw_sha.c */
 381
 382#elif defined(WOLFSSL_SE050) && defined(WOLFSSL_SE050_HASH)
 383
 384    #include <wolfssl/wolfcrypt/port/nxp/se050_port.h>
 385    int wc_InitSha_ex(wc_Sha* sha, void* heap, int devId)
 386    {
 387        if (sha == NULL) {
 388            return BAD_FUNC_ARG;
 389        }
 390        (void)devId;
 391
 392        return se050_hash_init(&sha->se050Ctx, heap);
 393    }
 394
 395    int wc_ShaUpdate(wc_Sha* sha, const byte* data, word32 len)
 396    {
 397        return se050_hash_update(&sha->se050Ctx, data, len);
 398
 399    }
 400
 401    int wc_ShaFinal(wc_Sha* sha, byte* hash)
 402    {
 403        int ret = 0;
 404        ret = se050_hash_final(&sha->se050Ctx, hash, WC_SHA_DIGEST_SIZE,
 405                               kAlgorithm_SSS_SHA1);
 406        return ret;
 407    }
 408    int wc_ShaFinalRaw(wc_Sha* sha, byte* hash)
 409    {
 410        int ret = 0;
 411        ret = se050_hash_final(&sha->se050Ctx, hash, WC_SHA_DIGEST_SIZE,
 412                               kAlgorithm_SSS_SHA1);
 413        return ret;
 414    }
 415
 416#elif defined(WOLFSSL_HAVE_PSA) && !defined(WOLFSSL_PSA_NO_HASH)
 417/* implemented in wolfcrypt/src/port/psa/psa_hash.c */
 418#elif defined(PSOC6_HASH_SHA1)
 419    /* Implemented in wolfcrypt/src/port/cypress/psoc6_crypto.c */
 420#else
 421    /* Software implementation */
 422    #define USE_SHA_SOFTWARE_IMPL
 423
 424    static int InitSha(wc_Sha* sha)
 425    {
 426        int ret = 0;
 427
 428        sha->digest[0] = 0x67452301L;
 429        sha->digest[1] = 0xEFCDAB89L;
 430        sha->digest[2] = 0x98BADCFEL;
 431        sha->digest[3] = 0x10325476L;
 432        sha->digest[4] = 0xC3D2E1F0L;
 433
 434        sha->buffLen = 0;
 435        XMEMSET(sha->buffer, 0, sizeof(sha->buffer));
 436        sha->loLen   = 0;
 437        sha->hiLen   = 0;
 438    #ifdef WOLFSSL_HASH_FLAGS
 439        sha->flags = 0;
 440    #endif
 441
 442        return ret;
 443    }
 444#endif /* End Hardware Acceleration */
 445
 446/* Software implementation */
 447#ifdef USE_SHA_SOFTWARE_IMPL
 448
 449static WC_INLINE void AddLength(wc_Sha* sha, word32 len)
 450{
 451    word32 tmp = sha->loLen;
 452    if ((sha->loLen += len) < tmp)
 453        sha->hiLen++;                       /* carry low to high */
 454}
 455
 456/* Check if custom wc_Sha transform is used */
 457#ifndef XTRANSFORM
 458    #define XTRANSFORM(S,B)   Transform((S),(B))
 459
 460    #define blk0(i) (W[i] = *((const word32*)&data[(i)*sizeof(word32)]))
 461    #define blk1(i) (W[(i)&15] = \
 462        rotlFixed(W[((i)+13)&15]^W[((i)+8)&15]^W[((i)+2)&15]^W[(i)&15],1))
 463
 464    #define f1(x,y,z) ((z)^((x) &((y)^(z))))
 465    #define f2(x,y,z) ((x)^(y)^(z))
 466    #define f3(x,y,z) (((x)&(y))|((z)&((x)|(y))))
 467    #define f4(x,y,z) ((x)^(y)^(z))
 468
 469    #if defined(WOLFSSL_NUCLEUS_1_2) || defined(NUCLEUS_PLUS_2_3)
 470        /* nucleus.h also defines R1-R4 */
 471        #undef R1
 472        #undef R2
 473        #undef R3
 474        #undef R4
 475    #endif
 476
 477    /* (R0+R1), R2, R3, R4 are the different operations used in SHA1 */
 478    #define R0(v,w,x,y,z,i) (z)+= f1((w),(x),(y)) + blk0((i)) + 0x5A827999+ \
 479        rotlFixed((v),5); (w) = rotlFixed((w),30);
 480    #define R1(v,w,x,y,z,i) (z)+= f1((w),(x),(y)) + blk1((i)) + 0x5A827999+ \
 481        rotlFixed((v),5); (w) = rotlFixed((w),30);
 482    #define R2(v,w,x,y,z,i) (z)+= f2((w),(x),(y)) + blk1((i)) + 0x6ED9EBA1+ \
 483        rotlFixed((v),5); (w) = rotlFixed((w),30);
 484    #define R3(v,w,x,y,z,i) (z)+= f3((w),(x),(y)) + blk1((i)) + 0x8F1BBCDC+ \
 485        rotlFixed((v),5); (w) = rotlFixed((w),30);
 486    #define R4(v,w,x,y,z,i) (z)+= f4((w),(x),(y)) + blk1((i)) + 0xCA62C1D6+ \
 487        rotlFixed((v),5); (w) = rotlFixed((w),30);
 488
 489    static int Transform(wc_Sha* sha, const byte* data)
 490    {
 491        word32 W[WC_SHA_BLOCK_SIZE / sizeof(word32)];
 492
 493        /* Copy context->state[] to working vars */
 494        word32 a = sha->digest[0];
 495        word32 b = sha->digest[1];
 496        word32 c = sha->digest[2];
 497        word32 d = sha->digest[3];
 498        word32 e = sha->digest[4];
 499
 500    #ifdef USE_SLOW_SHA
 501        word32 t, i;
 502
 503        for (i = 0; i < 16; i++) {
 504            R0(a, b, c, d, e, i);
 505            t = e; e = d; d = c; c = b; b = a; a = t;
 506        }
 507
 508        for (; i < 20; i++) {
 509            R1(a, b, c, d, e, i);
 510            t = e; e = d; d = c; c = b; b = a; a = t;
 511        }
 512
 513        for (; i < 40; i++) {
 514            R2(a, b, c, d, e, i);
 515            t = e; e = d; d = c; c = b; b = a; a = t;
 516        }
 517
 518        for (; i < 60; i++) {
 519            R3(a, b, c, d, e, i);
 520            t = e; e = d; d = c; c = b; b = a; a = t;
 521        }
 522
 523        for (; i < 80; i++) {
 524            R4(a, b, c, d, e, i);
 525            t = e; e = d; d = c; c = b; b = a; a = t;
 526        }
 527    #else
 528        /* nearly 1 K bigger in code size but 25% faster */
 529        /* 4 rounds of 20 operations each. Loop unrolled. */
 530        R0(a,b,c,d,e, 0); R0(e,a,b,c,d, 1); R0(d,e,a,b,c, 2); R0(c,d,e,a,b, 3);
 531        R0(b,c,d,e,a, 4); R0(a,b,c,d,e, 5); R0(e,a,b,c,d, 6); R0(d,e,a,b,c, 7);
 532        R0(c,d,e,a,b, 8); R0(b,c,d,e,a, 9); R0(a,b,c,d,e,10); R0(e,a,b,c,d,11);
 533        R0(d,e,a,b,c,12); R0(c,d,e,a,b,13); R0(b,c,d,e,a,14); R0(a,b,c,d,e,15);
 534
 535        R1(e,a,b,c,d,16); R1(d,e,a,b,c,17); R1(c,d,e,a,b,18); R1(b,c,d,e,a,19);
 536
 537        R2(a,b,c,d,e,20); R2(e,a,b,c,d,21); R2(d,e,a,b,c,22); R2(c,d,e,a,b,23);
 538        R2(b,c,d,e,a,24); R2(a,b,c,d,e,25); R2(e,a,b,c,d,26); R2(d,e,a,b,c,27);
 539        R2(c,d,e,a,b,28); R2(b,c,d,e,a,29); R2(a,b,c,d,e,30); R2(e,a,b,c,d,31);
 540        R2(d,e,a,b,c,32); R2(c,d,e,a,b,33); R2(b,c,d,e,a,34); R2(a,b,c,d,e,35);
 541        R2(e,a,b,c,d,36); R2(d,e,a,b,c,37); R2(c,d,e,a,b,38); R2(b,c,d,e,a,39);
 542
 543        R3(a,b,c,d,e,40); R3(e,a,b,c,d,41); R3(d,e,a,b,c,42); R3(c,d,e,a,b,43);
 544        R3(b,c,d,e,a,44); R3(a,b,c,d,e,45); R3(e,a,b,c,d,46); R3(d,e,a,b,c,47);
 545        R3(c,d,e,a,b,48); R3(b,c,d,e,a,49); R3(a,b,c,d,e,50); R3(e,a,b,c,d,51);
 546        R3(d,e,a,b,c,52); R3(c,d,e,a,b,53); R3(b,c,d,e,a,54); R3(a,b,c,d,e,55);
 547        R3(e,a,b,c,d,56); R3(d,e,a,b,c,57); R3(c,d,e,a,b,58); R3(b,c,d,e,a,59);
 548
 549        R4(a,b,c,d,e,60); R4(e,a,b,c,d,61); R4(d,e,a,b,c,62); R4(c,d,e,a,b,63);
 550        R4(b,c,d,e,a,64); R4(a,b,c,d,e,65); R4(e,a,b,c,d,66); R4(d,e,a,b,c,67);
 551        R4(c,d,e,a,b,68); R4(b,c,d,e,a,69); R4(a,b,c,d,e,70); R4(e,a,b,c,d,71);
 552        R4(d,e,a,b,c,72); R4(c,d,e,a,b,73); R4(b,c,d,e,a,74); R4(a,b,c,d,e,75);
 553        R4(e,a,b,c,d,76); R4(d,e,a,b,c,77); R4(c,d,e,a,b,78); R4(b,c,d,e,a,79);
 554    #endif
 555
 556        /* Add the working vars back into digest state[] */
 557        sha->digest[0] += a;
 558        sha->digest[1] += b;
 559        sha->digest[2] += c;
 560        sha->digest[3] += d;
 561        sha->digest[4] += e;
 562
 563        (void)data; /* Not used */
 564
 565        return 0;
 566    }
 567#endif /* XTRANSFORM when USE_SHA_SOFTWARE_IMPL is enabled */
 568
 569
 570/*
 571** wolfCrypt InitSha external wrapper.
 572**
 573** we'll assume this is ALWAYS for a new, uninitialized sha
 574*/
 575int wc_InitSha_ex(wc_Sha* sha, void* heap, int devId)
 576{
 577    int ret = 0;
 578    if (sha == NULL) {
 579        return BAD_FUNC_ARG;
 580    }
 581
 582    sha->heap = heap;
 583#ifdef WOLF_CRYPTO_CB
 584    sha->devId = devId;
 585    sha->devCtx = NULL;
 586#endif
 587#ifdef WOLFSSL_HASH_KEEP
 588    sha->msg  = NULL;
 589    sha->len  = 0;
 590    sha->used = 0;
 591#endif
 592
 593#ifdef WOLFSSL_USE_ESP32_CRYPT_HASH_HW
 594    if (sha->ctx.mode != ESP32_SHA_INIT) {
 595        /* it may be interesting to see old values during debugging */
 596        ESP_LOGV(TAG, "Set ctx mode from prior value: %d", sha->ctx.mode);
 597    }
 598    /* We know this is a fresh, uninitialized item, so set to INIT */
 599    sha->ctx.mode = ESP32_SHA_INIT;
 600#endif
 601
 602    ret = InitSha(sha);
 603    if (ret != 0) {
 604        return ret;
 605    }
 606
 607#if defined(WOLFSSL_ASYNC_CRYPT) && defined(WC_ASYNC_ENABLE_SHA)
 608    ret = wolfAsync_DevCtxInit(&sha->asyncDev, WOLFSSL_ASYNC_MARKER_SHA,
 609                                                            sha->heap, devId);
 610#else
 611    (void)devId;
 612#endif /* WOLFSSL_ASYNC_CRYPT */
 613#ifdef WOLFSSL_IMXRT1170_CAAM
 614   ret = wc_CAAM_HashInit(&sha->hndl, &sha->ctx, WC_HASH_TYPE_SHA);
 615#endif
 616
 617    return ret;
 618} /* wc_InitSha_ex */
 619
 620/* do block size increments/updates */
 621int wc_ShaUpdate(wc_Sha* sha, const byte* data, word32 len)
 622{
 623    int ret = 0;
 624    word32 blocksLen;
 625    byte* local;
 626
 627    if (sha == NULL || (data == NULL && len > 0)) {
 628        return BAD_FUNC_ARG;
 629    }
 630
 631    if (data == NULL && len == 0) {
 632        /* valid, but do nothing */
 633        return 0;
 634    }
 635
 636#ifdef WOLF_CRYPTO_CB
 637    if (sha->devId != INVALID_DEVID) {
 638        ret = wc_CryptoCb_ShaHash(sha, data, len, NULL);
 639        if (ret != WC_NO_ERR_TRACE(CRYPTOCB_UNAVAILABLE))
 640            return ret;
 641        ret = 0; /* reset ret */
 642        /* fall-through when unavailable */
 643    }
 644#endif
 645#if defined(WOLFSSL_ASYNC_CRYPT) && defined(WC_ASYNC_ENABLE_SHA)
 646    if (sha->asyncDev.marker == WOLFSSL_ASYNC_MARKER_SHA) {
 647    #if defined(HAVE_INTEL_QA)
 648        return IntelQaSymSha(&sha->asyncDev, NULL, data, len);
 649    #endif
 650    }
 651#endif /* WOLFSSL_ASYNC_CRYPT */
 652
 653    /* check that internal buffLen is valid */
 654    if (sha->buffLen >= WC_SHA_BLOCK_SIZE) {
 655        return BUFFER_E;
 656    }
 657
 658    /* add length for final */
 659    AddLength(sha, len);
 660
 661    local = (byte*)sha->buffer;
 662
 663    /* process any remainder from previous operation */
 664    if (sha->buffLen > 0) {
 665        blocksLen = min(len, WC_SHA_BLOCK_SIZE - sha->buffLen);
 666        XMEMCPY(&local[sha->buffLen], data, blocksLen);
 667
 668        sha->buffLen += blocksLen;
 669        data         += blocksLen;
 670        len          -= blocksLen;
 671
 672        if (sha->buffLen == WC_SHA_BLOCK_SIZE) {
 673        #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 674            if (sha->ctx.mode == ESP32_SHA_INIT) {
 675                #if defined(WOLFSSL_DEBUG_MUTEX)
 676                {
 677                    ESP_LOGI(TAG, "wc_ShaUpdate try hardware");
 678                }
 679                #endif
 680                esp_sha_try_hw_lock(&sha->ctx);
 681            }
 682        #endif
 683
 684        #if defined(LITTLE_ENDIAN_ORDER) && !defined(FREESCALE_MMCAU_SHA)
 685            #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 686                  defined(CONFIG_IDF_TARGET_ESP8684) || \
 687                  defined(CONFIG_IDF_TARGET_ESP32C3) || \
 688                  defined(CONFIG_IDF_TARGET_ESP32C6)    \
 689                ) && \
 690                 defined(WOLFSSL_ESP32_CRYPT) && \
 691                !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 692                /* For Espressif RISC-V Targets, we *may* need to reverse bytes
 693                 * depending on if HW is active or not. */
 694                if (esp_sha_need_byte_reversal(&sha->ctx))
 695            #endif
 696            {
 697                ByteReverseWords(sha->buffer, sha->buffer, WC_SHA_BLOCK_SIZE);
 698            }
 699        #endif
 700
 701        #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 702            if (sha->ctx.mode == ESP32_SHA_SW) {
 703                #if defined(WOLFSSL_DEBUG_MUTEX)
 704                {
 705                    ESP_LOGI(TAG, "wc_ShaUpdate process software");
 706                }
 707                #endif
 708                ret = XTRANSFORM(sha, (const byte*)local);
 709            }
 710            else {
 711                #if defined(WOLFSSL_DEBUG_MUTEX)
 712                {
 713                    ESP_LOGI(TAG, "wc_ShaUpdate process hardware");
 714                }
 715                #endif
 716                esp_sha_process(sha, (const byte*)local);
 717            }
 718        #elif defined (WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW)
 719            ESP_LOGI(TAG, "wc_ShaUpdate not implemented for ESP32C3");
 720            ret = XTRANSFORM(sha, (const byte*)local);
 721        #else
 722            ret = XTRANSFORM(sha, (const byte*)local);
 723        #endif
 724            if (ret != 0) {
 725                return ret;
 726            }
 727
 728            sha->buffLen = 0; /* Nothing left to do, so set to zero. */
 729        } /* (sha->buffLen == WC_SHA_BLOCK_SIZE) */
 730    } /* (sha->buffLen > 0)  Process any remainder from previous operation. */
 731
 732    /* process blocks */
 733#ifdef XTRANSFORM_LEN
 734    /* get number of blocks */
 735    /* 64-1 = 0x3F (~ Inverted = 0xFFFFFFC0) */
 736    /* len (masked by 0xFFFFFFC0) returns block aligned length */
 737    blocksLen = len & ~(WC_SHA_BLOCK_SIZE-1);
 738    if (blocksLen > 0) {
 739        /* Byte reversal performed in function if required. */
 740        XTRANSFORM_LEN(sha, data, blocksLen);
 741        data += blocksLen;
 742        len  -= blocksLen;
 743    }
 744#else
 745    while (len >= WC_SHA_BLOCK_SIZE) {
 746        word32* local32 = sha->buffer;
 747        /* optimization to avoid memcpy if data pointer is properly aligned */
 748        /* Little Endian requires byte swap, so can't use data directly */
 749    #if defined(WC_HASH_DATA_ALIGNMENT) && !defined(LITTLE_ENDIAN_ORDER)
 750        if (((wc_ptr_t)data % WC_HASH_DATA_ALIGNMENT) == 0) {
 751            local32 = (word32*)data;
 752        }
 753        else
 754    #endif
 755        {
 756            XMEMCPY(local32, data, WC_SHA_BLOCK_SIZE);
 757        }
 758
 759        data += WC_SHA_BLOCK_SIZE;
 760        len  -= WC_SHA_BLOCK_SIZE;
 761
 762    #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 763        if (sha->ctx.mode == ESP32_SHA_INIT){
 764            esp_sha_try_hw_lock(&sha->ctx);
 765        }
 766    #endif
 767
 768    #if defined(LITTLE_ENDIAN_ORDER) && !defined(FREESCALE_MMCAU_SHA)
 769        #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 770              defined(CONFIG_IDF_TARGET_ESP8684) || \
 771              defined(CONFIG_IDF_TARGET_ESP32C3) || \
 772              defined(CONFIG_IDF_TARGET_ESP32C6)    \
 773            ) && \
 774             defined(WOLFSSL_ESP32_CRYPT) && \
 775            !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 776            /* For Espressif RISC-V Targets, we *may* need to reverse bytes
 777             * depending on if HW is active or not. */
 778            if (esp_sha_need_byte_reversal(&sha->ctx))
 779        #endif
 780        {
 781            ByteReverseWords(local32, local32, WC_SHA_BLOCK_SIZE);
 782        }
 783    #endif
 784
 785    #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 786        if (sha->ctx.mode == ESP32_SHA_SW){
 787            ret = XTRANSFORM(sha, (const byte*)local32);
 788        }
 789        else {
 790            esp_sha_process(sha, (const byte*)local32);
 791        }
 792    #else
 793        ret = XTRANSFORM(sha, (const byte*)local32);
 794    #endif
 795    }
 796#endif /* XTRANSFORM_LEN */
 797
 798    /* save remainder */
 799    if (len > 0) {
 800        XMEMCPY(local, data, len);
 801        sha->buffLen = len;
 802    }
 803
 804    return ret;
 805}
 806
 807int wc_ShaFinalRaw(wc_Sha* sha, byte* hash)
 808{
 809#ifdef LITTLE_ENDIAN_ORDER
 810    word32 digest[WC_SHA_DIGEST_SIZE / sizeof(word32)];
 811    XMEMSET(digest, 0, sizeof(digest));
 812#endif
 813
 814    if (sha == NULL || hash == NULL) {
 815        return BAD_FUNC_ARG;
 816    }
 817
 818#ifdef LITTLE_ENDIAN_ORDER
 819    #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 820          defined(CONFIG_IDF_TARGET_ESP8684) || \
 821          defined(CONFIG_IDF_TARGET_ESP32C3) || \
 822          defined(CONFIG_IDF_TARGET_ESP32C6)    \
 823        ) && \
 824         defined(WOLFSSL_ESP32_CRYPT) && \
 825        !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 826        /* For Espressif RISC-V Targets, we *may* need to reverse bytes
 827         * depending on if HW is active or not. */
 828        if (esp_sha_need_byte_reversal(&sha->ctx))
 829    #endif
 830    {
 831        ByteReverseWords((word32*)digest, (word32*)sha->digest, WC_SHA_DIGEST_SIZE);
 832    }
 833    XMEMCPY(hash, (byte *)&digest[0], WC_SHA_DIGEST_SIZE);
 834#else
 835    XMEMCPY(hash, sha->digest, WC_SHA_DIGEST_SIZE);
 836#endif
 837
 838    return 0;
 839}
 840
 841/*
 842** Finalizes hashing of data. Result is placed into hash.
 843** Resets state of sha struct.
 844*/
 845int wc_ShaFinal(wc_Sha* sha, byte* hash)
 846{
 847    int ret;
 848    byte* local;
 849
 850    if (sha == NULL || hash == NULL) {
 851        return BAD_FUNC_ARG;
 852    }
 853
 854    local = (byte*)sha->buffer;
 855
 856#ifdef WOLF_CRYPTO_CB
 857    if (sha->devId != INVALID_DEVID) {
 858        ret = wc_CryptoCb_ShaHash(sha, NULL, 0, hash);
 859        if (ret != WC_NO_ERR_TRACE(CRYPTOCB_UNAVAILABLE))
 860            return ret;
 861        /* fall-through when unavailable */
 862    }
 863#endif
 864#if defined(WOLFSSL_ASYNC_CRYPT) && defined(WC_ASYNC_ENABLE_SHA)
 865    if (sha->asyncDev.marker == WOLFSSL_ASYNC_MARKER_SHA) {
 866    #if defined(HAVE_INTEL_QA)
 867        return IntelQaSymSha(&sha->asyncDev, hash, NULL, WC_SHA_DIGEST_SIZE);
 868    #endif
 869    }
 870#endif /* WOLFSSL_ASYNC_CRYPT */
 871
 872    /* we'll add a 0x80 byte at the end,
 873    ** so make sure we have appropriate buffer length. */
 874    if (sha->buffLen > WC_SHA_BLOCK_SIZE - 1) {
 875        /* exit with error code if there's a bad buffer size in buffLen */
 876        return BAD_STATE_E;
 877    } /* buffLen check */
 878
 879    local[sha->buffLen++] = 0x80;  /* add 1 */
 880
 881    /* pad with zeros */
 882    if (sha->buffLen > WC_SHA_PAD_SIZE) {
 883        if (sha->buffLen < WC_SHA_BLOCK_SIZE) {
 884            XMEMSET(&local[sha->buffLen], 0, WC_SHA_BLOCK_SIZE - sha->buffLen);
 885        }
 886
 887        sha->buffLen += WC_SHA_BLOCK_SIZE - sha->buffLen;
 888
 889    #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 890        /* For a fresh sha.ctx, try to use hardware acceleration */
 891        if (sha->ctx.mode == ESP32_SHA_INIT) {
 892            esp_sha_try_hw_lock(&sha->ctx);
 893        }
 894    #endif
 895
 896    #if defined(LITTLE_ENDIAN_ORDER) && !defined(FREESCALE_MMCAU_SHA)
 897        #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 898              defined(CONFIG_IDF_TARGET_ESP8684) || \
 899              defined(CONFIG_IDF_TARGET_ESP32C3) || \
 900              defined(CONFIG_IDF_TARGET_ESP32C6)    \
 901            ) && \
 902             defined(WOLFSSL_ESP32_CRYPT) && \
 903            !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 904            /* For Espressif RISC-V Targets, we *may* need to reverse bytes
 905             * depending on if HW is active or not. */
 906            if (esp_sha_need_byte_reversal(&sha->ctx))
 907        #endif
 908        {
 909            ByteReverseWords(sha->buffer, sha->buffer, WC_SHA_BLOCK_SIZE);
 910        }
 911    #endif
 912
 913    #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 914        /* if HW was busy, we may need to fall back to SW. */
 915        if (sha->ctx.mode == ESP32_SHA_SW) {
 916            ret = XTRANSFORM(sha, (const byte*)local);
 917        }
 918        else {
 919            ret = esp_sha_process(sha, (const byte*)local);
 920        }
 921    #else
 922        /*
 923        ** The #if defined(WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW) also falls
 924        ** though here to SW, as it's not yet implemented for HW.
 925        */
 926        ret = XTRANSFORM(sha, (const byte*)local);
 927    #endif
 928        if (ret != 0) {
 929            return ret;
 930        }
 931
 932        sha->buffLen = 0;
 933    } /* (sha->buffLen > WC_SHA_PAD_SIZE) */
 934
 935    XMEMSET(&local[sha->buffLen], 0, WC_SHA_PAD_SIZE - sha->buffLen);
 936
 937#if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
 938    if (sha->ctx.mode == ESP32_SHA_INIT) {
 939        esp_sha_try_hw_lock(&sha->ctx);
 940    }
 941#endif
 942
 943#if defined(LITTLE_ENDIAN_ORDER) && !defined(FREESCALE_MMCAU_SHA)
 944    #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 945          defined(CONFIG_IDF_TARGET_ESP8684) || \
 946          defined(CONFIG_IDF_TARGET_ESP32C3) || \
 947          defined(CONFIG_IDF_TARGET_ESP32C6)    \
 948        ) && \
 949         defined(WOLFSSL_ESP32_CRYPT) && \
 950        !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 951        /* For Espressif RISC-V Targets, we *may* need to reverse bytes
 952         * depending on if HW is active or not. */
 953        if (esp_sha_need_byte_reversal(&sha->ctx))
 954    #endif
 955    { /* reminder local also points to sha->buffer  */
 956        ByteReverseWords(sha->buffer, sha->buffer, WC_SHA_BLOCK_SIZE);
 957    }
 958#endif
 959
 960    /* store lengths */
 961    /* put lengths in bits */
 962    sha->hiLen = (sha->loLen >> (8*sizeof(sha->loLen) - 3)) + (sha->hiLen << 3);
 963    sha->loLen = sha->loLen << 3;
 964
 965    /* ! length ordering dependent on digest endian type ! */
 966    XMEMCPY(&local[WC_SHA_PAD_SIZE], &sha->hiLen, sizeof(word32));
 967    XMEMCPY(&local[WC_SHA_PAD_SIZE + sizeof(word32)], &sha->loLen, sizeof(word32));
 968
 969#if defined(FREESCALE_MMCAU_SHA)
 970    /* Kinetis requires only these bytes reversed */
 971    ByteReverseWords(&sha->buffer[WC_SHA_PAD_SIZE/sizeof(word32)],
 972                     &sha->buffer[WC_SHA_PAD_SIZE/sizeof(word32)],
 973                     2 * sizeof(word32));
 974#endif
 975
 976
 977#if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
 978      defined(CONFIG_IDF_TARGET_ESP8684) || \
 979      defined(CONFIG_IDF_TARGET_ESP32C3) || \
 980      defined(CONFIG_IDF_TARGET_ESP32C6)    \
 981    ) && \
 982    defined(WOLFSSL_ESP32_CRYPT) && !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
 983if (sha->ctx.mode == ESP32_SHA_HW) {
 984    #if defined(WOLFSSL_SUPER_VERBOSE_DEBUG)
 985    {
 986        ESP_LOGV(TAG, "Start: Reverse PAD SIZE Endianness.");
 987    }
 988    #endif
 989    ByteReverseWords(&sha->buffer[WC_SHA_PAD_SIZE/sizeof(word32)], /* out */
 990                     &sha->buffer[WC_SHA_PAD_SIZE/sizeof(word32)], /* in  */
 991                     2 * sizeof(word32) /* byte count to reverse */
 992                    );
 993    #if defined(WOLFSSL_SUPER_VERBOSE_DEBUG)
 994    {
 995        ESP_LOGV(TAG, "End: Reverse PAD SIZE Endianness.");
 996    }
 997    #endif
 998} /* end if (sha->ctx.mode == ESP32_SHA_HW) */
 999#endif
1000
1001#if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
1002    if (sha->ctx.mode == ESP32_SHA_SW) {
1003        ret = XTRANSFORM(sha, (const byte*)local);
1004    }
1005    else {
1006        ret = esp_sha_digest_process(sha, 1);
1007    }
1008/*
1009** The #if defined(WOLFSSL_USE_ESP32C3_CRYPT_HASH_HW) also falls
1010** though here to SW, as it's not yet implemented for HW.
1011*/
1012#else
1013    ret = XTRANSFORM(sha, (const byte*)local);
1014#endif
1015
1016#ifdef LITTLE_ENDIAN_ORDER
1017    #if ( defined(CONFIG_IDF_TARGET_ESP32C2) || \
1018          defined(CONFIG_IDF_TARGET_ESP8684) || \
1019          defined(CONFIG_IDF_TARGET_ESP32C3) || \
1020          defined(CONFIG_IDF_TARGET_ESP32C6)    \
1021        ) && \
1022        defined(WOLFSSL_ESP32_CRYPT) && !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
1023        /* For Espressif RISC-V Targets, we *may* need to reverse bytes
1024         * depending on if HW is active or not. */
1025        if (esp_sha_need_byte_reversal(&sha->ctx))
1026    #endif
1027    {
1028        ByteReverseWords(sha->digest, sha->digest, WC_SHA_DIGEST_SIZE);
1029    }
1030#endif
1031
1032    XMEMCPY(hash, (byte *)&sha->digest[0], WC_SHA_DIGEST_SIZE);
1033
1034    /* we'll always reset state upon exit and return the error code from above,
1035     * which may cause fall back to SW if HW is busy. we do not return result
1036     * of initSha here */
1037    (void)InitSha(sha); /* reset state */
1038    return ret;
1039}
1040
1041#if defined(OPENSSL_EXTRA) || defined(HAVE_CURL)
1042/* Apply SHA1 transformation to the data                  */
1043/* @param sha  a pointer to wc_Sha structure              */
1044/* @param data data to be applied SHA1 transformation     */
1045/* @return 0 on successful, otherwise non-zero on failure */
1046int wc_ShaTransform(wc_Sha* sha, const unsigned char* data)
1047{
1048    /* sanity check */
1049    if (sha == NULL || data == NULL) {
1050        return BAD_FUNC_ARG;
1051    }
1052    return (Transform(sha, data));
1053}
1054#endif
1055
1056#endif /* USE_SHA_SOFTWARE_IMPL */
1057
1058/*
1059** This function initializes SHA. This is automatically called by wc_ShaHash.
1060*/
1061int wc_InitSha(wc_Sha* sha)
1062{
1063    return wc_InitSha_ex(sha, NULL, INVALID_DEVID);
1064}
1065
1066
1067#if !defined(WOLFSSL_HAVE_PSA) || defined(WOLFSSL_PSA_NO_HASH)
1068
1069#ifndef MAX3266X_SHA
1070
1071void wc_ShaFree(wc_Sha* sha)
1072{
1073#if defined(WOLF_CRYPTO_CB) && defined(WOLF_CRYPTO_CB_FREE)
1074    int ret = 0;
1075#endif
1076
1077    if (sha == NULL)
1078        return;
1079
1080#if defined(WOLF_CRYPTO_CB) && defined(WOLF_CRYPTO_CB_FREE)
1081    #ifndef WOLF_CRYPTO_CB_FIND
1082    if (sha->devId != INVALID_DEVID)
1083    #endif
1084    {
1085        ret = wc_CryptoCb_Free(sha->devId, WC_ALGO_TYPE_HASH,
1086                         WC_HASH_TYPE_SHA, 0, (void*)sha);
1087        /* If they want the standard free, they can call it themselves */
1088        /* via their callback setting devId to INVALID_DEVID */
1089        /* otherwise assume the callback handled it */
1090        if (ret != WC_NO_ERR_TRACE(CRYPTOCB_UNAVAILABLE))
1091            return;
1092        /* fall-through when unavailable */
1093    }
1094
1095    /* silence compiler warning */
1096    (void)ret;
1097
1098#endif /* WOLF_CRYPTO_CB && WOLF_CRYPTO_CB_FREE */
1099
1100#if defined(WOLFSSL_ESP32) &&  !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
1101    esp_sha_release_unfinished_lock(&sha->ctx);
1102#endif
1103
1104#if defined(WOLFSSL_ASYNC_CRYPT) && defined(WC_ASYNC_ENABLE_SHA)
1105    wolfAsync_DevCtxFree(&sha->asyncDev, WOLFSSL_ASYNC_MARKER_SHA);
1106#endif /* WOLFSSL_ASYNC_CRYPT */
1107
1108#ifdef WOLFSSL_PIC32MZ_HASH
1109    wc_ShaPic32Free(sha);
1110#endif
1111#if defined(WOLFSSL_SE050) && defined(WOLFSSL_SE050_HASH)
1112    se050_hash_free(&sha->se050Ctx);
1113#endif
1114#if (defined(WOLFSSL_RENESAS_TSIP_TLS) || \
1115     defined(WOLFSSL_RENESAS_TSIP_CRYPTONLY)) && \
1116    !defined(NO_WOLFSSL_RENESAS_TSIP_CRYPT_HASH) || \
1117    (defined(WOLFSSL_RENESAS_RSIP) && (WOLFSSL_RENESAS_RZFSP_VER >= 220)) ||\
1118    defined(WOLFSSL_RENESAS_RX64_HASH)
1119    XFREE(sha->msg, sha->heap, DYNAMIC_TYPE_TMP_BUFFER);
1120    sha->msg = NULL;
1121#endif
1122#ifdef WOLFSSL_IMXRT_DCP
1123    DCPShaFree(sha);
1124#endif
1125
1126#ifdef WOLFSSL_HASH_KEEP
1127    if (sha->msg != NULL) {
1128        ForceZero(sha->msg, sha->len);
1129        XFREE(sha->msg, sha->heap, DYNAMIC_TYPE_TMP_BUFFER);
1130        sha->msg = NULL;
1131    }
1132#endif
1133
1134#if defined(PSOC6_HASH_SHA1)
1135    wc_Psoc6_Sha_Free();
1136#endif
1137}
1138
1139#endif /* !MAX3266X_SHA */
1140#endif /* !defined(WOLFSSL_HAVE_PSA) || defined(WOLFSSL_PSA_NO_HASH) */
1141#endif /* !WOLFSSL_TI_HASH */
1142
1143#if !defined(WOLFSSL_TI_HASH) && !defined(WOLFSSL_IMXRT_DCP)
1144
1145#if ((!defined(WOLFSSL_RENESAS_TSIP_TLS) && \
1146     !defined(WOLFSSL_RENESAS_TSIP_CRYPTONLY)) || \
1147    defined(NO_WOLFSSL_RENESAS_TSIP_CRYPT_HASH)) && \
1148    (!defined(WOLFSSL_RENESAS_RSIP) || \
1149      defined(NO_WOLFSSL_RENESAS_FSPSM_HASH))
1150#if !defined(WOLFSSL_RENESAS_RX64_HASH)
1151
1152#if !defined(WOLFSSL_HAVE_PSA) || defined(WOLFSSL_PSA_NO_HASH)
1153
1154#ifndef MAX3266X_SHA
1155
1156/* wc_ShaGetHash get hash value */
1157int wc_ShaGetHash(wc_Sha* sha, byte* hash)
1158{
1159    int ret;
1160    WC_DECLARE_VAR(tmpSha, wc_Sha, 1, 0);
1161
1162    if (sha == NULL || hash == NULL) {
1163        return BAD_FUNC_ARG;
1164    }
1165
1166    WC_CALLOC_VAR_EX(tmpSha, wc_Sha, 1, NULL, DYNAMIC_TYPE_TMP_BUFFER,
1167        return MEMORY_E);
1168
1169    ret = wc_ShaCopy(sha, tmpSha);
1170    if (ret == 0) {
1171        ret = wc_ShaFinal(tmpSha, hash);
1172    }
1173
1174    WC_FREE_VAR_EX(tmpSha, NULL, DYNAMIC_TYPE_TMP_BUFFER);
1175
1176    return ret;
1177}
1178
1179int wc_ShaCopy(wc_Sha* src, wc_Sha* dst)
1180{
1181    int ret = 0;
1182
1183    if (src == NULL || dst == NULL)
1184        return BAD_FUNC_ARG;
1185
1186#if defined(WOLF_CRYPTO_CB) && defined(WOLF_CRYPTO_CB_COPY)
1187    #ifndef WOLF_CRYPTO_CB_FIND
1188    if (src->devId != INVALID_DEVID)
1189    #endif
1190    {
1191        /* Cast the source and destination to be void to keep the abstraction */
1192        ret = wc_CryptoCb_Copy(src->devId, WC_ALGO_TYPE_HASH,
1193                               WC_HASH_TYPE_SHA, (void*)src, (void*)dst);
1194        if (ret != WC_NO_ERR_TRACE(CRYPTOCB_UNAVAILABLE))
1195            return ret;
1196        /* fall-through when unavailable */
1197    }
1198    ret = 0; /* Reset ret to 0 to avoid returning the callback error code */
1199#endif /* WOLF_CRYPTO_CB && WOLF_CRYPTO_CB_COPY */
1200
1201    /* Free dst resources before copy to prevent memory leaks (e.g., msg
1202     * buffer, W cache, hardware contexts). XMEMCPY overwrites dst. */
1203    wc_ShaFree(dst);
1204    XMEMCPY(dst, src, sizeof(wc_Sha));
1205
1206#if defined(WOLFSSL_SILABS_SE_ACCEL) && defined(WOLFSSL_SILABS_SE_ACCEL_3)
1207    dst->silabsCtx.hash_ctx.cmd_ctx = &dst->silabsCtx.cmd_ctx;
1208    dst->silabsCtx.hash_ctx.hash_type_ctx = &dst->silabsCtx.hash_type_ctx;
1209#endif
1210
1211#if defined(WOLFSSL_ASYNC_CRYPT) && defined(WC_ASYNC_ENABLE_SHA)
1212    ret = wolfAsync_DevCopy(&src->asyncDev, &dst->asyncDev);
1213#endif
1214
1215#ifdef WOLFSSL_PIC32MZ_HASH
1216    ret = wc_Pic32HashCopy(&src->cache, &dst->cache);
1217#endif
1218
1219#if defined(WOLFSSL_SE050) && defined(WOLFSSL_SE050_HASH)
1220    ret = se050_hash_copy(&src->se050Ctx, &dst->se050Ctx);
1221#endif
1222
1223#if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
1224    esp_sha_ctx_copy(src, dst);
1225#endif
1226
1227
1228#if defined(PSOC6_HASH_SHA1)
1229    wc_Psoc6_Sha1_Sha2_Init(dst, WC_PSOC6_SHA1, 0);
1230#endif
1231
1232#ifdef WOLFSSL_HASH_FLAGS
1233    dst->flags |= WC_HASH_FLAG_ISCOPY;
1234#endif
1235
1236#if defined(WOLFSSL_HASH_KEEP)
1237    if (src->msg != NULL) {
1238        dst->msg = (byte*)XMALLOC(src->len, dst->heap,
1239                                  DYNAMIC_TYPE_TMP_BUFFER);
1240        if (dst->msg == NULL) {
1241            return MEMORY_E;
1242        }
1243        XMEMCPY(dst->msg, src->msg, src->used);
1244    }
1245#endif
1246
1247    return ret;
1248}
1249#endif /* WOLFSSL_RENESAS_RX64_HASH */
1250#endif /* !MAX3266X_SHA */
1251#endif /* !defined(WOLFSSL_HAVE_PSA) || defined(WOLFSSL_PSA_NO_HASH) */
1252#endif /* !defined(WOLFSSL_RENESAS_TSIP_TLS) && \
1253          !defined(WOLFSSL_RENESAS_TSIP_CRYPTONLY) ||
1254          defined(NO_WOLFSSL_RENESAS_TSIP_CRYPT_HASH) */
1255#endif /* !defined(WOLFSSL_TI_HASH) && !defined(WOLFSSL_IMXRT_DCP) */
1256
1257#ifdef WOLFSSL_HASH_FLAGS
1258int wc_ShaSetFlags(wc_Sha* sha, word32 flags)
1259{
1260    if (sha) {
1261        sha->flags = flags;
1262    }
1263    return 0;
1264}
1265int wc_ShaGetFlags(wc_Sha* sha, word32* flags)
1266{
1267    if (sha && flags) {
1268        *flags = sha->flags;
1269    }
1270    return 0;
1271}
1272#endif
1273
1274#endif /* !NO_SHA */