auth_basic.h (2664B)
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_basic.h 41 * @brief The declaration of the Basic Authorization header parser 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_AUTH_BASIC_H 46 #define MHD_AUTH_BASIC_H 1 47 48 #include "mhd_sys_options.h" 49 50 #if ! defined(MHD_SUPPORT_AUTH_BASIC) 51 #error Basic Authorization must be enabled 52 #endif 53 54 #include "mhd_public_api.h" 55 56 /** 57 * Find in request and parse Basic Authentication information 58 * @param req the request to use 59 * @param[out] v_auth_basic_creds the pointer to set to the found data 60 * @return #MHD_SC_OK on success, 61 * error code otherwise 62 */ 63 MHD_INTERNAL enum MHD_StatusCode 64 mhd_request_get_auth_basic_creds ( 65 struct MHD_Request *restrict req, 66 const struct MHD_AuthBasicCreds **restrict v_auth_basic_creds) 67 MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (2); 68 69 #endif /* ! MHD_AUTH_BASIC_H */