libmicrohttpd2

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

mhd_tls_common.h (3006B)

      1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */
      2 /*
      3   This file is part of GNU libmicrohttpd.
      4   Copyright (C) 2024-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/mhd_tls_common.h
     41  * @brief  The TLS functions and data common for all TLS backends
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_TLS_COMMON_H
     46 #define MHD_TLS_COMMON_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #ifndef MHD_SUPPORT_HTTPS
     51 #error This header should be used only if HTTPS is enabled
     52 #endif
     53 
     54 struct DaemonOptions; /* Forward declaration */
     55 
     56 /* ** General information function ** */
     57 
     58 /**
     59  * Result of TLS backend availability check
     60  */
     61 enum mhd_TlsBackendAvailable
     62 {
     63   /**
     64    * The TLS backend is available and can be used
     65    */
     66   mhd_TLS_BACKEND_AVAIL_OK = 0
     67   ,
     68   /**
     69    * The TLS backend support is not enabled in this MHD build
     70    */
     71   mhd_TLS_BACKEND_AVAIL_NOT_SUPPORTED
     72   ,
     73   /**
     74    * The TLS backend supported, but not available
     75    */
     76   mhd_TLS_BACKEND_AVAIL_NOT_AVAILABLE
     77 };
     78 
     79 /**
     80  * Check whether the requested TLS backend is available
     81  * @param s the daemon settings
     82  * @return 'mhd_TLS_BACKEND_AVAIL_OK' if requested backend is available,
     83  *         error code otherwise
     84  */
     85 MHD_INTERNAL enum mhd_TlsBackendAvailable
     86 mhd_tls_is_backend_available (struct DaemonOptions *s)
     87 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_MUST_CHECK_RESULT_;
     88 
     89 #endif /* ! MHD_TLS_COMMON_H */