source: mod_gnutls/include/mod_gnutls.h.in @ 379a297

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

Remove code used only with GnuTLS 2.x

  • Property mode set to 100644
File size: 15.0 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
74typedef enum {
75    mgs_cvm_unset,
76    mgs_cvm_cartel,
77    mgs_cvm_msva
78} mgs_client_verification_method_e;
79
80
81/* Directory Configuration Record */
82typedef struct {
83    int client_verify_mode;
84    const char* lua_bytecode;
85    apr_size_t lua_bytecode_len;
86} mgs_dirconf_rec;
87
88
89/* The maximum number of certificates to send in a chain */
90#define MAX_CHAIN_SIZE 8
91/* The maximum number of SANs to read from a x509 certificate */
92#define MAX_CERT_SAN 5
93
94/* Server Configuration Record */
95typedef struct {
96    /* --- Configuration values --- */
97        /* Is the module enabled? */
98    int enabled;
99        /* Is mod_proxy enabled? */
100    int proxy_enabled;
101        /* A Plain HTTP request */
102    int non_ssl_request;
103
104    /* List of PKCS #11 provider modules to load, only valid in the
105     * base config, ignored in virtual hosts */
106    apr_array_header_t *p11_modules;
107
108    /* PIN used for PKCS #11 operations */
109    char *pin;
110
111    /* the SRK PIN used in TPM operations */
112    char *srk_pin;
113
114    char *x509_cert_file;
115    char *x509_key_file;
116    char *x509_ca_file;
117
118    char *pgp_cert_file;
119    char *pgp_key_file;
120    char *pgp_ring_file;
121
122    char *dh_file;
123
124    char *priorities_str;
125    char *proxy_priorities_str;
126
127    const char* srp_tpasswd_file;
128    const char* srp_tpasswd_conf_file;
129
130        /* Cache timeout value */
131    int cache_timeout;
132        /* Chose Cache Type */
133    mgs_cache_e cache_type;
134    const char* cache_config;
135
136        /* GnuTLS uses Session Tickets */
137    int tickets;
138
139    /* --- Things initialized at _child_init --- */
140
141    /* x509 Certificate Structure */
142    gnutls_certificate_credentials_t certs;
143    /* x509 credentials for proxy connections */
144    gnutls_certificate_credentials_t proxy_x509_creds;
145    /* trust list for proxy_x509_creds */
146    gnutls_x509_trust_list_t proxy_x509_tl;
147    const char* proxy_x509_key_file;
148    const char* proxy_x509_cert_file;
149    const char* proxy_x509_ca_file;
150    const char* proxy_x509_crl_file;
151    /* GnuTLS priorities for proxy connections */
152    gnutls_priority_t proxy_priorities;
153    /* SRP Certificate Structure*/
154    gnutls_srp_server_credentials_t srp_creds;
155    /* Anonymous Certificate Structure */
156    gnutls_anon_server_credentials_t anon_creds;
157    /* Anonymous Client Certificate Structure, used for proxy
158     * connections */
159    gnutls_anon_client_credentials_t anon_client_creds;
160        /* Current x509 Certificate CN [Common Name] */
161    char* cert_cn;
162        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
163    char* cert_san[MAX_CERT_SAN];
164        /* An x509 Certificate Chain */
165    gnutls_pcert_st *certs_x509_chain;
166    gnutls_x509_crt_t *certs_x509_crt_chain;
167        /* Number of Certificates in Chain */
168    unsigned int certs_x509_chain_num;
169
170        /* Current x509 Certificate Private Key */
171    gnutls_privkey_t privkey_x509;
172
173        /* OpenPGP Certificate */
174    gnutls_pcert_st *cert_pgp;
175    gnutls_openpgp_crt_t *cert_crt_pgp;
176
177        /* OpenPGP Certificate Private Key */
178    gnutls_privkey_t privkey_pgp;
179#if GNUTLS_VERSION_NUMBER < 0x030312
180    /* Internal structure for the OpenPGP private key, used in the
181     * workaround for a bug in gnutls_privkey_import_openpgp_raw that
182     * frees memory that is still needed. DO NOT USE for any other
183     * purpose. */
184    gnutls_openpgp_privkey_t privkey_pgp_internal;
185#endif
186
187    /* Export full certificates to CGI environment: */
188    int export_certificates_size;
189        /* GnuTLS Priorities */
190    gnutls_priority_t priorities;
191        /* GnuTLS DH Parameters */
192    gnutls_dh_params_t dh_params;
193        /* A list of CA Certificates */
194    gnutls_x509_crt_t *ca_list;
195        /* OpenPGP Key Ring */
196    gnutls_openpgp_keyring_t pgp_list;
197        /* CA Certificate list size */
198    unsigned int ca_list_size;
199        /* Client Certificate Verification Mode */
200    int client_verify_mode;
201        /* Client Certificate Verification Method */
202    mgs_client_verification_method_e client_verify_method;
203        /* Last Cache timestamp */
204    apr_time_t last_cache_check;
205
206    /* EXPERIMENTAL: OCSP response file for stapling, will go away
207     * once sending OCSP requests is implemented */
208    char *ocsp_response_file;
209    /* OCSP URI extracted from the server certificate. NULL if
210     * unset. */
211    apr_uri_t *ocsp_uri;
212    /* Trust list to verify OCSP responses for stapling. Should
213     * usually only contain the CA that signed the server
214     * certificate. */
215    gnutls_x509_trust_list_t *ocsp_trust;
216} mgs_srvconf_rec;
217
218/* Character Buffer */
219typedef struct {
220    int length;
221    char *value;
222} mgs_char_buffer_t;
223
224/* GnuTLS Handle */
225typedef struct {
226        /* Server configuration record */
227    mgs_srvconf_rec *sc;
228        /* Connection record */
229    conn_rec* c;
230        /* Is TLS enabled for this connection? */
231    int enabled;
232    /* Is this a proxy connection? */
233    int is_proxy;
234        /* GnuTLS Session handle */
235    gnutls_session_t session;
236        /* module input status */
237    apr_status_t input_rc;
238        /* Input filter */
239    ap_filter_t *input_filter;
240        /* Input Bucket Brigade */
241    apr_bucket_brigade *input_bb;
242        /* Input Read Type */
243    apr_read_type_e input_block;
244        /* Input Mode */
245    ap_input_mode_t input_mode;
246        /* Input Character Buffer */
247    mgs_char_buffer_t input_cbuf;
248        /* Input Character Array */
249    char input_buffer[AP_IOBUFSIZE];
250        /* module Output status */
251    apr_status_t output_rc;
252        /* Output filter */
253    ap_filter_t *output_filter;
254        /* Output Bucket Brigade */
255    apr_bucket_brigade *output_bb;
256        /* Output character array */
257    char output_buffer[AP_IOBUFSIZE];
258        /* Output buffer length */
259    apr_size_t output_blen;
260        /* Output length */
261    apr_size_t output_length;
262        /* General Status */
263    int status;
264} mgs_handle_t;
265
266
267
268/** Functions in gnutls_io.c **/
269
270/* apr_signal_block() for blocking SIGPIPE */
271apr_status_t apr_signal_block(int signum);
272
273 /* Proxy Support */
274/* An optional function which returns non-zero if the given connection
275is using SSL/TLS. */
276APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
277/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
278 * are used by mod_proxy to enable use of SSL for outgoing
279 * connections. */
280APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
281APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
282int ssl_is_https(conn_rec *c);
283int ssl_proxy_enable(conn_rec *c);
284int ssl_engine_disable(conn_rec *c);
285const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
286                                 const int arg);
287apr_status_t mgs_cleanup_pre_config(void *data);
288
289/**
290 * mgs_filter_input will filter the input data
291 * by decrypting it using GnuTLS and passes it cleartext.
292 *
293 * @param f     the filter info record
294 * @param bb    the bucket brigade, where to store the result to
295 * @param mode  what shall we read?
296 * @param block a block index we shall read from?
297 * @return result status
298 */
299apr_status_t mgs_filter_input(ap_filter_t * f,
300                                     apr_bucket_brigade * bb,
301                                     ap_input_mode_t mode,
302                                     apr_read_type_e block,
303                                     apr_off_t readbytes);
304
305/**
306 * mgs_filter_output will filter the encrypt
307 * the incoming bucket using GnuTLS and passes it onto the next filter.
308 *
309 * @param f     the filter info record
310 * @param bb    the bucket brigade, where to store the result to
311 * @return result status
312 */
313apr_status_t mgs_filter_output(ap_filter_t * f,
314                                      apr_bucket_brigade * bb);
315
316
317/**
318 * mgs_transport_read is called from GnuTLS to provide encrypted
319 * data from the client.
320 *
321 * @param ptr     pointer to the filter context
322 * @param buffer  place to put data
323 * @param len     maximum size
324 * @return size   length of the data stored in buffer
325 */
326ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
327                                  void *buffer, size_t len);
328
329/**
330 * mgs_transport_write is called from GnuTLS to
331 * write data to the client.
332 *
333 * @param ptr     pointer to the filter context
334 * @param buffer  buffer to write to the client
335 * @param len     size of the buffer
336 * @return size   length of the data written
337 */
338ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
339                                   const void *buffer, size_t len);
340
341
342int mgs_rehandshake(mgs_handle_t * ctxt);
343
344
345
346/**
347 * Init the Cache after Configuration is done
348 */
349int mgs_cache_post_config(apr_pool_t *p, server_rec *s,
350                                 mgs_srvconf_rec *sc);
351/**
352 * Init the Cache inside each Process
353 */
354int mgs_cache_child_init(apr_pool_t *p, server_rec *s,
355                                mgs_srvconf_rec *sc);
356/**
357 * Setup the Session Caching
358 */
359int mgs_cache_session_init(mgs_handle_t *ctxt);
360
361#define GNUTLS_SESSION_ID_STRING_LEN \
362    ((GNUTLS_MAX_SESSION_ID + 1) * 2)
363
364/**
365 * Perform any reinitialization required in PKCS #11
366 */
367int mgs_pkcs11_reinit(server_rec * s);
368
369/**
370 * Convert a SSL Session ID into a Null Terminated Hex Encoded String
371 * @param id raw SSL Session ID
372 * @param idlen Length of the raw Session ID
373 * @param str Location to store the Hex Encoded String
374 * @param strsize The Maximum Length that can be stored in str
375 */
376char *mgs_session_id2sz(unsigned char *id, int idlen,
377                                char *str, int strsize);
378
379/**
380 * Convert a time_t into a Null Terminated String
381 * @param t time_t time
382 * @param str Location to store the Hex Encoded String
383 * @param strsize The Maximum Length that can be stored in str
384 */
385char *mgs_time2sz(time_t t, char *str, int strsize);
386
387
388/* Configuration Functions */
389
390/* Loads all files set in the configuration */
391int mgs_load_files(apr_pool_t * p, server_rec * s);
392
393const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
394                                        const char *arg);
395const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
396                                        const char *arg);
397const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
398                                        const char *arg);
399const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
400                                        const char *arg);
401
402const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
403                             const char *arg);
404
405const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
406                                        const char *arg);
407
408const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
409                             const char *arg);
410
411const char *mgs_set_cache(cmd_parms * parms, void *dummy,
412                          const char *type, const char* arg);
413
414const char *mgs_set_cache_timeout(cmd_parms * parms, void *dummy,
415                                  const char *arg);
416
417const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
418                                  const char *arg);
419
420const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
421                                         const char *arg);
422
423const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
424                                   const char *arg);
425
426const char *mgs_set_p11_module(cmd_parms * parms, void *dummy,
427                               const char *arg);
428
429const char *mgs_set_pin(cmd_parms * parms, void *dummy,
430                                   const char *arg);
431
432const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
433                                   const char *arg);
434
435const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
436                                   const char *arg);
437
438const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
439                            const int arg);
440const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
441                            const char *arg);
442const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
443                            const char *arg);
444const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
445                            const int arg);
446
447const char *mgs_set_require_section(cmd_parms *cmd,
448                                    void *mconfig, const char *arg);
449void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
450void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
451
452void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
453
454void *mgs_config_dir_create(apr_pool_t *p, char *dir);
455
456const char *mgs_set_require_bytecode(cmd_parms *cmd,
457                                    void *mconfig, const char *arg);
458
459mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
460
461const char *mgs_store_cred_path(cmd_parms * parms,
462                                void *dummy __attribute__((unused)),
463                                const char *arg);
464
465/* mod_gnutls Hooks. */
466
467int mgs_hook_pre_config(apr_pool_t * pconf,
468                        apr_pool_t * plog, apr_pool_t * ptemp);
469
470int mgs_hook_post_config(apr_pool_t *pconf,
471                         apr_pool_t *plog,
472                         apr_pool_t *ptemp,
473                         server_rec *base_server);
474
475void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
476
477const char *mgs_hook_http_scheme(const request_rec * r);
478
479apr_port_t mgs_hook_default_port(const request_rec * r);
480
481int mgs_hook_pre_connection(conn_rec * c, void *csd);
482
483int mgs_hook_fixups(request_rec *r);
484
485int mgs_hook_authz(request_rec *r);
486
487#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.