source: mod_gnutls/include/mod_gnutls.h.in @ babdb29

asynciodebian/masterproxy-ticket
Last change on this file since babdb29 was babdb29, checked in by Fiona Klute <fiona.klute@…>, 3 years ago

Initialize and clean up the OCSP cache, following session cache patterns

  • Property mode set to 100644
File size: 14.2 KB
RevLine 
[104e881]1/*
[fcb122d]2 *  Copyright 2004-2005 Paul Querna
[e021722]3 *  Copyright 2014 Nikos Mavrogiannopoulos
[3c123cd]4 *  Copyright 2015-2018 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_strings.h"
29#include "apr_tables.h"
[482f47f]30#include "ap_release.h"
[9ddaa29]31#include "apr_fnmatch.h"
[3b4c0d0]32/* GnuTLS Library Headers */
[31645b2]33#include <gnutls/gnutls.h>
[031acac]34#include <gnutls/abstract.h>
[31645b2]35#include <gnutls/x509.h>
36
[05d56ce]37#ifndef __mod_gnutls_h_inc
38#define __mod_gnutls_h_inc
39
[6d4de37]40extern module AP_MODULE_DECLARE_DATA gnutls_module;
[7e2b223]41
[3b4c0d0]42/* IO Filter names */
[7e2b223]43#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
44#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
[3b4c0d0]45/* GnuTLS Constants */
[7e2b223]46#define GNUTLS_ENABLED_FALSE 0
47#define GNUTLS_ENABLED_TRUE  1
[040387c]48#define GNUTLS_ENABLED_UNSET  2
[3b4c0d0]49/* Current module version */
[032ff02]50#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
51
[3b4c0d0]52/* Module Debug Mode */
[032ff02]53#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
[3b4c0d0]54
[0e3f8c6]55/** Name of the module-wide singleton watchdog */
56#define MGS_SINGLETON_WATCHDOG "_mod_gnutls_singleton_"
57
58
[e809fb3]59/* Internal cache data, defined in gnutls_cache.h */
60typedef struct mgs_cache* mgs_cache_t;
61
[cf2b905]62typedef enum {
63    mgs_cvm_unset,
64    mgs_cvm_cartel,
65    mgs_cvm_msva
66} mgs_client_verification_method_e;
67
68
[3b4c0d0]69/* Directory Configuration Record */
70typedef struct {
[e924ddd]71    int client_verify_mode;
[c301152]72} mgs_dirconf_rec;
[31645b2]73
[7bebb42]74
[cc74801e]75/* Internal per-vhost config for OCSP, defined in gnutls_ocsp.h */
76typedef struct mgs_ocsp_data* mgs_ocsp_data_t;
77
78
[3b4c0d0]79/* The maximum number of certificates to send in a chain */
[5e81262]80#define MAX_CHAIN_SIZE 8
[3b4c0d0]81/* The maximum number of SANs to read from a x509 certificate */
82#define MAX_CERT_SAN 5
[7bebb42]83
[0e3f8c6]84/** Server Configuration Record */
[3b4c0d0]85typedef struct {
[031acac]86    /* --- Configuration values --- */
87        /* Is the module enabled? */
88    int enabled;
89        /* Is mod_proxy enabled? */
90    int proxy_enabled;
91
[9ca1f21]92    /* List of PKCS #11 provider modules to load, only valid in the
[87f1ed2]93     * base config, ignored in virtual hosts */
[9ca1f21]94    apr_array_header_t *p11_modules;
[87f1ed2]95
[031acac]96    /* PIN used for PKCS #11 operations */
97    char *pin;
98
99    /* the SRK PIN used in TPM operations */
100    char *srk_pin;
101
102    char *x509_cert_file;
103    char *x509_key_file;
104    char *x509_ca_file;
105
106    char *dh_file;
[7314438]107
[031acac]108    char *priorities_str;
[4133f2d]109    char *proxy_priorities_str;
[031acac]110
111    const char* srp_tpasswd_file;
112    const char* srp_tpasswd_conf_file;
113
114        /* Cache timeout value */
115    int cache_timeout;
[b94aee2]116    /* Enable cache */
117    unsigned char cache_enable : 2;
[e809fb3]118    /* Internal cache data */
119    mgs_cache_t cache;
[031acac]120
121        /* GnuTLS uses Session Tickets */
122    int tickets;
123
[0de1839]124    /* x509 Certificate Structure */
[671b64f]125    gnutls_certificate_credentials_t certs;
[0de1839]126    /* x509 credentials for proxy connections */
127    gnutls_certificate_credentials_t proxy_x509_creds;
[bd24203]128    /* trust list for proxy_x509_creds */
129    gnutls_x509_trust_list_t proxy_x509_tl;
[0de1839]130    const char* proxy_x509_key_file;
131    const char* proxy_x509_cert_file;
132    const char* proxy_x509_ca_file;
[809c422]133    const char* proxy_x509_crl_file;
[f030883]134    /* GnuTLS priorities for proxy connections */
135    gnutls_priority_t proxy_priorities;
[0de1839]136    /* SRP Certificate Structure*/
[7bebb42]137    gnutls_srp_server_credentials_t srp_creds;
[beb14d9]138    /* Anonymous Certificate Structure */
[7bebb42]139    gnutls_anon_server_credentials_t anon_creds;
[beb14d9]140    /* Anonymous Client Certificate Structure, used for proxy
141     * connections */
142    gnutls_anon_client_credentials_t anon_client_creds;
[3b4c0d0]143        /* Current x509 Certificate CN [Common Name] */
[e924ddd]144    char* cert_cn;
[3b4c0d0]145        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
[031acac]146    char* cert_san[MAX_CERT_SAN];
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 */
[94cb972]179    char *ocsp_response_file;
[c6dda6d]180    /* Internal OCSP data for this server */
[cc74801e]181    mgs_ocsp_data_t ocsp;
[d6834e0]182    /* Mutex to prevent parallel OCSP requests */
183    apr_global_mutex_t *ocsp_mutex;
[babdb29]184    /* Enable OCSP cache */
185    unsigned char ocsp_cache_enable : 2;
186    /* Internal OCSP cache data */
187    mgs_cache_t ocsp_cache;
[e1c094c]188    /* Cache timeout for OCSP responses. Note that the nextUpdate
189     * field of the response takes precedence if shorter. */
190    apr_interval_time_t ocsp_cache_time;
[c6dda6d]191    /* If an OCSP request fails wait this long before trying again. */
[0a02378]192    apr_interval_time_t ocsp_failure_timeout;
[2246a84]193    /** How long before a cached OCSP response expires should it be
194     * updated? During configuration parsing this is set to the
195     * maximum, during post configuration the value will be set to
196     * half that. After each update the interval to for the next one
197     * is choosen randomly as `ocsp_fuzz_time + ocsp_fuzz_time *
198     * RANDOM` with `0 <= RANDOM <= 1`. */
199    apr_interval_time_t ocsp_fuzz_time;
[333bbc7]200    /* Socket timeout for OCSP requests */
201    apr_interval_time_t ocsp_socket_timeout;
[0e3f8c6]202
203    /** This module's singleton watchdog, used for async OCSP cache
204     * updates. */
205    struct mgs_watchdog *singleton_wd;
[c301152]206} mgs_srvconf_rec;
[7e2b223]207
[3b4c0d0]208/* Character Buffer */
[dae0aec]209typedef struct {
210    int length;
211    char *value;
[c301152]212} mgs_char_buffer_t;
[dae0aec]213
[3b4c0d0]214/* GnuTLS Handle */
215typedef struct {
216        /* Server configuration record */
[c301152]217    mgs_srvconf_rec *sc;
[3b4c0d0]218        /* Connection record */
[dae0aec]219    conn_rec* c;
[e8acf05]220        /* Is TLS enabled for this connection? */
221    int enabled;
[c1ef069]222    /* Is this a proxy connection? */
223    int is_proxy;
[3b4c0d0]224        /* GnuTLS Session handle */
[7e2b223]225    gnutls_session_t session;
[3b4c0d0]226        /* module input status */
[dae0aec]227    apr_status_t input_rc;
[3b4c0d0]228        /* Input filter */
[7e2b223]229    ap_filter_t *input_filter;
[3b4c0d0]230        /* Input Bucket Brigade */
[7e2b223]231    apr_bucket_brigade *input_bb;
[3b4c0d0]232        /* Input Read Type */
[7e2b223]233    apr_read_type_e input_block;
[3b4c0d0]234        /* Input Mode */
[dae0aec]235    ap_input_mode_t input_mode;
[3b4c0d0]236        /* Input Character Buffer */
[c301152]237    mgs_char_buffer_t input_cbuf;
[3b4c0d0]238        /* Input Character Array */
[dae0aec]239    char input_buffer[AP_IOBUFSIZE];
[3b4c0d0]240        /* module Output status */
[dae0aec]241    apr_status_t output_rc;
[3b4c0d0]242        /* Output filter */
[dae0aec]243    ap_filter_t *output_filter;
[3b4c0d0]244        /* Output Bucket Brigade */
[dae0aec]245    apr_bucket_brigade *output_bb;
[3b4c0d0]246        /* Output character array */
[dae0aec]247    char output_buffer[AP_IOBUFSIZE];
[3b4c0d0]248        /* Output buffer length */
[dae0aec]249    apr_size_t output_blen;
[3b4c0d0]250        /* Output length */
[dae0aec]251    apr_size_t output_length;
[3b4c0d0]252        /* General Status */
[7e2b223]253    int status;
[c301152]254} mgs_handle_t;
[7e2b223]255
[3b4c0d0]256
257
[7e2b223]258/** Functions in gnutls_io.c **/
259
[fb26be5]260/* apr_signal_block() for blocking SIGPIPE */
261apr_status_t apr_signal_block(int signum);
262
[265159d]263/* Proxy Support */
264/** mod_proxy adds a note with this key to the connection->notes table
265 * for client connections */
266#define PROXY_SNI_NOTE "proxy-request-hostname"
[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
[7e2b223]294/**
[c301152]295 * mgs_filter_input will filter the input data
[7e2b223]296 * by decrypting it using GnuTLS and passes it cleartext.
297 *
298 * @param f     the filter info record
299 * @param bb    the bucket brigade, where to store the result to
300 * @param mode  what shall we read?
301 * @param block a block index we shall read from?
302 * @return result status
303 */
[c301152]304apr_status_t mgs_filter_input(ap_filter_t * f,
[2e12226]305                                     apr_bucket_brigade * bb,
306                                     ap_input_mode_t mode,
307                                     apr_read_type_e block,
308                                     apr_off_t readbytes);
[7e2b223]309
310/**
[c301152]311 * mgs_filter_output will filter the encrypt
[7e2b223]312 * the incoming bucket using GnuTLS and passes it onto the next filter.
313 *
314 * @param f     the filter info record
315 * @param bb    the bucket brigade, where to store the result to
316 * @return result status
317 */
[c301152]318apr_status_t mgs_filter_output(ap_filter_t * f,
[2e12226]319                                      apr_bucket_brigade * bb);
[7e2b223]320
321
322/**
[671b64f]323 * mgs_transport_read is called from GnuTLS to provide encrypted
[7e2b223]324 * data from the client.
325 *
326 * @param ptr     pointer to the filter context
327 * @param buffer  place to put data
328 * @param len     maximum size
329 * @return size   length of the data stored in buffer
330 */
[c301152]331ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
[2e12226]332                                  void *buffer, size_t len);
[7e2b223]333
334/**
[671b64f]335 * mgs_transport_write is called from GnuTLS to
[7e2b223]336 * write data to the client.
337 *
338 * @param ptr     pointer to the filter context
339 * @param buffer  buffer to write to the client
340 * @param len     size of the buffer
341 * @return size   length of the data written
342 */
[c301152]343ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
[2e12226]344                                   const void *buffer, size_t len);
[7e2b223]345
346
[c301152]347int mgs_rehandshake(mgs_handle_t * ctxt);
[e924ddd]348
349
350
[a66e147]351/**
[031acac]352 * Perform any reinitialization required in PKCS #11
353 */
354int mgs_pkcs11_reinit(server_rec * s);
355
[7bebb42]356
[c301152]357
[46b85d8]358/* Configuration Functions */
359
[031acac]360/* Loads all files set in the configuration */
[eee1432]361int mgs_load_files(apr_pool_t *pconf, apr_pool_t *ptemp, server_rec *s)
362    __attribute__((nonnull));
[031acac]363
[7bebb42]364const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
365                                        const char *arg);
366const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
367                                        const char *arg);
368const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
369                                        const char *arg);
[46b85d8]370const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
371                                        const char *arg);
372
373const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
374                             const char *arg);
375
[70a1e5a]376const char *mgs_set_timeout(cmd_parms *parms, void *dummy, const char *arg);
[46b85d8]377
378const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
379                                  const char *arg);
380
[cf2b905]381const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
382                                         const char *arg);
383
[46b85d8]384const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
385                                   const char *arg);
[87f1ed2]386
387const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
388                               const char *arg);
389
[031acac]390const char *mgs_set_pin(cmd_parms * parms, void *dummy,
391                                   const char *arg);
392
393const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
394                                   const char *arg);
[46b85d8]395
396const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
[176047e]397                            const int arg);
[2aaf4f5]398const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
[7bebb42]399                            const char *arg);
400const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
401                            const char *arg);
[ae233c2]402const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
[176047e]403                            const int arg);
[671b64f]404
[46b85d8]405void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
[040387c]406void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
[46b85d8]407
[84cb5b2]408void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
409
[46b85d8]410void *mgs_config_dir_create(apr_pool_t *p, char *dir);
411
[836417f]412mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
[c301152]413
[0de1839]414const char *mgs_store_cred_path(cmd_parms * parms,
415                                void *dummy __attribute__((unused)),
416                                const char *arg);
417
[c301152]418/* mod_gnutls Hooks. */
419
420int mgs_hook_pre_config(apr_pool_t * pconf,
421                        apr_pool_t * plog, apr_pool_t * ptemp);
422
[64856fd]423int mgs_hook_post_config(apr_pool_t *pconf,
424                         apr_pool_t *plog,
425                         apr_pool_t *ptemp,
426                         server_rec *base_server);
[c301152]427
428void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
429
430const char *mgs_hook_http_scheme(const request_rec * r);
431
432apr_port_t mgs_hook_default_port(const request_rec * r);
433
434int mgs_hook_pre_connection(conn_rec * c, void *csd);
435
[e7cf823]436int mgs_hook_process_connection(conn_rec* c);
437
[c301152]438int mgs_hook_fixups(request_rec *r);
439
440int mgs_hook_authz(request_rec *r);
441
[7e2b223]442#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.