sha256_builtin.h (5498B)
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) 2019-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/sha256_builtin.h 41 * @brief Calculation of SHA-256 digest, built-in implementation 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_SHA256_BUILTIN_H 46 #define MHD_SHA256_BUILTIN_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_base_types.h" 51 52 53 /** 54 * Digest is kept internally as 8 32-bit words. 55 */ 56 #define mhd_SHA256_DIGEST_SIZE_WORDS 8 57 58 /** 59 * Number of bits in single SHA-256 word 60 */ 61 #define mhd_SHA256_WORD_SIZE_BITS 32 62 63 /** 64 * Number of bytes in single SHA-256 word 65 * used to process data 66 */ 67 #define mhd_SHA256_BYTES_IN_WORD (mhd_SHA256_WORD_SIZE_BITS / 8) 68 69 #ifndef mhd_SHA256_DIGEST_SIZE 70 /** 71 * Size of SHA-256 digest in bytes 72 */ 73 # define mhd_SHA256_DIGEST_SIZE \ 74 (mhd_SHA256_DIGEST_SIZE_WORDS * mhd_SHA256_BYTES_IN_WORD) 75 #endif 76 77 /** 78 * Size of single processing block in bits 79 */ 80 #define mhd_SHA256_BLOCK_SIZE_BITS 512 81 82 /** 83 * Size of single processing block in bytes 84 */ 85 #define mhd_SHA256_BLOCK_SIZE (mhd_SHA256_BLOCK_SIZE_BITS / 8) 86 87 /** 88 * Size of single processing block in bytes 89 */ 90 #define mhd_SHA256_BLOCK_SIZE_WORDS \ 91 (mhd_SHA256_BLOCK_SIZE_BITS / mhd_SHA256_WORD_SIZE_BITS) 92 93 94 /** 95 * SHA-256 calculation context 96 */ 97 struct mhd_Sha256CtxBlti 98 { 99 uint32_t H[mhd_SHA256_DIGEST_SIZE_WORDS]; /**< Intermediate hash value / digest at end of calculation */ 100 uint32_t buffer[mhd_SHA256_BLOCK_SIZE_WORDS]; /**< SHA256 input data buffer */ 101 uint64_t count; /**< number of bytes, mod 2^64 */ 102 }; 103 104 /** 105 * Indicates whether struct mhd_Sha256CtxBlti has an 'ext_error' member. 106 * 107 * Set to '0' when the structure has no 'ext_error' member. 108 */ 109 #define mhd_SHA256_BLTI_EXT_ERROR_FLAG 0 110 111 /** 112 * Initialise the context for SHA-256 calculation. 113 * 114 * This function must not be called more than once for @a ctx without an 115 * intervening #mhd_SHA256_blti_deinit(). 116 * 117 * @param ctx the calculation context 118 */ 119 MHD_INTERNAL void 120 mhd_SHA256_blti_init (struct mhd_Sha256CtxBlti *ctx) 121 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (1); 122 123 /** 124 * Add a portion of data to the SHA-256 calculation. 125 * 126 * @param ctx the calculation context 127 * @param size number of bytes in @a data, must not be 0 128 * @param data bytes to add to hash 129 */ 130 MHD_INTERNAL void 131 mhd_SHA256_blti_update (struct mhd_Sha256CtxBlti *restrict ctx, 132 size_t size, 133 const void *restrict data) 134 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1) MHD_FN_PAR_IN_SIZE_ (3, 2); 135 136 /** 137 * Finalise the SHA-256 calculation and return the digest. 138 * 139 * @param ctx the calculation context 140 * @param[out] digest set to the hash, must be #mhd_SHA256_DIGEST_SIZE bytes 141 */ 142 MHD_INTERNAL void 143 mhd_SHA256_blti_finish ( 144 struct mhd_Sha256CtxBlti *restrict ctx, 145 uint8_t digest[MHD_FN_PAR_FIX_ARR_SIZE_ (mhd_SHA256_DIGEST_SIZE)]) 146 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1) MHD_FN_PAR_OUT_ (2); 147 148 /** 149 * Reset the context for a new SHA-256 calculation. 150 * 151 * This function may be called only after #mhd_SHA256_blti_finish(). If the 152 * context is subsequently reused for a new calculation, this function must be 153 * called before starting that calculation. 154 * 155 * @param ctx the calculation context 156 */ 157 #define mhd_SHA256_blti_reset(ctx) mhd_SHA256_blti_init((ctx)) 158 159 /** 160 * Deinitialise the SHA-256 calculation context. 161 * 162 * After calling this function, @a ctx can be reinitialised with 163 * #mhd_SHA256_blti_init(). 164 * 165 * @param ctx the calculation context 166 */ 167 #define mhd_SHA256_blti_deinit(ctx) ((void) (ctx)) 168 169 /** 170 * Indicates whether #mhd_SHA256_blti_deinit() is a real function or a no-op. 171 * 172 * Set to '1' as #mhd_SHA256_blti_deinit() is a no-op. 173 */ 174 #define mhd_SHA256_BLTI_DEINIT_NOOP_FLAG 1 175 176 #endif /* MHD_SHA256_BUILTIN_H */