source: mod_gnutls/include/mod_gnutls.h.in @ 05e2d9e

asyncioproxy-ticket
Last change on this file since 05e2d9e was 05e2d9e, checked in by Fiona Klute <fiona.klute@…>, 19 months ago

Move function declarations for gnutls_io.c into a separate header

  • Property mode set to 100644
File size: 12.5 KB
RevLine 
[104e881]1/*
[fcb122d]2 *  Copyright 2004-2005 Paul Querna
[e021722]3 *  Copyright 2014 Nikos Mavrogiannopoulos
[c446ca5]4 *  Copyright 2015-2020 Fiona Klute
[7e2b223]5 *
6 *  Licensed under the Apache License, Version 2.0 (the "License");
7 *  you may not use this file except in compliance with the License.
8 *  You may obtain a copy of the License at
9 *
10 *      http://www.apache.org/licenses/LICENSE-2.0
11 *
12 *  Unless required by applicable law or agreed to in writing, software
13 *  distributed under the License is distributed on an "AS IS" BASIS,
14 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 *  See the License for the specific language governing permissions and
16 *  limitations under the License.
17 */
18
[3b4c0d0]19/* Apache Runtime Headers */
[7e2b223]20#include "httpd.h"
21#include "http_config.h"
22#include "http_protocol.h"
23#include "http_connection.h"
[76bd3bf]24#include "http_request.h"
[7e2b223]25#include "http_core.h"
26#include "http_log.h"
27#include "apr_buckets.h"
28#include "apr_tables.h"
[482f47f]29#include "ap_release.h"
[3b4c0d0]30/* GnuTLS Library Headers */
[31645b2]31#include <gnutls/gnutls.h>
[031acac]32#include <gnutls/abstract.h>
[31645b2]33#include <gnutls/x509.h>
34
[05d56ce]35#ifndef __mod_gnutls_h_inc
36#define __mod_gnutls_h_inc
37
[6d4de37]38extern module AP_MODULE_DECLARE_DATA gnutls_module;
[7e2b223]39
[3b4c0d0]40/* IO Filter names */
[7e2b223]41#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
42#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
[3b4c0d0]43/* GnuTLS Constants */
[7e2b223]44#define GNUTLS_ENABLED_FALSE 0
45#define GNUTLS_ENABLED_TRUE  1
[040387c]46#define GNUTLS_ENABLED_UNSET  2
[3b4c0d0]47/* Current module version */
[032ff02]48#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
49
[3b4c0d0]50/* Module Debug Mode */
[032ff02]51#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
[3b4c0d0]52
[a939015]53/* Compile support for early SNI? */
54#if @ENABLE_EARLY_SNI@ == 1
55#define ENABLE_EARLY_SNI
56#endif
57
[0e3f8c6]58/** Name of the module-wide singleton watchdog */
59#define MGS_SINGLETON_WATCHDOG "_mod_gnutls_singleton_"
60
61
[e809fb3]62/* Internal cache data, defined in gnutls_cache.h */
63typedef struct mgs_cache* mgs_cache_t;
64
[cf2b905]65typedef enum {
66    mgs_cvm_unset,
67    mgs_cvm_cartel,
68    mgs_cvm_msva
69} mgs_client_verification_method_e;
70
71
[3b4c0d0]72/* Directory Configuration Record */
73typedef struct {
[e924ddd]74    int client_verify_mode;
[c301152]75} mgs_dirconf_rec;
[31645b2]76
[7bebb42]77
[cc74801e]78/* Internal per-vhost config for OCSP, defined in gnutls_ocsp.h */
79typedef struct mgs_ocsp_data* mgs_ocsp_data_t;
80
81
[3b4c0d0]82/* The maximum number of certificates to send in a chain */
[5e81262]83#define MAX_CHAIN_SIZE 8
[7bebb42]84
[0e3f8c6]85/** Server Configuration Record */
[3b4c0d0]86typedef struct {
[d4c1a4e]87    /** Server this mod_gnutls configuration is for */
88    server_rec* s;
89
[031acac]90    /* --- Configuration values --- */
91        /* Is the module enabled? */
92    int enabled;
93        /* Is mod_proxy enabled? */
94    int proxy_enabled;
95
[9ca1f21]96    /* List of PKCS #11 provider modules to load, only valid in the
[87f1ed2]97     * base config, ignored in virtual hosts */
[9ca1f21]98    apr_array_header_t *p11_modules;
[87f1ed2]99
[031acac]100    /* PIN used for PKCS #11 operations */
101    char *pin;
102
103    /* the SRK PIN used in TPM operations */
104    char *srk_pin;
105
106    char *x509_cert_file;
107    char *x509_key_file;
108    char *x509_ca_file;
109
110    char *dh_file;
[7314438]111
[031acac]112    char *priorities_str;
[4133f2d]113    char *proxy_priorities_str;
[031acac]114
115    const char* srp_tpasswd_file;
116    const char* srp_tpasswd_conf_file;
117
118        /* Cache timeout value */
119    int cache_timeout;
[b94aee2]120    /* Enable cache */
121    unsigned char cache_enable : 2;
[e809fb3]122    /* Internal cache data */
123    mgs_cache_t cache;
[031acac]124
125        /* GnuTLS uses Session Tickets */
126    int tickets;
127
[0de1839]128    /* x509 Certificate Structure */
[671b64f]129    gnutls_certificate_credentials_t certs;
[0de1839]130    /* x509 credentials for proxy connections */
131    gnutls_certificate_credentials_t proxy_x509_creds;
[bd24203]132    /* trust list for proxy_x509_creds */
133    gnutls_x509_trust_list_t proxy_x509_tl;
[0de1839]134    const char* proxy_x509_key_file;
135    const char* proxy_x509_cert_file;
136    const char* proxy_x509_ca_file;
[809c422]137    const char* proxy_x509_crl_file;
[f030883]138    /* GnuTLS priorities for proxy connections */
139    gnutls_priority_t proxy_priorities;
[0de1839]140    /* SRP Certificate Structure*/
[7bebb42]141    gnutls_srp_server_credentials_t srp_creds;
[beb14d9]142    /* Anonymous Certificate Structure */
[7bebb42]143    gnutls_anon_server_credentials_t anon_creds;
[beb14d9]144    /* Anonymous Client Certificate Structure, used for proxy
145     * connections */
146    gnutls_anon_client_credentials_t anon_client_creds;
[031acac]147        /* An x509 Certificate Chain */
148    gnutls_pcert_st *certs_x509_chain;
149    gnutls_x509_crt_t *certs_x509_crt_chain;
150        /* Number of Certificates in Chain */
151    unsigned int certs_x509_chain_num;
152
[3b4c0d0]153        /* Current x509 Certificate Private Key */
[031acac]154    gnutls_privkey_t privkey_x509;
155
[7d1ab49]156    /* Export full certificates to CGI environment: */
[2aaf4f5]157    int export_certificates_size;
[3b4c0d0]158        /* GnuTLS Priorities */
[7bebb42]159    gnutls_priority_t priorities;
[3b4c0d0]160        /* GnuTLS DH Parameters */
[a3c97d1]161    gnutls_dh_params_t dh_params;
[3b4c0d0]162        /* A list of CA Certificates */
[8663ace]163    gnutls_x509_crt_t *ca_list;
[3b4c0d0]164        /* CA Certificate list size */
[7bebb42]165    unsigned int ca_list_size;
[3b4c0d0]166        /* Client Certificate Verification Mode */
[e924ddd]167    int client_verify_mode;
[cf2b905]168        /* Client Certificate Verification Method */
169    mgs_client_verification_method_e client_verify_method;
[94cb972]170
[3475e62]171    /* Enable OCSP stapling */
[4d4a406]172    unsigned char ocsp_staple;
[2246a84]173    /* Automatically refresh cached OCSP response? */
174    unsigned char ocsp_auto_refresh;
[b888e8b]175    /* Check nonce in OCSP responses? */
176    unsigned char ocsp_check_nonce;
[3475e62]177    /* Read OCSP response for stapling from this file instead of
178     * sending a request over HTTP */
[a3e0f7b]179    char **ocsp_response_file;
180    /* Number of configured OCSP response files */
181    int ocsp_response_file_num;
[c6dda6d]182    /* Internal OCSP data for this server */
[08ba205]183    mgs_ocsp_data_t *ocsp;
[1c3853a]184    /* Number of successfully configured OCSP data sets */
185    unsigned int ocsp_num;
[d6834e0]186    /* Mutex to prevent parallel OCSP requests */
187    apr_global_mutex_t *ocsp_mutex;
[babdb29]188    /* Internal OCSP cache data */
189    mgs_cache_t ocsp_cache;
[e1c094c]190    /* Cache timeout for OCSP responses. Note that the nextUpdate
191     * field of the response takes precedence if shorter. */
192    apr_interval_time_t ocsp_cache_time;
[c6dda6d]193    /* If an OCSP request fails wait this long before trying again. */
[0a02378]194    apr_interval_time_t ocsp_failure_timeout;
[2246a84]195    /** How long before a cached OCSP response expires should it be
196     * updated? During configuration parsing this is set to the
197     * maximum, during post configuration the value will be set to
198     * half that. After each update the interval to for the next one
199     * is choosen randomly as `ocsp_fuzz_time + ocsp_fuzz_time *
200     * RANDOM` with `0 <= RANDOM <= 1`. */
201    apr_interval_time_t ocsp_fuzz_time;
[333bbc7]202    /* Socket timeout for OCSP requests */
203    apr_interval_time_t ocsp_socket_timeout;
[0e3f8c6]204
205    /** This module's singleton watchdog, used for async OCSP cache
206     * updates. */
207    struct mgs_watchdog *singleton_wd;
[c301152]208} mgs_srvconf_rec;
[7e2b223]209
[3b4c0d0]210/* Character Buffer */
[dae0aec]211typedef struct {
212    int length;
213    char *value;
[c301152]214} mgs_char_buffer_t;
[dae0aec]215
[72b669e]216/** GnuTLS connection handle */
[3b4c0d0]217typedef struct {
218        /* Server configuration record */
[c301152]219    mgs_srvconf_rec *sc;
[3b4c0d0]220        /* Connection record */
[dae0aec]221    conn_rec* c;
[e8acf05]222        /* Is TLS enabled for this connection? */
223    int enabled;
[c1ef069]224    /* Is this a proxy connection? */
225    int is_proxy;
[3b4c0d0]226        /* GnuTLS Session handle */
[7e2b223]227    gnutls_session_t session;
[a14cf5c]228    /** Server name requested via SNI if any, or NULL. */
229    const char *sni_name;
[3b4c0d0]230        /* module input status */
[dae0aec]231    apr_status_t input_rc;
[3b4c0d0]232        /* Input filter */
[7e2b223]233    ap_filter_t *input_filter;
[3b4c0d0]234        /* Input Bucket Brigade */
[7e2b223]235    apr_bucket_brigade *input_bb;
[3b4c0d0]236        /* Input Read Type */
[7e2b223]237    apr_read_type_e input_block;
[3b4c0d0]238        /* Input Mode */
[dae0aec]239    ap_input_mode_t input_mode;
[3b4c0d0]240        /* Input Character Buffer */
[c301152]241    mgs_char_buffer_t input_cbuf;
[3b4c0d0]242        /* Input Character Array */
[dae0aec]243    char input_buffer[AP_IOBUFSIZE];
[3b4c0d0]244        /* module Output status */
[dae0aec]245    apr_status_t output_rc;
[3b4c0d0]246        /* Output filter */
[dae0aec]247    ap_filter_t *output_filter;
[3b4c0d0]248        /* Output Bucket Brigade */
[dae0aec]249    apr_bucket_brigade *output_bb;
[3b4c0d0]250        /* Output character array */
[dae0aec]251    char output_buffer[AP_IOBUFSIZE];
[3b4c0d0]252        /* Output buffer length */
[dae0aec]253    apr_size_t output_blen;
[3b4c0d0]254        /* Output length */
[dae0aec]255    apr_size_t output_length;
[72b669e]256    /** Connection status: 0 before (re-)handshake, 1 when up, -1 on
257     * error (checks use status < 0 or status > 0) */
[7e2b223]258    int status;
[c301152]259} mgs_handle_t;
[7e2b223]260
[3b4c0d0]261
262
[fb26be5]263/* apr_signal_block() for blocking SIGPIPE */
264apr_status_t apr_signal_block(int signum);
265
[265159d]266/* Proxy Support */
[37f8282]267/* An optional function which returns non-zero if the given connection
268is using SSL/TLS. */
269APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
[4cdd4fd]270/* The ssl_var_lookup() optional function retrieves SSL environment
271 * variables. */
272APR_DECLARE_OPTIONAL_FN(char *, ssl_var_lookup,
273                        (apr_pool_t *, server_rec *,
274                         conn_rec *, request_rec *,
275                         char *));
[37f8282]276/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
277 * are used by mod_proxy to enable use of SSL for outgoing
278 * connections. */
279APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
280APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
[23e98b3]281APR_DECLARE_OPTIONAL_FN(int, ssl_engine_set, (conn_rec *,
282                                              ap_conf_vector_t *,
283                                              int proxy, int enable));
[4cdd4fd]284mgs_handle_t* get_effective_gnutls_ctxt(conn_rec *c);
[37f8282]285int ssl_is_https(conn_rec *c);
[4cdd4fd]286char* ssl_var_lookup(apr_pool_t *p, server_rec *s, conn_rec *c,
287                     request_rec *r, char *var);
[33826c5]288int ssl_proxy_enable(conn_rec *c);
289int ssl_engine_disable(conn_rec *c);
[37f8282]290const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
[176047e]291                                 const int arg);
[37f8282]292apr_status_t mgs_cleanup_pre_config(void *data);
[33826c5]293
[e924ddd]294
295
[a66e147]296/**
[031acac]297 * Perform any reinitialization required in PKCS #11
298 */
299int mgs_pkcs11_reinit(server_rec * s);
300
[7bebb42]301
[c301152]302
[46b85d8]303/* Configuration Functions */
304
[031acac]305/* Loads all files set in the configuration */
[eee1432]306int mgs_load_files(apr_pool_t *pconf, apr_pool_t *ptemp, server_rec *s)
307    __attribute__((nonnull));
[031acac]308
[7bebb42]309const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
310                                        const char *arg);
311const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
312                                        const char *arg);
313const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
314                                        const char *arg);
[46b85d8]315const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
316                                        const char *arg);
317
318const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
319                             const char *arg);
320
[70a1e5a]321const char *mgs_set_timeout(cmd_parms *parms, void *dummy, const char *arg);
[46b85d8]322
323const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
324                                  const char *arg);
325
[cf2b905]326const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
327                                         const char *arg);
328
[46b85d8]329const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
330                                   const char *arg);
[87f1ed2]331
332const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
333                               const char *arg);
334
[031acac]335const char *mgs_set_pin(cmd_parms * parms, void *dummy,
336                                   const char *arg);
337
338const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
339                                   const char *arg);
[46b85d8]340
341const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
[176047e]342                            const int arg);
[2aaf4f5]343const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
[7bebb42]344                            const char *arg);
345const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
346                            const char *arg);
[ae233c2]347const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
[176047e]348                            const int arg);
[671b64f]349
[46b85d8]350void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
[040387c]351void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
[46b85d8]352
[84cb5b2]353void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
354
[46b85d8]355void *mgs_config_dir_create(apr_pool_t *p, char *dir);
356
[0de1839]357const char *mgs_store_cred_path(cmd_parms * parms,
358                                void *dummy __attribute__((unused)),
359                                const char *arg);
360
[c301152]361/* mod_gnutls Hooks. */
362
363int mgs_hook_pre_config(apr_pool_t * pconf,
364                        apr_pool_t * plog, apr_pool_t * ptemp);
365
[64856fd]366int mgs_hook_post_config(apr_pool_t *pconf,
367                         apr_pool_t *plog,
368                         apr_pool_t *ptemp,
369                         server_rec *base_server);
[c301152]370
371void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
372
373const char *mgs_hook_http_scheme(const request_rec * r);
374
375apr_port_t mgs_hook_default_port(const request_rec * r);
376
377int mgs_hook_pre_connection(conn_rec * c, void *csd);
378
[e7cf823]379int mgs_hook_process_connection(conn_rec* c);
380
[c301152]381int mgs_hook_fixups(request_rec *r);
382
[de3fad3]383/** Post request hook, checks if TLS connection and vhost match */
384int mgs_req_vhost_check(request_rec *r);
385
[c301152]386int mgs_hook_authz(request_rec *r);
387
[7e2b223]388#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.