source: mod_gnutls/include/mod_gnutls.h.in

debian/master debian/0.9.0-1
Last change on this file was 0378c22, checked in by Fiona Klute <fiona.klute@…>, 7 months ago

Move mod_proxy note name definitions to gnutls_proxy.h

  • Property mode set to 100644
File size: 14.1 KB
Line 
1/*
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2014 Nikos Mavrogiannopoulos
4 *  Copyright 2015-2018 Fiona 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/* Apache Runtime Headers */
20#include "httpd.h"
21#include "http_config.h"
22#include "http_protocol.h"
23#include "http_connection.h"
24#include "http_request.h"
25#include "http_core.h"
26#include "http_log.h"
27#include "apr_buckets.h"
28#include "apr_tables.h"
29#include "ap_release.h"
30/* GnuTLS Library Headers */
31#include <gnutls/gnutls.h>
32#include <gnutls/abstract.h>
33#include <gnutls/x509.h>
34
35#ifndef __mod_gnutls_h_inc
36#define __mod_gnutls_h_inc
37
38extern module AP_MODULE_DECLARE_DATA gnutls_module;
39
40/* IO Filter names */
41#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
42#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
43/* GnuTLS Constants */
44#define GNUTLS_ENABLED_FALSE 0
45#define GNUTLS_ENABLED_TRUE  1
46#define GNUTLS_ENABLED_UNSET  2
47/* Current module version */
48#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
49
50/* Module Debug Mode */
51#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
52
53/* Compile support for early SNI? */
54#if @ENABLE_EARLY_SNI@ == 1
55#define ENABLE_EARLY_SNI
56#endif
57
58/** Name of the module-wide singleton watchdog */
59#define MGS_SINGLETON_WATCHDOG "_mod_gnutls_singleton_"
60
61
62/* Internal cache data, defined in gnutls_cache.h */
63typedef struct mgs_cache* mgs_cache_t;
64
65typedef enum {
66    mgs_cvm_unset,
67    mgs_cvm_cartel,
68    mgs_cvm_msva
69} mgs_client_verification_method_e;
70
71
72/* Directory Configuration Record */
73typedef struct {
74    int client_verify_mode;
75} mgs_dirconf_rec;
76
77
78/* Internal per-vhost config for OCSP, defined in gnutls_ocsp.h */
79typedef struct mgs_ocsp_data* mgs_ocsp_data_t;
80
81
82/* The maximum number of certificates to send in a chain */
83#define MAX_CHAIN_SIZE 8
84
85/** Server Configuration Record */
86typedef struct {
87    /** Server this mod_gnutls configuration is for */
88    server_rec* s;
89
90    /* --- Configuration values --- */
91        /* Is the module enabled? */
92    int enabled;
93        /* Is mod_proxy enabled? */
94    int proxy_enabled;
95
96    /* List of PKCS #11 provider modules to load, only valid in the
97     * base config, ignored in virtual hosts */
98    apr_array_header_t *p11_modules;
99
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;
111
112    char *priorities_str;
113    char *proxy_priorities_str;
114
115    const char* srp_tpasswd_file;
116    const char* srp_tpasswd_conf_file;
117
118        /* Cache timeout value */
119    int cache_timeout;
120    /* Enable cache */
121    unsigned char cache_enable : 2;
122    /* Internal cache data */
123    mgs_cache_t cache;
124
125        /* GnuTLS uses Session Tickets */
126    int tickets;
127
128    /* x509 Certificate Structure */
129    gnutls_certificate_credentials_t certs;
130    /* x509 credentials for proxy connections */
131    gnutls_certificate_credentials_t proxy_x509_creds;
132    /* trust list for proxy_x509_creds */
133    gnutls_x509_trust_list_t proxy_x509_tl;
134    const char* proxy_x509_key_file;
135    const char* proxy_x509_cert_file;
136    const char* proxy_x509_ca_file;
137    const char* proxy_x509_crl_file;
138    /* GnuTLS priorities for proxy connections */
139    gnutls_priority_t proxy_priorities;
140    /* SRP Certificate Structure*/
141    gnutls_srp_server_credentials_t srp_creds;
142    /* Anonymous Certificate Structure */
143    gnutls_anon_server_credentials_t anon_creds;
144    /* Anonymous Client Certificate Structure, used for proxy
145     * connections */
146    gnutls_anon_client_credentials_t anon_client_creds;
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
153        /* Current x509 Certificate Private Key */
154    gnutls_privkey_t privkey_x509;
155
156    /* Export full certificates to CGI environment: */
157    int export_certificates_size;
158        /* GnuTLS Priorities */
159    gnutls_priority_t priorities;
160        /* GnuTLS DH Parameters */
161    gnutls_dh_params_t dh_params;
162        /* A list of CA Certificates */
163    gnutls_x509_crt_t *ca_list;
164        /* CA Certificate list size */
165    unsigned int ca_list_size;
166        /* Client Certificate Verification Mode */
167    int client_verify_mode;
168        /* Client Certificate Verification Method */
169    mgs_client_verification_method_e client_verify_method;
170
171    /* Enable OCSP stapling */
172    unsigned char ocsp_staple;
173    /* Automatically refresh cached OCSP response? */
174    unsigned char ocsp_auto_refresh;
175    /* Check nonce in OCSP responses? */
176    unsigned char ocsp_check_nonce;
177    /* Read OCSP response for stapling from this file instead of
178     * sending a request over HTTP */
179    char *ocsp_response_file;
180    /* Internal OCSP data for this server */
181    mgs_ocsp_data_t ocsp;
182    /* Mutex to prevent parallel OCSP requests */
183    apr_global_mutex_t *ocsp_mutex;
184    /* Internal OCSP cache data */
185    mgs_cache_t ocsp_cache;
186    /* Cache timeout for OCSP responses. Note that the nextUpdate
187     * field of the response takes precedence if shorter. */
188    apr_interval_time_t ocsp_cache_time;
189    /* If an OCSP request fails wait this long before trying again. */
190    apr_interval_time_t ocsp_failure_timeout;
191    /** How long before a cached OCSP response expires should it be
192     * updated? During configuration parsing this is set to the
193     * maximum, during post configuration the value will be set to
194     * half that. After each update the interval to for the next one
195     * is choosen randomly as `ocsp_fuzz_time + ocsp_fuzz_time *
196     * RANDOM` with `0 <= RANDOM <= 1`. */
197    apr_interval_time_t ocsp_fuzz_time;
198    /* Socket timeout for OCSP requests */
199    apr_interval_time_t ocsp_socket_timeout;
200
201    /** This module's singleton watchdog, used for async OCSP cache
202     * updates. */
203    struct mgs_watchdog *singleton_wd;
204} mgs_srvconf_rec;
205
206/* Character Buffer */
207typedef struct {
208    int length;
209    char *value;
210} mgs_char_buffer_t;
211
212/** GnuTLS connection handle */
213typedef struct {
214        /* Server configuration record */
215    mgs_srvconf_rec *sc;
216        /* Connection record */
217    conn_rec* c;
218        /* Is TLS enabled for this connection? */
219    int enabled;
220    /* Is this a proxy connection? */
221    int is_proxy;
222        /* GnuTLS Session handle */
223    gnutls_session_t session;
224    /** Server name requested via SNI if any, or NULL. */
225    const char *sni_name;
226        /* module input status */
227    apr_status_t input_rc;
228        /* Input filter */
229    ap_filter_t *input_filter;
230        /* Input Bucket Brigade */
231    apr_bucket_brigade *input_bb;
232        /* Input Read Type */
233    apr_read_type_e input_block;
234        /* Input Mode */
235    ap_input_mode_t input_mode;
236        /* Input Character Buffer */
237    mgs_char_buffer_t input_cbuf;
238        /* Input Character Array */
239    char input_buffer[AP_IOBUFSIZE];
240        /* module Output status */
241    apr_status_t output_rc;
242        /* Output filter */
243    ap_filter_t *output_filter;
244        /* Output Bucket Brigade */
245    apr_bucket_brigade *output_bb;
246        /* Output character array */
247    char output_buffer[AP_IOBUFSIZE];
248        /* Output buffer length */
249    apr_size_t output_blen;
250        /* Output length */
251    apr_size_t output_length;
252    /** Connection status: 0 before (re-)handshake, 1 when up, -1 on
253     * error (checks use status < 0 or status > 0) */
254    int status;
255} mgs_handle_t;
256
257
258
259/** Functions in gnutls_io.c **/
260
261/* apr_signal_block() for blocking SIGPIPE */
262apr_status_t apr_signal_block(int signum);
263
264/* Proxy Support */
265/* An optional function which returns non-zero if the given connection
266is using SSL/TLS. */
267APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
268/* The ssl_var_lookup() optional function retrieves SSL environment
269 * variables. */
270APR_DECLARE_OPTIONAL_FN(char *, ssl_var_lookup,
271                        (apr_pool_t *, server_rec *,
272                         conn_rec *, request_rec *,
273                         char *));
274/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
275 * are used by mod_proxy to enable use of SSL for outgoing
276 * connections. */
277APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
278APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
279APR_DECLARE_OPTIONAL_FN(int, ssl_engine_set, (conn_rec *,
280                                              ap_conf_vector_t *,
281                                              int proxy, int enable));
282mgs_handle_t* get_effective_gnutls_ctxt(conn_rec *c);
283int ssl_is_https(conn_rec *c);
284char* ssl_var_lookup(apr_pool_t *p, server_rec *s, conn_rec *c,
285                     request_rec *r, char *var);
286int ssl_proxy_enable(conn_rec *c);
287int ssl_engine_disable(conn_rec *c);
288const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
289                                 const int arg);
290apr_status_t mgs_cleanup_pre_config(void *data);
291
292/**
293 * mgs_filter_input will filter the input data
294 * by decrypting it using GnuTLS and passes it cleartext.
295 *
296 * @param f     the filter info record
297 * @param bb    the bucket brigade, where to store the result to
298 * @param mode  what shall we read?
299 * @param block a block index we shall read from?
300 * @return result status
301 */
302apr_status_t mgs_filter_input(ap_filter_t * f,
303                                     apr_bucket_brigade * bb,
304                                     ap_input_mode_t mode,
305                                     apr_read_type_e block,
306                                     apr_off_t readbytes);
307
308/**
309 * mgs_filter_output will filter the encrypt
310 * the incoming bucket using GnuTLS and passes it onto the next filter.
311 *
312 * @param f     the filter info record
313 * @param bb    the bucket brigade, where to store the result to
314 * @return result status
315 */
316apr_status_t mgs_filter_output(ap_filter_t * f,
317                                      apr_bucket_brigade * bb);
318
319
320/**
321 * mgs_transport_read is called from GnuTLS to provide encrypted
322 * data from the client.
323 *
324 * @param ptr     pointer to the filter context
325 * @param buffer  place to put data
326 * @param len     maximum size
327 * @return size   length of the data stored in buffer
328 */
329ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
330                                  void *buffer, size_t len);
331
332/**
333 * mgs_transport_write is called from GnuTLS to
334 * write data to the client.
335 *
336 * @param ptr     pointer to the filter context
337 * @param buffer  buffer to write to the client
338 * @param len     size of the buffer
339 * @return size   length of the data written
340 */
341ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
342                                   const void *buffer, size_t len);
343
344
345int mgs_rehandshake(mgs_handle_t * ctxt);
346
347
348
349/**
350 * Perform any reinitialization required in PKCS #11
351 */
352int mgs_pkcs11_reinit(server_rec * s);
353
354
355
356/* Configuration Functions */
357
358/* Loads all files set in the configuration */
359int mgs_load_files(apr_pool_t *pconf, apr_pool_t *ptemp, server_rec *s)
360    __attribute__((nonnull));
361
362const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
363                                        const char *arg);
364const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
365                                        const char *arg);
366const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
367                                        const char *arg);
368const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
369                                        const char *arg);
370
371const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
372                             const char *arg);
373
374const char *mgs_set_timeout(cmd_parms *parms, void *dummy, const char *arg);
375
376const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
377                                  const char *arg);
378
379const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
380                                         const char *arg);
381
382const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
383                                   const char *arg);
384
385const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
386                               const char *arg);
387
388const char *mgs_set_pin(cmd_parms * parms, void *dummy,
389                                   const char *arg);
390
391const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
392                                   const char *arg);
393
394const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
395                            const int arg);
396const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
397                            const char *arg);
398const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
399                            const char *arg);
400const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
401                            const int arg);
402
403void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
404void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
405
406void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
407
408void *mgs_config_dir_create(apr_pool_t *p, char *dir);
409
410const char *mgs_store_cred_path(cmd_parms * parms,
411                                void *dummy __attribute__((unused)),
412                                const char *arg);
413
414/* mod_gnutls Hooks. */
415
416int mgs_hook_pre_config(apr_pool_t * pconf,
417                        apr_pool_t * plog, apr_pool_t * ptemp);
418
419int mgs_hook_post_config(apr_pool_t *pconf,
420                         apr_pool_t *plog,
421                         apr_pool_t *ptemp,
422                         server_rec *base_server);
423
424void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
425
426const char *mgs_hook_http_scheme(const request_rec * r);
427
428apr_port_t mgs_hook_default_port(const request_rec * r);
429
430int mgs_hook_pre_connection(conn_rec * c, void *csd);
431
432int mgs_hook_process_connection(conn_rec* c);
433
434int mgs_hook_fixups(request_rec *r);
435
436/** Post request hook, checks if TLS connection and vhost match */
437int mgs_req_vhost_check(request_rec *r);
438
439int mgs_hook_authz(request_rec *r);
440
441#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.