libmicrohttpd2

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

md5_ext.h (3899B)

      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  * @file src/mhd2/md5_ext.h
     40  * @brief  Wrapper declarations for MD5 calculation performed by TLS library
     41  * @author Karlson2k (Evgeny Grin)
     42  */
     43 #ifndef MHD_MD5_EXT_H
     44 #define MHD_MD5_EXT_H 1
     45 
     46 #include "mhd_sys_options.h"
     47 
     48 #include "sys_base_types.h"
     49 
     50 /**
     51  * Size of MD5 resulting digest in bytes
     52  * This is the final digest size, not intermediate hash.
     53  */
     54 #define mhd_MD5_DIGEST_SIZE (16)
     55 
     56 #ifndef MHD_MD5_Context
     57 #define MHD_MD5_Context void
     58 #endif
     59 
     60 /**
     61  * Indicates that struct mhd_Md5CtxExt has 'ext_error'
     62  */
     63 #define mhd_MD5_HAS_EXT_ERROR 1
     64 
     65 /**
     66  * MD5 calculation context
     67  */
     68 struct mhd_Md5CtxExt
     69 {
     70   MHD_MD5_Context *handle; /**< Hash calculation handle */
     71   int ext_error; /**< Non-zero if external error occurs during init or hashing */
     72 };
     73 
     74 /**
     75  * Indicates that mhd_MD5_init_one_time() function is present.
     76  */
     77 #define mhd_MD5_HAS_INIT_ONE_TIME 1
     78 
     79 /**
     80  * Initialise structure for MD5 calculation, allocate resources.
     81  *
     82  * This function must not be called more than one time for @a ctx.
     83  *
     84  * @param ctx the calculation context
     85  */
     86 void
     87 mhd_MD5_init_one_time (struct mhd_Md5CtxExt *ctx);
     88 
     89 
     90 /**
     91  * MD5 process portion of bytes.
     92  *
     93  * @param ctx the calculation context
     94  * @param size number of bytes in @a data, must not be 0
     95  * @param data bytes to add to hash
     96  */
     97 void
     98 mhd_MD5_update (struct mhd_Md5CtxExt *restrict ctx,
     99                 size_t size,
    100                 const uint8_t *restrict data);
    101 
    102 
    103 /**
    104  * Indicates that mhd_MD5_finish_reset() function is available
    105  */
    106 #define mhd_MD5_HAS_FINISH_RESET 1
    107 
    108 /**
    109  * Finalise MD5 calculation, return digest, reset hash calculation.
    110  *
    111  * @param ctx the calculation context
    112  * @param[out] digest set to the hash, must be #mhd_MD5_DIGEST_SIZE bytes
    113  */
    114 void
    115 mhd_MD5_finish_reset (struct mhd_Md5CtxExt *restrict ctx,
    116                       uint8_t digest[mhd_MD5_DIGEST_SIZE]);
    117 
    118 /**
    119  * Indicates that mhd_MD5_deinit() function is present
    120  */
    121 #define mhd_MD5_HAS_DEINIT 1
    122 
    123 /**
    124  * Free allocated resources.
    125  *
    126  * @param[in] ctx the calculation context
    127  */
    128 void
    129 mhd_MD5_deinit (struct mhd_Md5CtxExt *ctx);
    130 
    131 #endif /* MHD_MD5_EXT_H */