request_auth_get.h (3646B)
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/request_auth_get.h 41 * @brief The declaration of the request Authorization header parsing helper 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_REQUEST_AUTH_GET_H 46 #define MHD_REQUEST_AUTH_GET_H 1 47 48 #include "mhd_sys_options.h" 49 50 #if ! defined(MHD_SUPPORT_AUTH_BASIC) && ! defined(MHD_SUPPORT_AUTH_DIGEST) 51 #error Authorization header parsing must be enabled 52 #endif 53 54 #include "sys_bool_type.h" 55 56 struct MHD_String; /* forward declaration */ 57 struct MHD_Request; /* forward declaration */ 58 59 /** 60 * The type of Authorization header to look for 61 */ 62 enum MHD_FIXED_ENUM_ mhd_AuthHeaderKind 63 { 64 #ifdef MHD_SUPPORT_AUTH_BASIC 65 mhd_AUTH_HDR_BASIC, 66 #endif 67 #ifdef MHD_SUPPORT_AUTH_DIGEST 68 mhd_AUTH_HDR_DIGEST, 69 #endif 70 #ifdef MHD_ENUMS_NEED_TRAILING_VALUE 71 mhd_AUTH_HDR_KIND_SENTINEL 72 #endif 73 }; 74 75 76 /** 77 * Get value of the specific Authorization header 78 * 79 * This function supports multiple types of the Authorization headers in 80 * one request, but does not parse each header for several types of 81 * Authorization. This should not be a limitation as RFC 7235 (section 4.2) 82 * allows only one type of Authorization in each request. 83 * 84 * @param request the request to use 85 * @param auth_type the type of Authorization to get 86 * @param[out] header_value the value of the Authorization header, excluding 87 * the prefix (type) and initial whitespaces 88 * @return 'true' if requested header found, 89 * 'false' otherwise (@a header_value not set) 90 */ 91 MHD_INTERNAL bool 92 mhd_request_get_auth_header_value (struct MHD_Request *restrict request, 93 enum mhd_AuthHeaderKind auth_type, 94 struct MHD_String *restrict header_value) 95 MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_ (3); 96 97 #endif /* ! MHD_REQUEST_AUTH_GET_H */