sha512_256_builtin.h (6171B)
1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */ 2 /* 3 This file is part of GNU libmicrohttpd. 4 Copyright (C) 2022-2026 Evgeny Grin (Karlson2k) 5 6 GNU libmicrohttpd is free software; you can redistribute it and/or 7 modify it under the terms of the GNU Lesser General Public 8 License as published by the Free Software Foundation; either 9 version 2.1 of the License, or (at your option) any later version. 10 11 GNU libmicrohttpd is distributed in the hope that it will be useful, 12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 Lesser General Public License for more details. 15 16 Alternatively, you can redistribute GNU libmicrohttpd and/or 17 modify it under the terms of the GNU General Public License as 18 published by the Free Software Foundation; either version 2 of 19 the License, or (at your option) any later version, together 20 with the eCos exception, as follows: 21 22 As a special exception, if other files instantiate templates or 23 use macros or inline functions from this file, or you compile this 24 file and link it with other works to produce a work based on this 25 file, this file does not by itself cause the resulting work to be 26 covered by the GNU General Public License. However the source code 27 for this file must still be made available in accordance with 28 section (3) of the GNU General Public License v2. 29 30 This exception does not invalidate any other reasons why a work 31 based on this file might be covered by the GNU General Public 32 License. 33 34 You should have received copies of the GNU Lesser General Public 35 License and the GNU General Public License along with this library; 36 if not, see <https://www.gnu.org/licenses/>. 37 */ 38 39 /** 40 * @file src/mhd2/sha512_256_builtin.h 41 * @brief Calculation of SHA-512/256 digest, built-in implementation 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_SHA512_256_BUILTIN_H 46 #define MHD_SHA512_256_BUILTIN_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_base_types.h" 51 52 53 /** 54 * Number of bits in single SHA-512/256 word. 55 */ 56 #define mhd_SHA512_256_WORD_SIZE_BITS 64 57 58 /** 59 * Number of bytes in single SHA-512/256 word. 60 */ 61 #define mhd_SHA512_256_BYTES_IN_WORD (mhd_SHA512_256_WORD_SIZE_BITS / 8) 62 63 /** 64 * Hash is kept internally as 8 64-bit words. 65 * This is the intermediate hash size, used while computing the final digest. 66 */ 67 #define mhd_SHA512_256_HASH_SIZE_WORDS 8 68 69 /** 70 * Size of SHA-512/256 resulting digest in words. 71 * This is the final digest size, not the intermediate hash. 72 */ 73 #define mhd_SHA512_256_DIGEST_SIZE_WORDS (mhd_SHA512_256_HASH_SIZE_WORDS / 2) 74 75 #ifndef mhd_SHA512_256_DIGEST_SIZE 76 /** 77 * Size of SHA-512/256 resulting digest in bytes. 78 * This is the final digest size, not the intermediate hash. 79 */ 80 # define mhd_SHA512_256_DIGEST_SIZE \ 81 (mhd_SHA512_256_DIGEST_SIZE_WORDS * mhd_SHA512_256_BYTES_IN_WORD) 82 #endif 83 84 /** 85 * Size of SHA-512/256 single processing block in bits. 86 */ 87 #define mhd_SHA512_256_BLOCK_SIZE_BITS 1024 88 89 /** 90 * Size of SHA-512/256 single processing block in bytes. 91 */ 92 #define mhd_SHA512_256_BLOCK_SIZE (mhd_SHA512_256_BLOCK_SIZE_BITS / 8) 93 94 /** 95 * Size of SHA-512/256 single processing block in words. 96 */ 97 #define mhd_SHA512_256_BLOCK_SIZE_WORDS \ 98 (mhd_SHA512_256_BLOCK_SIZE_BITS / mhd_SHA512_256_WORD_SIZE_BITS) 99 100 101 /** 102 * SHA-512/256 calculation context 103 */ 104 struct mhd_Sha512_256CtxBlti 105 { 106 uint64_t H[mhd_SHA512_256_HASH_SIZE_WORDS]; /**< Intermediate hash value */ 107 uint64_t buffer[mhd_SHA512_256_BLOCK_SIZE_WORDS]; /**< SHA512_256 input data buffer */ 108 /** 109 * The number of bytes, lower part 110 */ 111 uint64_t count; 112 /** 113 * The number of bits, high part. 114 * Unlike lower part, this counts the number of bits, not bytes. 115 */ 116 uint64_t count_bits_hi; 117 }; 118 119 /** 120 * Indicates whether struct mhd_Sha512_256CtxBlti has an 'ext_error' member. 121 * 122 * Set to '0' when the structure has no 'ext_error' member. 123 */ 124 #define mhd_SHA512_256_BLTI_EXT_ERROR_FLAG 0 125 126 /** 127 * Initialise the context for SHA-512/256 calculation. 128 * 129 * This function must not be called more than once for @a ctx without an 130 * intervening #mhd_SHA512_256_blti_deinit(). 131 * 132 * @param ctx the calculation context 133 */ 134 MHD_INTERNAL void 135 mhd_SHA512_256_blti_init (struct mhd_Sha512_256CtxBlti *ctx) 136 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (1); 137 138 /** 139 * Add a portion of data to the SHA-512/256 calculation. 140 * 141 * @param ctx the calculation context 142 * @param size number of bytes in @a data, must not be 0 143 * @param data bytes to add to hash 144 */ 145 MHD_INTERNAL void 146 mhd_SHA512_256_blti_update (struct mhd_Sha512_256CtxBlti *restrict ctx, 147 size_t size, 148 const void *restrict data) 149 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1) MHD_FN_PAR_IN_SIZE_ (3, 2); 150 151 /** 152 * Finalise the SHA-512/256 calculation and return the digest. 153 * 154 * @param ctx the calculation context 155 * @param[out] digest set to the hash, must be #mhd_SHA512_256_DIGEST_SIZE bytes 156 */ 157 MHD_INTERNAL void 158 mhd_SHA512_256_blti_finish ( 159 struct mhd_Sha512_256CtxBlti *restrict ctx, 160 uint8_t digest[MHD_FN_PAR_FIX_ARR_SIZE_ (mhd_SHA512_256_DIGEST_SIZE)]) 161 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1) MHD_FN_PAR_OUT_ (2); 162 163 /** 164 * Reset the context for a new SHA-512/256 calculation. 165 * 166 * This function may be called only after #mhd_SHA512_256_blti_finish(). If the 167 * context is subsequently reused for a new calculation, this function must be 168 * called before starting that calculation. 169 * 170 * @param ctx the calculation context 171 */ 172 #define mhd_SHA512_256_blti_reset(ctx) mhd_SHA512_256_blti_init((ctx)) 173 174 /** 175 * Deinitialise the SHA-512/256 calculation context. 176 * 177 * After calling this function, @a ctx can be reinitialised with 178 * #mhd_SHA512_256_blti_init(). 179 * 180 * @param ctx the calculation context 181 */ 182 #define mhd_SHA512_256_blti_deinit(ctx) ((void) (ctx)) 183 184 /** 185 * Indicates whether #mhd_SHA512_256_blti_deinit() is a real function or a 186 * no-op. 187 * 188 * Set to '1' as #mhd_SHA512_256_blti_deinit() is a no-op. 189 */ 190 #define mhd_SHA512_256_BLTI_DEINIT_NOOP_FLAG 1 191 192 #endif /* MHD_SHA512_256_BUILTIN_H */