libmicrohttpd2

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

tls_mbed_conn_data.h (4257B)

      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/tls_mbed_conn_data.h
     41  * @brief  The definition of MbedTLS connection-specific data structures
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_TLS_MBED_CONN_DATA_H
     46 #define MHD_TLS_MBED_CONN_DATA_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #ifndef MHD_SUPPORT_MBEDTLS
     51 #error This header can be used only if MbedTLS is enabled
     52 #endif
     53 
     54 #include "sys_bool_type.h"
     55 #include "sys_sizet_type.h"
     56 
     57 #include "tls_mbed_tls_lib.h"
     58 
     59 #include "mhd_socket_error.h"
     60 
     61 struct mhd_ConnSocket; /* Forward declaration */
     62 
     63 #ifndef NDEBUG
     64 struct mhd_TlsMbedConnDebug
     65 {
     66   bool is_inited;
     67   bool is_tls_handshake_completed;
     68   bool is_failed;
     69 };
     70 #endif /* ! NDEBUG */
     71 
     72 /**
     73  * The state for the current "custom transport" operation
     74  */
     75 struct mhd_TlsMbedConnCstmTrtState
     76 {
     77   /**
     78    * 'true' if recv() callback has been called
     79    */
     80   bool recv_called;
     81   /**
     82    * The result of last call of recv().
     83    * #mhd_SOCKET_ERR_NO_ERROR if recv() has not been called.
     84    */
     85   enum mhd_SocketError recv_res;
     86   /**
     87    * 'true' if send() callback has been called
     88    */
     89   bool send_called;
     90   /**
     91    * The result of last call of send().
     92    * #mhd_SOCKET_ERR_NO_ERROR if send() has not been called.
     93    */
     94   enum mhd_SocketError send_res;
     95   /**
     96    * The size of the send() data before TLS encryption.
     97    * Zero if no application data is being sent.
     98    */
     99   size_t send_unenc_size;
    100 };
    101 
    102 /**
    103  * Data for connection's "custom transport"
    104  */
    105 struct mhd_TlsMbedConnCstmTrtData
    106 {
    107   /**
    108    * The pointer to the socket information data
    109    */
    110   struct mhd_ConnSocket *sk;
    111   /**
    112    * The state for the current "custom transport" operation
    113    */
    114   struct mhd_TlsMbedConnCstmTrtState state;
    115 };
    116 
    117 /**
    118  * The structure with connection-specific MbedTLS data
    119  *
    120  * @note Unlike other TLS backends this struct contains MbedTLS data itself,
    121  *       not just pointers.
    122  */
    123 struct mhd_TlsMbedConnData
    124 {
    125   /**
    126    * MbedTLS session data
    127    */
    128   mbedtls_ssl_context sess;
    129 
    130   /**
    131  * Data for connection's "custom transport"
    132    */
    133   struct mhd_TlsMbedConnCstmTrtData tr;
    134   /**
    135    * 'true' is already received data in waiting in TLS buffers
    136    */
    137   bool recv_data_in_buff;
    138   /**
    139    * 'true' if sent TLS shutdown "alert"
    140    */
    141   bool shut_tls_wr_sent;
    142 
    143   /**
    144    * 'true' if received EOF (the peer initiated TLS shut down)
    145    */
    146   bool shut_tls_wr_received;
    147 #ifndef NDEBUG
    148   /**
    149    * Debugging data
    150    */
    151   struct mhd_TlsMbedConnDebug dbg;
    152 #endif /* ! NDEBUG */
    153 };
    154 
    155 #endif /* ! MHD_TLS_MBED_CONN_DATA_H */