auth_digest.h (3388B)
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) 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/auth_digest.h 41 * @brief The declaration of the Digest Authorization internal functions 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_AUTH_DIGEST_H 46 #define MHD_AUTH_DIGEST_H 1 47 48 #include "mhd_sys_options.h" 49 50 #if ! defined(MHD_SUPPORT_AUTH_DIGEST) 51 #error Digest Authorization must be enabled 52 #endif 53 54 #include "sys_bool_type.h" 55 #include "sys_base_types.h" 56 57 #include "mhd_digest_auth_data.h" 58 59 #include "mhd_public_api.h" 60 61 struct MHD_Connection; /* forward declaration */ 62 struct MHD_Request; /* forward declaration */ 63 64 /** 65 * Generate new nonce for Digest Auth, put the nonce in text form to the buffer 66 * @param c the connection to use // TODO: replace with daemon object 67 * @param out_buf the output buffer to put the generated nonce, 68 * NOT zero terminated 69 * @return 'true' if succeed, 70 * 'false' otherwise 71 */ 72 MHD_INTERNAL bool 73 mhd_auth_digest_get_new_nonce (struct MHD_Connection *restrict c, 74 char out_buf[mhd_AUTH_DIGEST_NONCE_LEN]) 75 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (2); 76 77 /** 78 * Find in request and parse Digest Authentication information 79 * @param req the request to use 80 * @param[out] v_auth_digest_info the pointer to set to the found data 81 * @return #MHD_SC_OK on success, 82 * error code otherwise 83 */ 84 MHD_INTERNAL enum MHD_StatusCode 85 mhd_request_get_auth_digest_info ( 86 struct MHD_Request *restrict req, 87 const struct MHD_AuthDigestInfo **restrict v_auth_digest_info) 88 MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (2); 89 90 #endif /* ! MHD_AUTH_DIGEST_H */