source: mod_gnutls/include/mod_gnutls.h.in

mod_gnutls/0.10.0
Last change on this file was e819f13, checked in by Fiona Klute <fiona.klute@…>, 2 months ago

Unconditionally enable early SNI parsing

All supported GnuTLS versions provide gnutls_ext_raw_parse(), so
there's no more need to provide a fallback for older versions.

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