libmicrohttpd2

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

h2_req_fields.h (3906B)


      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) 2025 Evgeny Grin (Karlson2k)
      5 
      6   GNU libmicrohttpd is free software; you can redistribute it and/or
      7   modify it under the terms of the GNU Lesser General Public
      8   License as published by the Free Software Foundation; either
      9   version 2.1 of the License, or (at your option) any later version.
     10 
     11   GNU libmicrohttpd is distributed in the hope that it will be useful,
     12   but WITHOUT ANY WARRANTY; without even the implied warranty of
     13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     14   Lesser General Public License for more details.
     15 
     16   Alternatively, you can redistribute GNU libmicrohttpd and/or
     17   modify it under the terms of the GNU General Public License as
     18   published by the Free Software Foundation; either version 2 of
     19   the License, or (at your option) any later version, together
     20   with the eCos exception, as follows:
     21 
     22     As a special exception, if other files instantiate templates or
     23     use macros or inline functions from this file, or you compile this
     24     file and link it with other works to produce a work based on this
     25     file, this file does not by itself cause the resulting work to be
     26     covered by the GNU General Public License. However the source code
     27     for this file must still be made available in accordance with
     28     section (3) of the GNU General Public License v2.
     29 
     30     This exception does not invalidate any other reasons why a work
     31     based on this file might be covered by the GNU General Public
     32     License.
     33 
     34   You should have received copies of the GNU Lesser General Public
     35   License and the GNU General Public License along with this library;
     36   if not, see <https://www.gnu.org/licenses/>.
     37 */
     38 
     39 /**
     40  * @file src/mhd2/h2/h2_req_fields.h
     41  * @brief  Declaration of HTTP/2 request fields functions
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_H2_REQ_FIELDS_H
     46 #define MHD_H2_REQ_FIELDS_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #include "sys_bool_type.h"
     51 #include "sys_sizet_type.h"
     52 
     53 struct mhd_Buffer;              /* Forward declaration */
     54 struct mhd_HpackDecContext;     /* Forward declaration */
     55 struct mhd_H2ReqItemsBlock;     /* Forward declaration */
     56 struct mhd_H2Stream;            /* Forward declaration */
     57 
     58 enum MHD_FIXED_ENUM_ mhd_H2DecFieldsResult
     59 {
     60   /**
     61    * The data was successfully decoded.
     62    * Some incomplete data at the end of the block may be left unprocessed.
     63    */
     64   mhd_H2_DEC_FIELDS_OK
     65   ,
     66   /**
     67    * Not enough space to add the decoded field
     68    */
     69   mhd_H2_DEC_FIELDS_NO_SPACE
     70   ,
     71   /**
     72    * Internal error while decoding the data.
     73    * It could be memory allocation error when dynamic table is increasing
     74    * within the allowed limits.
     75    */
     76   mhd_H2_DEC_FIELDS_INT_ERR
     77   ,
     78   /**
     79    * The encoded data is incorrectly encoded or broken
     80    */
     81   mhd_H2_DEC_FIELDS_BROKEN_DATA
     82   ,
     83   /**
     84    * The data encoded in a way that excessively use resources or bandwidth
     85    */
     86   mhd_H2_DEC_FIELDS_PROT_ABUSE
     87 };
     88 
     89 MHD_INTERNAL enum mhd_H2DecFieldsResult
     90 mhd_h2_req_fields_decode (struct mhd_HpackDecContext *restrict hk_dec,
     91                           const struct mhd_Buffer *restrict enc_data,
     92                           bool are_trailers,
     93                           struct mhd_H2ReqItemsBlock *restrict ib,
     94                           size_t *restrict left_unprocessed)
     95 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_(1) MHD_FN_PAR_IN_(2)
     96 MHD_FN_PAR_INOUT_(4) MHD_FN_PAR_OUT_ (5);
     97 
     98 MHD_INTERNAL bool
     99 mhd_h2_req_headers_preprocess (struct mhd_H2Stream *restrict s)
    100 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1);
    101 
    102 MHD_INTERNAL bool
    103 mhd_h2_req_uri_parse (struct mhd_H2Stream *restrict s)
    104 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1);
    105 
    106 MHD_INTERNAL bool
    107 mhd_h2_req_cookie_parse (struct mhd_H2Stream *restrict s)
    108 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_INOUT_ (1);
    109 
    110 
    111 #endif /* ! MHD_H2_REQ_FIELDS_H */