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