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

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

Move global cache mutex into the private cache struct

  • Property mode set to 100644
File size: 14.2 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    /* Trust list to verify OCSP responses for stapling. Should
218     * usually only contain the CA that signed the server
219     * certificate. */
220    gnutls_x509_trust_list_t *ocsp_trust;
221    /* Cached OCSP responses expire this long before their validity
222     * period expires. This way mod_gnutls does not staple barely
223     * valid responses. */
224    apr_time_t ocsp_grace_time;
225} mgs_srvconf_rec;
226
227/* Character Buffer */
228typedef struct {
229    int length;
230    char *value;
231} mgs_char_buffer_t;
232
233/* GnuTLS Handle */
234typedef struct {
235        /* Server configuration record */
236    mgs_srvconf_rec *sc;
237        /* Connection record */
238    conn_rec* c;
239        /* Is TLS enabled for this connection? */
240    int enabled;
241    /* Is this a proxy connection? */
242    int is_proxy;
243        /* GnuTLS Session handle */
244    gnutls_session_t session;
245        /* module input status */
246    apr_status_t input_rc;
247        /* Input filter */
248    ap_filter_t *input_filter;
249        /* Input Bucket Brigade */
250    apr_bucket_brigade *input_bb;
251        /* Input Read Type */
252    apr_read_type_e input_block;
253        /* Input Mode */
254    ap_input_mode_t input_mode;
255        /* Input Character Buffer */
256    mgs_char_buffer_t input_cbuf;
257        /* Input Character Array */
258    char input_buffer[AP_IOBUFSIZE];
259        /* module Output status */
260    apr_status_t output_rc;
261        /* Output filter */
262    ap_filter_t *output_filter;
263        /* Output Bucket Brigade */
264    apr_bucket_brigade *output_bb;
265        /* Output character array */
266    char output_buffer[AP_IOBUFSIZE];
267        /* Output buffer length */
268    apr_size_t output_blen;
269        /* Output length */
270    apr_size_t output_length;
271        /* General Status */
272    int status;
273} mgs_handle_t;
274
275
276
277/** Functions in gnutls_io.c **/
278
279/* apr_signal_block() for blocking SIGPIPE */
280apr_status_t apr_signal_block(int signum);
281
282 /* Proxy Support */
283/* An optional function which returns non-zero if the given connection
284is using SSL/TLS. */
285APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
286/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
287 * are used by mod_proxy to enable use of SSL for outgoing
288 * connections. */
289APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
290APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
291int ssl_is_https(conn_rec *c);
292int ssl_proxy_enable(conn_rec *c);
293int ssl_engine_disable(conn_rec *c);
294const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
295                                 const int arg);
296apr_status_t mgs_cleanup_pre_config(void *data);
297
298/**
299 * mgs_filter_input will filter the input data
300 * by decrypting it using GnuTLS and passes it cleartext.
301 *
302 * @param f     the filter info record
303 * @param bb    the bucket brigade, where to store the result to
304 * @param mode  what shall we read?
305 * @param block a block index we shall read from?
306 * @return result status
307 */
308apr_status_t mgs_filter_input(ap_filter_t * f,
309                                     apr_bucket_brigade * bb,
310                                     ap_input_mode_t mode,
311                                     apr_read_type_e block,
312                                     apr_off_t readbytes);
313
314/**
315 * mgs_filter_output will filter the encrypt
316 * the incoming bucket using GnuTLS and passes it onto the next filter.
317 *
318 * @param f     the filter info record
319 * @param bb    the bucket brigade, where to store the result to
320 * @return result status
321 */
322apr_status_t mgs_filter_output(ap_filter_t * f,
323                                      apr_bucket_brigade * bb);
324
325
326/**
327 * mgs_transport_read is called from GnuTLS to provide encrypted
328 * data from the client.
329 *
330 * @param ptr     pointer to the filter context
331 * @param buffer  place to put data
332 * @param len     maximum size
333 * @return size   length of the data stored in buffer
334 */
335ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
336                                  void *buffer, size_t len);
337
338/**
339 * mgs_transport_write is called from GnuTLS to
340 * write data to the client.
341 *
342 * @param ptr     pointer to the filter context
343 * @param buffer  buffer to write to the client
344 * @param len     size of the buffer
345 * @return size   length of the data written
346 */
347ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
348                                   const void *buffer, size_t len);
349
350
351int mgs_rehandshake(mgs_handle_t * ctxt);
352
353
354
355/**
356 * Perform any reinitialization required in PKCS #11
357 */
358int mgs_pkcs11_reinit(server_rec * s);
359
360
361
362/* Configuration Functions */
363
364/* Loads all files set in the configuration */
365int mgs_load_files(apr_pool_t * p, server_rec * s);
366
367const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
368                                        const char *arg);
369const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
370                                        const char *arg);
371const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
372                                        const char *arg);
373const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
374                                        const char *arg);
375
376const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
377                             const char *arg);
378
379const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
380                                        const char *arg);
381
382const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
383                             const char *arg);
384
385const char *mgs_set_cache(cmd_parms * parms, void *dummy,
386                          const char *type, const char* arg);
387
388const char *mgs_set_timeout(cmd_parms *parms, void *dummy, const char *arg);
389
390const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
391                                  const char *arg);
392
393const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
394                                         const char *arg);
395
396const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
397                                   const char *arg);
398
399const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
400                               const char *arg);
401
402const char *mgs_set_pin(cmd_parms * parms, void *dummy,
403                                   const char *arg);
404
405const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
406                                   const char *arg);
407
408const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
409                                   const char *arg);
410
411const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
412                            const int arg);
413const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
414                            const char *arg);
415const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
416                            const char *arg);
417const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
418                            const int arg);
419
420const char *mgs_set_require_section(cmd_parms *cmd,
421                                    void *mconfig, const char *arg);
422void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
423void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
424
425void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
426
427void *mgs_config_dir_create(apr_pool_t *p, char *dir);
428
429const char *mgs_set_require_bytecode(cmd_parms *cmd,
430                                    void *mconfig, const char *arg);
431
432mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
433
434const char *mgs_store_cred_path(cmd_parms * parms,
435                                void *dummy __attribute__((unused)),
436                                const char *arg);
437
438/* mod_gnutls Hooks. */
439
440int mgs_hook_pre_config(apr_pool_t * pconf,
441                        apr_pool_t * plog, apr_pool_t * ptemp);
442
443int mgs_hook_post_config(apr_pool_t *pconf,
444                         apr_pool_t *plog,
445                         apr_pool_t *ptemp,
446                         server_rec *base_server);
447
448void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
449
450const char *mgs_hook_http_scheme(const request_rec * r);
451
452apr_port_t mgs_hook_default_port(const request_rec * r);
453
454int mgs_hook_pre_connection(conn_rec * c, void *csd);
455
456int mgs_hook_fixups(request_rec *r);
457
458int mgs_hook_authz(request_rec *r);
459
460#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.