libmicrohttpd2

HTTP server C library (MHD 2.x, alpha)
Log | Files | Refs | README | LICENSE

sha256_int.h (4280B)

      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-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/sha256.h
     41  * @brief  Calculation of SHA-256 digest
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_SHA256_INT_H
     46 #define MHD_SHA256_INT_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 /**
     70  * Size of SHA-256 digest in bytes
     71  */
     72 #define mhd_SHA256_DIGEST_SIZE \
     73         (mhd_SHA256_DIGEST_SIZE_WORDS * mhd_SHA256_BYTES_IN_WORD)
     74 
     75 /**
     76  * Size of single processing block in bits
     77  */
     78 #define mhd_SHA256_BLOCK_SIZE_BITS 512
     79 
     80 /**
     81  * Size of single processing block in bytes
     82  */
     83 #define mhd_SHA256_BLOCK_SIZE (mhd_SHA256_BLOCK_SIZE_BITS / 8)
     84 
     85 /**
     86  * Size of single processing block in bytes
     87  */
     88 #define mhd_SHA256_BLOCK_SIZE_WORDS \
     89         (mhd_SHA256_BLOCK_SIZE_BITS / mhd_SHA256_WORD_SIZE_BITS)
     90 
     91 
     92 struct mhd_Sha256CtxInt
     93 {
     94   uint32_t H[mhd_SHA256_DIGEST_SIZE_WORDS];     /**< Intermediate hash value / digest at end of calculation */
     95   uint32_t buffer[mhd_SHA256_BLOCK_SIZE_WORDS]; /**< SHA256 input data buffer */
     96   uint64_t count;                               /**< number of bytes, mod 2^64 */
     97 };
     98 
     99 /**
    100  * Initialise structure for SHA-256 calculation.
    101  *
    102  * @param ctx must be a `struct mhd_Sha256CtxInt *`
    103  */
    104 MHD_INTERNAL void
    105 mhd_SHA256_init (struct mhd_Sha256CtxInt *ctx)
    106 MHD_FN_PAR_NONNULL_ALL_;
    107 
    108 
    109 /**
    110  * Process portion of bytes.
    111  *
    112  * @param ctx must be a `struct mhd_Sha256CtxInt *`
    113  * @param size number of bytes in @a data
    114  * @param data bytes to add to hash
    115  */
    116 MHD_INTERNAL void
    117 mhd_SHA256_update (struct mhd_Sha256CtxInt *restrict ctx,
    118                    size_t size,
    119                    const uint8_t *restrict data)
    120 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_IN_SIZE_ (3, 2);
    121 
    122 
    123 /**
    124  * Finalise SHA256 calculation, return digest.
    125  *
    126  * @param ctx must be a `struct mhd_Sha256CtxInt *`
    127  * @param[out] digest set to the hash, must be #mhd_SHA256_DIGEST_SIZE bytes
    128  */
    129 MHD_INTERNAL void
    130 mhd_SHA256_finish (struct mhd_Sha256CtxInt *restrict ctx,
    131                    uint8_t digest[mhd_SHA256_DIGEST_SIZE])
    132 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (2);
    133 
    134 /**
    135  * Indicates that function mhd_SHA256_finish() (without context reset) is available
    136  */
    137 #define mhd_SHA256_HAS_FINISH 1
    138 
    139 #endif /* MHD_SHA256_INT_H */