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

debian/masterdebian/stretch-backportsupstream
Last change on this file since d6834e0 was d6834e0, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

OCSP refresh mutex: Prevent parallel requests

Add a global mutex which a thread must hold before updating a cached
OCSP response. This avoids two threads updating the same response in
parallel. The impact of parallel updates may be small with the
experimental file-based mechanism, but an extra OCSP request over HTTP
would add a lot of overhead.

Note that the new 'gnutls-ocsp' mutex is a global mutex, not one per
virtual host, because a mutex must be registered in pre_config for the
Mutex directive to work.

  • Property mode set to 100644
File size: 14.3 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2014 Nikos Mavrogiannopoulos
4 *  Copyright 2015-2016 Thomas Klute
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 */
19
20/* Apache Runtime Headers */
21#include "httpd.h"
22#include "http_config.h"
23#include "http_protocol.h"
24#include "http_connection.h"
25#include "http_request.h"
26#include "http_core.h"
27#include "http_log.h"
28#include "apr_buckets.h"
29#include "apr_strings.h"
30#include "apr_tables.h"
31#include "ap_release.h"
32#include "apr_fnmatch.h"
33/* GnuTLS Library Headers */
34#include <gnutls/gnutls.h>
35#include <gnutls/abstract.h>
36#include <gnutls/openpgp.h>
37#include <gnutls/x509.h>
38
39#ifndef __mod_gnutls_h_inc
40#define __mod_gnutls_h_inc
41
42#define HAVE_APR_MEMCACHE    @have_apr_memcache@
43
44extern module AP_MODULE_DECLARE_DATA gnutls_module;
45
46/* IO Filter names */
47#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
48#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
49/* GnuTLS Constants */
50#define GNUTLS_ENABLED_FALSE 0
51#define GNUTLS_ENABLED_TRUE  1
52#define GNUTLS_ENABLED_UNSET  2
53/* Current module version */
54#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
55
56/* Module Debug Mode */
57#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
58
59/* mod_gnutls Cache Types */
60typedef enum {
61        /* No Cache */
62    mgs_cache_none,
63        /* Use Old Berkley DB */
64    mgs_cache_dbm,
65        /* Use Gnu's version of Berkley DB */
66    mgs_cache_gdbm,
67#if HAVE_APR_MEMCACHE
68        /* Use Memcache */
69    mgs_cache_memcache,
70#endif
71    mgs_cache_unset
72} mgs_cache_e;
73
74/* Internal cache data, defined in gnutls_cache.h */
75typedef struct mgs_cache* mgs_cache_t;
76
77typedef enum {
78    mgs_cvm_unset,
79    mgs_cvm_cartel,
80    mgs_cvm_msva
81} mgs_client_verification_method_e;
82
83
84/* Directory Configuration Record */
85typedef struct {
86    int client_verify_mode;
87    const char* lua_bytecode;
88    apr_size_t lua_bytecode_len;
89} mgs_dirconf_rec;
90
91
92/* The maximum number of certificates to send in a chain */
93#define MAX_CHAIN_SIZE 8
94/* The maximum number of SANs to read from a x509 certificate */
95#define MAX_CERT_SAN 5
96
97/* Server Configuration Record */
98typedef struct {
99    /* --- Configuration values --- */
100        /* Is the module enabled? */
101    int enabled;
102        /* Is mod_proxy enabled? */
103    int proxy_enabled;
104        /* A Plain HTTP request */
105    int non_ssl_request;
106
107    /* List of PKCS #11 provider modules to load, only valid in the
108     * base config, ignored in virtual hosts */
109    apr_array_header_t *p11_modules;
110
111    /* PIN used for PKCS #11 operations */
112    char *pin;
113
114    /* the SRK PIN used in TPM operations */
115    char *srk_pin;
116
117    char *x509_cert_file;
118    char *x509_key_file;
119    char *x509_ca_file;
120
121    char *pgp_cert_file;
122    char *pgp_key_file;
123    char *pgp_ring_file;
124
125    char *dh_file;
126
127    char *priorities_str;
128    char *proxy_priorities_str;
129
130    const char* srp_tpasswd_file;
131    const char* srp_tpasswd_conf_file;
132
133        /* Cache timeout value */
134    int cache_timeout;
135        /* Chose Cache Type */
136    mgs_cache_e cache_type;
137    const char* cache_config;
138    /* Internal cache data */
139    mgs_cache_t cache;
140
141        /* GnuTLS uses Session Tickets */
142    int tickets;
143
144    /* --- Things initialized at _child_init --- */
145
146    /* x509 Certificate Structure */
147    gnutls_certificate_credentials_t certs;
148    /* x509 credentials for proxy connections */
149    gnutls_certificate_credentials_t proxy_x509_creds;
150    /* trust list for proxy_x509_creds */
151    gnutls_x509_trust_list_t proxy_x509_tl;
152    const char* proxy_x509_key_file;
153    const char* proxy_x509_cert_file;
154    const char* proxy_x509_ca_file;
155    const char* proxy_x509_crl_file;
156    /* GnuTLS priorities for proxy connections */
157    gnutls_priority_t proxy_priorities;
158    /* SRP Certificate Structure*/
159    gnutls_srp_server_credentials_t srp_creds;
160    /* Anonymous Certificate Structure */
161    gnutls_anon_server_credentials_t anon_creds;
162    /* Anonymous Client Certificate Structure, used for proxy
163     * connections */
164    gnutls_anon_client_credentials_t anon_client_creds;
165        /* Current x509 Certificate CN [Common Name] */
166    char* cert_cn;
167        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
168    char* cert_san[MAX_CERT_SAN];
169        /* An x509 Certificate Chain */
170    gnutls_pcert_st *certs_x509_chain;
171    gnutls_x509_crt_t *certs_x509_crt_chain;
172        /* Number of Certificates in Chain */
173    unsigned int certs_x509_chain_num;
174
175        /* Current x509 Certificate Private Key */
176    gnutls_privkey_t privkey_x509;
177
178        /* OpenPGP Certificate */
179    gnutls_pcert_st *cert_pgp;
180    gnutls_openpgp_crt_t *cert_crt_pgp;
181
182        /* OpenPGP Certificate Private Key */
183    gnutls_privkey_t privkey_pgp;
184#if GNUTLS_VERSION_NUMBER < 0x030312
185    /* Internal structure for the OpenPGP private key, used in the
186     * workaround for a bug in gnutls_privkey_import_openpgp_raw that
187     * frees memory that is still needed. DO NOT USE for any other
188     * purpose. */
189    gnutls_openpgp_privkey_t privkey_pgp_internal;
190#endif
191
192    /* Export full certificates to CGI environment: */
193    int export_certificates_size;
194        /* GnuTLS Priorities */
195    gnutls_priority_t priorities;
196        /* GnuTLS DH Parameters */
197    gnutls_dh_params_t dh_params;
198        /* A list of CA Certificates */
199    gnutls_x509_crt_t *ca_list;
200        /* OpenPGP Key Ring */
201    gnutls_openpgp_keyring_t pgp_list;
202        /* CA Certificate list size */
203    unsigned int ca_list_size;
204        /* Client Certificate Verification Mode */
205    int client_verify_mode;
206        /* Client Certificate Verification Method */
207    mgs_client_verification_method_e client_verify_method;
208        /* Last Cache timestamp */
209    apr_time_t last_cache_check;
210
211    /* EXPERIMENTAL: OCSP response file for stapling, will go away
212     * once sending OCSP requests is implemented */
213    char *ocsp_response_file;
214    /* OCSP URI extracted from the server certificate. NULL if
215     * unset. */
216    apr_uri_t *ocsp_uri;
217    /* Mutex to prevent parallel OCSP requests */
218    apr_global_mutex_t *ocsp_mutex;
219    /* Trust list to verify OCSP responses for stapling. Should
220     * usually only contain the CA that signed the server
221     * certificate. */
222    gnutls_x509_trust_list_t *ocsp_trust;
223    /* Cached OCSP responses expire this long before their validity
224     * period expires. This way mod_gnutls does not staple barely
225     * valid responses. */
226    apr_time_t ocsp_grace_time;
227} mgs_srvconf_rec;
228
229/* Character Buffer */
230typedef struct {
231    int length;
232    char *value;
233} mgs_char_buffer_t;
234
235/* GnuTLS Handle */
236typedef struct {
237        /* Server configuration record */
238    mgs_srvconf_rec *sc;
239        /* Connection record */
240    conn_rec* c;
241        /* Is TLS enabled for this connection? */
242    int enabled;
243    /* Is this a proxy connection? */
244    int is_proxy;
245        /* GnuTLS Session handle */
246    gnutls_session_t session;
247        /* module input status */
248    apr_status_t input_rc;
249        /* Input filter */
250    ap_filter_t *input_filter;
251        /* Input Bucket Brigade */
252    apr_bucket_brigade *input_bb;
253        /* Input Read Type */
254    apr_read_type_e input_block;
255        /* Input Mode */
256    ap_input_mode_t input_mode;
257        /* Input Character Buffer */
258    mgs_char_buffer_t input_cbuf;
259        /* Input Character Array */
260    char input_buffer[AP_IOBUFSIZE];
261        /* module Output status */
262    apr_status_t output_rc;
263        /* Output filter */
264    ap_filter_t *output_filter;
265        /* Output Bucket Brigade */
266    apr_bucket_brigade *output_bb;
267        /* Output character array */
268    char output_buffer[AP_IOBUFSIZE];
269        /* Output buffer length */
270    apr_size_t output_blen;
271        /* Output length */
272    apr_size_t output_length;
273        /* General Status */
274    int status;
275} mgs_handle_t;
276
277
278
279/** Functions in gnutls_io.c **/
280
281/* apr_signal_block() for blocking SIGPIPE */
282apr_status_t apr_signal_block(int signum);
283
284 /* Proxy Support */
285/* An optional function which returns non-zero if the given connection
286is using SSL/TLS. */
287APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
288/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
289 * are used by mod_proxy to enable use of SSL for outgoing
290 * connections. */
291APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
292APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
293int ssl_is_https(conn_rec *c);
294int ssl_proxy_enable(conn_rec *c);
295int ssl_engine_disable(conn_rec *c);
296const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
297                                 const int arg);
298apr_status_t mgs_cleanup_pre_config(void *data);
299
300/**
301 * mgs_filter_input will filter the input data
302 * by decrypting it using GnuTLS and passes it cleartext.
303 *
304 * @param f     the filter info record
305 * @param bb    the bucket brigade, where to store the result to
306 * @param mode  what shall we read?
307 * @param block a block index we shall read from?
308 * @return result status
309 */
310apr_status_t mgs_filter_input(ap_filter_t * f,
311                                     apr_bucket_brigade * bb,
312                                     ap_input_mode_t mode,
313                                     apr_read_type_e block,
314                                     apr_off_t readbytes);
315
316/**
317 * mgs_filter_output will filter the encrypt
318 * the incoming bucket using GnuTLS and passes it onto the next filter.
319 *
320 * @param f     the filter info record
321 * @param bb    the bucket brigade, where to store the result to
322 * @return result status
323 */
324apr_status_t mgs_filter_output(ap_filter_t * f,
325                                      apr_bucket_brigade * bb);
326
327
328/**
329 * mgs_transport_read is called from GnuTLS to provide encrypted
330 * data from the client.
331 *
332 * @param ptr     pointer to the filter context
333 * @param buffer  place to put data
334 * @param len     maximum size
335 * @return size   length of the data stored in buffer
336 */
337ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
338                                  void *buffer, size_t len);
339
340/**
341 * mgs_transport_write is called from GnuTLS to
342 * write data to the client.
343 *
344 * @param ptr     pointer to the filter context
345 * @param buffer  buffer to write to the client
346 * @param len     size of the buffer
347 * @return size   length of the data written
348 */
349ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
350                                   const void *buffer, size_t len);
351
352
353int mgs_rehandshake(mgs_handle_t * ctxt);
354
355
356
357/**
358 * Perform any reinitialization required in PKCS #11
359 */
360int mgs_pkcs11_reinit(server_rec * s);
361
362
363
364/* Configuration Functions */
365
366/* Loads all files set in the configuration */
367int mgs_load_files(apr_pool_t * p, server_rec * s);
368
369const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
370                                        const char *arg);
371const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
372                                        const char *arg);
373const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
374                                        const char *arg);
375const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
376                                        const char *arg);
377
378const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
379                             const char *arg);
380
381const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
382                                        const char *arg);
383
384const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
385                             const char *arg);
386
387const char *mgs_set_cache(cmd_parms * parms, void *dummy,
388                          const char *type, const char* arg);
389
390const char *mgs_set_timeout(cmd_parms *parms, void *dummy, const char *arg);
391
392const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
393                                  const char *arg);
394
395const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
396                                         const char *arg);
397
398const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
399                                   const char *arg);
400
401const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
402                               const char *arg);
403
404const char *mgs_set_pin(cmd_parms * parms, void *dummy,
405                                   const char *arg);
406
407const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
408                                   const char *arg);
409
410const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
411                                   const char *arg);
412
413const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
414                            const int arg);
415const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
416                            const char *arg);
417const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
418                            const char *arg);
419const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
420                            const int arg);
421
422const char *mgs_set_require_section(cmd_parms *cmd,
423                                    void *mconfig, const char *arg);
424void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
425void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
426
427void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
428
429void *mgs_config_dir_create(apr_pool_t *p, char *dir);
430
431const char *mgs_set_require_bytecode(cmd_parms *cmd,
432                                    void *mconfig, const char *arg);
433
434mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
435
436const char *mgs_store_cred_path(cmd_parms * parms,
437                                void *dummy __attribute__((unused)),
438                                const char *arg);
439
440/* mod_gnutls Hooks. */
441
442int mgs_hook_pre_config(apr_pool_t * pconf,
443                        apr_pool_t * plog, apr_pool_t * ptemp);
444
445int mgs_hook_post_config(apr_pool_t *pconf,
446                         apr_pool_t *plog,
447                         apr_pool_t *ptemp,
448                         server_rec *base_server);
449
450void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
451
452const char *mgs_hook_http_scheme(const request_rec * r);
453
454apr_port_t mgs_hook_default_port(const request_rec * r);
455
456int mgs_hook_pre_connection(conn_rec * c, void *csd);
457
458int mgs_hook_fixups(request_rec *r);
459
460int mgs_hook_authz(request_rec *r);
461
462#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.