sha512_256_int.h (4903B)
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-2024 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.h 41 * @brief Calculation of SHA-512/256 digest 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_SHA512_256_INT_H 46 #define MHD_SHA512_256_INT_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 intermediate hash size, used during 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 intermediate hash. 72 */ 73 #define mhd_SHA512_256_DIGEST_SIZE_WORDS (mhd_SHA512_256_HASH_SIZE_WORDS / 2) 74 75 /** 76 * Size of SHA-512/256 resulting digest in bytes. 77 * This is the final digest size, not intermediate hash. 78 */ 79 #define mhd_SHA512_256_DIGEST_SIZE \ 80 (mhd_SHA512_256_DIGEST_SIZE_WORDS * mhd_SHA512_256_BYTES_IN_WORD) 81 82 /** 83 * Size of SHA-512/256 single processing block in bits. 84 */ 85 #define mhd_SHA512_256_BLOCK_SIZE_BITS 1024 86 87 /** 88 * Size of SHA-512/256 single processing block in bytes. 89 */ 90 #define mhd_SHA512_256_BLOCK_SIZE (mhd_SHA512_256_BLOCK_SIZE_BITS / 8) 91 92 /** 93 * Size of SHA-512/256 single processing block in words. 94 */ 95 #define mhd_SHA512_256_BLOCK_SIZE_WORDS \ 96 (mhd_SHA512_256_BLOCK_SIZE_BITS / mhd_SHA512_256_WORD_SIZE_BITS) 97 98 99 /** 100 * SHA-512/256 calculation context 101 */ 102 struct mhd_Sha512_256CtxInt 103 { 104 uint64_t H[mhd_SHA512_256_HASH_SIZE_WORDS]; /**< Intermediate hash value */ 105 uint64_t buffer[mhd_SHA512_256_BLOCK_SIZE_WORDS]; /**< SHA512_256 input data buffer */ 106 /** 107 * The number of bytes, lower part 108 */ 109 uint64_t count; 110 /** 111 * The number of bits, high part. 112 * Unlike lower part, this counts the number of bits, not bytes. 113 */ 114 uint64_t count_bits_hi; 115 }; 116 117 /** 118 * Initialise structure for SHA-512/256 calculation. 119 * 120 * @param ctx the calculation context 121 */ 122 MHD_INTERNAL void 123 mhd_SHA512_256_init (struct mhd_Sha512_256CtxInt *ctx) 124 MHD_FN_PAR_NONNULL_ALL_; 125 126 127 /** 128 * Process portion of bytes. 129 * 130 * @param ctx the calculation context 131 * @param size number of bytes in @a data, must not be 0 132 * @param data bytes to add to hash 133 */ 134 MHD_INTERNAL void 135 mhd_SHA512_256_update (struct mhd_Sha512_256CtxInt *restrict ctx, 136 size_t size, 137 const uint8_t *restrict data) 138 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_IN_SIZE_ (3, 2); 139 140 141 /** 142 * Finalise SHA-512/256 calculation, return digest. 143 * 144 * @param ctx the calculation context 145 * @param[out] digest set to the hash, must be #mhd_SHA512_256_DIGEST_SIZE bytes 146 */ 147 MHD_INTERNAL void 148 mhd_SHA512_256_finish (struct mhd_Sha512_256CtxInt *restrict ctx, 149 uint8_t digest[mhd_SHA512_256_DIGEST_SIZE]) 150 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (2); 151 152 /** 153 * Indicates that function mhd_SHA512_256_finish() (without context reset) is 154 * available 155 */ 156 #define mhd_SHA512_256_HAS_FINISH 1 157 158 #endif /* MHD_SHA512_256_H */