libmicrohttpd2

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

microhttpd2_preamble.h.in (139464B)


      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) 2006-2025 Christian Grothoff, Karlson2k (Evgeny Grin)
      5   (and other contributing authors)
      6 
      7   GNU libmicrohttpd is free software; you can redistribute it and/or
      8   modify it under the terms of the GNU Lesser General Public
      9   License as published by the Free Software Foundation; either
     10   version 2.1 of the License, or (at your option) any later version.
     11 
     12   GNU libmicrohttpd is distributed in the hope that it will be useful,
     13   but WITHOUT ANY WARRANTY; without even the implied warranty of
     14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     15   Lesser General Public License for more details.
     16 
     17   Alternatively, you can redistribute GNU libmicrohttpd and/or
     18   modify it under the terms of the GNU General Public License as
     19   published by the Free Software Foundation; either version 2 of
     20   the License, or (at your option) any later version, together
     21   with the eCos exception, as follows:
     22 
     23     As a special exception, if other files instantiate templates or
     24     use macros or inline functions from this file, or you compile this
     25     file and link it with other works to produce a work based on this
     26     file, this file does not by itself cause the resulting work to be
     27     covered by the GNU General Public License. However the source code
     28     for this file must still be made available in accordance with
     29     section (3) of the GNU General Public License v2.
     30 
     31     This exception does not invalidate any other reasons why a work
     32     based on this file might be covered by the GNU General Public
     33     License.
     34 
     35   You should have received copies of the GNU Lesser General Public
     36   License and the GNU General Public License along with this library;
     37   if not, see <https://www.gnu.org/licenses/>.
     38 */
     39 
     40 /*
     41   Main goals for the libmicrohttpd 2.0 API:
     42 
     43   - simplify application callbacks by splitting header/upload/post
     44     functionality currently provided by calling the same
     45     MHD_AccessHandlerCallback 3+ times into separate callbacks.
     46   - keep the API very simple for simple requests, but allow
     47     more complex logic to be incrementally introduced
     48     (via new struct MHD_Action construction)
     49   - avoid repeated scans for URL matches via the new
     50     struct MHD_Action construction
     51   - better types, in particular avoid varargs for options
     52   - make it harder to pass inconsistent options
     53   - combine options and flags into more uniform API (at least
     54     exterally!)
     55   - simplify API use by using sane defaults (benefiting from
     56     breaking backwards compatibility) and making all options
     57     really optional, and where applicable avoid having options
     58     where the default works if nothing is specified
     59   - simplify API by moving rarely used http_version into
     60     MHD_request_get_info_fixed()
     61   - avoid 'int' for MHD_YES/MHD_NO by introducing `enum MHD_Bool`
     62   - improve terminology by eliminating confusion between
     63     'request' and 'connection'; add 'session' for HTTP2/3;
     64     use clear separation between connection and request. Do not mix the kind
     65     data in the callbacks.  Currently we are mixing things in
     66     MHD_AccessHandlerCallback and MHD_RequestCompletedCallback. Instead of
     67     pointers to struct MHD_Connection we should use pointers to (new) struct
     68     MHD_Request.
     69   - prepare API for having multiple TLS backends
     70   - use more consistent prefixes for related functions
     71     by using MHD_subject_verb_object naming convention, also
     72     at the same time avoid symbol conflict with legacy names
     73     (so we can have one binary implementing old and new
     74     library API at the same time via compatibility layer).
     75   - make it impossible to queue a response at the wrong time
     76   - make it impossible to suspend a connection/request at the
     77     wrong time (improves thread-safety)
     78   - make it clear which response status codes are "properly"
     79     supported (include the descriptive string) by using an enum;
     80   - simplify API for common-case of one-shot responses by
     81     eliminating need for destroy response in most cases;
     82   - avoid fixed types, like uint32_t. They may not exist on some
     83     platforms. Instead use uint_fast32_t.
     84     It is also better for future-proof.
     85   - check portability for embedded platforms. Some of them support
     86     64 bits, but 'int' could be just 16 bits resulting of silently
     87     dropping enum values higher than 65535.
     88     => in general, more functions, fewer enums for setup
     89   - Avoid returning pointers to internal members. It is not thread-safe and
     90     even in single thread the value could change over the time. Prefer pointers to
     91     app-allocated memory with the size, like MHD_daemon_get_static_info(enum
     92     MHD_enum_name info_type, void *buf, size_t buf_size).
     93     => Except in cases where zero-copy matters.
     94   - Use separate app calls/functions for data the will not change for the
     95     lifetime of the object and dynamic data. The only difference should be the
     96     name. Like MHD_daemon_get_static_info(enum MHD_enum_name info_type, void *buf,
     97     size_t buf_size) MHD_daemon_get_dynamic_info(enum MHD_enum_name info_type,
     98     void *buf, size_t buf_size) Examples of static data: listen socket, number of
     99     workers, daemon flags.  Examples of dynamic data: number of connections,
    100     quiesce status.  It should give a clear idea whether the data could be changed
    101     over the time (could be not obvious for some data) and thus may change the
    102     approach how to use the data in app.  The same for: library, daemon,
    103     connection, request. Not sure that dynamic data makes sense for the library.
    104   - Define response code in response object. There are a very little
    105     chance that response body designed for 404 or 403 codes will be used with
    106     200 code. However, the responses body for 307 and 308 could be the same. So:
    107     Add default response code in response object.
    108   - Make responses unmodifiable after first use. It is not thread-safe.
    109     MHD-generated headers (Date, Connection/Keep-Alive) are again
    110     part of the *request* and do not count as part of the "response" here.
    111   - Remove "footers" from responses. With unmodifiable responses everything should
    112     be "headers". Add footers to *requests* instead.
    113   - Add API for adding request-specific response headers and footers. To
    114     simplify the things it should just copy the strings (to avoid dealing with
    115     complicated deinit of possible dynamic strings).  After this change it should
    116     be possible to simplify DAuth handling as response could be reused (currently
    117     403 responses are modified for each reply).
    118   - Control response behaviour mainly by response flags, not by additional
    119     headers (like MHD_RF_FORCE_CLOSE instead of "Connection: close").
    120     It is easier&faster for both: app and MHD.
    121   - Move response codes from MHD_HTTP_xxx namespace to MHD_HTTP_CODE_xxx
    122     namespace. It already may clash with other HTTP values.
    123   - Postprocessor is unusable night-mare when doing "stream processing"
    124     for tiny values where the application basically has to copy together
    125     the stream back into a single compact heap value, just making the
    126     parsing highly more complicated (see examples in Challenger)
    127   - non-stream processing variant for request bodies, give apps a
    128     way to request the full body in one buffer; give apps a way
    129     to request a 'large new allocation' for such buffers; give apps
    130     a way to specify a global quota for large allocations to ensure
    131     memory usage has a hard bound
    132 
    133   - Internals: carefully check where locking is really required. Probably
    134     separate locks. Check out-of-thread value reading. Currently code assumes
    135     atomic reading of values used in other threads, which mostly true on x86,
    136     but not OK on other arches. Probably use read/write locking to minimize
    137     the threads interference.
    138   - Internals: figure out how to do portable variant of cork/uncork
    139   - Internals: remove request data from memory pool when response is queued
    140     (IF no callbacks and thus data cannot be used anymore, or IF
    141      application permits explicitly per daemon) to get more space
    142     for building response;
    143   - Internals: Fix TCP FIN graceful closure issue for upgraded
    144     connections (API implications?)
    145 
    146 */
    147 
    148 #ifndef MICROHTTPD2_H
    149 #define MICROHTTPD2_H
    150 
    151 #ifndef __cplusplus
    152 #  define MHD_C_DECLRATIONS_START_HERE_   /* Empty */
    153 #  define MHD_C_DECLRATIONS_FINISH_HERE_  /* Empty */
    154 #else  /* __cplusplus */
    155 /* *INDENT-OFF* */
    156 #  define MHD_C_DECLRATIONS_START_HERE_   extern "C" {
    157 #  define MHD_C_DECLRATIONS_FINISH_HERE_  }
    158 /* *INDENT-ON* */
    159 #endif /* __cplusplus */
    160 
    161 MHD_C_DECLRATIONS_START_HERE_
    162 
    163 /**
    164  * Current version of the library in packed BCD form.
    165  * (For example, version 1.9.30-1 would be 0x01093001)
    166  */
    167 #define MHD_VERSION 0x01990001
    168 
    169 #include "microhttpd2_portability.h"
    170 
    171 /* If generic headers do not work on your platform, include headers that
    172    define 'va_list', 'size_t', 'uint_least16_t', 'uint_fast32_t',
    173    'uint_fast64_t', and 'struct sockaddr', and then
    174    add "#define MHD_HAVE_SYS_HEADERS_INCLUDED" before including "microhttpd2.h".
    175    When 'MHD_HAVE_SYS_HEADERS_INCLUDED' is defined, the following "standard"
    176    includes will not be used (which might be a good idea, especially on
    177    platforms where they do not exist).
    178    */
    179 #ifndef MHD_HAVE_SYS_HEADERS_INCLUDED
    180 #  include <stdarg.h>
    181 #  ifndef MHD_SYS_BASE_TYPES_H
    182 /* Headers for uint_fastXX_t, size_t */
    183 #    include <stdint.h>
    184 #    include <stddef.h>
    185 #    include <sys/types.h> /* This header is actually optional */
    186 #  endif
    187 #  ifndef MHD_SYS_SOCKET_TYPES_H
    188 /* Headers for 'struct sockaddr' */
    189 #    if ! defined(_WIN32) || defined(__CYGWIN__)
    190 #      include <sys/socket.h>
    191 #    else
    192 /* Prevent conflict of <winsock.h> and <winsock2.h> */
    193 #      if ! defined(_WINSOCK2API_) && ! defined(_WINSOCKAPI_)
    194 #        ifndef WIN32_LEAN_AND_MEAN
    195 /* Do not use unneeded parts of W32 headers. */
    196 #          define WIN32_LEAN_AND_MEAN 1
    197 #        endif /* !WIN32_LEAN_AND_MEAN */
    198 #        include <winsock2.h>
    199 #      endif
    200 #    endif
    201 #  endif
    202 #endif
    203 
    204 #ifndef MHD_BOOL_DEFINED
    205 
    206 /**
    207  * Representation of 'bool' in the public API as stdbool.h may not
    208  * always be available and presence of 'bool' keyword may depend on
    209  * used C version.
    210  * It is always safe to cast 'MHD_Bool' variable to 'bool' and vice versa.
    211  * Note: it may be UNSAFE to cast pointers 'MHD_Bool*' to 'bool*' and
    212  *       vice versa.
    213  */
    214 enum MHD_Bool
    215 {
    216 
    217   /**
    218    * MHD-internal return code for "NO".
    219    */
    220   MHD_NO = 0
    221   ,
    222   /**
    223    * MHD-internal return code for "YES".  All non-zero values
    224    * will be interpreted as "YES", but MHD will only ever
    225    * return #MHD_YES or #MHD_NO.
    226    */
    227   MHD_YES = 1
    228 };
    229 
    230 
    231 #define MHD_BOOL_DEFINED 1
    232 #endif /* ! MHD_BOOL_DEFINED */
    233 
    234 #ifndef MHD_STRINGS_DEFINED
    235 
    236 
    237 /**
    238  * String with length data.
    239  * This type should always have valid @a cstr pointer.
    240  */
    241 struct MHD_String
    242 {
    243   /**
    244    * Number of characters in @e str, not counting 0-termination.
    245    */
    246   size_t len;
    247 
    248   /**
    249    * 0-terminated C-string.
    250    * Must not be NULL.
    251    */
    252   const char *cstr;
    253 };
    254 
    255 /**
    256  * String with length data.
    257  * This type of data may have NULL as the @a cstr pointer.
    258  */
    259 struct MHD_StringNullable
    260 {
    261   /**
    262    * Number of characters in @e cstr, not counting 0-termination.
    263    * If @a cstr is NULL, it must be zero.
    264    */
    265   size_t len;
    266 
    267   /**
    268    * 0-terminated C-string.
    269    * In some cases it could be NULL.
    270    */
    271   const char *cstr;
    272 };
    273 
    274 #define MHD_STRINGS_DEFINED 1
    275 #endif /* ! MHD_STRINGS_DEFINED */
    276 
    277 
    278 #ifndef MHD_INVALID_SOCKET
    279 #  if ! defined(_WIN32) || defined(_SYS_TYPES_FD_SET)
    280 #    define MHD_SOCKETS_KIND_POSIX 1
    281 /**
    282  * MHD_Socket is a type for socket FDs
    283  */
    284 typedef int MHD_Socket;
    285 #    define MHD_INVALID_SOCKET (-1)
    286 #  else /* !defined(_WIN32) || defined(_SYS_TYPES_FD_SET) */
    287 #    define MHD_SOCKETS_KIND_WINSOCK 1
    288 /**
    289  * MHD_Socket is a type for socket FDs
    290  */
    291 typedef SOCKET MHD_Socket;
    292 #    define MHD_INVALID_SOCKET (INVALID_SOCKET)
    293 #  endif /* !defined(_WIN32) || defined(_SYS_TYPES_FD_SET) */
    294 #endif /* MHD_INVALID_SOCKET */
    295 
    296 
    297 /**
    298  * Constant used to indicate unknown size (use when creating a response).
    299  * Any possible larger sizes are interpreted as the same value.
    300  */
    301 #ifdef UINT64_MAX
    302 #  define MHD_SIZE_UNKNOWN UINT64_MAX
    303 #else
    304 #  define MHD_SIZE_UNKNOWN \
    305         MHD_STATIC_CAST_ (uint_fast64_t,0xffffffffffffffffU)
    306 #endif
    307 
    308 
    309 /**
    310  * Constant used to indicate unlimited wait time.
    311  * Any possible larger values are interpreted as this value.
    312  */
    313 #ifdef UINT64_MAX
    314 #  define MHD_WAIT_INDEFINITELY UINT64_MAX
    315 #else
    316 #  define MHD_WAIT_INDEFINITELY \
    317         MHD_STATIC_CAST_ (uint_fast64_t,0xffffffffffffffffU)
    318 #endif
    319 
    320 
    321 /* ********** (a) Core HTTP Processing ************ */
    322 
    323 
    324 /**
    325  * @brief Handle for a daemon that listens for requests.
    326  *
    327  * Manages the listen socket, event loop, optional threads and server
    328  * settings.
    329  *
    330  * @defgroup daemon HTTP server handling client connections
    331  */
    332 struct MHD_Daemon;
    333 
    334 
    335 /**
    336  * @brief Handle/identifier of a network connection abstraction.
    337  *
    338  * A single network (i.e. TCP) connection can be used for
    339  * a single (in HTTP/1.1) data stream.
    340  *
    341  * @defgroup connection client connection with streams
    342  */
    343 struct MHD_Connection;
    344 
    345 
    346 /**
    347  * @brief Handle/identifier of a data stream over network
    348  * connection.
    349  *
    350  * A data stream may be used for multiple requests, which
    351  * in HTTP/1.1 must be processed sequentially.
    352  *
    353  * @defgroup stream stream of HTTP requests
    354  */
    355 struct MHD_Stream;
    356 
    357 /**
    358  * @brief Handle representing an HTTP request.
    359  *
    360  * With HTTP/1.1, multiple requests can be run over the same
    361  * stream.  However, MHD will only show one request per data
    362  * stream to the client at any given time.
    363  *
    364  * Replaces `struct MHD_Connection` in the API prior to version 2.0.0,
    365  * renamed to better reflect what this object truly represents to
    366  * the application using MHD.
    367  *
    368  * @defgroup request HTTP requests
    369  */
    370 struct MHD_Request;
    371 
    372 
    373 /**
    374  * @brief Actions are returned by the application when processed client header
    375  * to drive the request handling of MHD.
    376  *
    377  * @defgroup action Request actions
    378  */
    379 struct MHD_Action;
    380 
    381 
    382 /**
    383  * @brief Actions are returned by the application when processing client upload
    384  * to drive the request handling of MHD.
    385  *
    386  * @defgroup action Request actions
    387  */
    388 struct MHD_UploadAction;
    389 
    390 /**
    391  * @defgroup general Primary MHD functions and data
    392  */
    393 
    394 /**
    395  * @defgroup specialized Introspection and other special control
    396  */
    397 
    398 /**
    399  * @defgroup authentication Digest and other HTTP authentications
    400  */
    401 
    402 
    403 /**
    404  * Return values for reporting errors, also used for logging.
    405  *
    406  * A value of 0 indicates success (as a return value).
    407  * Values between 0 and 10000 must be handled explicitly by the app.
    408  * Values from 10000-19999 are informational.
    409  * Values from 20000-29999 indicate successful operations.
    410  * Values from 30000-39999 indicate unsuccessful (normal) operations.
    411  * Values from 40000-49999 indicate client errors.
    412  * Values from 50000-59999 indicate MHD server errors.
    413  * Values from 60000-65535 indicate application errors.
    414  *
    415  * @ingroup general
    416  */
    417 enum MHD_FIXED_ENUM_MHD_SET_ MHD_StatusCode
    418 {
    419 
    420   /* 00000-level status codes indicate return values
    421      the application must act on. */
    422 
    423   /**
    424    * Successful operation (not used for logging).
    425    * The code is guaranteed to be always zero.
    426    */
    427   MHD_SC_OK = 0
    428   ,
    429 
    430   /* 10000-level status codes indicate intermediate
    431      results of some kind. */
    432 
    433   /**
    434    * Informational event, MHD started.
    435    */
    436   MHD_SC_DAEMON_STARTED = 10000
    437   ,
    438   /**
    439    * Informational event, we accepted a connection.
    440    */
    441   MHD_SC_CONNECTION_ACCEPTED = 10001
    442   ,
    443   /**
    444    * Informational event, thread processing connection terminates.
    445    */
    446   MHD_SC_THREAD_TERMINATING = 10002
    447   ,
    448   /**
    449    * Informational event, state machine status for a connection.
    450    */
    451   MHD_SC_STATE_MACHINE_STATUS_REPORT = 10003
    452   ,
    453   /**
    454    * accept() returned transient error.
    455    */
    456   MHD_SC_ACCEPT_FAILED_EAGAIN = 10004
    457   ,
    458   /**
    459    * Accepted socket is unknown type (probably non-IP).
    460    */
    461   MHD_SC_ACCEPTED_UNKNOWN_TYPE = 10040
    462   ,
    463   /**
    464    * The sockaddr for the accepted socket does not fit the buffer.
    465    * (Strange)
    466    */
    467   MHD_SC_ACCEPTED_SOCKADDR_TOO_LARGE = 10041
    468   ,
    469 
    470   /* 20000-level status codes indicate success of some kind. */
    471 
    472   /**
    473    * MHD is closing a connection after the client closed it
    474    * (perfectly normal end).
    475    */
    476   MHD_SC_CONNECTION_CLOSED = 20000
    477   ,
    478   /**
    479    * MHD is closing a connection because the application
    480    * logic to generate the response data completed.
    481    */
    482   MHD_SC_APPLICATION_DATA_GENERATION_FINISHED = 20001
    483   ,
    484   /**
    485    * The request does not contain a particular type of Authentication
    486    * credentials
    487    */
    488   MHD_SC_AUTH_ABSENT = 20060
    489   ,
    490 
    491   /* 30000-level status codes indicate transient failures
    492      that might go away if the client tries again. */
    493 
    494 
    495   /**
    496    * Resource limit in terms of number of parallel connections
    497    * hit.
    498    */
    499   MHD_SC_LIMIT_CONNECTIONS_REACHED = 30000
    500   ,
    501   /**
    502    * The operation failed because the respective
    503    * daemon is already too deep inside of the shutdown
    504    * activity.
    505    */
    506   MHD_SC_DAEMON_ALREADY_SHUTDOWN = 30020
    507   ,
    508   /**
    509    * Failed to start new thread because of system limits.
    510    */
    511   MHD_SC_CONNECTION_THREAD_SYS_LIMITS_REACHED = 30030
    512   ,
    513   /**
    514    * Failed to start a thread.
    515    */
    516   MHD_SC_CONNECTION_THREAD_LAUNCH_FAILURE = 30031
    517   ,
    518   /**
    519    * The operation failed because we either have no
    520    * listen socket or were already quiesced.
    521    */
    522   MHD_SC_DAEMON_ALREADY_QUIESCED = 30040
    523   ,
    524   /**
    525    * The operation failed because client disconnected
    526    * faster than we could accept().
    527    */
    528   MHD_SC_ACCEPT_FAST_DISCONNECT = 30040
    529   ,
    530   /**
    531    * Operating resource limits hit on accept().
    532    */
    533   MHD_SC_ACCEPT_SYSTEM_LIMIT_REACHED = 30060
    534   ,
    535   /**
    536    * Connection was refused by accept policy callback.
    537    */
    538   MHD_SC_ACCEPT_POLICY_REJECTED = 30070
    539   ,
    540   /**
    541    * Failed to allocate memory for the daemon resources.
    542    * TODO: combine similar error codes for daemon
    543    */
    544   MHD_SC_DAEMON_MEM_ALLOC_FAILURE = 30081
    545   ,
    546   /**
    547    * We failed to allocate memory for the connection.
    548    * (May be transient.)
    549    */
    550   MHD_SC_CONNECTION_MEM_ALLOC_FAILURE = 30082
    551   ,
    552   /**
    553    * We failed to allocate memory for the connection's memory pool.
    554    * (May be transient.)
    555    */
    556   MHD_SC_POOL_MEM_ALLOC_FAILURE = 30083
    557   ,
    558   /**
    559    * We failed to allocate memory for the HTTP/2 connection's resources.
    560    * (May be transient.)
    561    */
    562   MHD_SC_H2_CONN_MEM_ALLOC_FAILURE = 30084
    563   ,
    564   /**
    565    * We failed to forward data from a Web socket to the
    566    * application to the remote side due to the socket
    567    * being closed prematurely. (May be transient.)
    568    */
    569   MHD_SC_UPGRADE_FORWARD_INCOMPLETE = 30100
    570   ,
    571   /**
    572    * Failed to allocate memory from our memory pool for processing
    573    * the request.  Likely the request fields are too large to leave
    574    * enough room.
    575    */
    576   MHD_SC_CONNECTION_POOL_NO_MEM_REQ = 30130
    577   ,
    578   /**
    579    * Failed to allocate memory from our memory pool to store GET parameter.
    580    * Likely the request URI or header fields are too large to leave enough room.
    581    */
    582   MHD_SC_CONNECTION_POOL_NO_MEM_GET_PARAM = 30131
    583   ,
    584   /**
    585    * Failed to allocate memory from our memory pool to store parsed cookie.
    586    */
    587   MHD_SC_CONNECTION_POOL_NO_MEM_COOKIE = 30132
    588   ,
    589   /**
    590    * Failed to allocate memory from connection memory pool to store
    591    * parsed Authentication data.
    592    */
    593   MHD_SC_CONNECTION_POOL_NO_MEM_AUTH_DATA = 30133
    594   ,
    595   /**
    596    * Detected jump back of system clock
    597    */
    598   MHD_SC_SYS_CLOCK_JUMP_BACK_LARGE = 30140
    599   ,
    600   /**
    601    * Detected correctable jump back of system clock
    602    */
    603   MHD_SC_SYS_CLOCK_JUMP_BACK_CORRECTED = 30141
    604   ,
    605   /**
    606    * Timeout waiting for communication operation for HTTP-Upgraded connection
    607    */
    608   MHD_SC_UPGRADED_NET_TIMEOUT = 30161
    609   ,
    610   /**
    611    * Not enough system resources
    612    */
    613   MHD_SC_NO_SYS_RESOURCES = 30180
    614   ,
    615 
    616   /* 40000-level errors are caused by the HTTP client
    617      (or the network) */
    618 
    619   /**
    620    * MHD is closing a connection because parsing the
    621    * request failed.
    622    */
    623   MHD_SC_CONNECTION_PARSE_FAIL_CLOSED = 40000
    624   ,
    625   /**
    626    * MHD is returning an error because the header provided
    627    * by the client is too big.
    628    */
    629   MHD_SC_CLIENT_HEADER_TOO_BIG = 40020
    630   ,
    631   /**
    632    * An HTTP/1.1 request was sent without the "Host:" header.
    633    */
    634   MHD_SC_HOST_HEADER_MISSING = 40060
    635   ,
    636   /**
    637    * Request has more than one "Host:" header.
    638    */
    639   MHD_SC_HOST_HEADER_SEVERAL = 40061
    640   ,
    641   /**
    642    * The value of the "Host:" header is invalid.
    643    */
    644   MHD_SC_HOST_HEADER_MALFORMED = 40062
    645   ,
    646   /**
    647    * The given content length was not a number.
    648    */
    649   MHD_SC_CONTENT_LENGTH_MALFORMED = 40065
    650   ,
    651   /**
    652    * Request has more than one "Content-Length:" header with the same value.
    653    */
    654   MHD_SC_CONTENT_LENGTH_SEVERAL_SAME = 40066
    655   ,
    656   /**
    657    * Request has more than one "Content-Length:" header with the different
    658    * values.
    659    */
    660   MHD_SC_CONTENT_LENGTH_SEVERAL_DIFFERENT = 40067
    661   ,
    662   /**
    663    * The BOTH Content-Length and Transfer-Encoding headers are used.
    664    */
    665   MHD_SC_CONTENT_LENGTH_AND_TR_ENC = 40068
    666   ,
    667   /**
    668    * The Content-Length is too large to be handled.
    669    */
    670   MHD_SC_CONTENT_LENGTH_TOO_LARGE = 40069
    671   ,
    672   /**
    673    * Transfer encoding in request is unsupported or invalid.
    674    */
    675   MHD_SC_TRANSFER_ENCODING_UNSUPPORTED = 40075
    676   ,
    677   /**
    678    * "Expect:" value in request is unsupported or invalid.
    679    */
    680   MHD_SC_EXPECT_HEADER_VALUE_UNSUPPORTED = 40076
    681   ,
    682   /**
    683    * The given uploaded, chunked-encoded body was malformed.
    684    */
    685   MHD_SC_CHUNKED_ENCODING_MALFORMED = 40080
    686   ,
    687   /**
    688    * The first header line has whitespace at the start
    689    */
    690   MHD_SC_REQ_FIRST_HEADER_LINE_SPACE_PREFIXED = 40100
    691   ,
    692   /**
    693    * The request target (URI) has whitespace character
    694    */
    695   MHD_SC_REQ_TARGET_HAS_WHITESPACE = 40101
    696   ,
    697   /**
    698    * Wrong bare CR characters has been replaced with space.
    699    */
    700   MHD_SC_REQ_HEADER_CR_REPLACED = 40120
    701   ,
    702   /**
    703    * Header line has not colon and skipped.
    704    */
    705   MHD_SC_REQ_HEADER_LINE_NO_COLON = 40121
    706   ,
    707   /**
    708    * Wrong bare CR characters has been replaced with space.
    709    */
    710   MHD_SC_REQ_FOOTER_CR_REPLACED = 40140
    711   ,
    712   /**
    713    * Footer line has not colon and skipped.
    714    */
    715   MHD_SC_REQ_FOOTER_LINE_NO_COLON = 40141
    716   ,
    717   /**
    718    * The request is malformed.
    719    */
    720   MHD_SC_REQ_MALFORMED = 40155
    721   ,
    722   /**
    723    * The cookie string has been parsed, but it is not fully compliant with
    724    * specifications
    725    */
    726   MHD_SC_REQ_COOKIE_PARSED_NOT_COMPLIANT = 40160
    727   ,
    728   /**
    729    * The cookie string has been parsed only partially
    730    */
    731   MHD_SC_REQ_COOKIE_PARSED_PARTIALLY = 40161
    732   ,
    733   /**
    734    * The cookie string is ignored, as it is not fully compliant with
    735    * specifications
    736    */
    737   MHD_SC_REQ_COOKIE_IGNORED_NOT_COMPLIANT = 40162
    738   ,
    739   /**
    740    * The cookie string has been ignored as it is invalid
    741    */
    742   MHD_SC_REQ_COOKIE_INVALID = 40163
    743   ,
    744   /**
    745    * The POST data parsed successfully, but has missing or incorrect
    746    * termination.
    747    * The last parsed field may have incorrect data.
    748    */
    749   MHD_SC_REQ_POST_PARSE_OK_BAD_TERMINATION = 40202
    750   ,
    751   /**
    752    * Parsing of the POST data is incomplete because client used incorrect
    753    * format of POST encoding.
    754    * Some POST data is available or has been provided via callback.
    755    */
    756   MHD_SC_REQ_POST_PARSE_PARTIAL_INVALID_POST_FORMAT = 40203
    757   ,
    758   /**
    759    * The request does not have "Content-Type:" header and POST data cannot
    760    * be parsed
    761    */
    762   MHD_SC_REQ_POST_PARSE_FAILED_NO_CNTN_TYPE = 40280
    763   ,
    764   /**
    765    * The request has unknown POST encoding specified by "Content-Type:" header
    766    */
    767   MHD_SC_REQ_POST_PARSE_FAILED_UNKNOWN_CNTN_TYPE = 40281
    768   ,
    769   /**
    770    * The request has "Content-Type: multipart/form-data" header without
    771    * "boundary" parameter
    772    */
    773   MHD_SC_REQ_POST_PARSE_FAILED_HEADER_NO_BOUNDARY = 40282
    774   ,
    775   /**
    776    * The request has "Content-Type: multipart/form-data" header with misformed
    777    * data
    778    */
    779   MHD_SC_REQ_POST_PARSE_FAILED_HEADER_MISFORMED = 40283
    780   ,
    781   /**
    782    * The POST data cannot be parsed because client used incorrect format
    783    * of POST encoding.
    784    */
    785   MHD_SC_REQ_POST_PARSE_FAILED_INVALID_POST_FORMAT = 40290
    786   ,
    787   /**
    788    * The data in Auth request header has invalid format.
    789    * For example, for Basic Authentication base64 decoding failed.
    790    */
    791   MHD_SC_REQ_AUTH_DATA_BROKEN = 40320
    792   ,
    793   /**
    794    * The request cannot be processed. Sending error reply.
    795    */
    796   MHD_SC_REQ_PROCCESSING_ERR_REPLY = 41000
    797   ,
    798   /**
    799    * MHD is closing a connection because of timeout.
    800    */
    801   MHD_SC_CONNECTION_TIMEOUT = 42000
    802   ,
    803   /**
    804    * MHD is closing a connection because receiving the
    805    * request failed.
    806    */
    807   MHD_SC_CONNECTION_RECV_FAIL_CLOSED = 42020
    808   ,
    809   /**
    810    * MHD is closing a connection because sending the response failed.
    811    */
    812   MHD_SC_CONNECTION_SEND_FAIL_CLOSED = 42021
    813   ,
    814   /**
    815    * MHD is closing a connection because remote client shut down its sending
    816    * side before full request was sent.
    817    */
    818   MHD_SC_CLIENT_SHUTDOWN_EARLY = 42040
    819   ,
    820   /**
    821    * MHD is closing a connection because remote client closed connection
    822    * early.
    823    */
    824   MHD_SC_CLIENT_CLOSED_CONN_EARLY = 42041
    825   ,
    826   /**
    827    * MHD is closing a connection connection has been (remotely) aborted.
    828    */
    829   MHD_SC_CONNECTION_ABORTED = 42042
    830   ,
    831   /**
    832    * MHD is closing a connection because it was reset.
    833    */
    834   MHD_SC_CONNECTION_RESET = 42060
    835   ,
    836   /**
    837    * MHD is closing a connection connection (or connection socket) has
    838    * been broken.
    839    */
    840   MHD_SC_CONNECTION_BROKEN = 42061
    841   ,
    842   /**
    843    * ALPN in TLS connection selected HTTP/2 (as advertised by the client),
    844    * but the client did not send a valid HTTP/2 connection preface.
    845    */
    846   MHD_SC_ALPN_H2_NO_PREFACE = 43001
    847   ,
    848 
    849   /* 50000-level errors are because of an error internal
    850      to the MHD logic, possibly including our interaction
    851      with the operating system (but not the application) */
    852 
    853   /**
    854    * This build of MHD does not support TLS, but the application
    855    * requested TLS.
    856    */
    857   MHD_SC_TLS_DISABLED = 50000
    858   ,
    859   /**
    860    * The selected TLS backend does not yet support this operation.
    861    */
    862   MHD_SC_TLS_BACKEND_OPERATION_UNSUPPORTED = 50004
    863   ,
    864   /**
    865    * Failed to setup ITC channel.
    866    */
    867   MHD_SC_ITC_INITIALIZATION_FAILED = 50005
    868   ,
    869   /**
    870    * File descriptor for ITC cannot be used because the FD number is higher
    871    * than the limit set by FD_SETSIZE (if internal polling with select is used)
    872    * or by application.
    873    */
    874   MHD_SC_ITC_FD_OUTSIDE_OF_SET_RANGE = 50006
    875   ,
    876   /**
    877    * The specified value for the NC length is way too large
    878    * for this platform (integer overflow on `size_t`).
    879    */
    880   MHD_SC_DIGEST_AUTH_NC_LENGTH_TOO_BIG = 50010
    881   ,
    882   /**
    883    * We failed to allocate memory for the specified nonce
    884    * counter array.  The option was not set.
    885    */
    886   MHD_SC_DIGEST_AUTH_NC_ALLOCATION_FAILURE = 50011
    887   ,
    888   /**
    889    * This build of the library does not support
    890    * digest authentication.
    891    */
    892   MHD_SC_DIGEST_AUTH_NOT_SUPPORTED_BY_BUILD = 50012
    893   ,
    894   /**
    895    * IPv6 requested but not supported by this build.
    896    * @sa #MHD_SC_AF_NOT_SUPPORTED_BY_BUILD
    897    */
    898   MHD_SC_IPV6_NOT_SUPPORTED_BY_BUILD = 50020
    899   ,
    900   /**
    901    * Specified address/protocol family is not supported by this build.
    902    * @sa MHD_SC_IPV6_NOT_SUPPORTED_BY_BUILD
    903    */
    904   MHD_SC_AF_NOT_SUPPORTED_BY_BUILD = 50021
    905   ,
    906   /**
    907    * The requested address/protocol family is rejected by the OS.
    908    * @sa #MHD_SC_AF_NOT_SUPPORTED_BY_BUILD
    909    */
    910   MHD_SC_AF_NOT_AVAILABLE = 500022
    911   ,
    912   /**
    913    * We failed to open the listen socket.
    914    */
    915   MHD_SC_FAILED_TO_OPEN_LISTEN_SOCKET = 50040
    916   ,
    917   /**
    918    * Failed to enable listen port reuse.
    919    */
    920   MHD_SC_LISTEN_PORT_REUSE_ENABLE_FAILED = 50041
    921   ,
    922   /**
    923    * Failed to enable listen port reuse.
    924    */
    925   MHD_SC_LISTEN_PORT_REUSE_ENABLE_NOT_SUPPORTED = 50042
    926   ,
    927   /**
    928    * Failed to enable listen address reuse.
    929    */
    930   MHD_SC_LISTEN_ADDRESS_REUSE_ENABLE_FAILED = 50043
    931   ,
    932   /**
    933    * Enabling listen address reuse is not supported by this platform.
    934    */
    935   MHD_SC_LISTEN_ADDRESS_REUSE_ENABLE_NOT_SUPPORTED = 50044
    936   ,
    937   /**
    938    * Failed to enable exclusive use of listen address.
    939    */
    940   MHD_SC_LISTEN_ADDRESS_EXCLUSIVE_ENABLE_FAILED = 50045
    941   ,
    942   /**
    943    * Dual stack configuration is not possible for provided sockaddr.
    944    */
    945   MHD_SC_LISTEN_DUAL_STACK_NOT_SUITABLE = 50046
    946   ,
    947   /**
    948    * Failed to enable or disable dual stack for the IPv6 listen socket.
    949    * The OS default dual-stack setting is different from what is requested.
    950    */
    951   MHD_SC_LISTEN_DUAL_STACK_CONFIGURATION_REJECTED = 50047
    952   ,
    953   /**
    954    * Failed to enable or disable dual stack for the IPv6 listen socket.
    955    * The socket will be used in whatever the default is the OS uses.
    956    */
    957   MHD_SC_LISTEN_DUAL_STACK_CONFIGURATION_UNKNOWN = 50048
    958   ,
    959   /**
    960    * On this platform, MHD does not support explicitly configuring
    961    * dual stack behaviour.
    962    */
    963   MHD_SC_LISTEN_DUAL_STACK_CONFIGURATION_NOT_SUPPORTED = 50049
    964   ,
    965   /**
    966    * Failed to enable TCP FAST OPEN option.
    967    */
    968   MHD_SC_LISTEN_FAST_OPEN_FAILURE = 50050
    969   ,
    970   /**
    971    * TCP FAST OPEN is not supported by the platform or by this MHD build.
    972    */
    973   MHD_SC_FAST_OPEN_NOT_SUPPORTED = 50051
    974   ,
    975   /**
    976    * We failed to set the listen socket to non-blocking.
    977    */
    978   MHD_SC_LISTEN_SOCKET_NONBLOCKING_FAILURE = 50052
    979   ,
    980   /**
    981    * Failed to configure listen socket to be non-inheritable.
    982    */
    983   MHD_SC_LISTEN_SOCKET_NOINHERIT_FAILED = 50053
    984   ,
    985   /**
    986    * Listen socket FD cannot be used because the FD number is higher than
    987    * the limit set by FD_SETSIZE (if internal polling with select is used) or
    988    * by application.
    989    */
    990   MHD_SC_LISTEN_FD_OUTSIDE_OF_SET_RANGE = 50054
    991   ,
    992   /**
    993    * We failed to bind the listen socket.
    994    */
    995   MHD_SC_LISTEN_SOCKET_BIND_FAILED = 50055
    996   ,
    997   /**
    998    * Failed to start listening on listen socket.
    999    */
   1000   MHD_SC_LISTEN_FAILURE = 50056
   1001   ,
   1002   /**
   1003    * Failed to detect the port number on the listening socket
   1004    */
   1005   MHD_SC_LISTEN_PORT_DETECT_FAILURE = 50057
   1006   ,
   1007   /**
   1008    * We failed to create control socket for the epoll().
   1009    */
   1010   MHD_SC_EPOLL_CTL_CREATE_FAILED = 50060
   1011   ,
   1012   /**
   1013    * We failed to configure control socket for the epoll()
   1014    * to be non-inheritable.
   1015    */
   1016   MHD_SC_EPOLL_CTL_CONFIGURE_NOINHERIT_FAILED = 50061
   1017   ,
   1018   /**
   1019    * The epoll() control FD cannot be used because the FD number is higher
   1020    * than the limit set by application.
   1021    */
   1022   MHD_SC_EPOLL_CTL_OUTSIDE_OF_SET_RANGE = 50062
   1023   ,
   1024   /**
   1025    * Failed to allocate memory for daemon's fd_sets
   1026    */
   1027   MHD_SC_FD_SET_MEMORY_ALLOCATE_FAILURE = 50063
   1028   ,
   1029   /**
   1030    * Failed to allocate memory for poll() structures
   1031    */
   1032   MHD_SC_POLL_FDS_MEMORY_ALLOCATE_FAILURE = 50063
   1033   ,
   1034   /**
   1035    * Failed to allocate memory for epoll data
   1036    */
   1037   MHD_SC_EPOLL_EVENTS_MEMORY_ALLOCATE_FAILURE = 50064
   1038   ,
   1039   /**
   1040    * Failed to add daemon's FDs (ITC and/or listening) to the epoll monitoring
   1041    */
   1042   MHD_SC_EPOLL_ADD_DAEMON_FDS_FAILURE = 50065
   1043   ,
   1044   /**
   1045    * Failed to register daemon's FDs (ITC or listening) in the application
   1046    * (external event) monitoring
   1047    */
   1048   MHD_SC_EXT_EVENT_REG_DAEMON_FDS_FAILURE = 50066
   1049   ,
   1050   /**
   1051    * The select() syscall is not available on this platform or in this MHD
   1052    * build.
   1053    */
   1054   MHD_SC_SELECT_SYSCALL_NOT_AVAILABLE = 50070
   1055   ,
   1056   /**
   1057    * The poll() syscall is not available on this platform or in this MHD
   1058    * build.
   1059    */
   1060   MHD_SC_POLL_SYSCALL_NOT_AVAILABLE = 50071
   1061   ,
   1062   /**
   1063    * The epoll syscalls are not available on this platform or in this MHD
   1064    * build.
   1065    */
   1066   MHD_SC_EPOLL_SYSCALL_NOT_AVAILABLE = 50072
   1067   ,
   1068   /**
   1069    * Failed to obtain our listen port via introspection.
   1070    * FIXME: remove?
   1071    */
   1072   MHD_SC_LISTEN_PORT_INTROSPECTION_FAILURE = 50080
   1073   ,
   1074   /**
   1075    * Failed to obtain our listen port via introspection
   1076    * due to unsupported address family being used.
   1077    */
   1078   MHD_SC_LISTEN_PORT_INTROSPECTION_UNKNOWN_AF = 50081
   1079   ,
   1080   /**
   1081    * Failed to initialise mutex.
   1082    */
   1083   MHD_SC_MUTEX_INIT_FAILURE = 50085
   1084   ,
   1085   /**
   1086    * Failed to allocate memory for the thread pool.
   1087    */
   1088   MHD_SC_THREAD_POOL_MEM_ALLOC_FAILURE = 50090
   1089   ,
   1090   /**
   1091    * We failed to allocate mutex for thread pool worker.
   1092    */
   1093   MHD_SC_THREAD_POOL_CREATE_MUTEX_FAILURE = 50093
   1094   ,
   1095   /**
   1096    * Failed to start the main daemon thread.
   1097    */
   1098   MHD_SC_THREAD_MAIN_LAUNCH_FAILURE = 50095
   1099   ,
   1100   /**
   1101    * Failed to start the daemon thread for listening.
   1102    */
   1103   MHD_SC_THREAD_LISTENING_LAUNCH_FAILURE = 50096
   1104   ,
   1105   /**
   1106    * Failed to start the worker thread for the thread pool.
   1107    */
   1108   MHD_SC_THREAD_WORKER_LAUNCH_FAILURE = 50097
   1109   ,
   1110   /**
   1111    * There was an attempt to upgrade a connection on
   1112    * a daemon where upgrades are disallowed.
   1113    */
   1114   MHD_SC_UPGRADE_ON_DAEMON_WITH_UPGRADE_DISALLOWED = 50100
   1115   ,
   1116   /**
   1117    * Failed to signal via ITC channel.
   1118    */
   1119   MHD_SC_ITC_USE_FAILED = 500101
   1120   ,
   1121   /**
   1122    * Failed to check for the signal on the ITC channel.
   1123    */
   1124   MHD_SC_ITC_CHECK_FAILED = 500102
   1125   ,
   1126   /**
   1127    * System reported error conditions on the ITC FD.
   1128    */
   1129   MHD_SC_ITC_STATUS_ERROR = 500104
   1130   ,
   1131   /**
   1132    * Failed to add a socket to the epoll set.
   1133    */
   1134   MHD_SC_EPOLL_CTL_ADD_FAILED = 500110
   1135   ,
   1136   /**
   1137    * Socket FD cannot be used because the FD number is higher than the limit set
   1138    * by FD_SETSIZE (if internal polling with select is used) or by application.
   1139    */
   1140   MHD_SC_SOCKET_OUTSIDE_OF_SET_RANGE = 500111
   1141   ,
   1142   /**
   1143    * The daemon cannot be started with the specified settings as no space
   1144    * left for the connections sockets within limits set by FD_SETSIZE.
   1145    * Consider use another sockets polling syscall (only select() has such
   1146    * limitations)
   1147    */
   1148   MHD_SC_SYS_FD_SETSIZE_TOO_STRICT = 50112
   1149   ,
   1150   /**
   1151    * This daemon was not configured with options that
   1152    * would allow us to obtain a meaningful timeout.
   1153    */
   1154   MHD_SC_CONFIGURATION_MISMATCH_FOR_GET_TIMEOUT = 50113
   1155   ,
   1156   /**
   1157    * This daemon was not configured with options that
   1158    * would allow us to run with select() data.
   1159    */
   1160   MHD_SC_CONFIGURATION_MISMATCH_FOR_RUN_SELECT = 50114
   1161   ,
   1162   /**
   1163    * This daemon was not configured to run with an
   1164    * external event loop.
   1165    */
   1166   MHD_SC_CONFIGURATION_MISMATCH_FOR_RUN_EXTERNAL = 50115
   1167   ,
   1168   /**
   1169    * Encountered an unexpected error from select()
   1170    * (should never happen).
   1171    */
   1172   MHD_SC_UNEXPECTED_SELECT_ERROR = 50116
   1173   ,
   1174   /**
   1175    * Failed to remove a socket to the epoll set.
   1176    */
   1177   MHD_SC_EPOLL_CTL_REMOVE_FAILED = 50117
   1178   ,
   1179   /**
   1180    * poll() is not supported.
   1181    */
   1182   MHD_SC_POLL_NOT_SUPPORTED = 50120
   1183   ,
   1184   /**
   1185    * Encountered a (potentially) recoverable error from poll().
   1186    */
   1187   MHD_SC_POLL_SOFT_ERROR = 50121
   1188   ,
   1189   /**
   1190    * Encountered an unrecoverable error from poll().
   1191    */
   1192   MHD_SC_POLL_HARD_ERROR = 50122
   1193   ,
   1194   /**
   1195    * Encountered a (potentially) recoverable error from select().
   1196    */
   1197   MHD_SC_SELECT_SOFT_ERROR = 50123
   1198   ,
   1199   /**
   1200    * Encountered an unrecoverable error from select().
   1201    */
   1202   MHD_SC_SELECT_HARD_ERROR = 50124
   1203   ,
   1204   /**
   1205    * System reported error conditions on the listening socket.
   1206    */
   1207   MHD_SC_LISTEN_STATUS_ERROR = 50129
   1208   ,
   1209   /**
   1210    * Encountered an unrecoverable error from epoll function.
   1211    */
   1212   MHD_SC_EPOLL_HARD_ERROR = 50130
   1213   ,
   1214   /**
   1215    * We failed to configure accepted socket
   1216    * to not use a SIGPIPE.
   1217    */
   1218   MHD_SC_ACCEPT_CONFIGURE_NOSIGPIPE_FAILED = 50140
   1219   ,
   1220   /**
   1221    * We failed to configure accepted socket
   1222    * to be non-inheritable.
   1223    */
   1224   MHD_SC_ACCEPT_CONFIGURE_NOINHERIT_FAILED = 50141
   1225   ,
   1226   /**
   1227    * We failed to configure accepted socket
   1228    * to be non-blocking.
   1229    */
   1230   MHD_SC_ACCEPT_CONFIGURE_NONBLOCKING_FAILED = 50142
   1231   ,
   1232   /**
   1233    * The accepted socket FD value is too large.
   1234    */
   1235   MHD_SC_ACCEPT_OUTSIDE_OF_SET_RANGE = 50143
   1236   ,
   1237   /**
   1238    * accept() returned unexpected error.
   1239    */
   1240   MHD_SC_ACCEPT_FAILED_UNEXPECTEDLY = 50144
   1241   ,
   1242   /**
   1243    * Operating resource limits hit on accept() while
   1244    * zero connections are active. Oopsie.
   1245    */
   1246   MHD_SC_ACCEPT_SYSTEM_LIMIT_REACHED_INSTANTLY = 50145
   1247   ,
   1248   /**
   1249    * The daemon sockets polling mode requires non-blocking sockets.
   1250    */
   1251   MHD_SC_NONBLOCKING_REQUIRED = 50146
   1252   ,
   1253   /**
   1254    * Encountered an unexpected error from epoll_wait()
   1255    * (should never happen).
   1256    */
   1257   MHD_SC_UNEXPECTED_EPOLL_WAIT_ERROR = 50150
   1258   ,
   1259   /**
   1260    * epoll file descriptor is invalid (strange)
   1261    */
   1262   MHD_SC_EPOLL_FD_INVALID = 50151
   1263   ,
   1264   /**
   1265    * Unexpected socket error (strange)
   1266    */
   1267   MHD_SC_UNEXPECTED_SOCKET_ERROR = 50152
   1268   ,
   1269   /**
   1270    * Failed to add IP address to per-IP counter for
   1271    * some reason.
   1272    */
   1273   MHD_SC_IP_COUNTER_FAILURE = 50160
   1274   ,
   1275   /**
   1276    * Application violated our API by calling shutdown
   1277    * while having an upgrade connection still open.
   1278    */
   1279   MHD_SC_SHUTDOWN_WITH_OPEN_UPGRADED_CONNECTION = 50180
   1280   ,
   1281   /**
   1282    * Due to an unexpected internal error with the
   1283    * state machine, we closed the connection.
   1284    */
   1285   MHD_SC_STATEMACHINE_FAILURE_CONNECTION_CLOSED = 50200
   1286   ,
   1287   /**
   1288    * Failed to allocate memory in connection's pool
   1289    * to parse the cookie header.
   1290    */
   1291   MHD_SC_COOKIE_POOL_ALLOCATION_FAILURE = 50220
   1292   ,
   1293   /**
   1294    * MHD failed to build the response header.
   1295    */
   1296   MHD_SC_REPLY_FAILED_HEADER_GENERATION = 50230
   1297   ,
   1298   /**
   1299    * Failed to allocate memory in connection's pool for the reply.
   1300    */
   1301   MHD_SC_REPLY_POOL_ALLOCATION_FAILURE = 50231
   1302   ,
   1303   /**
   1304    * Failed to read the file for file-backed response.
   1305    */
   1306   MHD_SC_REPLY_FILE_READ_ERROR = 50232
   1307   ,
   1308   /**
   1309    * Failed to generate the nonce for the Digest Auth.
   1310    */
   1311   MHD_SC_REPLY_NONCE_ERROR = 50233
   1312   ,
   1313   /**
   1314    * Failed to allocate memory in connection's pool for the reply.
   1315    */
   1316   MHD_SC_ERR_RESPONSE_ALLOCATION_FAILURE = 50250
   1317   ,
   1318   /**
   1319    * The request POST data cannot be parsed because stream has not enough
   1320    * pool memory free.
   1321    */
   1322   MHD_SC_REQ_POST_PARSE_FAILED_NO_POOL_MEM = 50260
   1323   ,
   1324   /**
   1325    * The POST data cannot be parsed completely because no "large shared buffer"
   1326    * space is available.
   1327    * Some POST data may be parsed.
   1328    */
   1329   MHD_SC_REQ_POST_PARSE_FAILED_NO_LARGE_BUF_MEM = 50261
   1330   ,
   1331   /**
   1332    * The application set POST encoding to "multipart/form-data", but the request
   1333    * has no "Content-Type: multipart/form-data" header which is required
   1334    * to find "boundary" used in this encoding
   1335    */
   1336   MHD_SC_REQ_POST_PARSE_FAILED_HEADER_NOT_MPART = 50284
   1337   ,
   1338   /**
   1339    * The feature is not supported by this MHD build (either
   1340    * disabled by configure parameters or build platform
   1341    * did not support it, because headers are missing or
   1342    * so kernel does not have such feature).
   1343    * The feature will not be enabled if the same MHD binary
   1344    * will be run on another kernel, computer or system
   1345    * configuration.
   1346    */
   1347   MHD_SC_FEATURE_DISABLED = 50300
   1348   ,
   1349   /**
   1350    * The feature is not supported by this platform, while
   1351    * supported by MHD build.
   1352    * The feature can be enabled by changing the kernel or
   1353    * running on another computer or with other system
   1354    * configuration.
   1355    */
   1356   MHD_SC_FEATURE_NOT_AVAILABLE = 50320
   1357   ,
   1358   /**
   1359    * Failed to stop the thread
   1360    */
   1361   MHD_SC_DAEMON_THREAD_STOP_ERROR = 50350
   1362   ,
   1363   /**
   1364    * Unexpected reasons for thread stop
   1365    */
   1366   MHD_SC_DAEMON_THREAD_STOP_UNEXPECTED = 50351
   1367   ,
   1368   /**
   1369    * Daemon system data is broken (like listen socket was unexpectedly closed).
   1370    * The daemon needs to be closed.
   1371    * A new daemon can be started as a replacement after closing the current
   1372    * daemon.
   1373    */
   1374   MHD_SC_DAEMON_SYS_DATA_BROKEN = 50370
   1375   ,
   1376   /**
   1377    * Failed to acquire response mutex lock
   1378    */
   1379   MHD_SC_RESPONSE_MUTEX_LOCK_FAILED = 50500
   1380   ,
   1381   /**
   1382    * Failed to initialise response mutex
   1383    */
   1384   MHD_SC_RESPONSE_MUTEX_INIT_FAILED = 50501
   1385   ,
   1386   /**
   1387    * Unable to clear "reusable" flag.
   1388    * One this flag set, it cannot be removed for the response lifetime.
   1389    */
   1390   MHD_SC_RESPONSE_CANNOT_CLEAR_REUSE = 50520
   1391   ,
   1392   /**
   1393    * Unable to allocate memory for the response header
   1394    */
   1395   MHD_SC_RESPONSE_HEADER_MEM_ALLOC_FAILED = 50540
   1396   ,
   1397   /**
   1398    * Failed to switch TCP_NODELAY option for the socket
   1399    */
   1400   MHD_SC_SOCKET_TCP_NODELAY_FAILED = 50600
   1401   ,
   1402   /**
   1403    * Failed to switch TCP_CORK or TCP_NOPUSH option for the socket
   1404    */
   1405   MHD_SC_SOCKET_TCP_CORK_NOPUSH_FAILED = 50601
   1406   ,
   1407   /**
   1408    * Failed to force flush the last part of the response header or
   1409    * the response content
   1410    */
   1411   MHD_SC_SOCKET_FLUSH_LAST_PART_FAILED = 50620
   1412   ,
   1413   /**
   1414    * Failed to push buffered data by zero-sized send()
   1415    */
   1416   MHD_SC_SOCKET_ZERO_SEND_FAILED = 50621
   1417   ,
   1418   /**
   1419    * The HTTP-Upgraded network connection has been closed / disconnected
   1420    */
   1421   MHD_SC_UPGRADED_NET_CONN_CLOSED = 50800
   1422   ,
   1423   /**
   1424    * The HTTP-Upgraded network connection has been broken
   1425    */
   1426   MHD_SC_UPGRADED_NET_CONN_BROKEN = 50801
   1427   ,
   1428   /**
   1429    * The TLS communication error on HTTP-Upgraded connection
   1430    */
   1431   MHD_SC_UPGRADED_TLS_ERROR = 50801
   1432   ,
   1433   /**
   1434    * Unrecoverable sockets communication error on HTTP-Upgraded connection
   1435    */
   1436   MHD_SC_UPGRADED_NET_HARD_ERROR = 50840
   1437   ,
   1438   /**
   1439    * MHD cannot wait for the data on the HTTP-Upgraded connection, because
   1440    * current build or the platform does not support required functionality.
   1441    * Communication with zero timeout is fully supported.
   1442    */
   1443   MHD_SC_UPGRADED_WAITING_NOT_SUPPORTED = 50840
   1444   ,
   1445   /**
   1446    * Global initialisation of MHD library failed
   1447    */
   1448   MHD_SC_LIB_INIT_GLOBAL_FAILED = 51000
   1449   ,
   1450   /**
   1451    * Failed to initialise TLS context for the daemon
   1452    */
   1453   MHD_SC_TLS_DAEMON_INIT_FAILED = 51200
   1454   ,
   1455   /**
   1456    * Failed to initialise TLS context for the new connection
   1457    */
   1458   MHD_SC_TLS_CONNECTION_INIT_FAILED = 51201
   1459   ,
   1460   /**
   1461    * Warning about TLS backend configuration
   1462    */
   1463   MHD_SC_TLS_LIB_CONF_WARNING = 51202
   1464   ,
   1465   /**
   1466    * Failed to perform TLS handshake
   1467    */
   1468   MHD_SC_TLS_CONNECTION_HANDSHAKED_FAILED = 51220
   1469   ,
   1470   /**
   1471    * Hashing failed.
   1472    * Internal hashing function can never fail (and this code is never returned
   1473    * for them). External hashing function (like TLS backend-based) may fail
   1474    * for various reasons, like failure of hardware acccelerated hashing.
   1475    */
   1476   MHD_SC_HASH_FAILED = 51260
   1477   ,
   1478   /**
   1479    * Something wrong in the internal MHD logic.
   1480    * This error should be never returned if MHD works as expected.
   1481    * If this code is ever returned, please report to MHD maintainers.
   1482    */
   1483   MHD_SC_INTERNAL_ERROR = 59900
   1484   ,
   1485 
   1486   /* 60000-level errors are because the application
   1487      logic did something wrong or generated an error. */
   1488 
   1489   /**
   1490    * The application called function too early.
   1491    * For example, a header value was requested before the headers
   1492    * had been received.
   1493    */
   1494   MHD_SC_TOO_EARLY = 60000
   1495   ,
   1496   /**
   1497    * The application called this function too late.
   1498    * For example, MHD has already started sending reply.
   1499    */
   1500   MHD_SC_TOO_LATE = 60001
   1501   ,
   1502   /**
   1503    * MHD does not support the requested combination of
   1504    * the sockets polling syscall and the work mode.
   1505    */
   1506   MHD_SC_SYSCALL_WORK_MODE_COMBINATION_INVALID = 60010
   1507   ,
   1508   /**
   1509    * MHD does not support quiescing if ITC was disabled
   1510    * and threads are used.
   1511    */
   1512   MHD_SC_SYSCALL_QUIESCE_REQUIRES_ITC = 60011
   1513   ,
   1514   /**
   1515    * The option provided or function called can be used only with "external
   1516    * events" modes.
   1517    */
   1518   MHD_SC_EXTERNAL_EVENT_ONLY = 60012
   1519   ,
   1520   /**
   1521    * MHD is closing a connection because the application
   1522    * logic to generate the response data failed.
   1523    */
   1524   MHD_SC_APPLICATION_DATA_GENERATION_FAILURE_CLOSED = 60015
   1525   ,
   1526   /**
   1527    * MHD is closing a connection because the application
   1528    * callback told it to do so.
   1529    */
   1530   MHD_SC_APPLICATION_CALLBACK_ABORT_ACTION = 60016
   1531   ,
   1532   /**
   1533    * Application only partially processed upload and did
   1534    * not suspend connection. This may result in a hung
   1535    * connection.
   1536    */
   1537   MHD_SC_APPLICATION_HUNG_CONNECTION = 60017
   1538   ,
   1539   /**
   1540    * Application only partially processed upload and did
   1541    * not suspend connection and the read buffer was maxxed
   1542    * out, so MHD closed the connection.
   1543    */
   1544   MHD_SC_APPLICATION_HUNG_CONNECTION_CLOSED = 60018
   1545   ,
   1546   /**
   1547    * Attempted to set an option that conflicts with another option
   1548    * already set.
   1549    */
   1550   MHD_SC_OPTIONS_CONFLICT = 60020
   1551   ,
   1552   /**
   1553    * Attempted to set an option that not recognised by MHD.
   1554    */
   1555   MHD_SC_OPTION_UNKNOWN = 60021
   1556   ,
   1557   /**
   1558    * Parameter specified unknown work mode.
   1559    */
   1560   MHD_SC_CONFIGURATION_UNEXPECTED_WM = 60022
   1561   ,
   1562   /**
   1563    * Parameter specified unknown Sockets Polling Syscall (SPS).
   1564    */
   1565   MHD_SC_CONFIGURATION_UNEXPECTED_SPS = 60023
   1566   ,
   1567   /**
   1568    * The size of the provided sockaddr does not match address family.
   1569    */
   1570   MHD_SC_CONFIGURATION_WRONG_SA_SIZE = 60024
   1571   ,
   1572   /**
   1573    * The number set by #MHD_D_O_FD_NUMBER_LIMIT is too strict to run
   1574    * the daemon
   1575    */
   1576   MHD_SC_MAX_FD_NUMBER_LIMIT_TOO_STRICT = 60025
   1577   ,
   1578   /**
   1579    * The number set by #MHD_D_O_GLOBAL_CONNECTION_LIMIT is too for the daemon
   1580    * configuration
   1581    */
   1582   MHD_SC_CONFIGURATION_CONN_LIMIT_TOO_SMALL = 60026
   1583   ,
   1584   /**
   1585    * The provided configuration parameter is NULL, but it must be non-NULL
   1586    */
   1587   MHD_SC_CONFIGURATION_PARAM_NULL = 60027
   1588   ,
   1589   /**
   1590    * The size of the provided configuration parameter is too large
   1591    */
   1592   MHD_SC_CONFIGURATION_PARAM_TOO_LARGE = 60028
   1593   ,
   1594   /**
   1595    * The application requested an unsupported TLS backend to be used.
   1596    */
   1597   MHD_SC_TLS_BACKEND_UNSUPPORTED = 60030
   1598   ,
   1599   /**
   1600    * The application attempted to setup TLS parameters before
   1601    * enabling TLS.
   1602    */
   1603   MHD_SC_TLS_BACKEND_UNINITIALIZED = 60031
   1604   ,
   1605   /**
   1606    * The application requested a TLS backend which cannot be used due
   1607    * to missing TLS dynamic library or backend initialisation problem.
   1608    */
   1609   MHD_SC_TLS_BACKEND_UNAVAILABLE = 60032
   1610   ,
   1611   /**
   1612    * Provided TLS certificate and/or private key are incorrect
   1613    */
   1614   MHD_SC_TLS_CONF_BAD_CERT = 60033
   1615   ,
   1616   /**
   1617    * The application requested a daemon setting that cannot be used with
   1618    * selected TLS backend
   1619    */
   1620   MHD_SC_TLS_BACKEND_DAEMON_INCOMPATIBLE_SETTINGS = 60034
   1621   ,
   1622   /**
   1623    * The response header name has forbidden characters or token
   1624    */
   1625   MHD_SC_RESP_HEADER_NAME_INVALID = 60050
   1626   ,
   1627   /**
   1628    * The response header value has forbidden characters or token
   1629    */
   1630   MHD_SC_RESP_HEADER_VALUE_INVALID = 60051
   1631   ,
   1632   /**
   1633    * An attempt to add header conflicting with other response header
   1634    */
   1635   MHD_SC_RESP_HEADERS_CONFLICT = 60052
   1636   ,
   1637   /**
   1638    * The pointer to the response object is NULL
   1639    */
   1640   MHD_SC_RESP_POINTER_NULL = 60060
   1641   ,
   1642   /**
   1643    * The response HTTP status code is not suitable
   1644    */
   1645   MHD_SC_RESP_HTTP_CODE_NOT_SUITABLE = 60061
   1646   ,
   1647   /**
   1648    * The provided MHD_Action is invalid
   1649    */
   1650   MHD_SC_ACTION_INVALID = 60080
   1651   ,
   1652   /**
   1653    * The provided MHD_UploadAction is invalid
   1654    */
   1655   MHD_SC_UPLOAD_ACTION_INVALID = 60081
   1656   ,
   1657   /**
   1658    * The provided Dynamic Content Creator action is invalid
   1659    */
   1660   MHD_SC_DCC_ACTION_INVALID = 60082
   1661   ,
   1662   /**
   1663    * The response must be empty
   1664    */
   1665   MHD_SC_REPLY_NOT_EMPTY_RESPONSE = 60101
   1666   ,
   1667   /**
   1668    * The "Content-Length" header is not allowed in the reply
   1669    */
   1670   MHD_SC_REPLY_CONTENT_LENGTH_NOT_ALLOWED = 60102
   1671   ,
   1672   /**
   1673    * The provided reply headers do not fit the connection buffer
   1674    */
   1675   MHD_SC_REPLY_HEADERS_TOO_LARGE = 60103
   1676   ,
   1677   /**
   1678    * Specified offset in file-backed response is too large and not supported
   1679    * by the platform
   1680    */
   1681   MHD_SC_REPLY_FILE_OFFSET_TOO_LARGE = 60104
   1682   ,
   1683   /**
   1684    * File-backed response has file smaller than specified combination of
   1685    * the file offset and the response size.
   1686    */
   1687   MHD_SC_REPLY_FILE_TOO_SHORT = 60105
   1688   ,
   1689   /**
   1690    * The new connection cannot be used because the FD number is higher than
   1691    * the limit set by FD_SETSIZE (if internal polling with select is used) or
   1692    * by application.
   1693    */
   1694   MHD_SC_NEW_CONN_FD_OUTSIDE_OF_SET_RANGE = 60140
   1695   ,
   1696   /**
   1697    * The daemon is being destroyed, while not all HTTP-Upgraded connections
   1698    * has been closed.
   1699    */
   1700   MHD_SC_DAEMON_DESTROYED_WITH_UNCLOSED_UPGRADED = 60160
   1701   ,
   1702   /**
   1703    * The provided pointer to 'struct MHD_UpgradedHandle' is invalid
   1704    */
   1705   MHD_SC_UPGRADED_HANDLE_INVALID = 60161
   1706   ,
   1707   /**
   1708    * The provided output buffer is too small.
   1709    */
   1710   MHD_SC_OUT_BUFF_TOO_SMALL = 60180
   1711   ,
   1712   /**
   1713    * The requested type of information is not recognised.
   1714    */
   1715   MHD_SC_INFO_GET_TYPE_UNKNOWN = 60200
   1716   ,
   1717   /**
   1718    * The information of the requested type is too large to fit into
   1719    * the provided buffer.
   1720    */
   1721   MHD_SC_INFO_GET_BUFF_TOO_SMALL = 60201
   1722   ,
   1723   /**
   1724    * The type of the information is not supported by this MHD build.
   1725    * It can be information not supported on the current platform or related
   1726    * to feature disabled for this build.
   1727    */
   1728   MHD_SC_INFO_GET_TYPE_NOT_SUPP_BY_BUILD = 60202
   1729   ,
   1730   /**
   1731    * The type of the information is not available due to configuration
   1732    * or state of the object.
   1733    */
   1734   MHD_SC_INFO_GET_TYPE_NOT_APPLICABLE = 60203
   1735   ,
   1736   /**
   1737    * The type of the information should be available for the object, but
   1738    * cannot be provided due to some error or other reasons.
   1739    */
   1740   MHD_SC_INFO_GET_TYPE_UNOBTAINABLE = 60204
   1741   ,
   1742   /**
   1743    * The type of the Digest Auth algorithm is unknown or not supported.
   1744    */
   1745   MHD_SC_AUTH_DIGEST_ALGO_NOT_SUPPORTED = 60240
   1746   ,
   1747   /**
   1748    * The Digest Auth QOP value is unknown or not supported.
   1749    */
   1750   MHD_SC_AUTH_DIGEST_QOP_NOT_SUPPORTED = 60241
   1751   ,
   1752   /**
   1753    * The Digest Auth is not supported due to configuration
   1754    */
   1755   MHD_SC_AUTH_DIGEST_UNSUPPORTED = 60242
   1756   ,
   1757   /**
   1758    * The application failed to register FD for the external events monitoring
   1759    */
   1760   MHD_SC_EXTR_EVENT_REG_FAILED = 60243
   1761   ,
   1762   /**
   1763    * The application failed to de-register FD for the external events monitoring
   1764    */
   1765   MHD_SC_EXTR_EVENT_DEREG_FAILED = 60244
   1766   ,
   1767   /**
   1768    * The application called #MHD_daemon_event_update() with broken data
   1769    */
   1770   MHD_SC_EXTR_EVENT_BROKEN_DATA = 60250
   1771   ,
   1772   /**
   1773    * The application called #MHD_daemon_event_update() with status that
   1774    * has not been requested
   1775    */
   1776   MHD_SC_EXTR_EVENT_UNEXPECTED_STATUS = 60251
   1777 };
   1778 
   1779 /**
   1780  * Get text description for the MHD error code.
   1781  *
   1782  * This function works for @b MHD error codes, not for @b HTTP status codes.
   1783  * @param code the MHD code to get description for
   1784  * @return the pointer to the text description,
   1785  *         NULL if MHD code in not known.
   1786  *
   1787  * @ingroup general
   1788  */
   1789 MHD_EXTERN_ const struct MHD_String *
   1790 MHD_status_code_to_string (enum MHD_StatusCode code)
   1791 MHD_FN_CONST_;
   1792 
   1793 /**
   1794  * Get the pointer to the C string for the MHD error code, never NULL.
   1795  */
   1796 #define MHD_status_code_to_string_lazy(code) \
   1797         (MHD_status_code_to_string ((code)) ? \
   1798          ((MHD_status_code_to_string (code))->cstr) : ("[No code]") )
   1799 
   1800 #ifndef MHD_HTTP_METHOD_DEFINED
   1801 
   1802 /**
   1803  * @brief HTTP request methods
   1804  *
   1805  * @defgroup methods HTTP methods
   1806  *
   1807  * See: https://www.iana.org/assignments/http-methods/http-methods.xml
   1808  * Registry export date: 2023-10-02
   1809  * @{
   1810  */
   1811 
   1812 /**
   1813  * HTTP methods explicitly supported by MHD.  Note that for non-canonical
   1814  * methods, MHD will return #MHD_HTTP_METHOD_OTHER and you can use
   1815  * #MHD_REQUEST_INFO_FIXED_HTTP_METHOD to get the original string.
   1816  *
   1817  * However, applications must check for #MHD_HTTP_METHOD_OTHER *or* any enum-value
   1818  * above those in this list, as future versions of MHD may add additional
   1819  * methods (as per IANA registry), thus even if the API returns
   1820  * #MHD_HTTP_METHOD_OTHER today, it may return a method-specific header in the
   1821  * future!
   1822  */
   1823 enum MHD_FIXED_ENUM_MHD_SET_ MHD_HTTP_Method
   1824 {
   1825 
   1826   /**
   1827    * Method did not match any of the methods given below.
   1828    */
   1829   MHD_HTTP_METHOD_OTHER = 255
   1830   ,
   1831   /* Main HTTP methods. */
   1832 
   1833   /**
   1834    * "GET"
   1835    * Safe.     Idempotent.     RFC9110, Section 9.3.1.
   1836    */
   1837   MHD_HTTP_METHOD_GET = 1
   1838   ,
   1839   /**
   1840    * "HEAD"
   1841    * Safe.     Idempotent.     RFC9110, Section 9.3.2.
   1842    */
   1843   MHD_HTTP_METHOD_HEAD = 2
   1844   ,
   1845   /**
   1846    * "POST"
   1847    * Not safe. Not idempotent. RFC9110, Section 9.3.3.
   1848    */
   1849   MHD_HTTP_METHOD_POST = 3
   1850   ,
   1851   /**
   1852    * "PUT"
   1853    * Not safe. Idempotent.     RFC9110, Section 9.3.4.
   1854    */
   1855   MHD_HTTP_METHOD_PUT = 4
   1856   ,
   1857   /**
   1858    * "DELETE"
   1859    * Not safe. Idempotent.     RFC9110, Section 9.3.5.
   1860    */
   1861   MHD_HTTP_METHOD_DELETE = 5
   1862   ,
   1863   /**
   1864    * "CONNECT"
   1865    * Not safe. Not idempotent. RFC9110, Section 9.3.6.
   1866    */
   1867   MHD_HTTP_METHOD_CONNECT = 6
   1868   ,
   1869   /**
   1870    * "OPTIONS"
   1871    * Safe.     Idempotent.     RFC9110, Section 9.3.7.
   1872    */
   1873   MHD_HTTP_METHOD_OPTIONS = 7
   1874   ,
   1875   /**
   1876    * "TRACE"
   1877    * Safe.     Idempotent.     RFC9110, Section 9.3.8.
   1878    */
   1879   MHD_HTTP_METHOD_TRACE = 8
   1880   ,
   1881   /**
   1882    * "*"
   1883    * Not safe. Not idempotent. RFC9110, Section 18.2.
   1884    */
   1885   MHD_HTTP_METHOD_ASTERISK = 9
   1886 };
   1887 
   1888 #define MHD_HTTP_METHOD_DEFINED 1
   1889 #endif /* ! MHD_HTTP_METHOD_DEFINED */
   1890 
   1891 /**
   1892  * Get text version of the method name.
   1893  * @param method the method to get the text version
   1894  * @return the pointer to the text version,
   1895  *         NULL if method is MHD_HTTP_METHOD_OTHER
   1896  *         or not known.
   1897  */
   1898 MHD_EXTERN_ const struct MHD_String *
   1899 MHD_http_method_to_string (enum MHD_HTTP_Method method)
   1900 MHD_FN_CONST_;
   1901 
   1902 
   1903 /* Main HTTP methods. */
   1904 /* Safe.     Idempotent.     RFC9110, Section 9.3.1. */
   1905 #define MHD_HTTP_METHOD_STR_GET      "GET"
   1906 /* Safe.     Idempotent.     RFC9110, Section 9.3.2. */
   1907 #define MHD_HTTP_METHOD_STR_HEAD     "HEAD"
   1908 /* Not safe. Not idempotent. RFC9110, Section 9.3.3. */
   1909 #define MHD_HTTP_METHOD_STR_POST     "POST"
   1910 /* Not safe. Idempotent.     RFC9110, Section 9.3.4. */
   1911 #define MHD_HTTP_METHOD_STR_PUT      "PUT"
   1912 /* Not safe. Idempotent.     RFC9110, Section 9.3.5. */
   1913 #define MHD_HTTP_METHOD_STR_DELETE   "DELETE"
   1914 /* Not safe. Not idempotent. RFC9110, Section 9.3.6. */
   1915 #define MHD_HTTP_METHOD_STR_CONNECT  "CONNECT"
   1916 /* Safe.     Idempotent.     RFC9110, Section 9.3.7. */
   1917 #define MHD_HTTP_METHOD_STR_OPTIONS  "OPTIONS"
   1918 /* Safe.     Idempotent.     RFC9110, Section 9.3.8. */
   1919 #define MHD_HTTP_METHOD_STR_TRACE    "TRACE"
   1920 /* Not safe. Not idempotent. RFC9110, Section 18.2. */
   1921 #define MHD_HTTP_METHOD_STR_ASTERISK  "*"
   1922 
   1923 /* Additional HTTP methods. */
   1924 /* Not safe. Idempotent.     RFC3744, Section 8.1. */
   1925 #define MHD_HTTP_METHOD_STR_ACL            "ACL"
   1926 /* Not safe. Idempotent.     RFC3253, Section 12.6. */
   1927 #define MHD_HTTP_METHOD_STR_BASELINE_CONTROL "BASELINE-CONTROL"
   1928 /* Not safe. Idempotent.     RFC5842, Section 4. */
   1929 #define MHD_HTTP_METHOD_STR_BIND           "BIND"
   1930 /* Not safe. Idempotent.     RFC3253, Section 4.4, Section 9.4. */
   1931 #define MHD_HTTP_METHOD_STR_CHECKIN        "CHECKIN"
   1932 /* Not safe. Idempotent.     RFC3253, Section 4.3, Section 8.8. */
   1933 #define MHD_HTTP_METHOD_STR_CHECKOUT       "CHECKOUT"
   1934 /* Not safe. Idempotent.     RFC4918, Section 9.8. */
   1935 #define MHD_HTTP_METHOD_STR_COPY           "COPY"
   1936 /* Not safe. Idempotent.     RFC3253, Section 8.2. */
   1937 #define MHD_HTTP_METHOD_STR_LABEL          "LABEL"
   1938 /* Not safe. Idempotent.     RFC2068, Section 19.6.1.2. */
   1939 #define MHD_HTTP_METHOD_STR_LINK           "LINK"
   1940 /* Not safe. Not idempotent. RFC4918, Section 9.10. */
   1941 #define MHD_HTTP_METHOD_STR_LOCK           "LOCK"
   1942 /* Not safe. Idempotent.     RFC3253, Section 11.2. */
   1943 #define MHD_HTTP_METHOD_STR_MERGE          "MERGE"
   1944 /* Not safe. Idempotent.     RFC3253, Section 13.5. */
   1945 #define MHD_HTTP_METHOD_STR_MKACTIVITY     "MKACTIVITY"
   1946 /* Not safe. Idempotent.     RFC4791, Section 5.3.1; RFC8144, Section 2.3. */
   1947 #define MHD_HTTP_METHOD_STR_MKCALENDAR     "MKCALENDAR"
   1948 /* Not safe. Idempotent.     RFC4918, Section 9.3; RFC5689, Section 3; RFC8144, Section 2.3. */
   1949 #define MHD_HTTP_METHOD_STR_MKCOL          "MKCOL"
   1950 /* Not safe. Idempotent.     RFC4437, Section 6. */
   1951 #define MHD_HTTP_METHOD_STR_MKREDIRECTREF  "MKREDIRECTREF"
   1952 /* Not safe. Idempotent.     RFC3253, Section 6.3. */
   1953 #define MHD_HTTP_METHOD_STR_MKWORKSPACE    "MKWORKSPACE"
   1954 /* Not safe. Idempotent.     RFC4918, Section 9.9. */
   1955 #define MHD_HTTP_METHOD_STR_MOVE           "MOVE"
   1956 /* Not safe. Idempotent.     RFC3648, Section 7. */
   1957 #define MHD_HTTP_METHOD_STR_ORDERPATCH     "ORDERPATCH"
   1958 /* Not safe. Not idempotent. RFC5789, Section 2. */
   1959 #define MHD_HTTP_METHOD_STR_PATCH          "PATCH"
   1960 /* Safe.     Idempotent.     RFC9113, Section 3.4. */
   1961 #define MHD_HTTP_METHOD_STR_PRI            "PRI"
   1962 /* Safe.     Idempotent.     RFC4918, Section 9.1; RFC8144, Section 2.1. */
   1963 #define MHD_HTTP_METHOD_STR_PROPFIND       "PROPFIND"
   1964 /* Not safe. Idempotent.     RFC4918, Section 9.2; RFC8144, Section 2.2. */
   1965 #define MHD_HTTP_METHOD_STR_PROPPATCH      "PROPPATCH"
   1966 /* Not safe. Idempotent.     RFC5842, Section 6. */
   1967 #define MHD_HTTP_METHOD_STR_REBIND         "REBIND"
   1968 /* Safe.     Idempotent.     RFC3253, Section 3.6; RFC8144, Section 2.1. */
   1969 #define MHD_HTTP_METHOD_STR_REPORT         "REPORT"
   1970 /* Safe.     Idempotent.     RFC5323, Section 2. */
   1971 #define MHD_HTTP_METHOD_STR_SEARCH         "SEARCH"
   1972 /* Not safe. Idempotent.     RFC5842, Section 5. */
   1973 #define MHD_HTTP_METHOD_STR_UNBIND         "UNBIND"
   1974 /* Not safe. Idempotent.     RFC3253, Section 4.5. */
   1975 #define MHD_HTTP_METHOD_STR_UNCHECKOUT     "UNCHECKOUT"
   1976 /* Not safe. Idempotent.     RFC2068, Section 19.6.1.3. */
   1977 #define MHD_HTTP_METHOD_STR_UNLINK         "UNLINK"
   1978 /* Not safe. Idempotent.     RFC4918, Section 9.11. */
   1979 #define MHD_HTTP_METHOD_STR_UNLOCK         "UNLOCK"
   1980 /* Not safe. Idempotent.     RFC3253, Section 7.1. */
   1981 #define MHD_HTTP_METHOD_STR_UPDATE         "UPDATE"
   1982 /* Not safe. Idempotent.     RFC4437, Section 7. */
   1983 #define MHD_HTTP_METHOD_STR_UPDATEREDIRECTREF "UPDATEREDIRECTREF"
   1984 /* Not safe. Idempotent.     RFC3253, Section 3.5. */
   1985 #define MHD_HTTP_METHOD_STR_VERSION_CONTROL "VERSION-CONTROL"
   1986 
   1987 /** @} */ /* end of group methods */
   1988 
   1989 #ifndef MHD_HTTP_POSTENCODING_DEFINED
   1990 
   1991 
   1992 /**
   1993  * @brief Possible encodings for HTML forms submitted as HTTP POST requests
   1994  *
   1995  * @defgroup postenc HTTP POST encodings
   1996  * See also: https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#form-submission-2
   1997  * @{
   1998  */
   1999 enum MHD_FIXED_ENUM_MHD_APP_SET_ MHD_HTTP_PostEncoding
   2000 {
   2001   /**
   2002    * No post encoding / broken data / unknown encoding
   2003    */
   2004   MHD_HTTP_POST_ENCODING_OTHER = 0
   2005   ,
   2006   /**
   2007    * "application/x-www-form-urlencoded"
   2008    * See https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#url-encoded-form-data
   2009    * See https://url.spec.whatwg.org/#application/x-www-form-urlencoded
   2010    * See https://datatracker.ietf.org/doc/html/rfc3986#section-2
   2011    */
   2012   MHD_HTTP_POST_ENCODING_FORM_URLENCODED = 1
   2013   ,
   2014   /**
   2015    * "multipart/form-data"
   2016    * See https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#multipart-form-data
   2017    * See https://www.rfc-editor.org/rfc/rfc7578.html
   2018    */
   2019   MHD_HTTP_POST_ENCODING_MULTIPART_FORMDATA = 2
   2020   ,
   2021   /**
   2022    * "text/plain"
   2023    * Introduced by HTML5
   2024    * See https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#plain-text-form-data
   2025    * @warning Format is ambiguous. Do not use unless there is a very strong reason.
   2026    */
   2027   MHD_HTTP_POST_ENCODING_TEXT_PLAIN = 3
   2028 };
   2029 
   2030 
   2031 /** @} */ /* end of group postenc */
   2032 
   2033 #define MHD_HTTP_POSTENCODING_DEFINED 1
   2034 #endif /* ! MHD_HTTP_POSTENCODING_DEFINED */
   2035 
   2036 
   2037 /**
   2038  * @brief Standard headers found in HTTP requests and responses.
   2039  *
   2040  * See: https://www.iana.org/assignments/http-fields/http-fields.xhtml
   2041  *
   2042  * @defgroup headers HTTP headers
   2043  * Registry export date: 2023-10-02
   2044  * @{
   2045  */
   2046 
   2047 /* Main HTTP headers. */
   2048 /* Permanent.     RFC9110, Section 12.5.1: HTTP Semantics */
   2049 #define MHD_HTTP_HEADER_ACCEPT       "Accept"
   2050 /* Deprecated.    RFC9110, Section 12.5.2: HTTP Semantics */
   2051 #define MHD_HTTP_HEADER_ACCEPT_CHARSET "Accept-Charset"
   2052 /* Permanent.     RFC9110, Section 12.5.3: HTTP Semantics */
   2053 #define MHD_HTTP_HEADER_ACCEPT_ENCODING "Accept-Encoding"
   2054 /* Permanent.     RFC9110, Section 12.5.4: HTTP Semantics */
   2055 #define MHD_HTTP_HEADER_ACCEPT_LANGUAGE "Accept-Language"
   2056 /* Permanent.     RFC9110, Section 14.3: HTTP Semantics */
   2057 #define MHD_HTTP_HEADER_ACCEPT_RANGES "Accept-Ranges"
   2058 /* Permanent.     RFC9111, Section 5.1: HTTP Caching */
   2059 #define MHD_HTTP_HEADER_AGE          "Age"
   2060 /* Permanent.     RFC9110, Section 10.2.1: HTTP Semantics */
   2061 #define MHD_HTTP_HEADER_ALLOW        "Allow"
   2062 /* Permanent.     RFC9110, Section 11.6.3: HTTP Semantics */
   2063 #define MHD_HTTP_HEADER_AUTHENTICATION_INFO "Authentication-Info"
   2064 /* Permanent.     RFC9110, Section 11.6.2: HTTP Semantics */
   2065 #define MHD_HTTP_HEADER_AUTHORIZATION "Authorization"
   2066 /* Permanent.     RFC9111, Section 5.2 */
   2067 #define MHD_HTTP_HEADER_CACHE_CONTROL "Cache-Control"
   2068 /* Permanent.     RFC9112, Section 9.6: HTTP/1.1 */
   2069 #define MHD_HTTP_HEADER_CLOSE        "Close"
   2070 /* Permanent.     RFC9110, Section 7.6.1: HTTP Semantics */
   2071 #define MHD_HTTP_HEADER_CONNECTION   "Connection"
   2072 /* Permanent.     RFC9110, Section 8.4: HTTP Semantics */
   2073 #define MHD_HTTP_HEADER_CONTENT_ENCODING "Content-Encoding"
   2074 /* Permanent.     RFC9110, Section 8.5: HTTP Semantics */
   2075 #define MHD_HTTP_HEADER_CONTENT_LANGUAGE "Content-Language"
   2076 /* Permanent.     RFC9110, Section 8.6: HTTP Semantics */
   2077 #define MHD_HTTP_HEADER_CONTENT_LENGTH "Content-Length"
   2078 /* Permanent.     RFC9110, Section 8.7: HTTP Semantics */
   2079 #define MHD_HTTP_HEADER_CONTENT_LOCATION "Content-Location"
   2080 /* Permanent.     RFC9110, Section 14.4: HTTP Semantics */
   2081 #define MHD_HTTP_HEADER_CONTENT_RANGE "Content-Range"
   2082 /* Permanent.     RFC9110, Section 8.3: HTTP Semantics */
   2083 #define MHD_HTTP_HEADER_CONTENT_TYPE "Content-Type"
   2084 /* Permanent.     RFC9110, Section 6.6.1: HTTP Semantics */
   2085 #define MHD_HTTP_HEADER_DATE         "Date"
   2086 /* Permanent.     RFC9110, Section 8.8.3: HTTP Semantics */
   2087 #define MHD_HTTP_HEADER_ETAG         "ETag"
   2088 /* Permanent.     RFC9110, Section 10.1.1: HTTP Semantics */
   2089 #define MHD_HTTP_HEADER_EXPECT       "Expect"
   2090 /* Permanent.     RFC9111, Section 5.3: HTTP Caching */
   2091 #define MHD_HTTP_HEADER_EXPIRES      "Expires"
   2092 /* Permanent.     RFC9110, Section 10.1.2: HTTP Semantics */
   2093 #define MHD_HTTP_HEADER_FROM         "From"
   2094 /* Permanent.     RFC9110, Section 7.2: HTTP Semantics */
   2095 #define MHD_HTTP_HEADER_HOST         "Host"
   2096 /* Permanent.     RFC9110, Section 13.1.1: HTTP Semantics */
   2097 #define MHD_HTTP_HEADER_IF_MATCH     "If-Match"
   2098 /* Permanent.     RFC9110, Section 13.1.3: HTTP Semantics */
   2099 #define MHD_HTTP_HEADER_IF_MODIFIED_SINCE "If-Modified-Since"
   2100 /* Permanent.     RFC9110, Section 13.1.2: HTTP Semantics */
   2101 #define MHD_HTTP_HEADER_IF_NONE_MATCH "If-None-Match"
   2102 /* Permanent.     RFC9110, Section 13.1.5: HTTP Semantics */
   2103 #define MHD_HTTP_HEADER_IF_RANGE     "If-Range"
   2104 /* Permanent.     RFC9110, Section 13.1.4: HTTP Semantics */
   2105 #define MHD_HTTP_HEADER_IF_UNMODIFIED_SINCE "If-Unmodified-Since"
   2106 /* Permanent.     RFC9110, Section 8.8.2: HTTP Semantics */
   2107 #define MHD_HTTP_HEADER_LAST_MODIFIED "Last-Modified"
   2108 /* Permanent.     RFC9110, Section 10.2.2: HTTP Semantics */
   2109 #define MHD_HTTP_HEADER_LOCATION     "Location"
   2110 /* Permanent.     RFC9110, Section 7.6.2: HTTP Semantics */
   2111 #define MHD_HTTP_HEADER_MAX_FORWARDS "Max-Forwards"
   2112 /* Permanent.     RFC9112, Appendix B.1: HTTP/1.1 */
   2113 #define MHD_HTTP_HEADER_MIME_VERSION "MIME-Version"
   2114 /* Deprecated.    RFC9111, Section 5.4: HTTP Caching */
   2115 #define MHD_HTTP_HEADER_PRAGMA       "Pragma"
   2116 /* Permanent.     RFC9110, Section 11.7.1: HTTP Semantics */
   2117 #define MHD_HTTP_HEADER_PROXY_AUTHENTICATE "Proxy-Authenticate"
   2118 /* Permanent.     RFC9110, Section 11.7.3: HTTP Semantics */
   2119 #define MHD_HTTP_HEADER_PROXY_AUTHENTICATION_INFO "Proxy-Authentication-Info"
   2120 /* Permanent.     RFC9110, Section 11.7.2: HTTP Semantics */
   2121 #define MHD_HTTP_HEADER_PROXY_AUTHORIZATION "Proxy-Authorization"
   2122 /* Permanent.     RFC9110, Section 14.2: HTTP Semantics */
   2123 #define MHD_HTTP_HEADER_RANGE        "Range"
   2124 /* Permanent.     RFC9110, Section 10.1.3: HTTP Semantics */
   2125 #define MHD_HTTP_HEADER_REFERER      "Referer"
   2126 /* Permanent.     RFC9110, Section 10.2.3: HTTP Semantics */
   2127 #define MHD_HTTP_HEADER_RETRY_AFTER  "Retry-After"
   2128 /* Permanent.     RFC9110, Section 10.2.4: HTTP Semantics */
   2129 #define MHD_HTTP_HEADER_SERVER       "Server"
   2130 /* Permanent.     RFC9110, Section 10.1.4: HTTP Semantics */
   2131 #define MHD_HTTP_HEADER_TE           "TE"
   2132 /* Permanent.     RFC9110, Section 6.6.2: HTTP Semantics */
   2133 #define MHD_HTTP_HEADER_TRAILER      "Trailer"
   2134 /* Permanent.     RFC9112, Section 6.1: HTTP Semantics */
   2135 #define MHD_HTTP_HEADER_TRANSFER_ENCODING "Transfer-Encoding"
   2136 /* Permanent.     RFC9110, Section 7.8: HTTP Semantics */
   2137 #define MHD_HTTP_HEADER_UPGRADE      "Upgrade"
   2138 /* Permanent.     RFC9110, Section 10.1.5: HTTP Semantics */
   2139 #define MHD_HTTP_HEADER_USER_AGENT   "User-Agent"
   2140 /* Permanent.     RFC9110, Section 12.5.5: HTTP Semantics */
   2141 #define MHD_HTTP_HEADER_VARY         "Vary"
   2142 /* Permanent.     RFC9110, Section 7.6.3: HTTP Semantics */
   2143 #define MHD_HTTP_HEADER_VIA          "Via"
   2144 /* Permanent.     RFC9110, Section 11.6.1: HTTP Semantics */
   2145 #define MHD_HTTP_HEADER_WWW_AUTHENTICATE "WWW-Authenticate"
   2146 /* Permanent.     RFC9110, Section 12.5.5: HTTP Semantics */
   2147 #define MHD_HTTP_HEADER_ASTERISK     "*"
   2148 
   2149 /* Additional HTTP headers. */
   2150 /* Permanent.     RFC 3229: Delta encoding in HTTP */
   2151 #define MHD_HTTP_HEADER_A_IM         "A-IM"
   2152 /* Permanent.     RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0) */
   2153 #define MHD_HTTP_HEADER_ACCEPT_ADDITIONS "Accept-Additions"
   2154 /* Permanent.     RFC 8942, Section 3.1: HTTP Client Hints */
   2155 #define MHD_HTTP_HEADER_ACCEPT_CH    "Accept-CH"
   2156 /* Permanent.     RFC 7089: HTTP Framework for Time-Based Access to Resource States -- Memento */
   2157 #define MHD_HTTP_HEADER_ACCEPT_DATETIME "Accept-Datetime"
   2158 /* Permanent.     RFC 2295: Transparent Content Negotiation in HTTP */
   2159 #define MHD_HTTP_HEADER_ACCEPT_FEATURES "Accept-Features"
   2160 /* Permanent.     RFC 5789: PATCH Method for HTTP */
   2161 #define MHD_HTTP_HEADER_ACCEPT_PATCH "Accept-Patch"
   2162 /* Permanent.     Linked Data Platform 1.0 */
   2163 #define MHD_HTTP_HEADER_ACCEPT_POST  "Accept-Post"
   2164 /* Permanent.     RFC-ietf-httpbis-message-signatures-19, Section 5.1: HTTP Message Signatures */
   2165 #define MHD_HTTP_HEADER_ACCEPT_SIGNATURE "Accept-Signature"
   2166 /* Permanent.     Fetch */
   2167 #define MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_CREDENTIALS \
   2168         "Access-Control-Allow-Credentials"
   2169 /* Permanent.     Fetch */
   2170 #define MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_HEADERS \
   2171         "Access-Control-Allow-Headers"
   2172 /* Permanent.     Fetch */
   2173 #define MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_METHODS \
   2174         "Access-Control-Allow-Methods"
   2175 /* Permanent.     Fetch */
   2176 #define MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN \
   2177         "Access-Control-Allow-Origin"
   2178 /* Permanent.     Fetch */
   2179 #define MHD_HTTP_HEADER_ACCESS_CONTROL_EXPOSE_HEADERS \
   2180         "Access-Control-Expose-Headers"
   2181 /* Permanent.     Fetch */
   2182 #define MHD_HTTP_HEADER_ACCESS_CONTROL_MAX_AGE "Access-Control-Max-Age"
   2183 /* Permanent.     Fetch */
   2184 #define MHD_HTTP_HEADER_ACCESS_CONTROL_REQUEST_HEADERS \
   2185         "Access-Control-Request-Headers"
   2186 /* Permanent.     Fetch */
   2187 #define MHD_HTTP_HEADER_ACCESS_CONTROL_REQUEST_METHOD \
   2188         "Access-Control-Request-Method"
   2189 /* Permanent.     RFC 7639, Section 2: The ALPN HTTP Header Field */
   2190 #define MHD_HTTP_HEADER_ALPN         "ALPN"
   2191 /* Permanent.     RFC 7838: HTTP Alternative Services */
   2192 #define MHD_HTTP_HEADER_ALT_SVC      "Alt-Svc"
   2193 /* Permanent.     RFC 7838: HTTP Alternative Services */
   2194 #define MHD_HTTP_HEADER_ALT_USED     "Alt-Used"
   2195 /* Permanent.     RFC 2295: Transparent Content Negotiation in HTTP */
   2196 #define MHD_HTTP_HEADER_ALTERNATES   "Alternates"
   2197 /* Permanent.     RFC 4437: Web Distributed Authoring and Versioning (WebDAV) Redirect Reference Resources */
   2198 #define MHD_HTTP_HEADER_APPLY_TO_REDIRECT_REF "Apply-To-Redirect-Ref"
   2199 /* Permanent.     RFC 8053, Section 4: HTTP Authentication Extensions for Interactive Clients */
   2200 #define MHD_HTTP_HEADER_AUTHENTICATION_CONTROL "Authentication-Control"
   2201 /* Permanent.     RFC9211: The Cache-Status HTTP Response Header Field */
   2202 #define MHD_HTTP_HEADER_CACHE_STATUS "Cache-Status"
   2203 /* Permanent.     RFC 8607, Section 5.1: Calendaring Extensions to WebDAV (CalDAV): Managed Attachments */
   2204 #define MHD_HTTP_HEADER_CAL_MANAGED_ID "Cal-Managed-ID"
   2205 /* Permanent.     RFC 7809, Section 7.1: Calendaring Extensions to WebDAV (CalDAV): Time Zones by Reference */
   2206 #define MHD_HTTP_HEADER_CALDAV_TIMEZONES "CalDAV-Timezones"
   2207 /* Permanent.     RFC9297 */
   2208 #define MHD_HTTP_HEADER_CAPSULE_PROTOCOL "Capsule-Protocol"
   2209 /* Permanent.     RFC9213: Targeted HTTP Cache Control */
   2210 #define MHD_HTTP_HEADER_CDN_CACHE_CONTROL "CDN-Cache-Control"
   2211 /* Permanent.     RFC 8586: Loop Detection in Content Delivery Networks (CDNs) */
   2212 #define MHD_HTTP_HEADER_CDN_LOOP     "CDN-Loop"
   2213 /* Permanent.     RFC 8739, Section 3.3: Support for Short-Term, Automatically Renewed (STAR) Certificates in the Automated Certificate Management Environment (ACME) */
   2214 #define MHD_HTTP_HEADER_CERT_NOT_AFTER "Cert-Not-After"
   2215 /* Permanent.     RFC 8739, Section 3.3: Support for Short-Term, Automatically Renewed (STAR) Certificates in the Automated Certificate Management Environment (ACME) */
   2216 #define MHD_HTTP_HEADER_CERT_NOT_BEFORE "Cert-Not-Before"
   2217 /* Permanent.     Clear Site Data */
   2218 #define MHD_HTTP_HEADER_CLEAR_SITE_DATA "Clear-Site-Data"
   2219 /* Permanent.     RFC9440, Section 2: Client-Cert HTTP Header Field */
   2220 #define MHD_HTTP_HEADER_CLIENT_CERT  "Client-Cert"
   2221 /* Permanent.     RFC9440, Section 2: Client-Cert HTTP Header Field */
   2222 #define MHD_HTTP_HEADER_CLIENT_CERT_CHAIN "Client-Cert-Chain"
   2223 /* Permanent.     RFC-ietf-httpbis-digest-headers-13, Section 2: Digest Fields */
   2224 #define MHD_HTTP_HEADER_CONTENT_DIGEST "Content-Digest"
   2225 /* Permanent.     RFC 6266: Use of the Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP) */
   2226 #define MHD_HTTP_HEADER_CONTENT_DISPOSITION "Content-Disposition"
   2227 /* Permanent.     The HTTP Distribution and Replication Protocol */
   2228 #define MHD_HTTP_HEADER_CONTENT_ID   "Content-ID"
   2229 /* Permanent.     Content Security Policy Level 3 */
   2230 #define MHD_HTTP_HEADER_CONTENT_SECURITY_POLICY "Content-Security-Policy"
   2231 /* Permanent.     Content Security Policy Level 3 */
   2232 #define MHD_HTTP_HEADER_CONTENT_SECURITY_POLICY_REPORT_ONLY \
   2233         "Content-Security-Policy-Report-Only"
   2234 /* Permanent.     RFC 6265: HTTP State Management Mechanism */
   2235 #define MHD_HTTP_HEADER_COOKIE       "Cookie"
   2236 /* Permanent.     HTML */
   2237 #define MHD_HTTP_HEADER_CROSS_ORIGIN_EMBEDDER_POLICY \
   2238         "Cross-Origin-Embedder-Policy"
   2239 /* Permanent.     HTML */
   2240 #define MHD_HTTP_HEADER_CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY \
   2241         "Cross-Origin-Embedder-Policy-Report-Only"
   2242 /* Permanent.     HTML */
   2243 #define MHD_HTTP_HEADER_CROSS_ORIGIN_OPENER_POLICY "Cross-Origin-Opener-Policy"
   2244 /* Permanent.     HTML */
   2245 #define MHD_HTTP_HEADER_CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY \
   2246         "Cross-Origin-Opener-Policy-Report-Only"
   2247 /* Permanent.     Fetch */
   2248 #define MHD_HTTP_HEADER_CROSS_ORIGIN_RESOURCE_POLICY \
   2249         "Cross-Origin-Resource-Policy"
   2250 /* Permanent.     RFC 5323: Web Distributed Authoring and Versioning (WebDAV) SEARCH */
   2251 #define MHD_HTTP_HEADER_DASL         "DASL"
   2252 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2253 #define MHD_HTTP_HEADER_DAV          "DAV"
   2254 /* Permanent.     RFC 3229: Delta encoding in HTTP */
   2255 #define MHD_HTTP_HEADER_DELTA_BASE   "Delta-Base"
   2256 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2257 #define MHD_HTTP_HEADER_DEPTH        "Depth"
   2258 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2259 #define MHD_HTTP_HEADER_DESTINATION  "Destination"
   2260 /* Permanent.     The HTTP Distribution and Replication Protocol */
   2261 #define MHD_HTTP_HEADER_DIFFERENTIAL_ID "Differential-ID"
   2262 /* Permanent.     RFC9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP) */
   2263 #define MHD_HTTP_HEADER_DPOP         "DPoP"
   2264 /* Permanent.     RFC9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP) */
   2265 #define MHD_HTTP_HEADER_DPOP_NONCE   "DPoP-Nonce"
   2266 /* Permanent.     RFC 8470: Using Early Data in HTTP */
   2267 #define MHD_HTTP_HEADER_EARLY_DATA   "Early-Data"
   2268 /* Permanent.     RFC9163: Expect-CT Extension for HTTP */
   2269 #define MHD_HTTP_HEADER_EXPECT_CT    "Expect-CT"
   2270 /* Permanent.     RFC 7239: Forwarded HTTP Extension */
   2271 #define MHD_HTTP_HEADER_FORWARDED    "Forwarded"
   2272 /* Permanent.     RFC 7486, Section 6.1.1: HTTP Origin-Bound Authentication (HOBA) */
   2273 #define MHD_HTTP_HEADER_HOBAREG      "Hobareg"
   2274 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2275 #define MHD_HTTP_HEADER_IF           "If"
   2276 /* Permanent.      RFC 6338: Scheduling Extensions to CalDAV */
   2277 #define MHD_HTTP_HEADER_IF_SCHEDULE_TAG_MATCH "If-Schedule-Tag-Match"
   2278 /* Permanent.     RFC 3229: Delta encoding in HTTP */
   2279 #define MHD_HTTP_HEADER_IM           "IM"
   2280 /* Permanent.     RFC 8473: Token Binding over HTTP */
   2281 #define MHD_HTTP_HEADER_INCLUDE_REFERRED_TOKEN_BINDING_ID \
   2282         "Include-Referred-Token-Binding-ID"
   2283 /* Permanent.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1 */
   2284 #define MHD_HTTP_HEADER_KEEP_ALIVE   "Keep-Alive"
   2285 /* Permanent.     RFC 3253: Versioning Extensions to WebDAV: (Web Distributed Authoring and Versioning) */
   2286 #define MHD_HTTP_HEADER_LABEL        "Label"
   2287 /* Permanent.     HTML */
   2288 #define MHD_HTTP_HEADER_LAST_EVENT_ID "Last-Event-ID"
   2289 /* Permanent.     RFC 8288: Web Linking */
   2290 #define MHD_HTTP_HEADER_LINK         "Link"
   2291 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2292 #define MHD_HTTP_HEADER_LOCK_TOKEN   "Lock-Token"
   2293 /* Permanent.     RFC 7089: HTTP Framework for Time-Based Access to Resource States -- Memento */
   2294 #define MHD_HTTP_HEADER_MEMENTO_DATETIME "Memento-Datetime"
   2295 /* Permanent.     RFC 2227: Simple Hit-Metering and Usage-Limiting for HTTP */
   2296 #define MHD_HTTP_HEADER_METER        "Meter"
   2297 /* Permanent.     RFC 2295: Transparent Content Negotiation in HTTP */
   2298 #define MHD_HTTP_HEADER_NEGOTIATE    "Negotiate"
   2299 /* Permanent.     Network Error Logging */
   2300 #define MHD_HTTP_HEADER_NEL          "NEL"
   2301 /* Permanent.     OData Version 4.01 Part 1: Protocol; OASIS; Chet_Ensign */
   2302 #define MHD_HTTP_HEADER_ODATA_ENTITYID "OData-EntityId"
   2303 /* Permanent.     OData Version 4.01 Part 1: Protocol; OASIS; Chet_Ensign */
   2304 #define MHD_HTTP_HEADER_ODATA_ISOLATION "OData-Isolation"
   2305 /* Permanent.     OData Version 4.01 Part 1: Protocol; OASIS; Chet_Ensign */
   2306 #define MHD_HTTP_HEADER_ODATA_MAXVERSION "OData-MaxVersion"
   2307 /* Permanent.     OData Version 4.01 Part 1: Protocol; OASIS; Chet_Ensign */
   2308 #define MHD_HTTP_HEADER_ODATA_VERSION "OData-Version"
   2309 /* Permanent.     RFC 8053, Section 3: HTTP Authentication Extensions for Interactive Clients */
   2310 #define MHD_HTTP_HEADER_OPTIONAL_WWW_AUTHENTICATE "Optional-WWW-Authenticate"
   2311 /* Permanent.     RFC 3648: Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol */
   2312 #define MHD_HTTP_HEADER_ORDERING_TYPE "Ordering-Type"
   2313 /* Permanent.     RFC 6454: The Web Origin Concept */
   2314 #define MHD_HTTP_HEADER_ORIGIN       "Origin"
   2315 /* Permanent.     HTML */
   2316 #define MHD_HTTP_HEADER_ORIGIN_AGENT_CLUSTER "Origin-Agent-Cluster"
   2317 /* Permanent.     RFC 8613, Section 11.1: Object Security for Constrained RESTful Environments (OSCORE) */
   2318 #define MHD_HTTP_HEADER_OSCORE       "OSCORE"
   2319 /* Permanent.     OASIS Project Specification 01; OASIS; Chet_Ensign */
   2320 #define MHD_HTTP_HEADER_OSLC_CORE_VERSION "OSLC-Core-Version"
   2321 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2322 #define MHD_HTTP_HEADER_OVERWRITE    "Overwrite"
   2323 /* Permanent.     HTML */
   2324 #define MHD_HTTP_HEADER_PING_FROM    "Ping-From"
   2325 /* Permanent.     HTML */
   2326 #define MHD_HTTP_HEADER_PING_TO      "Ping-To"
   2327 /* Permanent.     RFC 3648: Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol */
   2328 #define MHD_HTTP_HEADER_POSITION     "Position"
   2329 /* Permanent.     RFC 7240: Prefer Header for HTTP */
   2330 #define MHD_HTTP_HEADER_PREFER       "Prefer"
   2331 /* Permanent.     RFC 7240: Prefer Header for HTTP */
   2332 #define MHD_HTTP_HEADER_PREFERENCE_APPLIED "Preference-Applied"
   2333 /* Permanent.     RFC9218: Extensible Prioritization Scheme for HTTP */
   2334 #define MHD_HTTP_HEADER_PRIORITY     "Priority"
   2335 /* Permanent.     RFC9209: The Proxy-Status HTTP Response Header Field */
   2336 #define MHD_HTTP_HEADER_PROXY_STATUS "Proxy-Status"
   2337 /* Permanent.     RFC 7469: Public Key Pinning Extension for HTTP */
   2338 #define MHD_HTTP_HEADER_PUBLIC_KEY_PINS "Public-Key-Pins"
   2339 /* Permanent.     RFC 7469: Public Key Pinning Extension for HTTP */
   2340 #define MHD_HTTP_HEADER_PUBLIC_KEY_PINS_REPORT_ONLY \
   2341         "Public-Key-Pins-Report-Only"
   2342 /* Permanent.     RFC 4437: Web Distributed Authoring and Versioning (WebDAV) Redirect Reference Resources */
   2343 #define MHD_HTTP_HEADER_REDIRECT_REF "Redirect-Ref"
   2344 /* Permanent.     HTML */
   2345 #define MHD_HTTP_HEADER_REFRESH      "Refresh"
   2346 /* Permanent.     RFC 8555, Section 6.5.1: Automatic Certificate Management Environment (ACME) */
   2347 #define MHD_HTTP_HEADER_REPLAY_NONCE "Replay-Nonce"
   2348 /* Permanent.     RFC-ietf-httpbis-digest-headers-13, Section 3: Digest Fields */
   2349 #define MHD_HTTP_HEADER_REPR_DIGEST  "Repr-Digest"
   2350 /* Permanent.     RFC 6638: Scheduling Extensions to CalDAV */
   2351 #define MHD_HTTP_HEADER_SCHEDULE_REPLY "Schedule-Reply"
   2352 /* Permanent.     RFC 6338: Scheduling Extensions to CalDAV */
   2353 #define MHD_HTTP_HEADER_SCHEDULE_TAG "Schedule-Tag"
   2354 /* Permanent.     Fetch */
   2355 #define MHD_HTTP_HEADER_SEC_PURPOSE  "Sec-Purpose"
   2356 /* Permanent.     RFC 8473: Token Binding over HTTP */
   2357 #define MHD_HTTP_HEADER_SEC_TOKEN_BINDING "Sec-Token-Binding"
   2358 /* Permanent.     RFC 6455: The WebSocket Protocol */
   2359 #define MHD_HTTP_HEADER_SEC_WEBSOCKET_ACCEPT "Sec-WebSocket-Accept"
   2360 /* Permanent.     RFC 6455: The WebSocket Protocol */
   2361 #define MHD_HTTP_HEADER_SEC_WEBSOCKET_EXTENSIONS "Sec-WebSocket-Extensions"
   2362 /* Permanent.     RFC 6455: The WebSocket Protocol */
   2363 #define MHD_HTTP_HEADER_SEC_WEBSOCKET_KEY "Sec-WebSocket-Key"
   2364 /* Permanent.     RFC 6455: The WebSocket Protocol */
   2365 #define MHD_HTTP_HEADER_SEC_WEBSOCKET_PROTOCOL "Sec-WebSocket-Protocol"
   2366 /* Permanent.     RFC 6455: The WebSocket Protocol */
   2367 #define MHD_HTTP_HEADER_SEC_WEBSOCKET_VERSION "Sec-WebSocket-Version"
   2368 /* Permanent.     Server Timing */
   2369 #define MHD_HTTP_HEADER_SERVER_TIMING "Server-Timing"
   2370 /* Permanent.     RFC 6265: HTTP State Management Mechanism */
   2371 #define MHD_HTTP_HEADER_SET_COOKIE   "Set-Cookie"
   2372 /* Permanent.     RFC-ietf-httpbis-message-signatures-19, Section 4.2: HTTP Message Signatures */
   2373 #define MHD_HTTP_HEADER_SIGNATURE    "Signature"
   2374 /* Permanent.     RFC-ietf-httpbis-message-signatures-19, Section 4.1: HTTP Message Signatures */
   2375 #define MHD_HTTP_HEADER_SIGNATURE_INPUT "Signature-Input"
   2376 /* Permanent.     RFC 5023: The Atom Publishing Protocol */
   2377 #define MHD_HTTP_HEADER_SLUG         "SLUG"
   2378 /* Permanent.     Simple Object Access Protocol (SOAP) 1.1 */
   2379 #define MHD_HTTP_HEADER_SOAPACTION   "SoapAction"
   2380 /* Permanent.     RFC 2518: HTTP Extensions for Distributed Authoring -- WEBDAV */
   2381 #define MHD_HTTP_HEADER_STATUS_URI   "Status-URI"
   2382 /* Permanent.     RFC 6797: HTTP Strict Transport Security (HSTS) */
   2383 #define MHD_HTTP_HEADER_STRICT_TRANSPORT_SECURITY "Strict-Transport-Security"
   2384 /* Permanent.     RFC 8594: The Sunset HTTP Header Field */
   2385 #define MHD_HTTP_HEADER_SUNSET       "Sunset"
   2386 /* Permanent.     Edge Architecture Specification */
   2387 #define MHD_HTTP_HEADER_SURROGATE_CAPABILITY "Surrogate-Capability"
   2388 /* Permanent.     Edge Architecture Specification */
   2389 #define MHD_HTTP_HEADER_SURROGATE_CONTROL "Surrogate-Control"
   2390 /* Permanent.     RFC 2295: Transparent Content Negotiation in HTTP */
   2391 #define MHD_HTTP_HEADER_TCN          "TCN"
   2392 /* Permanent.     RFC 4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV) */
   2393 #define MHD_HTTP_HEADER_TIMEOUT      "Timeout"
   2394 /* Permanent.     RFC 8030, Section 5.4: Generic Event Delivery Using HTTP Push */
   2395 #define MHD_HTTP_HEADER_TOPIC        "Topic"
   2396 /* Permanent.     Trace Context */
   2397 #define MHD_HTTP_HEADER_TRACEPARENT  "Traceparent"
   2398 /* Permanent.     Trace Context */
   2399 #define MHD_HTTP_HEADER_TRACESTATE   "Tracestate"
   2400 /* Permanent.     RFC 8030, Section 5.2: Generic Event Delivery Using HTTP Push */
   2401 #define MHD_HTTP_HEADER_TTL          "TTL"
   2402 /* Permanent.     RFC 8030, Section 5.3: Generic Event Delivery Using HTTP Push */
   2403 #define MHD_HTTP_HEADER_URGENCY      "Urgency"
   2404 /* Permanent.     RFC 2295: Transparent Content Negotiation in HTTP */
   2405 #define MHD_HTTP_HEADER_VARIANT_VARY "Variant-Vary"
   2406 /* Permanent.     RFC-ietf-httpbis-digest-headers-13, Section 4: Digest Fields */
   2407 #define MHD_HTTP_HEADER_WANT_CONTENT_DIGEST "Want-Content-Digest"
   2408 /* Permanent.     RFC-ietf-httpbis-digest-headers-13, Section 4: Digest Fields */
   2409 #define MHD_HTTP_HEADER_WANT_REPR_DIGEST "Want-Repr-Digest"
   2410 /* Permanent.     Fetch */
   2411 #define MHD_HTTP_HEADER_X_CONTENT_TYPE_OPTIONS "X-Content-Type-Options"
   2412 /* Permanent.     HTML */
   2413 #define MHD_HTTP_HEADER_X_FRAME_OPTIONS "X-Frame-Options"
   2414 /* Provisional.   AMP-Cache-Transform HTTP request header */
   2415 #define MHD_HTTP_HEADER_AMP_CACHE_TRANSFORM "AMP-Cache-Transform"
   2416 /* Provisional.   OSLC Configuration Management Version 1.0. Part 3: Configuration Specification */
   2417 #define MHD_HTTP_HEADER_CONFIGURATION_CONTEXT "Configuration-Context"
   2418 /* Provisional.   RFC 6017: Electronic Data Interchange - Internet Integration (EDIINT) Features Header Field */
   2419 #define MHD_HTTP_HEADER_EDIINT_FEATURES "EDIINT-Features"
   2420 /* Provisional.   OData Version 4.01 Part 1: Protocol; OASIS; Chet_Ensign */
   2421 #define MHD_HTTP_HEADER_ISOLATION    "Isolation"
   2422 /* Provisional.   Permissions Policy */
   2423 #define MHD_HTTP_HEADER_PERMISSIONS_POLICY "Permissions-Policy"
   2424 /* Provisional.   Repeatable Requests Version 1.0; OASIS; Chet_Ensign */
   2425 #define MHD_HTTP_HEADER_REPEATABILITY_CLIENT_ID "Repeatability-Client-ID"
   2426 /* Provisional.   Repeatable Requests Version 1.0; OASIS; Chet_Ensign */
   2427 #define MHD_HTTP_HEADER_REPEATABILITY_FIRST_SENT "Repeatability-First-Sent"
   2428 /* Provisional.   Repeatable Requests Version 1.0; OASIS; Chet_Ensign */
   2429 #define MHD_HTTP_HEADER_REPEATABILITY_REQUEST_ID "Repeatability-Request-ID"
   2430 /* Provisional.   Repeatable Requests Version 1.0; OASIS; Chet_Ensign */
   2431 #define MHD_HTTP_HEADER_REPEATABILITY_RESULT "Repeatability-Result"
   2432 /* Provisional.   Reporting API */
   2433 #define MHD_HTTP_HEADER_REPORTING_ENDPOINTS "Reporting-Endpoints"
   2434 /* Provisional.   Global Privacy Control (GPC) */
   2435 #define MHD_HTTP_HEADER_SEC_GPC      "Sec-GPC"
   2436 /* Provisional.   Resource Timing Level 1 */
   2437 #define MHD_HTTP_HEADER_TIMING_ALLOW_ORIGIN "Timing-Allow-Origin"
   2438 /* Deprecated.    PEP - an Extension Mechanism for HTTP; status-change-http-experiments-to-historic */
   2439 #define MHD_HTTP_HEADER_C_PEP_INFO   "C-PEP-Info"
   2440 /* Deprecated.    White Paper: Joint Electronic Payment Initiative */
   2441 #define MHD_HTTP_HEADER_PROTOCOL_INFO "Protocol-Info"
   2442 /* Deprecated.    White Paper: Joint Electronic Payment Initiative */
   2443 #define MHD_HTTP_HEADER_PROTOCOL_QUERY "Protocol-Query"
   2444 /* Obsoleted.     Access Control for Cross-site Requests */
   2445 #define MHD_HTTP_HEADER_ACCESS_CONTROL "Access-Control"
   2446 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2447 #define MHD_HTTP_HEADER_C_EXT        "C-Ext"
   2448 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2449 #define MHD_HTTP_HEADER_C_MAN        "C-Man"
   2450 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2451 #define MHD_HTTP_HEADER_C_OPT        "C-Opt"
   2452 /* Obsoleted.     PEP - an Extension Mechanism for HTTP; status-change-http-experiments-to-historic */
   2453 #define MHD_HTTP_HEADER_C_PEP        "C-PEP"
   2454 /* Obsoleted.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1; RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1 */
   2455 #define MHD_HTTP_HEADER_CONTENT_BASE "Content-Base"
   2456 /* Obsoleted.     RFC 2616, Section 14.15: Hypertext Transfer Protocol -- HTTP/1.1; RFC 7231, Appendix B: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content */
   2457 #define MHD_HTTP_HEADER_CONTENT_MD5  "Content-MD5"
   2458 /* Obsoleted.     HTML 4.01 Specification */
   2459 #define MHD_HTTP_HEADER_CONTENT_SCRIPT_TYPE "Content-Script-Type"
   2460 /* Obsoleted.     HTML 4.01 Specification */
   2461 #define MHD_HTTP_HEADER_CONTENT_STYLE_TYPE "Content-Style-Type"
   2462 /* Obsoleted.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1 */
   2463 #define MHD_HTTP_HEADER_CONTENT_VERSION "Content-Version"
   2464 /* Obsoleted.     RFC 2965: HTTP State Management Mechanism; RFC 6265: HTTP State Management Mechanism */
   2465 #define MHD_HTTP_HEADER_COOKIE2      "Cookie2"
   2466 /* Obsoleted.     HTML 4.01 Specification */
   2467 #define MHD_HTTP_HEADER_DEFAULT_STYLE "Default-Style"
   2468 /* Obsoleted.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1 */
   2469 #define MHD_HTTP_HEADER_DERIVED_FROM "Derived-From"
   2470 /* Obsoleted.     RFC 3230: Instance Digests in HTTP; RFC-ietf-httpbis-digest-headers-13, Section 1.3: Digest Fields */
   2471 #define MHD_HTTP_HEADER_DIGEST       "Digest"
   2472 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2473 #define MHD_HTTP_HEADER_EXT          "Ext"
   2474 /* Obsoleted.     Implementation of OPS Over HTTP */
   2475 #define MHD_HTTP_HEADER_GETPROFILE   "GetProfile"
   2476 /* Obsoleted.     RFC 7540, Section 3.2.1: Hypertext Transfer Protocol Version 2 (HTTP/2) */
   2477 #define MHD_HTTP_HEADER_HTTP2_SETTINGS "HTTP2-Settings"
   2478 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2479 #define MHD_HTTP_HEADER_MAN          "Man"
   2480 /* Obsoleted.     Access Control for Cross-site Requests */
   2481 #define MHD_HTTP_HEADER_METHOD_CHECK "Method-Check"
   2482 /* Obsoleted.     Access Control for Cross-site Requests */
   2483 #define MHD_HTTP_HEADER_METHOD_CHECK_EXPIRES "Method-Check-Expires"
   2484 /* Obsoleted.     RFC 2774: An HTTP Extension Framework; status-change-http-experiments-to-historic */
   2485 #define MHD_HTTP_HEADER_OPT          "Opt"
   2486 /* Obsoleted.     The Platform for Privacy Preferences 1.0 (P3P1.0) Specification */
   2487 #define MHD_HTTP_HEADER_P3P          "P3P"
   2488 /* Obsoleted.     PEP - an Extension Mechanism for HTTP */
   2489 #define MHD_HTTP_HEADER_PEP          "PEP"
   2490 /* Obsoleted.     PEP - an Extension Mechanism for HTTP */
   2491 #define MHD_HTTP_HEADER_PEP_INFO     "Pep-Info"
   2492 /* Obsoleted.     PICS Label Distribution Label Syntax and Communication Protocols */
   2493 #define MHD_HTTP_HEADER_PICS_LABEL   "PICS-Label"
   2494 /* Obsoleted.     Implementation of OPS Over HTTP */
   2495 #define MHD_HTTP_HEADER_PROFILEOBJECT "ProfileObject"
   2496 /* Obsoleted.     PICS Label Distribution Label Syntax and Communication Protocols */
   2497 #define MHD_HTTP_HEADER_PROTOCOL     "Protocol"
   2498 /* Obsoleted.     PICS Label Distribution Label Syntax and Communication Protocols */
   2499 #define MHD_HTTP_HEADER_PROTOCOL_REQUEST "Protocol-Request"
   2500 /* Obsoleted.     Notification for Proxy Caches */
   2501 #define MHD_HTTP_HEADER_PROXY_FEATURES "Proxy-Features"
   2502 /* Obsoleted.     Notification for Proxy Caches */
   2503 #define MHD_HTTP_HEADER_PROXY_INSTRUCTION "Proxy-Instruction"
   2504 /* Obsoleted.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1 */
   2505 #define MHD_HTTP_HEADER_PUBLIC       "Public"
   2506 /* Obsoleted.     Access Control for Cross-site Requests */
   2507 #define MHD_HTTP_HEADER_REFERER_ROOT "Referer-Root"
   2508 /* Obsoleted.     RFC 2310: The Safe Response Header Field; status-change-http-experiments-to-historic */
   2509 #define MHD_HTTP_HEADER_SAFE         "Safe"
   2510 /* Obsoleted.     RFC 2660: The Secure HyperText Transfer Protocol; status-change-http-experiments-to-historic */
   2511 #define MHD_HTTP_HEADER_SECURITY_SCHEME "Security-Scheme"
   2512 /* Obsoleted.     RFC 2965: HTTP State Management Mechanism; RFC 6265: HTTP State Management Mechanism */
   2513 #define MHD_HTTP_HEADER_SET_COOKIE2  "Set-Cookie2"
   2514 /* Obsoleted.     Implementation of OPS Over HTTP */
   2515 #define MHD_HTTP_HEADER_SETPROFILE   "SetProfile"
   2516 /* Obsoleted.     RFC 2068: Hypertext Transfer Protocol -- HTTP/1.1 */
   2517 #define MHD_HTTP_HEADER_URI          "URI"
   2518 /* Obsoleted.     RFC 3230: Instance Digests in HTTP; RFC-ietf-httpbis-digest-headers-13, Section 1.3: Digest Fields */
   2519 #define MHD_HTTP_HEADER_WANT_DIGEST  "Want-Digest"
   2520 /* Obsoleted.     RFC9111, Section 5.5: HTTP Caching */
   2521 #define MHD_HTTP_HEADER_WARNING      "Warning"
   2522 
   2523 /* Headers removed from the registry. Do not use! */
   2524 /* Obsoleted.     RFC4229 */
   2525 #define MHD_HTTP_HEADER_COMPLIANCE   "Compliance"
   2526 /* Obsoleted.     RFC4229 */
   2527 #define MHD_HTTP_HEADER_CONTENT_TRANSFER_ENCODING "Content-Transfer-Encoding"
   2528 /* Obsoleted.     RFC4229 */
   2529 #define MHD_HTTP_HEADER_COST         "Cost"
   2530 /* Obsoleted.     RFC4229 */
   2531 #define MHD_HTTP_HEADER_MESSAGE_ID   "Message-ID"
   2532 /* Obsoleted.     RFC4229 */
   2533 #define MHD_HTTP_HEADER_NON_COMPLIANCE "Non-Compliance"
   2534 /* Obsoleted.     RFC4229 */
   2535 #define MHD_HTTP_HEADER_OPTIONAL     "Optional"
   2536 /* Obsoleted.     RFC4229 */
   2537 #define MHD_HTTP_HEADER_RESOLUTION_HINT "Resolution-Hint"
   2538 /* Obsoleted.     RFC4229 */
   2539 #define MHD_HTTP_HEADER_RESOLVER_LOCATION "Resolver-Location"
   2540 /* Obsoleted.     RFC4229 */
   2541 #define MHD_HTTP_HEADER_SUBOK        "SubOK"
   2542 /* Obsoleted.     RFC4229 */
   2543 #define MHD_HTTP_HEADER_SUBST        "Subst"
   2544 /* Obsoleted.     RFC4229 */
   2545 #define MHD_HTTP_HEADER_TITLE        "Title"
   2546 /* Obsoleted.     RFC4229 */
   2547 #define MHD_HTTP_HEADER_UA_COLOR     "UA-Color"
   2548 /* Obsoleted.     RFC4229 */
   2549 #define MHD_HTTP_HEADER_UA_MEDIA     "UA-Media"
   2550 /* Obsoleted.     RFC4229 */
   2551 #define MHD_HTTP_HEADER_UA_PIXELS    "UA-Pixels"
   2552 /* Obsoleted.     RFC4229 */
   2553 #define MHD_HTTP_HEADER_UA_RESOLUTION "UA-Resolution"
   2554 /* Obsoleted.     RFC4229 */
   2555 #define MHD_HTTP_HEADER_UA_WINDOWPIXELS "UA-Windowpixels"
   2556 /* Obsoleted.     RFC4229 */
   2557 #define MHD_HTTP_HEADER_VERSION      "Version"
   2558 /* Obsoleted.     W3C Mobile Web Best Practices Working Group */
   2559 #define MHD_HTTP_HEADER_X_DEVICE_ACCEPT "X-Device-Accept"
   2560 /* Obsoleted.     W3C Mobile Web Best Practices Working Group */
   2561 #define MHD_HTTP_HEADER_X_DEVICE_ACCEPT_CHARSET "X-Device-Accept-Charset"
   2562 /* Obsoleted.     W3C Mobile Web Best Practices Working Group */
   2563 #define MHD_HTTP_HEADER_X_DEVICE_ACCEPT_ENCODING "X-Device-Accept-Encoding"
   2564 /* Obsoleted.     W3C Mobile Web Best Practices Working Group */
   2565 #define MHD_HTTP_HEADER_X_DEVICE_ACCEPT_LANGUAGE "X-Device-Accept-Language"
   2566 /* Obsoleted.     W3C Mobile Web Best Practices Working Group */
   2567 #define MHD_HTTP_HEADER_X_DEVICE_USER_AGENT "X-Device-User-Agent"
   2568 
   2569 
   2570 /**
   2571  * Predefined list of headers
   2572  * To be filled with HPACK static data
   2573  */
   2574 enum MHD_PredefinedHeader
   2575 {
   2576   MHD_PREDEF_ACCEPT_CHARSET = 15,
   2577   MHD_PREDEF_ACCEPT_LANGUAGE = 17
   2578 };
   2579 
   2580 
   2581 /** @} */ /* end of group headers */
   2582 
   2583 /**
   2584  * A client has requested the given url using the given method
   2585  * (#MHD_HTTP_METHOD_GET, #MHD_HTTP_METHOD_PUT,
   2586  * #MHD_HTTP_METHOD_DELETE, #MHD_HTTP_METHOD_POST, etc).
   2587  * If @a upload_size is not zero and response action is provided by this
   2588  * callback, then upload will be discarded and the stream (the connection for
   2589  * HTTP/1.1) will be closed after sending the response.
   2590  *
   2591  * @param cls argument given together with the function
   2592  *        pointer when the handler was registered with MHD
   2593  * @param request the request object
   2594  * @param path the requested uri (without arguments after "?")
   2595  * @param method the HTTP method used (#MHD_HTTP_METHOD_GET,
   2596  *        #MHD_HTTP_METHOD_PUT, etc.)
   2597  * @param upload_size the size of the message upload content payload,
   2598  *                    #MHD_SIZE_UNKNOWN for chunked uploads (if the
   2599  *                    final chunk has not been processed yet)
   2600  * @return action how to proceed, NULL
   2601  *         if the request must be aborted due to a serious
   2602  *         error while handling the request (implies closure
   2603  *         of underling data stream, for HTTP/1.1 it means
   2604  *         socket closure).
   2605  */
   2606 typedef const struct MHD_Action *
   2607 (MHD_FN_PAR_NONNULL_ (2) MHD_FN_PAR_NONNULL_ (3)
   2608  *MHD_RequestCallback)(void *cls,
   2609                        struct MHD_Request *MHD_RESTRICT request,
   2610                        const struct MHD_String *MHD_RESTRICT path,
   2611                        enum MHD_HTTP_Method method,
   2612                        uint_fast64_t upload_size);
   2613 
   2614 
   2615 /**
   2616  * Create (but do not yet start) an MHD daemon.
   2617  * Usually, various options are set before
   2618  * starting the daemon with #MHD_daemon_start().
   2619  *
   2620  * @param req_cb the function to be called for incoming requests
   2621  * @param req_cb_cls the closure for @a cb
   2622  * @return the pointer to the new object on success,
   2623  *         NULL on error (like out-of-memory)
   2624  */
   2625 MHD_EXTERN_ struct MHD_Daemon *
   2626 MHD_daemon_create (MHD_RequestCallback req_cb,
   2627                    void *req_cb_cls)
   2628 MHD_FN_MUST_CHECK_RESULT_;
   2629 
   2630 
   2631 /**
   2632  * Start a webserver.
   2633  * This function:
   2634  * + checks the combination of set options,
   2635  * + initialises the TLS library (if TLS is requested),
   2636  * + creates the listen socket (if not provided and if allowed),
   2637  * + starts the daemon internal threads (if allowed)
   2638  *
   2639  * @param[in,out] daemon daemon to start; you can no longer set
   2640  *        options on this daemon after this call!
   2641  * @return #MHD_SC_OK on success
   2642  * @ingroup daemon
   2643  */
   2644 MHD_EXTERN_ enum MHD_StatusCode
   2645 MHD_daemon_start (struct MHD_Daemon *daemon)
   2646 MHD_FN_PAR_NONNULL_ (1) MHD_FN_MUST_CHECK_RESULT_;
   2647 
   2648 
   2649 /**
   2650  * Stop accepting connections from the listening socket.  Allows
   2651  * clients to continue processing, but stops accepting new
   2652  * connections.  Note that the caller is responsible for closing the
   2653  * returned socket; however, if MHD is run using threads (anything but
   2654  * external select mode), it must not be closed until AFTER
   2655  * #MHD_daemon_destroy() has been called (as it is theoretically possible
   2656  * that an existing thread is still using it).
   2657  *
   2658  * @param[in,out] daemon the daemon to stop accepting new connections for
   2659  * @return the old listen socket on success, #MHD_INVALID_SOCKET if
   2660  *         the daemon was already not listening anymore, or
   2661  *         was never started, or has no listen socket.
   2662  * @ingroup daemon
   2663  */
   2664 MHD_EXTERN_ MHD_Socket
   2665 MHD_daemon_quiesce (struct MHD_Daemon *daemon)
   2666 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1);
   2667 
   2668 
   2669 /**
   2670  * Shutdown and destroy an HTTP daemon.
   2671  *
   2672  * @param[in] daemon daemon to stop
   2673  * @ingroup daemon
   2674  */
   2675 MHD_EXTERN_ void
   2676 MHD_daemon_destroy (struct MHD_Daemon *daemon)
   2677 MHD_FN_PAR_NONNULL_ALL_;
   2678 
   2679 /* ******************* External event loop ************************ */
   2680 
   2681 /**
   2682  * @defgroup event External network events processing
   2683  */
   2684 
   2685 /**
   2686  * The network status of the socket.
   2687  * When set by MHD (by #MHD_SocketRegistrationUpdateCallback or
   2688  * similar) it indicates a request to watch for specific socket state:
   2689  * watch for readiness for receiving the data, watch for readiness for sending
   2690  * the data and/or watch for exception state of the socket.
   2691  * When set by application (and provided for #MHD_daemon_event_update() and
   2692  * similar) it must indicate the actual status of the socket.
   2693  *
   2694  * Any actual state is a bitwise OR combination of #MHD_FD_STATE_RECV,
   2695  * #MHD_FD_STATE_SEND, #MHD_FD_STATE_EXCEPT.
   2696  * @ingroup event
   2697  */
   2698 enum MHD_FIXED_ENUM_ MHD_FdState
   2699 {
   2700   /**
   2701    * The socket is not ready for receiving or sending and
   2702    * does not have any exceptional state.
   2703    * The state never set by MHD, except de-registration of the sockets
   2704    * in a #MHD_SocketRegistrationUpdateCallback.
   2705    */
   2706   MHD_FD_STATE_NONE = 0
   2707   ,
   2708   /* ** Three bit-flags ** */
   2709 
   2710   /**
   2711    * Indicates that socket should be watched for incoming data
   2712    * (when set by #MHD_SocketRegistrationUpdateCallback)
   2713    * / socket has incoming data ready to read (when used for
   2714    * #MHD_daemon_event_update())
   2715    */
   2716   MHD_FD_STATE_RECV = 1 << 0
   2717   ,
   2718   /**
   2719    * Indicates that socket should be watched for availability for sending
   2720    * (when set by #MHD_SocketRegistrationUpdateCallback)
   2721    * / socket has ability to send data (when used for
   2722    * #MHD_daemon_event_update())
   2723    */
   2724   MHD_FD_STATE_SEND = 1 << 1
   2725   ,
   2726   /**
   2727    * Indicates that socket should be watched for disconnect, out-of-band
   2728    * data available or high priority data available (when set by
   2729    * #MHD_SocketRegistrationUpdateCallback)
   2730    * / socket has been disconnected, has out-of-band data available or
   2731    * has high priority data available (when used for
   2732    * #MHD_daemon_event_update()). This status must not include "remote
   2733    * peer shut down writing" status.
   2734    * Note: #MHD_SocketRegistrationUpdateCallback() always set it as exceptions
   2735    * must be always watched.
   2736    */
   2737   MHD_FD_STATE_EXCEPT = 1 << 2
   2738   ,
   2739 
   2740   /* The rest of the list is a bit-wise combination of three main
   2741    * states. Application may use three main states directly as
   2742    * a bit-mask instead of using of the following values
   2743    */
   2744 
   2745   /**
   2746    * Combination of #MHD_FD_STATE_RECV and #MHD_FD_STATE_SEND states.
   2747    */
   2748   MHD_FD_STATE_RECV_SEND = MHD_FD_STATE_RECV | MHD_FD_STATE_SEND
   2749   ,
   2750   /**
   2751    * Combination of #MHD_FD_STATE_RECV and #MHD_FD_STATE_EXCEPT states.
   2752    */
   2753   MHD_FD_STATE_RECV_EXCEPT = MHD_FD_STATE_RECV | MHD_FD_STATE_EXCEPT
   2754   ,
   2755   /**
   2756    * Combination of #MHD_FD_STATE_RECV and #MHD_FD_STATE_EXCEPT states.
   2757    */
   2758   MHD_FD_STATE_SEND_EXCEPT = MHD_FD_STATE_RECV | MHD_FD_STATE_EXCEPT
   2759   ,
   2760   /**
   2761    * Combination of #MHD_FD_STATE_RECV, #MHD_FD_STATE_SEND and
   2762    * #MHD_FD_STATE_EXCEPT states.
   2763    */
   2764   MHD_FD_STATE_RECV_SEND_EXCEPT = \
   2765     MHD_FD_STATE_RECV | MHD_FD_STATE_SEND | MHD_FD_STATE_EXCEPT
   2766 };
   2767 
   2768 /**
   2769  * Checks whether specific @a state is enabled/set in the @a var
   2770  */
   2771 #define MHD_FD_STATE_IS_SET(var,state)               \
   2772         (MHD_FD_STATE_NONE !=                        \
   2773          ((enum MHD_FdState) (((unsigned int) (var)) \
   2774                               & ((unsigned int) (state)))))
   2775 
   2776 /**
   2777  * Checks whether RECV is enabled/set in the @a var
   2778  */
   2779 #define MHD_FD_STATE_IS_SET_RECV(var) \
   2780         MHD_FD_STATE_IS_SET ((var),MHD_FD_STATE_RECV)
   2781 /**
   2782  * Checks whether SEND is enabled/set in the @a var
   2783  */
   2784 #define MHD_FD_STATE_IS_SET_SEND(var) \
   2785         MHD_FD_STATE_IS_SET ((var),MHD_FD_STATE_SEND)
   2786 /**
   2787  * Checks whether EXCEPT is enabled/set in the @a var
   2788  */
   2789 #define MHD_FD_STATE_IS_SET_EXCEPT(var) \
   2790         MHD_FD_STATE_IS_SET ((var),MHD_FD_STATE_EXCEPT)
   2791 
   2792 
   2793 /**
   2794  * Set/enable specific @a state in the @a var
   2795  */
   2796 #define MHD_FD_STATE_SET(var,state) \
   2797         ((var) =                    \
   2798            (enum MHD_FdState) (((unsigned int) var) | ((unsigned int) state)))
   2799 /**
   2800  * Set/enable RECV state in the @a var
   2801  */
   2802 #define MHD_FD_STATE_SET_RECV(var) MHD_FD_STATE_SET ((var),MHD_FD_STATE_RECV)
   2803 /**
   2804  * Set/enable SEND state in the @a var
   2805  */
   2806 #define MHD_FD_STATE_SET_SEND(var) MHD_FD_STATE_SET ((var),MHD_FD_STATE_SEND)
   2807 /**
   2808  * Set/enable EXCEPT state in the @a var
   2809  */
   2810 #define MHD_FD_STATE_SET_EXCEPT(var) \
   2811         MHD_FD_STATE_SET ((var),MHD_FD_STATE_EXCEPT)
   2812 
   2813 /**
   2814  * Clear/disable specific @a state in the @a var
   2815  */
   2816 #define MHD_FD_STATE_CLEAR(var,state) \
   2817         ( (var) =                     \
   2818             (enum MHD_FdState)        \
   2819             (((unsigned int) var)     \
   2820              & ((enum MHD_FdState) (~((unsigned int) state)))) \
   2821         )
   2822 /**
   2823  * Clear/disable RECV state in the @a var
   2824  */
   2825 #define MHD_FD_STATE_CLEAR_RECV(var) \
   2826         MHD_FD_STATE_CLEAR ((var),MHD_FD_STATE_RECV)
   2827 /**
   2828  * Clear/disable SEND state in the @a var
   2829  */
   2830 #define MHD_FD_STATE_CLEAR_SEND(var) \
   2831         MHD_FD_STATE_CLEAR ((var),MHD_FD_STATE_SEND)
   2832 /**
   2833  * Clear/disable EXCEPT state in the @a var
   2834  */
   2835 #define MHD_FD_STATE_CLEAR_EXCEPT(var) \
   2836         MHD_FD_STATE_CLEAR ((var),MHD_FD_STATE_EXCEPT)
   2837 
   2838 
   2839 /**
   2840  * The context data to be used for updates of the socket state
   2841  */
   2842 struct MHD_EventUpdateContext;
   2843 
   2844 
   2845 /* Define MHD_APP_SOCKET_CNTX_TYPE to the socket context type before
   2846  * including this header.
   2847  * This is optional, but improves the types safety.
   2848  * For example:
   2849  * #define MHD_APP_SOCKET_CNTX_TYPE struct my_structure
   2850  */
   2851 #ifndef MHD_APP_SOCKET_CNTX_TYPE
   2852 #  define MHD_APP_SOCKET_CNTX_TYPE void
   2853 #endif
   2854 
   2855 /**
   2856  * The callback for registration/de-registration of the sockets to watch.
   2857  *
   2858  * This callback must not call #MHD_daemon_destroy(), #MHD_daemon_quiesce(),
   2859  * #MHD_daemon_add_connection().
   2860  *
   2861  * @param cls the closure
   2862  * @param fd the socket to watch
   2863  * @param watch_for the states of the @a fd to watch, if set to
   2864  *                  #MHD_FD_STATE_NONE the socket must be de-registred
   2865  * @param app_cntx_old the old application defined context for the socket,
   2866  *                     NULL if @a fd socket was not registered before
   2867  * @param ecb_cntx the context handle to be used
   2868  *                 with #MHD_daemon_event_update()
   2869  * @return must be NULL for the removed (de-registred) sockets,
   2870  *         for new and updated sockets: NULL in case of error (the connection
   2871  *         will be aborted or daemon failed to start if FD does not belong to
   2872  *         connection)
   2873  *         or the new socket context (opaque for MHD, must be non-NULL)
   2874  * @sa #MHD_D_OPTION_REREGISTER_ALL
   2875  * @ingroup event
   2876  */
   2877 typedef MHD_APP_SOCKET_CNTX_TYPE *
   2878 (MHD_FN_PAR_NONNULL_ (5)
   2879  *MHD_SocketRegistrationUpdateCallback)(
   2880   void *cls,
   2881   MHD_Socket fd,
   2882   enum MHD_FdState watch_for,
   2883   MHD_APP_SOCKET_CNTX_TYPE *app_cntx_old,
   2884   struct MHD_EventUpdateContext *ecb_cntx);
   2885 
   2886 
   2887 /**
   2888  * Update the sockets state.
   2889  * Must be called for every socket that got state updated.
   2890  * For #MHD_D_OPTION_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL() mode
   2891  * this function must be called for each socket between any two calls of
   2892  * #MHD_daemon_process_reg_events() function.
   2893  * Available only for daemons started in
   2894  * #MHD_D_OPTION_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL or
   2895  * #MHD_D_OPTION_WM_EXTERNAL_EVENT_LOOP_CB_EDGE modes.
   2896  * @param daemon the daemon handle
   2897  * @param ecb_cntx the context handle provided
   2898  *                 for #MHD_SocketRegistrationUpdateCallback
   2899  * @param fd_current_state the current state of the socket
   2900  * @ingroup event
   2901  */
   2902 MHD_EXTERN_ void
   2903 MHD_daemon_event_update (
   2904   struct MHD_Daemon *MHD_RESTRICT daemon,
   2905   struct MHD_EventUpdateContext *MHD_RESTRICT ecb_cntx,
   2906   enum MHD_FdState fd_current_state)
   2907 MHD_FN_PAR_NONNULL_ (1) MHD_FN_PAR_NONNULL_ (2);
   2908 
   2909 
   2910 /**
   2911  * Perform all daemon activities based on FDs events provided earlier by
   2912  * application via #MHD_daemon_event_update().
   2913  *
   2914  * This function accepts new connections (if any), performs HTTP communications
   2915  * on all active connections, closes connections as needed and performs FDs
   2916  * registration updates by calling #MHD_SocketRegistrationUpdateCallback
   2917  * callback for every socket that needs to be added/updated/removed.
   2918  *
   2919  * Available only for daemons started in #MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL or
   2920  * #MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE modes.
   2921  *
   2922  * When used in #MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL mode, application must
   2923  * provide all updates by calling #MHD_daemon_event_update() for every
   2924  * registered FD between any two calls of this function.
   2925  *
   2926  * @param daemon the daemon handle
   2927  * @param[out] next_max_wait_milsec the optional pointer to receive the
   2928                                     next maximum wait time in milliseconds
   2929                                     to be used for the sockets polling
   2930                                     function, can be NULL
   2931  * @return #MHD_SC_OK on success,
   2932  *         error code otherwise
   2933  * @sa #MHD_D_OPTION_REREGISTER_ALL
   2934  * @ingroup event
   2935  */
   2936 MHD_EXTERN_ enum MHD_StatusCode
   2937 MHD_daemon_process_reg_events (
   2938   struct MHD_Daemon *MHD_RESTRICT daemon,
   2939   uint_fast64_t *MHD_RESTRICT next_max_wait_milsec)
   2940 MHD_FN_PAR_NONNULL_ (1);
   2941 
   2942 /* ********************* daemon options ************** */
   2943 
   2944 
   2945 /**
   2946  * Which threading and polling mode should be used by MHD?
   2947  */
   2948 enum MHD_FIXED_ENUM_APP_SET_ MHD_WorkMode
   2949 {
   2950   /**
   2951    * Work mode with no internal threads.
   2952    * The application periodically calls #MHD_daemon_process_blocking(), where
   2953    * MHD internally checks all sockets automatically.
   2954    * This is the default mode.
   2955    * Use helper macro #MHD_D_OPTION_WM_EXTERNAL_PERIODIC() to enable
   2956    * this mode.
   2957    */
   2958   MHD_WM_EXTERNAL_PERIODIC = 0
   2959   ,
   2960   /**
   2961    * Work mode with an external event loop with level triggers.
   2962    * MHD provides registration of all FDs to be monitored by using
   2963    * #MHD_SocketRegistrationUpdateCallback, application performs level triggered
   2964    * FDs polling (like select() or poll()), calls function
   2965    * #MHD_daemon_event_update() for every registered FD and then calls main
   2966    * function MHD_daemon_process_reg_events() to process the data.
   2967    * Use helper macro #MHD_D_OPTION_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL() to enable
   2968    * this mode.
   2969    * @sa #MHD_D_OPTION_REREGISTER_ALL
   2970    */
   2971   MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL = 8
   2972   ,
   2973   /**
   2974    * Work mode with an external event loop with edge triggers.
   2975    * MHD provides registration of all FDs to be monitored by using
   2976    * #MHD_SocketRegistrationUpdateCallback, application performs edge triggered
   2977    * sockets polling (like epoll with EPOLLET), calls function
   2978    * #MHD_daemon_event_update() for FDs with updated states and then calls main
   2979    * function MHD_daemon_process_reg_events() to process the data.
   2980    * Use helper macro #MHD_D_OPTION_WM_EXTERNAL_EVENT_LOOP_CB_EDGE() to enable
   2981    * this mode.
   2982    * @sa #MHD_D_OPTION_REREGISTER_ALL
   2983    */
   2984   MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE = 9
   2985   ,
   2986   /**
   2987    * Work mode with no internal threads and aggregate watch FD.
   2988    * Application uses #MHD_DAEMON_INFO_FIXED_AGGREAGATE_FD to get single FD
   2989    * that gets triggered by any MHD event.
   2990    * This FD can be watched as an aggregate indicator for all MHD events.
   2991    * This mode is available only on selected platforms (currently
   2992    * GNU/Linux and OpenIndiana only), see #MHD_LIB_INFO_FIXED_HAS_AGGREGATE_FD.
   2993    * When the FD is triggered, #MHD_daemon_process_nonblocking() should
   2994    * be called.
   2995    * Use helper macro #MHD_D_OPTION_WM_EXTERNAL_SINGLE_FD_WATCH() to enable
   2996    * this mode.
   2997    */
   2998   MHD_WM_EXTERNAL_SINGLE_FD_WATCH = 16
   2999   ,
   3000   /**
   3001    * Work mode with one or more worker threads.
   3002    * If specified number of threads is one, then daemon starts with single
   3003    * worker thread that handles all connections.
   3004    * If number of threads is larger than one, then that number of worker
   3005    * threads, and handling of connection is distributed among the workers.
   3006    * Use helper macro #MHD_D_OPTION_WM_WORKER_THREADS() to enable
   3007    * this mode.
   3008    */
   3009   MHD_WM_WORKER_THREADS = 24
   3010   ,
   3011   /**
   3012    * Work mode with one internal thread for listening and additional threads
   3013    * per every connection.  Use this if handling requests is CPU-intensive or
   3014    * blocking, your application is thread-safe and you have plenty of
   3015    * memory (per connection).
   3016    * Use helper macro #MHD_D_OPTION_WM_THREAD_PER_CONNECTION() to enable
   3017    * this mode.
   3018    */
   3019   MHD_WM_THREAD_PER_CONNECTION = 32
   3020 };
   3021 
   3022 /**
   3023  * Work mode parameters for #MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL and
   3024  * #MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE modes
   3025  */
   3026 struct MHD_WorkModeExternalEventLoopCBParam
   3027 {
   3028   /**
   3029    * Socket registration callback
   3030    */
   3031   MHD_SocketRegistrationUpdateCallback reg_cb;
   3032   /**
   3033    * Closure for the @a reg_cb
   3034    */
   3035   void *reg_cb_cls;
   3036 };
   3037 
   3038 /**
   3039  * MHD work mode parameters
   3040  */
   3041 union MHD_WorkModeParam
   3042 {
   3043   /**
   3044    * Work mode parameters for #MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL and
   3045    * #MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE modes
   3046    */
   3047   struct MHD_WorkModeExternalEventLoopCBParam v_external_event_loop_cb;
   3048   /**
   3049    * Number of worker threads for #MHD_WM_WORKER_THREADS.
   3050    * If set to one, then daemon starts with single worker thread that process
   3051    * all connections.
   3052    * If set to value larger than one, then that number of worker threads
   3053    * and distributed handling of requests among the workers.
   3054    * Zero is treated as one.
   3055    */
   3056   unsigned int num_worker_threads;
   3057 };
   3058 
   3059 /**
   3060  * Parameter for #MHD_D_O_WORK_MODE().
   3061  * Not recommended to be used directly, better use macro/functions to create it:
   3062  * #MHD_WM_OPTION_EXTERNAL_PERIODIC(),
   3063  * #MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_LEVEL(),
   3064  * #MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_EDGE(),
   3065  * #MHD_WM_OPTION_EXTERNAL_SINGLE_FD_WATCH(),
   3066  * #MHD_WM_OPTION_WORKER_THREADS(),
   3067  * #MHD_WM_OPTION_THREAD_PER_CONNECTION()
   3068  */
   3069 struct MHD_WorkModeWithParam
   3070 {
   3071   /**
   3072    * The work mode for MHD
   3073    */
   3074   enum MHD_WorkMode mode;
   3075   /**
   3076    * The parameters used for specified work mode
   3077    */
   3078   union MHD_WorkModeParam params;
   3079 };
   3080 
   3081 
   3082 #if defined(MHD_USE_COMPOUND_LITERALS) && defined(MHD_USE_DESIG_NEST_INIT)
   3083 /**
   3084  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3085  * no internal threads.
   3086  * The application periodically calls #MHD_daemon_process_blocking(), where
   3087  * MHD internally checks all sockets automatically.
   3088  * This is the default mode.
   3089  * @return the object of struct MHD_WorkModeWithParam with requested values
   3090  */
   3091 #  define MHD_WM_OPTION_EXTERNAL_PERIODIC()     \
   3092         MHD_NOWARN_COMPOUND_LITERALS_                 \
   3093           (const struct MHD_WorkModeWithParam)          \
   3094         {                                             \
   3095           .mode = (MHD_WM_EXTERNAL_PERIODIC)          \
   3096         }                                             \
   3097         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3098 
   3099 /**
   3100  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3101  * an external event loop with level triggers.
   3102  * Application uses #MHD_SocketRegistrationUpdateCallback, level triggered
   3103  * sockets polling (like select() or poll()) and #MHD_daemon_event_update().
   3104  * @param cb_val the callback for sockets registration
   3105  * @param cb_cls_val the closure for the @a cv_val callback
   3106  * @return the object of struct MHD_WorkModeWithParam with requested values
   3107  */
   3108 #  define MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_LEVEL(cb_val,cb_cls_val) \
   3109         MHD_NOWARN_COMPOUND_LITERALS_                                         \
   3110           (const struct MHD_WorkModeWithParam)                                  \
   3111         {                                                                     \
   3112           .mode = (MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL),                      \
   3113           .params.v_external_event_loop_cb.reg_cb = (cb_val),                 \
   3114           .params.v_external_event_loop_cb.reg_cb_cls = (cb_cls_val)          \
   3115         }                                                                     \
   3116         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3117 
   3118 /**
   3119  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3120  * an external event loop with edge triggers.
   3121  * Application uses #MHD_SocketRegistrationUpdateCallback, edge triggered
   3122  * sockets polling (like epoll with EPOLLET) and #MHD_daemon_event_update().
   3123  * @param cb_val the callback for sockets registration
   3124  * @param cb_cls_val the closure for the @a cv_val callback
   3125  * @return the object of struct MHD_WorkModeWithParam with requested values
   3126  */
   3127 #  define MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_EDGE(cb_val,cb_cls_val)  \
   3128         MHD_NOWARN_COMPOUND_LITERALS_                                         \
   3129           (const struct MHD_WorkModeWithParam)                                  \
   3130         {                                                                     \
   3131           .mode = (MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE),                       \
   3132           .params.v_external_event_loop_cb.reg_cb = (cb_val),                 \
   3133           .params.v_external_event_loop_cb.reg_cb_cls = (cb_cls_val)          \
   3134         }                                                                     \
   3135         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3136 
   3137 /**
   3138  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3139  * no internal threads and aggregate watch FD.
   3140  * Application uses #MHD_DAEMON_INFO_FIXED_AGGREAGATE_FD to get single FD
   3141  * that gets triggered by any MHD event.
   3142  * This FD can be watched as an aggregate indicator for all MHD events.
   3143  * This mode is available only on selected platforms (currently
   3144  * GNU/Linux only), see #MHD_LIB_INFO_FIXED_HAS_AGGREGATE_FD.
   3145  * When the FD is triggered, #MHD_daemon_process_nonblocking() should
   3146  * be called.
   3147  * @return the object of struct MHD_WorkModeWithParam with requested values
   3148  */
   3149 #  define MHD_WM_OPTION_EXTERNAL_SINGLE_FD_WATCH()      \
   3150         MHD_NOWARN_COMPOUND_LITERALS_                         \
   3151           (const struct MHD_WorkModeWithParam)                  \
   3152         {                                                     \
   3153           .mode = (MHD_WM_EXTERNAL_SINGLE_FD_WATCH)           \
   3154         }                                                     \
   3155         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3156 
   3157 /**
   3158  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3159  * one or more worker threads.
   3160  * If number of threads is one, then daemon starts with single worker thread
   3161  * that handles all connections.
   3162  * If number of threads is larger than one, then that number of worker threads,
   3163  * and handling of connection is distributed among the workers.
   3164  * @param num_workers the number of worker threads, zero is treated as one
   3165  * @return the object of struct MHD_WorkModeWithParam with requested values
   3166  */
   3167 #  define MHD_WM_OPTION_WORKER_THREADS(num_workers)     \
   3168         MHD_NOWARN_COMPOUND_LITERALS_                         \
   3169           (const struct MHD_WorkModeWithParam)                  \
   3170         {                                                     \
   3171           .mode = (MHD_WM_WORKER_THREADS),                    \
   3172           .params.num_worker_threads = (num_workers)          \
   3173         }                                                     \
   3174         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3175 
   3176 /**
   3177  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3178  * one internal thread for listening and additional threads per every
   3179  * connection.  Use this if handling requests is CPU-intensive or blocking,
   3180  * your application is thread-safe and you have plenty of memory (per
   3181  * connection).
   3182  * @return the object of struct MHD_WorkModeWithParam with requested values
   3183  */
   3184 #  define MHD_WM_OPTION_THREAD_PER_CONNECTION() \
   3185         MHD_NOWARN_COMPOUND_LITERALS_                 \
   3186           (const struct MHD_WorkModeWithParam)          \
   3187         {                                             \
   3188           .mode = (MHD_WM_THREAD_PER_CONNECTION)      \
   3189         }                                             \
   3190         MHD_RESTORE_WARN_COMPOUND_LITERALS_
   3191 
   3192 #else  /* !MHD_USE_COMPOUND_LITERALS || !MHD_USE_DESIG_NEST_INIT */
   3193 MHD_NOWARN_UNUSED_FUNC_
   3194 
   3195 /**
   3196  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3197  * no internal threads.
   3198  * The application periodically calls #MHD_daemon_process_blocking(), where
   3199  * MHD internally checks all sockets automatically.
   3200  * This is the default mode.
   3201  * @return the object of struct MHD_WorkModeWithParam with requested values
   3202  */
   3203 static MHD_INLINE struct MHD_WorkModeWithParam
   3204 MHD_WM_OPTION_EXTERNAL_PERIODIC (void)
   3205 {
   3206   struct MHD_WorkModeWithParam wm_val;
   3207 
   3208   wm_val.mode = MHD_WM_EXTERNAL_PERIODIC;
   3209 
   3210   return wm_val;
   3211 }
   3212 
   3213 
   3214 /**
   3215  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3216  * an external event loop with level triggers.
   3217  * Application uses #MHD_SocketRegistrationUpdateCallback, level triggered
   3218  * sockets polling (like select() or poll()) and #MHD_daemon_event_update().
   3219  * @param cb_val the callback for sockets registration
   3220  * @param cb_cls_val the closure for the @a cv_val callback
   3221  * @return the object of struct MHD_WorkModeWithParam with requested values
   3222  */
   3223 static MHD_INLINE struct MHD_WorkModeWithParam
   3224 MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_LEVEL (
   3225   MHD_SocketRegistrationUpdateCallback cb_val,
   3226   void *cb_cls_val)
   3227 {
   3228   struct MHD_WorkModeWithParam wm_val;
   3229 
   3230   wm_val.mode = MHD_WM_EXTERNAL_EVENT_LOOP_CB_LEVEL;
   3231   wm_val.params.v_external_event_loop_cb.reg_cb = cb_val;
   3232   wm_val.params.v_external_event_loop_cb.reg_cb_cls = cb_cls_val;
   3233 
   3234   return wm_val;
   3235 }
   3236 
   3237 
   3238 /**
   3239  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3240  * an external event loop with edge triggers.
   3241  * Application uses #MHD_SocketRegistrationUpdateCallback, edge triggered
   3242  * sockets polling (like epoll with EPOLLET) and #MHD_daemon_event_update().
   3243  * @param cb_val the callback for sockets registration
   3244  * @param cb_cls_val the closure for the @a cv_val callback
   3245  * @return the object of struct MHD_WorkModeWithParam with requested values
   3246  */
   3247 static MHD_INLINE struct MHD_WorkModeWithParam
   3248 MHD_WM_OPTION_EXTERNAL_EVENT_LOOP_CB_EDGE (
   3249   MHD_SocketRegistrationUpdateCallback cb_val,
   3250   void *cb_cls_val)
   3251 {
   3252   struct MHD_WorkModeWithParam wm_val;
   3253 
   3254   wm_val.mode = MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE;
   3255   wm_val.params.v_external_event_loop_cb.reg_cb = cb_val;
   3256   wm_val.params.v_external_event_loop_cb.reg_cb_cls = cb_cls_val;
   3257 
   3258   return wm_val;
   3259 }
   3260 
   3261 
   3262 /**
   3263  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3264  * no internal threads and aggregate watch FD.
   3265  * Application uses #MHD_DAEMON_INFO_FIXED_AGGREAGATE_FD to get single FD
   3266  * that gets triggered by any MHD event.
   3267  * This FD can be watched as an aggregate indicator for all MHD events.
   3268  * This mode is available only on selected platforms (currently
   3269  * GNU/Linux only), see #MHD_LIB_INFO_FIXED_HAS_AGGREGATE_FD.
   3270  * When the FD is triggered, #MHD_daemon_process_nonblocking() should
   3271  * be called.
   3272  * @return the object of struct MHD_WorkModeWithParam with requested values
   3273  */
   3274 static MHD_INLINE struct MHD_WorkModeWithParam
   3275 MHD_WM_OPTION_EXTERNAL_SINGLE_FD_WATCH (void)
   3276 {
   3277   struct MHD_WorkModeWithParam wm_val;
   3278 
   3279   wm_val.mode = MHD_WM_EXTERNAL_SINGLE_FD_WATCH;
   3280 
   3281   return wm_val;
   3282 }
   3283 
   3284 
   3285 /**
   3286  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3287  * one or more worker threads.
   3288  * If number of threads is one, then daemon starts with single worker thread
   3289  * that handles all connections.
   3290  * If number of threads is larger than one, then that number of worker threads,
   3291  * and handling of connection is distributed among the workers.
   3292  * @param num_workers the number of worker threads, zero is treated as one
   3293  * @return the object of struct MHD_WorkModeWithParam with requested values
   3294  */
   3295 static MHD_INLINE struct MHD_WorkModeWithParam
   3296 MHD_WM_OPTION_WORKER_THREADS (unsigned int num_workers)
   3297 {
   3298   struct MHD_WorkModeWithParam wm_val;
   3299 
   3300   wm_val.mode = MHD_WM_EXTERNAL_EVENT_LOOP_CB_EDGE;
   3301   wm_val.params.num_worker_threads = num_workers;
   3302 
   3303   return wm_val;
   3304 }
   3305 
   3306 
   3307 /**
   3308  * Create parameter for #MHD_D_O_WORK_MODE() for work mode with
   3309  * one internal thread for listening and additional threads per every
   3310  * connection.  Use this if handling requests is CPU-intensive or blocking,
   3311  * your application is thread-safe and you have plenty of memory (per
   3312  * connection).
   3313  * @return the object of struct MHD_WorkModeWithParam with requested values
   3314  */
   3315 static MHD_INLINE struct MHD_WorkModeWithParam
   3316 MHD_WM_OPTION_THREAD_PER_CONNECTION (void)
   3317 {
   3318   struct MHD_WorkModeWithParam wm_val;
   3319 
   3320   wm_val.mode = MHD_WM_THREAD_PER_CONNECTION;
   3321 
   3322   return wm_val;
   3323 }
   3324 
   3325 
   3326 MHD_RESTORE_WARN_UNUSED_FUNC_
   3327 #endif /* !MHD_USE_COMPOUND_LITERALS || !MHD_USE_DESIG_NEST_INIT */
   3328 
   3329 /**
   3330  * @defgroup logging Log events and control
   3331  */
   3332 
   3333 
   3334 /**
   3335  * Type of a callback function used for logging by MHD.
   3336  *
   3337  * @param cls closure
   3338  * @param sc status code of the event
   3339  * @param fm format string (`printf()`-style)
   3340  * @param ap arguments to @a fm
   3341  * @ingroup logging
   3342  */
   3343 typedef void
   3344 (MHD_FN_PAR_NONNULL_ (3)
   3345  MHD_FN_PAR_CSTR_ (3)
   3346  *MHD_LoggingCallback)(void *cls,
   3347                        enum MHD_StatusCode sc,
   3348                        const char *fm,
   3349                        va_list ap);
   3350 
   3351 /**
   3352  * Parameter for listen socket binding type
   3353  */
   3354 enum MHD_FIXED_ENUM_APP_SET_ MHD_DaemonOptionBindType
   3355 {
   3356   /**
   3357    * The listen socket bind to the networks address with sharing the address.
   3358    * Several sockets can bind to the same address.
   3359    */
   3360   MHD_D_OPTION_BIND_TYPE_SHARED = -1
   3361   ,
   3362   /**
   3363    * The listen socket bind to the networks address without sharing the address,
   3364    * except allowing binding to port/address which has TIME_WAIT state (the
   3365    * state after closing connection).
   3366    * On some platforms it may also allow to bind to specific address if other
   3367    * socket already bond to the same port of wildcard address (or bind to
   3368    * wildcard address when other socket already bond to specific address
   3369    * with the same port).
   3370    * Typically achieved by enabling 'SO_REUSEADDR' socket option.
   3371    * Default.
   3372    */
   3373   MHD_D_OPTION_BIND_TYPE_NOT_SHARED = 0
   3374   ,
   3375   /**
   3376    * The listen socket bind to the networks address without sharing the address.
   3377    * The daemon way fail to start when any sockets still in "TIME_WAIT" state
   3378    * on the same port, which effectively prevents quick restart of the daemon
   3379    * on the same port.
   3380    * On W32 systems it works like #MHD_D_OPTION_BIND_TYPE_NOT_SHARED due to
   3381    * the OS limitations.
   3382    */
   3383   MHD_D_OPTION_BIND_TYPE_NOT_SHARED_STRICTER = 1
   3384   ,
   3385   /**
   3386    * The list socket bind to the networks address in explicit exclusive mode.
   3387    * Works as #MHD_D_OPTION_BIND_TYPE_NOT_SHARED_STRICTER on platforms without
   3388    * support for the explicit exclusive socket use.
   3389    */
   3390   MHD_D_OPTION_BIND_TYPE_EXCLUSIVE = 2
   3391 };
   3392 
   3393 
   3394 /**
   3395  * Possible levels of enforcement for TCP_FASTOPEN.
   3396  */
   3397 enum MHD_FIXED_ENUM_APP_SET_ MHD_TCPFastOpenType
   3398 {
   3399   /**
   3400    * Disable use of TCP_FASTOPEN.
   3401    */
   3402   MHD_FOM_DISABLE = -1
   3403   ,
   3404   /**
   3405    * Enable TCP_FASTOPEN where supported.
   3406    * On GNU/Linux it works with a kernel >= 3.6.
   3407    * This is the default.
   3408    */
   3409   MHD_FOM_AUTO = 0
   3410   ,
   3411   /**
   3412    * Require TCP_FASTOPEN.
   3413    * Also causes #MHD_daemon_start() to fail if TCP_FASTOPEN cannot be enabled.
   3414    */
   3415   MHD_FOM_REQUIRE = 1
   3416 };
   3417 
   3418 
   3419 /**
   3420  * Address family to be used by MHD.
   3421  */
   3422 enum MHD_FIXED_ENUM_APP_SET_ MHD_AddressFamily
   3423 {
   3424   /**
   3425    * Option not given, do not listen at all
   3426    * (unless listen socket or address specified by
   3427    * other means).
   3428    */
   3429   MHD_AF_NONE = 0
   3430   ,
   3431   /**
   3432    * Pick "best" available method automatically.
   3433    */
   3434   MHD_AF_AUTO = 1
   3435   ,
   3436   /**
   3437    * Use IPv4 only.
   3438    */
   3439   MHD_AF_INET4 = 2
   3440   ,
   3441   /**
   3442    * Use IPv6 only.
   3443    */
   3444   MHD_AF_INET6 = 3
   3445   ,
   3446   /**
   3447    * Use dual stack (IPv4 and IPv6 on the same socket).
   3448    */
   3449   MHD_AF_DUAL = 4
   3450   ,
   3451   /**
   3452    * Use dual stack (IPv4 and IPv6 on the same socket),
   3453    * fallback to pure IPv6 if dual stack is not possible.
   3454    */
   3455   MHD_AF_DUAL_v4_OPTIONAL = 5
   3456   ,
   3457   /**
   3458    * Use dual stack (IPv4 and IPv6 on the same socket),
   3459    * fallback to pure IPv4 if dual stack is not possible.
   3460    */
   3461   MHD_AF_DUAL_v6_OPTIONAL = 6
   3462 
   3463 };
   3464 
   3465 
   3466 /**
   3467  * Sockets polling internal syscalls used by MHD.
   3468  */
   3469 enum MHD_FIXED_ENUM_APP_SET_ MHD_SockPollSyscall
   3470 {
   3471   /**
   3472    * Automatic selection of best-available method. This is also the
   3473    * default.
   3474    */
   3475   MHD_SPS_AUTO = 0
   3476   ,
   3477   /**
   3478    * Use select().
   3479    */
   3480   MHD_SPS_SELECT = 1
   3481   ,
   3482   /**
   3483    * Use poll().
   3484    */
   3485   MHD_SPS_POLL = 2
   3486   ,
   3487   /**
   3488    * Use epoll.
   3489    */
   3490   MHD_SPS_EPOLL = 3
   3491 };
   3492 
   3493 
   3494 /**
   3495  * Protocol strictness levels enforced by MHD on clients.
   3496  * Each level applies different parsing settings for HTTP headers and other
   3497  * protocol elements.
   3498  */
   3499 enum MHD_FIXED_ENUM_APP_SET_ MHD_ProtocolStrictLevel
   3500 {
   3501 
   3502   /* * Basic levels * */
   3503   /**
   3504    * A sane default level of protocol enforcement for production use.
   3505    * Provides a balance between enhanced security and broader compatibility,
   3506    * as permitted by RFCs for HTTP servers.
   3507    */
   3508   MHD_PSL_DEFAULT = 0
   3509   ,
   3510   /**
   3511    * Apply stricter protocol interpretation while remaining within
   3512    * RFC-defined limits for HTTP servers.
   3513    *
   3514    * At this level (and stricter), using a bare LF instead of CRLF is forbidden,
   3515    * and requests that include both a "Transfer-Encoding:" and
   3516    * a "Content-Length:" headers are rejected.
   3517    *
   3518    * Suitable for public servers.
   3519    */
   3520   MHD_PSL_STRICT = 1
   3521   ,
   3522   /**
   3523    * Be more permissive in interpreting the protocol, while still
   3524    * operating within the RFC-defined limits for HTTP servers.
   3525    */
   3526   MHD_PSL_PERMISSIVE = -1
   3527   ,
   3528   /* * Special levels * */
   3529   /**
   3530    * A stricter protocol interpretation than what is allowed by RFCs for HTTP
   3531    * servers. However, it should remain fully compatible with clients correctly
   3532    * following all RFC "MUST" requirements for HTTP clients.
   3533    *
   3534    * For chunked encoding, this level (and more restrictive ones) forbids
   3535    * whitespace in chunk extensions.
   3536    * For cookie parsing, this level (and more restrictive ones) rejects
   3537    * the entire cookie if even a single value within it is incorrectly encoded.
   3538    *
   3539    * Recommended for testing clients against MHD. Can also be used for
   3540    * security-centric applications, though doing so slightly violates
   3541    * relevant RFC requirements for HTTP servers.
   3542    */
   3543   MHD_PSL_VERY_STRICT = 2
   3544   ,
   3545   /**
   3546    * The strictest interpretation of the HTTP protocol, even stricter than
   3547    * allowed by RFCs for HTTP servers.
   3548    * However, it should remain fully compatible with clients complying with both
   3549    * RFC "SHOULD" and "MUST" requirements for HTTP clients.
   3550    *
   3551    * This level can be used for testing clients against MHD.
   3552    * It is not recommended for public services, as it may reject legitimate
   3553    * clients that do not follow RFC "SHOULD" requirements.
   3554    */
   3555   MHD_PSL_EXTRA_STRICT = 3
   3556   ,
   3557   /**
   3558    * A more relaxed protocol interpretation that violates some RFC "SHOULD"
   3559    * restrictions for HTTP servers.
   3560    * For cookie parsing, this level (and more permissive levels) allows
   3561    * whitespace in cookie values.
   3562    *
   3563    * This level may be used in isolated environments.
   3564    */
   3565   MHD_PSL_VERY_PERMISSIVE = -2
   3566   ,
   3567   /**
   3568    * The most flexible protocol interpretation, going beyond RFC "MUST"
   3569    * requirements for HTTP servers.
   3570    *
   3571    * This level allows HTTP/1.1 requests without a "Host:" header.
   3572    * For cookie parsing, whitespace is allowed before and after
   3573    * the '=' character.
   3574    *
   3575    * Not recommended unless absolutely necessary to communicate with clients
   3576    * that have severely broken HTTP implementations.
   3577    */
   3578   MHD_PSL_EXTRA_PERMISSIVE = -3,
   3579 };
   3580 
   3581 /**
   3582  * The way Strict Level is enforced.
   3583  * MHD can be compiled with limited set of strictness levels.
   3584  * These values instructs MHD how to apply the request level.
   3585  */
   3586 enum MHD_FIXED_ENUM_APP_SET_ MHD_UseStictLevel
   3587 {
   3588   /**
   3589    * Use requested level if available or the nearest stricter
   3590    * level.
   3591    * Fail if only more permissive levels available.
   3592    * Recommended value.
   3593    */
   3594   MHD_USL_THIS_OR_STRICTER = 0
   3595   ,
   3596   /**
   3597    * Use requested level only.
   3598    * Fail if this level is not available.
   3599    */
   3600   MHD_USL_PRECISE = 1
   3601   ,
   3602   /**
   3603    * Use requested level if available or the nearest level (stricter
   3604    * or more permissive).
   3605    */
   3606   MHD_USL_NEAREST = 2
   3607 };
   3608 
   3609 
   3610 /**
   3611  * Connection memory buffer zeroing mode.
   3612  * Works as a hardening measure.
   3613  */
   3614 enum MHD_FIXED_ENUM_APP_SET_ MHD_ConnBufferZeroingMode
   3615 {
   3616   /**
   3617    * Do not perform zeroing of connection memory buffer.
   3618    * Default mode.
   3619    */
   3620   MHD_CONN_BUFFER_ZEROING_DISABLED = 0
   3621   ,
   3622   /**
   3623    * Perform connection memory buffer zeroing before processing request.
   3624    */
   3625   MHD_CONN_BUFFER_ZEROING_BASIC = 1
   3626   ,
   3627   /**
   3628    * Perform connection memory buffer zeroing before processing request and
   3629    * when reusing buffer memory areas during processing request.
   3630    */
   3631   MHD_CONN_BUFFER_ZEROING_HEAVY = 2
   3632 };
   3633 
   3634 
   3635 /* ********************** (d) TLS support ********************** */
   3636 
   3637 /**
   3638  * The TLS backend choice
   3639  */
   3640 enum MHD_FIXED_ENUM_APP_SET_ MHD_TlsBackend
   3641 {
   3642   /**
   3643    * Disable TLS, use plain TCP connections (default)
   3644    */
   3645   MHD_TLS_BACKEND_NONE = 0
   3646   ,
   3647   /**
   3648    * Use best available TLS backend.
   3649    */
   3650   MHD_TLS_BACKEND_ANY = 1
   3651   ,
   3652   /**
   3653    * Use GnuTLS as TLS backend.
   3654    */
   3655   MHD_TLS_BACKEND_GNUTLS = 2
   3656   ,
   3657   /**
   3658    * Use OpenSSL as TLS backend.
   3659    */
   3660   MHD_TLS_BACKEND_OPENSSL = 3
   3661   ,
   3662   /**
   3663    * Use MbedTLS as TLS backend.
   3664    */
   3665   MHD_TLS_BACKEND_MBEDTLS = 4
   3666 };
   3667 
   3668 /**
   3669  * Values for #MHD_D_O_DAUTH_NONCE_BIND_TYPE.
   3670  *
   3671  * These values can limit the scope of validity of MHD-generated nonces.
   3672  * Values can be combined with bitwise OR.
   3673  * Any value, except #MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_NONE, enforce function
   3674  * #MHD_digest_auth_check() (and similar functions) to check nonce by
   3675  * re-generating it again with the same parameters, which is CPU-intensive
   3676  * operation.
   3677  */
   3678 enum MHD_FIXED_FLAGS_ENUM_APP_SET_ MHD_DaemonOptionValueDAuthBindNonce
   3679 {
   3680   /**
   3681    * Generated nonces are valid for any request from any client until expired.
   3682    * This is default and recommended value.
   3683    * #MHD_digest_auth_check() (and similar functions) would check only whether
   3684    * the nonce value that is used by client has been generated by MHD and not
   3685    * expired yet.
   3686    * It is recommended because RFC 7616 allows clients to use the same nonce
   3687    * for any request in the same "protection space".
   3688    * When checking client's authorisation requests CPU is loaded less if this
   3689    * value is used.
   3690    * This mode gives MHD maximum flexibility for nonces generation and can
   3691    * prevent possible nonce collisions (and corresponding log warning messages)
   3692    * when clients' requests are intensive.
   3693    * This value cannot be biwise-OR combined with other values.
   3694    */
   3695   MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_NONE = 0
   3696   ,
   3697   /**
   3698    * Generated nonces are valid only for the same realm.
   3699    */
   3700   MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_REALM = (1 << 0)
   3701   ,
   3702   /**
   3703    * Generated nonces are valid only for the same URI (excluding parameters
   3704    * after '?' in URI) and request method (GET, POST etc).
   3705    * Not recommended unless "protection space" is limited to a single URI as
   3706    * RFC 7616 allows clients to reuse server-generated nonces for any URI
   3707    * in the same "protection space" which by default consists of all server
   3708    * URIs.
   3709    */
   3710   MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_URI = (1 << 1)
   3711   ,
   3712 
   3713   /**
   3714    * Generated nonces are valid only for the same URI including URI parameters
   3715    * and request method (GET, POST etc).
   3716    * This value implies #MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_URI.
   3717    * Not recommended for that same reasons as
   3718    * #MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_URI.
   3719    */
   3720   MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_URI_PARAMS = (1 << 2)
   3721   ,
   3722 
   3723   /**
   3724    * Generated nonces are valid only for the single client's IP.
   3725    * While it looks like security improvement, in practice the same client may
   3726    * jump from one IP to another (mobile or Wi-Fi handover, DHCP re-assignment,
   3727    * Multi-NAT, different proxy chain and other reasons), while IP address
   3728    * spoofing could be used relatively easily.
   3729    */
   3730   MHD_D_OPTION_VALUE_DAUTH_BIND_NONCE_CLIENT_IP = (1 << 3)
   3731 };
   3732 
   3733 
   3734 struct MHD_ServerCredentialsContext;
   3735 
   3736 
   3737 /**
   3738  * Context required to provide a pre-shared key to the
   3739  * server.
   3740  *
   3741  * @param mscc the context
   3742  * @param psk_size the number of bytes in @a psk
   3743  * @param psk the pre-shared-key; should be allocated with malloc(),
   3744  *                 will be freed by MHD
   3745  */
   3746 MHD_EXTERN_ enum MHD_StatusCode
   3747 MHD_connection_set_psk (
   3748   struct MHD_ServerCredentialsContext *mscc,
   3749   size_t psk_size,
   3750   const /*void? */ char psk[MHD_FN_PAR_DYN_ARR_SIZE_ (psk_size)]);
   3751 
   3752 #define MHD_connection_set_psk_unavailable(mscc) \
   3753         MHD_connection_set_psk (mscc, 0, NULL)
   3754 
   3755 
   3756 /**
   3757  * Function called to lookup the pre-shared key (PSK) for a given
   3758  * HTTP connection based on the @a username.  MHD will suspend handling of
   3759  * the @a connection until the application calls #MHD_connection_set_psk().
   3760  * If looking up the PSK fails, the application must still call
   3761  * #MHD_connection_set_psk_unavailable().
   3762  *
   3763  * @param cls closure
   3764  * @param connection the HTTPS connection
   3765  * @param username the user name claimed by the other side
   3766  * @param mscc context to pass to #MHD_connection_set_psk().
   3767  */
   3768 typedef void
   3769 (*MHD_PskServerCredentialsCallback)(
   3770   void *cls,
   3771   const struct MHD_Connection *MHD_RESTRICT connection,
   3772   const struct MHD_String *MHD_RESTRICT username,
   3773   struct MHD_ServerCredentialsContext *mscc);
   3774 
   3775 
   3776 /**
   3777  * The specified callback will be called one time,
   3778  * after network initialisation, TLS pre-initialisation, but before
   3779  * the start of the internal threads (if allowed).
   3780  *
   3781  * This callback may use introspection call to retrieve and adjust
   3782  * some of the daemon aspects. For example, TLS backend handler can be used
   3783  * to configure some TLS aspects.
   3784  * @param cls the callback closure
   3785  */
   3786 typedef void
   3787 (*MHD_DaemonReadyCallback)(void *cls);
   3788 
   3789 
   3790 /**
   3791  * Allow or deny a client to connect.
   3792  *
   3793  * @param cls closure
   3794  * @param addr_len length of @a addr
   3795  * @param addr address information from the client
   3796  * @see #MHD_D_OPTION_ACCEPT_POLICY()
   3797  * @return #MHD_YES if connection is allowed, #MHD_NO if not
   3798  */
   3799 typedef enum MHD_Bool
   3800 (*MHD_AcceptPolicyCallback)(void *cls,
   3801                             size_t addr_len,
   3802                             const struct sockaddr *addr);
   3803 
   3804 
   3805 /**
   3806  * The data for the #MHD_EarlyUriLogCallback
   3807  */
   3808 struct MHD_EarlyUriCbData
   3809 {
   3810   /**
   3811    * The request handle.
   3812    * Headers are not yet available.
   3813    */
   3814   struct MHD_Request *request;
   3815 
   3816   /**
   3817    * The full URI ("request target") from the HTTP request, including URI
   3818    * parameters (the part after '?')
   3819    */
   3820   struct MHD_String full_uri;
   3821 
   3822   /**
   3823    * The request HTTP method
   3824    */
   3825   enum MHD_HTTP_Method method;
   3826 };
   3827 
   3828 /**
   3829  * Function called by MHD to allow the application to log the @a full_uri
   3830  * of the new request.
   3831  * This is the only moment when unmodified URI is provided.
   3832  * After this callback MHD parses the URI and modifies it by extracting
   3833  * GET parameters in-place.
   3834  *
   3835  * If this callback is set then it is the first application function called
   3836  * for the new request.
   3837  *
   3838  * If #MHD_RequestEndedCallback is also set then it is guaranteed that
   3839  * #MHD_RequestEndedCallback is called for the same request. Application
   3840  * may allocate request specific data in this callback and de-allocate
   3841  * the data in #MHD_RequestEndedCallback.
   3842  *
   3843  * @param cls client-defined closure
   3844  * @param req_data the request data
   3845  * @param request_app_context_ptr the pointer to variable that can be set to
   3846  *                                the application context for the request;
   3847  *                                initially the variable set to NULL
   3848  */
   3849 typedef void
   3850 (MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (3)
   3851  *MHD_EarlyUriLogCallback)(void *cls,
   3852                            const struct MHD_EarlyUriCbData *req_data,
   3853                            void **request_app_context_ptr);
   3854 
   3855 
   3856 /**
   3857  * The `enum MHD_ConnectionNotificationCode` specifies types
   3858  * of connection notifications.
   3859  * @ingroup request
   3860  */
   3861 enum MHD_FIXED_ENUM_MHD_SET_ MHD_ConnectionNotificationCode
   3862 {
   3863 
   3864   /**
   3865    * A new connection has been started.
   3866    * @ingroup request
   3867    */
   3868   MHD_CONNECTION_NOTIFY_STARTED = 0
   3869   ,
   3870   /**
   3871    * A connection is closed.
   3872    * @ingroup request
   3873    */
   3874   MHD_CONNECTION_NOTIFY_CLOSED = 1
   3875 
   3876 };
   3877 
   3878 /**
   3879  * Extra details for connection notifications.
   3880  * Currently not used
   3881  */
   3882 union MHD_ConnectionNotificationDetails
   3883 {
   3884   /**
   3885    * Unused
   3886    */
   3887   int reserved1;
   3888 };
   3889 
   3890 
   3891 /**
   3892  * The connection notification data structure
   3893  */
   3894 struct MHD_ConnectionNotificationData
   3895 {
   3896   /**
   3897    * The connection handle
   3898    */
   3899   struct MHD_Connection *connection;
   3900   /**
   3901    * The connection-specific application context data (opaque for MHD).
   3902    * Initially set to NULL (for connections added by MHD) or set by
   3903    * @a connection_cntx parameter for connections added by
   3904    * #MHD_daemon_add_connection().
   3905    */
   3906   void *application_context;
   3907   /**
   3908    * The code of the event
   3909    */
   3910   enum MHD_ConnectionNotificationCode code;
   3911   /**
   3912    * Event details
   3913    */
   3914   union MHD_ConnectionNotificationDetails details;
   3915 };
   3916 
   3917 
   3918 /**
   3919  * Signature of the callback used by MHD to notify the
   3920  * application about started/stopped network connections
   3921  *
   3922  * @param cls client-defined closure
   3923  * @param[in,out]  data the details about the event
   3924  * @see #MHD_D_OPTION_NOTIFY_CONNECTION()
   3925  * @ingroup request
   3926  */
   3927 typedef void
   3928 (MHD_FN_PAR_NONNULL_ (2)
   3929  *MHD_NotifyConnectionCallback)(void *cls,
   3930                                 struct MHD_ConnectionNotificationData *data);
   3931 
   3932 
   3933 /**
   3934  * The type of stream notifications.
   3935  * @ingroup request
   3936  */
   3937 enum MHD_FIXED_ENUM_MHD_SET_ MHD_StreamNotificationCode
   3938 {
   3939   /**
   3940    * A new stream has been started.
   3941    * @ingroup request
   3942    */
   3943   MHD_STREAM_NOTIFY_STARTED = 0
   3944   ,
   3945   /**
   3946    * A stream is closed.
   3947    * @ingroup request
   3948    */
   3949   MHD_STREAM_NOTIFY_CLOSED = 1
   3950 };
   3951 
   3952 /**
   3953  * Additional information about stream started event
   3954  */
   3955 struct MHD_StreamNotificationDetailStarted
   3956 {
   3957   /**
   3958    * Set to #MHD_YES of the stream was started by client
   3959    */
   3960   enum MHD_Bool by_client;
   3961 };
   3962 
   3963 /**
   3964  * Additional information about stream events
   3965  */
   3966 union MHD_StreamNotificationDetail
   3967 {
   3968   /**
   3969    * Information for event #MHD_STREAM_NOTIFY_STARTED
   3970    */
   3971   struct MHD_StreamNotificationDetailStarted started;
   3972 };
   3973 
   3974 /**
   3975  * Stream notification data structure
   3976  */
   3977 struct MHD_StreamNotificationData
   3978 {
   3979   /**
   3980    * The handle of the stream
   3981    */
   3982   struct MHD_Stream *stream;
   3983   /**
   3984    * The code of the event
   3985    */
   3986   enum MHD_StreamNotificationCode code;
   3987   /**
   3988    * Detailed information about notification event
   3989    */
   3990   union MHD_StreamNotificationDetail details;
   3991 };
   3992 
   3993 
   3994 /**
   3995  * Signature of the callback used by MHD to notify the
   3996  * application about started/stopped data stream
   3997  * For HTTP/1.1 it is the same like network connection
   3998  * with 1:1 match.
   3999  *
   4000  * @param cls client-defined closure
   4001  * @param data the details about the event
   4002  * @see #MHD_D_OPTION_NOTIFY_STREAM()
   4003  * @ingroup request
   4004  */
   4005 typedef void
   4006 (MHD_FN_PAR_NONNULL_ (2)
   4007  *MHD_NotifyStreamCallback)(
   4008   void *cls,
   4009   const struct MHD_StreamNotificationData *data);
   4010 
   4011 #include "microhttpd2_generated_daemon_options.h"
   4012 
   4013 
   4014 /**
   4015  * The `enum MHD_RequestEndedCode` specifies reasons
   4016  * why a request has been ended.
   4017  * @ingroup request
   4018  */
   4019 enum MHD_FIXED_ENUM_MHD_SET_ MHD_RequestEndedCode
   4020 {
   4021 
   4022   /**
   4023    * The response was successfully sent.
   4024    * @ingroup request
   4025    */
   4026   MHD_REQUEST_ENDED_COMPLETED_OK = 0
   4027   ,
   4028   /**
   4029    * The response was successfully sent and connection is being switched
   4030    * to another protocol.
   4031    * @ingroup request
   4032    */
   4033   MHD_REQUEST_ENDED_COMPLETED_OK_UPGRADE = 1
   4034   ,
   4035   /**
   4036    * No activity on the connection for the number of seconds specified using
   4037    * #MHD_C_OPTION_TIMEOUT().
   4038    * @ingroup request
   4039    */
   4040   MHD_REQUEST_ENDED_TIMEOUT_REACHED = 10
   4041   ,
   4042   /**
   4043    * The connection was broken or TLS protocol error.
   4044    * @ingroup request
   4045    */
   4046   MHD_REQUEST_ENDED_CONNECTION_ERROR = 20
   4047   ,
   4048   /**
   4049    * The client terminated the connection by closing the socket either
   4050    * completely or for writing (TCP half-closed) before sending complete
   4051    * request.
   4052    * @ingroup request
   4053    */
   4054   MHD_REQUEST_ENDED_CLIENT_ABORT = 30
   4055   ,
   4056   /**
   4057    * The request is not valid according to HTTP specifications.
   4058    * @ingroup request
   4059    */
   4060   MHD_REQUEST_ENDED_HTTP_PROTOCOL_ERROR = 31
   4061   ,
   4062   /**
   4063    * The application aborted request without response.
   4064    * @ingroup request
   4065    */
   4066   MHD_REQUEST_ENDED_BY_APP_ABORT = 40
   4067   ,
   4068   /**
   4069    * The request was aborted due to the application failed to provide a valid
   4070    * response.
   4071    * @ingroup request
   4072    */
   4073   MHD_REQUEST_ENDED_BY_APP_ERROR = 41
   4074   ,
   4075   /**
   4076    * The request was aborted due to the application failed to register external
   4077    * event monitoring for the connection.
   4078    * @ingroup request
   4079    */
   4080   MHD_REQUEST_ENDED_BY_EXT_EVENT_ERROR = 42
   4081   ,
   4082   /**
   4083    * Error handling the connection due to resources exhausted.
   4084    * @ingroup request
   4085    */
   4086   MHD_REQUEST_ENDED_NO_RESOURCES = 50
   4087   ,
   4088   /**
   4089    * The request was aborted due to error reading file for file-backed response
   4090    * @ingroup request
   4091    */
   4092   MHD_REQUEST_ENDED_FILE_ERROR = 51
   4093   ,
   4094   /**
   4095    * The request was aborted due to error generating valid nonce for Digest Auth
   4096    * @ingroup request
   4097    */
   4098   MHD_REQUEST_ENDED_NONCE_ERROR = 52
   4099   ,
   4100   /**
   4101    * Closing the session since MHD is being shut down.
   4102    * @ingroup request
   4103    */
   4104   MHD_REQUEST_ENDED_DAEMON_SHUTDOWN = 60
   4105 };
   4106 
   4107 /**
   4108  * Additional information about request ending
   4109  */
   4110 union MHD_RequestEndedDetail
   4111 {
   4112   /**
   4113    * Reserved member.
   4114    * Do not use.
   4115    */
   4116   void *reserved;
   4117 };
   4118 
   4119 /**
   4120  * Request termination data structure
   4121  */
   4122 struct MHD_RequestEndedData
   4123 {
   4124   /**
   4125    * The request handle.
   4126    * Note that most of the request data may be already unvailable.
   4127    */
   4128   struct MHD_Request *req;
   4129   /**
   4130    * The code of the event
   4131    */
   4132   enum MHD_RequestEndedCode code;
   4133   /**
   4134    * Detailed information about the event
   4135    */
   4136   union MHD_RequestEndedDetail details;
   4137 };
   4138 
   4139 
   4140 /**
   4141  * Signature of the callback used by MHD to notify the application
   4142  * about completed requests.
   4143  *
   4144  * This is the last callback called for any request (if provided by
   4145  * the application).
   4146  *
   4147  * @param cls client-defined closure
   4148  * @param data the details about the event
   4149  * @param request_app_context the application request context, as possibly set
   4150                               by the #MHD_EarlyUriLogCallback
   4151  * @see #MHD_R_OPTION_TERMINATION_CALLBACK()
   4152  * @ingroup request
   4153  */
   4154 typedef void
   4155 (*MHD_RequestEndedCallback) (void *cls,
   4156                              const struct MHD_RequestEndedData *data,
   4157                              void *request_app_context);
   4158 
   4159 
   4160 #include "microhttpd2_generated_response_options.h"