wolf SSL / wolfSSL

wolfSSL SSL/TLS library, support up to TLS1.3

Dependents:   CyaSSL-Twitter-OAuth4Tw Example-client-tls-cert TwitterReader TweetTest ... more

wolfssl/wolfcrypt/sha3.h@17:a5f916481144, 2020-06-05 (annotated)

Committer:
wolfSSL
Date:
Fri Jun 05 00:11:07 2020 +0000
Revision:
17:a5f916481144
Parent:
16:8e0d178b1d1e 
wolfSSL 4.4.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
wolfSSL 15:117db924cf7c 1 /* sha3.h
wolfSSL 15:117db924cf7c 2 *
wolfSSL 16:8e0d178b1d1e 3 * Copyright (C) 2006-2020 wolfSSL Inc.
wolfSSL 15:117db924cf7c 4 *
wolfSSL 15:117db924cf7c 5 * This file is part of wolfSSL.
wolfSSL 15:117db924cf7c 6 *
wolfSSL 15:117db924cf7c 7 * wolfSSL is free software; you can redistribute it and/or modify
wolfSSL 15:117db924cf7c 8 * it under the terms of the GNU General Public License as published by
wolfSSL 15:117db924cf7c 9 * the Free Software Foundation; either version 2 of the License, or
wolfSSL 15:117db924cf7c 10 * (at your option) any later version.
wolfSSL 15:117db924cf7c 11 *
wolfSSL 15:117db924cf7c 12 * wolfSSL is distributed in the hope that it will be useful,
wolfSSL 15:117db924cf7c 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
wolfSSL 15:117db924cf7c 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
wolfSSL 15:117db924cf7c 15 * GNU General Public License for more details.
wolfSSL 15:117db924cf7c 16 *
wolfSSL 15:117db924cf7c 17 * You should have received a copy of the GNU General Public License
wolfSSL 15:117db924cf7c 18 * along with this program; if not, write to the Free Software
wolfSSL 15:117db924cf7c 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
wolfSSL 15:117db924cf7c 20 */
wolfSSL 15:117db924cf7c 21
wolfSSL 15:117db924cf7c 22
wolfSSL 15:117db924cf7c 23 #ifndef WOLF_CRYPT_SHA3_H
wolfSSL 15:117db924cf7c 24 #define WOLF_CRYPT_SHA3_H
wolfSSL 15:117db924cf7c 25
wolfSSL 15:117db924cf7c 26 #include <wolfssl/wolfcrypt/types.h>
wolfSSL 15:117db924cf7c 27
wolfSSL 15:117db924cf7c 28 #ifdef WOLFSSL_SHA3
wolfSSL 15:117db924cf7c 29
wolfSSL 15:117db924cf7c 30 #ifdef HAVE_FIPS
wolfSSL 15:117db924cf7c 31 /* for fips @wc_fips */
wolfSSL 15:117db924cf7c 32 #include <wolfssl/wolfcrypt/fips.h>
wolfSSL 15:117db924cf7c 33 #endif
wolfSSL 15:117db924cf7c 34
wolfSSL 15:117db924cf7c 35 #ifdef __cplusplus
wolfSSL 15:117db924cf7c 36 extern "C" {
wolfSSL 15:117db924cf7c 37 #endif
wolfSSL 15:117db924cf7c 38
wolfSSL 15:117db924cf7c 39 #ifdef WOLFSSL_ASYNC_CRYPT
wolfSSL 15:117db924cf7c 40 #include <wolfssl/wolfcrypt/async.h>
wolfSSL 15:117db924cf7c 41 #endif
wolfSSL 15:117db924cf7c 42
wolfSSL 15:117db924cf7c 43 /* in bytes */
wolfSSL 15:117db924cf7c 44 enum {
wolfSSL 15:117db924cf7c 45 WC_SHA3_224 = WC_HASH_TYPE_SHA3_224,
wolfSSL 15:117db924cf7c 46 WC_SHA3_224_DIGEST_SIZE = 28,
wolfSSL 15:117db924cf7c 47 WC_SHA3_224_COUNT = 18,
wolfSSL 15:117db924cf7c 48
wolfSSL 15:117db924cf7c 49 WC_SHA3_256 = WC_HASH_TYPE_SHA3_256,
wolfSSL 15:117db924cf7c 50 WC_SHA3_256_DIGEST_SIZE = 32,
wolfSSL 15:117db924cf7c 51 WC_SHA3_256_COUNT = 17,
wolfSSL 15:117db924cf7c 52
wolfSSL 15:117db924cf7c 53 WC_SHA3_384 = WC_HASH_TYPE_SHA3_384,
wolfSSL 15:117db924cf7c 54 WC_SHA3_384_DIGEST_SIZE = 48,
wolfSSL 15:117db924cf7c 55 WC_SHA3_384_COUNT = 13,
wolfSSL 15:117db924cf7c 56
wolfSSL 15:117db924cf7c 57 WC_SHA3_512 = WC_HASH_TYPE_SHA3_512,
wolfSSL 15:117db924cf7c 58 WC_SHA3_512_DIGEST_SIZE = 64,
wolfSSL 15:117db924cf7c 59 WC_SHA3_512_COUNT = 9,
wolfSSL 15:117db924cf7c 60
wolfSSL 15:117db924cf7c 61 #ifndef HAVE_SELFTEST
wolfSSL 15:117db924cf7c 62 /* These values are used for HMAC, not SHA-3 directly.
wolfSSL 15:117db924cf7c 63 * They come from from FIPS PUB 202. */
wolfSSL 15:117db924cf7c 64 WC_SHA3_224_BLOCK_SIZE = 144,
wolfSSL 15:117db924cf7c 65 WC_SHA3_256_BLOCK_SIZE = 136,
wolfSSL 15:117db924cf7c 66 WC_SHA3_384_BLOCK_SIZE = 104,
wolfSSL 15:117db924cf7c 67 WC_SHA3_512_BLOCK_SIZE = 72,
wolfSSL 15:117db924cf7c 68 #endif
wolfSSL 15:117db924cf7c 69 };
wolfSSL 15:117db924cf7c 70
wolfSSL 15:117db924cf7c 71 #ifndef NO_OLD_WC_NAMES
wolfSSL 15:117db924cf7c 72 #define SHA3_224 WC_SHA3_224
wolfSSL 15:117db924cf7c 73 #define SHA3_224_DIGEST_SIZE WC_SHA3_224_DIGEST_SIZE
wolfSSL 15:117db924cf7c 74 #define SHA3_256 WC_SHA3_256
wolfSSL 15:117db924cf7c 75 #define SHA3_256_DIGEST_SIZE WC_SHA3_256_DIGEST_SIZE
wolfSSL 15:117db924cf7c 76 #define SHA3_384 WC_SHA3_384
wolfSSL 15:117db924cf7c 77 #define SHA3_384_DIGEST_SIZE WC_SHA3_384_DIGEST_SIZE
wolfSSL 15:117db924cf7c 78 #define SHA3_512 WC_SHA3_512
wolfSSL 15:117db924cf7c 79 #define SHA3_512_DIGEST_SIZE WC_SHA3_512_DIGEST_SIZE
wolfSSL 15:117db924cf7c 80 #define Sha3 wc_Sha3
wolfSSL 15:117db924cf7c 81 #endif
wolfSSL 15:117db924cf7c 82
wolfSSL 15:117db924cf7c 83
wolfSSL 16:8e0d178b1d1e 84
wolfSSL 15:117db924cf7c 85 #ifdef WOLFSSL_XILINX_CRYPT
wolfSSL 15:117db924cf7c 86 #include "wolfssl/wolfcrypt/port/xilinx/xil-sha3.h"
wolfSSL 16:8e0d178b1d1e 87 #elif defined(WOLFSSL_AFALG_XILINX_SHA3)
wolfSSL 16:8e0d178b1d1e 88 #include <wolfssl/wolfcrypt/port/af_alg/afalg_hash.h>
wolfSSL 15:117db924cf7c 89 #else
wolfSSL 16:8e0d178b1d1e 90
wolfSSL 15:117db924cf7c 91 /* Sha3 digest */
wolfSSL 16:8e0d178b1d1e 92 struct Sha3 {
wolfSSL 15:117db924cf7c 93 /* State data that is processed for each block. */
wolfSSL 15:117db924cf7c 94 word64 s[25];
wolfSSL 15:117db924cf7c 95 /* Unprocessed message data. */
wolfSSL 15:117db924cf7c 96 byte t[200];
wolfSSL 15:117db924cf7c 97 /* Index into unprocessed data to place next message byte. */
wolfSSL 15:117db924cf7c 98 byte i;
wolfSSL 15:117db924cf7c 99
wolfSSL 15:117db924cf7c 100 void* heap;
wolfSSL 15:117db924cf7c 101
wolfSSL 15:117db924cf7c 102 #ifdef WOLFSSL_ASYNC_CRYPT
wolfSSL 15:117db924cf7c 103 WC_ASYNC_DEV asyncDev;
wolfSSL 15:117db924cf7c 104 #endif /* WOLFSSL_ASYNC_CRYPT */
wolfSSL 16:8e0d178b1d1e 105 #if defined(WOLFSSL_HASH_FLAGS) || defined(WOLF_CRYPTO_CB)
wolfSSL 16:8e0d178b1d1e 106 word32 flags; /* enum wc_HashFlags in hash.h */
wolfSSL 15:117db924cf7c 107 #endif
wolfSSL 16:8e0d178b1d1e 108 };
wolfSSL 16:8e0d178b1d1e 109
wolfSSL 16:8e0d178b1d1e 110 #ifndef WC_SHA3_TYPE_DEFINED
wolfSSL 16:8e0d178b1d1e 111 typedef struct Sha3 wc_Sha3;
wolfSSL 16:8e0d178b1d1e 112 #define WC_SHA3_TYPE_DEFINED
wolfSSL 16:8e0d178b1d1e 113 #endif
wolfSSL 16:8e0d178b1d1e 114
wolfSSL 16:8e0d178b1d1e 115 #endif
wolfSSL 16:8e0d178b1d1e 116
wolfSSL 16:8e0d178b1d1e 117 typedef wc_Sha3 wc_Shake;
wolfSSL 15:117db924cf7c 118
wolfSSL 15:117db924cf7c 119
wolfSSL 15:117db924cf7c 120 WOLFSSL_API int wc_InitSha3_224(wc_Sha3*, void*, int);
wolfSSL 15:117db924cf7c 121 WOLFSSL_API int wc_Sha3_224_Update(wc_Sha3*, const byte*, word32);
wolfSSL 15:117db924cf7c 122 WOLFSSL_API int wc_Sha3_224_Final(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 123 WOLFSSL_API void wc_Sha3_224_Free(wc_Sha3*);
wolfSSL 15:117db924cf7c 124 WOLFSSL_API int wc_Sha3_224_GetHash(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 125 WOLFSSL_API int wc_Sha3_224_Copy(wc_Sha3* src, wc_Sha3* dst);
wolfSSL 15:117db924cf7c 126
wolfSSL 15:117db924cf7c 127 WOLFSSL_API int wc_InitSha3_256(wc_Sha3*, void*, int);
wolfSSL 15:117db924cf7c 128 WOLFSSL_API int wc_Sha3_256_Update(wc_Sha3*, const byte*, word32);
wolfSSL 15:117db924cf7c 129 WOLFSSL_API int wc_Sha3_256_Final(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 130 WOLFSSL_API void wc_Sha3_256_Free(wc_Sha3*);
wolfSSL 15:117db924cf7c 131 WOLFSSL_API int wc_Sha3_256_GetHash(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 132 WOLFSSL_API int wc_Sha3_256_Copy(wc_Sha3* src, wc_Sha3* dst);
wolfSSL 15:117db924cf7c 133
wolfSSL 15:117db924cf7c 134 WOLFSSL_API int wc_InitSha3_384(wc_Sha3*, void*, int);
wolfSSL 15:117db924cf7c 135 WOLFSSL_API int wc_Sha3_384_Update(wc_Sha3*, const byte*, word32);
wolfSSL 15:117db924cf7c 136 WOLFSSL_API int wc_Sha3_384_Final(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 137 WOLFSSL_API void wc_Sha3_384_Free(wc_Sha3*);
wolfSSL 15:117db924cf7c 138 WOLFSSL_API int wc_Sha3_384_GetHash(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 139 WOLFSSL_API int wc_Sha3_384_Copy(wc_Sha3* src, wc_Sha3* dst);
wolfSSL 15:117db924cf7c 140
wolfSSL 15:117db924cf7c 141 WOLFSSL_API int wc_InitSha3_512(wc_Sha3*, void*, int);
wolfSSL 15:117db924cf7c 142 WOLFSSL_API int wc_Sha3_512_Update(wc_Sha3*, const byte*, word32);
wolfSSL 15:117db924cf7c 143 WOLFSSL_API int wc_Sha3_512_Final(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 144 WOLFSSL_API void wc_Sha3_512_Free(wc_Sha3*);
wolfSSL 15:117db924cf7c 145 WOLFSSL_API int wc_Sha3_512_GetHash(wc_Sha3*, byte*);
wolfSSL 15:117db924cf7c 146 WOLFSSL_API int wc_Sha3_512_Copy(wc_Sha3* src, wc_Sha3* dst);
wolfSSL 15:117db924cf7c 147
wolfSSL 16:8e0d178b1d1e 148 WOLFSSL_API int wc_InitShake256(wc_Shake*, void*, int);
wolfSSL 16:8e0d178b1d1e 149 WOLFSSL_API int wc_Shake256_Update(wc_Shake*, const byte*, word32);
wolfSSL 16:8e0d178b1d1e 150 WOLFSSL_API int wc_Shake256_Final(wc_Shake*, byte*, word32);
wolfSSL 16:8e0d178b1d1e 151 WOLFSSL_API void wc_Shake256_Free(wc_Shake*);
wolfSSL 16:8e0d178b1d1e 152 WOLFSSL_API int wc_Shake256_Copy(wc_Shake* src, wc_Sha3* dst);
wolfSSL 16:8e0d178b1d1e 153
wolfSSL 16:8e0d178b1d1e 154 #if defined(WOLFSSL_HASH_FLAGS) || defined(WOLF_CRYPTO_CB)
wolfSSL 16:8e0d178b1d1e 155 WOLFSSL_API int wc_Sha3_SetFlags(wc_Sha3* sha3, word32 flags);
wolfSSL 16:8e0d178b1d1e 156 WOLFSSL_API int wc_Sha3_GetFlags(wc_Sha3* sha3, word32* flags);
wolfSSL 16:8e0d178b1d1e 157 #endif
wolfSSL 16:8e0d178b1d1e 158
wolfSSL 15:117db924cf7c 159 #ifdef __cplusplus
wolfSSL 15:117db924cf7c 160 } /* extern "C" */
wolfSSL 15:117db924cf7c 161 #endif
wolfSSL 15:117db924cf7c 162
wolfSSL 15:117db924cf7c 163 #endif /* WOLFSSL_SHA3 */
wolfSSL 15:117db924cf7c 164 #endif /* WOLF_CRYPT_SHA3_H */
wolfSSL 15:117db924cf7c 165
wolfSSL 15:117db924cf7c 166