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

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

Fix whitespace problems detected by git

  • Property mode set to 100644
File size: 13.3 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *
4 *  Licensed under the Apache License, Version 2.0 (the "License");
5 *  you may not use this file except in compliance with the License.
6 *  You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 *  Unless required by applicable law or agreed to in writing, software
11 *  distributed under the License is distributed on an "AS IS" BASIS,
12 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 *  See the License for the specific language governing permissions and
14 *  limitations under the License.
15 *
16 */
17
18/* Apache Runtime Headers */
19#include "httpd.h"
20#include "http_config.h"
21#include "http_protocol.h"
22#include "http_connection.h"
23#include "http_request.h"
24#include "http_core.h"
25#include "http_log.h"
26#include "apr_buckets.h"
27#include "apr_strings.h"
28#include "apr_tables.h"
29#include "ap_release.h"
30#include "apr_fnmatch.h"
31/* GnuTLS Library Headers */
32#include <gnutls/gnutls.h>
33#if GNUTLS_VERSION_MAJOR == 2
34#include <gnutls/extra.h>
35#endif
36#include <gnutls/abstract.h>
37#include <gnutls/openpgp.h>
38#include <gnutls/x509.h>
39
40#ifndef __mod_gnutls_h_inc
41#define __mod_gnutls_h_inc
42
43#define HAVE_APR_MEMCACHE    @have_apr_memcache@
44
45extern module AP_MODULE_DECLARE_DATA gnutls_module;
46
47/* IO Filter names */
48#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
49#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
50/* GnuTLS Constants */
51#define GNUTLS_ENABLED_FALSE 0
52#define GNUTLS_ENABLED_TRUE  1
53#define GNUTLS_ENABLED_UNSET  2
54/* Current module version */
55#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
56
57/* Module Debug Mode */
58#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
59
60/*
61 * Recent Versions of 2.1 renamed several hooks.
62 * This allows us to compile on 2.0.xx
63 */
64#if AP_SERVER_MINORVERSION_NUMBER >= 2 || (AP_SERVER_MINORVERSION_NUMBER == 1 && AP_SERVER_PATCHLEVEL_NUMBER >= 3)
65        #define USING_2_1_RECENT 1
66#else
67        #define USING_2_1_RECENT 0
68#endif
69
70/* mod_gnutls Cache Types */
71typedef enum {
72        /* No Cache */
73    mgs_cache_none,
74        /* Use Old Berkley DB */
75    mgs_cache_dbm,
76        /* Use Gnu's version of Berkley DB */
77    mgs_cache_gdbm,
78#if HAVE_APR_MEMCACHE
79        /* Use Memcache */
80    mgs_cache_memcache,
81#endif
82    mgs_cache_unset
83} mgs_cache_e;
84
85typedef enum {
86    mgs_cvm_unset,
87    mgs_cvm_cartel,
88    mgs_cvm_msva
89} mgs_client_verification_method_e;
90
91
92/* Directory Configuration Record */
93typedef struct {
94    int client_verify_mode;
95    const char* lua_bytecode;
96    apr_size_t lua_bytecode_len;
97} mgs_dirconf_rec;
98
99
100/* The maximum number of certificates to send in a chain */
101#define MAX_CHAIN_SIZE 8
102/* The maximum number of SANs to read from a x509 certificate */
103#define MAX_CERT_SAN 5
104
105/* Server Configuration Record */
106typedef struct {
107    /* --- Configuration values --- */
108        /* Is the module enabled? */
109    int enabled;
110        /* Is mod_proxy enabled? */
111    int proxy_enabled;
112        /* A Plain HTTP request */
113    int non_ssl_request;
114
115    /* PIN used for PKCS #11 operations */
116    char *pin;
117
118    /* the SRK PIN used in TPM operations */
119    char *srk_pin;
120
121    char *x509_cert_file;
122    char *x509_key_file;
123    char *x509_ca_file;
124
125    char *pgp_cert_file;
126    char *pgp_key_file;
127    char *pgp_ring_file;
128
129    char *dh_file;
130
131    char *priorities_str;
132
133    const char* srp_tpasswd_file;
134    const char* srp_tpasswd_conf_file;
135
136        /* Cache timeout value */
137    int cache_timeout;
138        /* Chose Cache Type */
139    mgs_cache_e cache_type;
140    const char* cache_config;
141
142        /* GnuTLS uses Session Tickets */
143    int tickets;
144
145    /* --- Things initialized at _child_init --- */
146
147        /* x509 Certificate Structure */
148    gnutls_certificate_credentials_t certs;
149        /* SRP Certificate Structure*/
150    gnutls_srp_server_credentials_t srp_creds;
151        /* Annonymous Certificate Structure */
152    gnutls_anon_server_credentials_t anon_creds;
153        /* Current x509 Certificate CN [Common Name] */
154    char* cert_cn;
155        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
156    char* cert_san[MAX_CERT_SAN];
157        /* An x509 Certificate Chain */
158    gnutls_pcert_st *certs_x509_chain;
159    gnutls_x509_crt_t *certs_x509_crt_chain;
160        /* Number of Certificates in Chain */
161    unsigned int certs_x509_chain_num;
162
163        /* Current x509 Certificate Private Key */
164    gnutls_privkey_t privkey_x509;
165
166        /* OpenPGP Certificate */
167    gnutls_pcert_st *cert_pgp;
168    gnutls_openpgp_crt_t *cert_crt_pgp;
169
170        /* OpenPGP Certificate Private Key */
171    gnutls_privkey_t privkey_pgp;
172
173    /* Export full certificates to CGI environment: */
174    int export_certificates_size;
175        /* GnuTLS Priorities */
176    gnutls_priority_t priorities;
177        /* GnuTLS DH Parameters */
178    gnutls_dh_params_t dh_params;
179        /* A list of CA Certificates */
180    gnutls_x509_crt_t *ca_list;
181        /* OpenPGP Key Ring */
182    gnutls_openpgp_keyring_t pgp_list;
183        /* CA Certificate list size */
184    unsigned int ca_list_size;
185        /* Client Certificate Verification Mode */
186    int client_verify_mode;
187        /* Client Certificate Verification Method */
188    mgs_client_verification_method_e client_verify_method;
189        /* Last Cache timestamp */
190    apr_time_t last_cache_check;
191} mgs_srvconf_rec;
192
193/* Character Buffer */
194typedef struct {
195    int length;
196    char *value;
197} mgs_char_buffer_t;
198
199/* GnuTLS Handle */
200typedef struct {
201        /* Server configuration record */
202    mgs_srvconf_rec *sc;
203        /* Connection record */
204    conn_rec* c;
205        /* GnuTLS Session handle */
206    gnutls_session_t session;
207        /* module input status */
208    apr_status_t input_rc;
209        /* Input filter */
210    ap_filter_t *input_filter;
211        /* Input Bucket Brigade */
212    apr_bucket_brigade *input_bb;
213        /* Input Read Type */
214    apr_read_type_e input_block;
215        /* Input Mode */
216    ap_input_mode_t input_mode;
217        /* Input Character Buffer */
218    mgs_char_buffer_t input_cbuf;
219        /* Input Character Array */
220    char input_buffer[AP_IOBUFSIZE];
221        /* module Output status */
222    apr_status_t output_rc;
223        /* Output filter */
224    ap_filter_t *output_filter;
225        /* Output Bucket Brigade */
226    apr_bucket_brigade *output_bb;
227        /* Output character array */
228    char output_buffer[AP_IOBUFSIZE];
229        /* Output buffer length */
230    apr_size_t output_blen;
231        /* Output length */
232    apr_size_t output_length;
233        /* General Status */
234    int status;
235} mgs_handle_t;
236
237
238
239/** Functions in gnutls_io.c **/
240
241/* apr_signal_block() for blocking SIGPIPE */
242apr_status_t apr_signal_block(int signum);
243
244 /* Proxy Support */
245/* An optional function which returns non-zero if the given connection
246is using SSL/TLS. */
247APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
248/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
249 * are used by mod_proxy to enable use of SSL for outgoing
250 * connections. */
251APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
252APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
253int ssl_is_https(conn_rec *c);
254int ssl_proxy_enable(conn_rec *c);
255int ssl_engine_disable(conn_rec *c);
256const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
257    const char *arg);
258apr_status_t mgs_cleanup_pre_config(void *data);
259
260/**
261 * mgs_filter_input will filter the input data
262 * by decrypting it using GnuTLS and passes it cleartext.
263 *
264 * @param f     the filter info record
265 * @param bb    the bucket brigade, where to store the result to
266 * @param mode  what shall we read?
267 * @param block a block index we shall read from?
268 * @return result status
269 */
270apr_status_t mgs_filter_input(ap_filter_t * f,
271                                     apr_bucket_brigade * bb,
272                                     ap_input_mode_t mode,
273                                     apr_read_type_e block,
274                                     apr_off_t readbytes);
275
276/**
277 * mgs_filter_output will filter the encrypt
278 * the incoming bucket using GnuTLS and passes it onto the next filter.
279 *
280 * @param f     the filter info record
281 * @param bb    the bucket brigade, where to store the result to
282 * @return result status
283 */
284apr_status_t mgs_filter_output(ap_filter_t * f,
285                                      apr_bucket_brigade * bb);
286
287
288/**
289 * mgs_transport_read is called from GnuTLS to provide encrypted
290 * data from the client.
291 *
292 * @param ptr     pointer to the filter context
293 * @param buffer  place to put data
294 * @param len     maximum size
295 * @return size   length of the data stored in buffer
296 */
297ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
298                                  void *buffer, size_t len);
299
300/**
301 * mgs_transport_write is called from GnuTLS to
302 * write data to the client.
303 *
304 * @param ptr     pointer to the filter context
305 * @param buffer  buffer to write to the client
306 * @param len     size of the buffer
307 * @return size   length of the data written
308 */
309ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
310                                   const void *buffer, size_t len);
311
312
313int mgs_rehandshake(mgs_handle_t * ctxt);
314
315
316
317/**
318 * Init the Cache after Configuration is done
319 */
320int mgs_cache_post_config(apr_pool_t *p, server_rec *s,
321                                 mgs_srvconf_rec *sc);
322/**
323 * Init the Cache inside each Process
324 */
325int mgs_cache_child_init(apr_pool_t *p, server_rec *s,
326                                mgs_srvconf_rec *sc);
327/**
328 * Setup the Session Caching
329 */
330int mgs_cache_session_init(mgs_handle_t *ctxt);
331
332#define GNUTLS_SESSION_ID_STRING_LEN \
333    ((GNUTLS_MAX_SESSION_ID + 1) * 2)
334
335/**
336 * Perform any reinitialization required in PKCS #11
337 */
338int mgs_pkcs11_reinit(server_rec * s);
339
340/**
341 * Convert a SSL Session ID into a Null Terminated Hex Encoded String
342 * @param id raw SSL Session ID
343 * @param idlen Length of the raw Session ID
344 * @param str Location to store the Hex Encoded String
345 * @param strsize The Maximum Length that can be stored in str
346 */
347char *mgs_session_id2sz(unsigned char *id, int idlen,
348                                char *str, int strsize);
349
350/**
351 * Convert a time_t into a Null Terminated String
352 * @param t time_t time
353 * @param str Location to store the Hex Encoded String
354 * @param strsize The Maximum Length that can be stored in str
355 */
356char *mgs_time2sz(time_t t, char *str, int strsize);
357
358
359/* Configuration Functions */
360
361/* Loads all files set in the configuration */
362int mgs_load_files(apr_pool_t * p, server_rec * s);
363
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);
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
376const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
377                                        const char *arg);
378
379const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
380                             const char *arg);
381
382const char *mgs_set_cache(cmd_parms * parms, void *dummy,
383                          const char *type, const char* arg);
384
385const char *mgs_set_cache_timeout(cmd_parms * parms, void *dummy,
386                                  const char *arg);
387
388const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
389                                  const char *arg);
390
391const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
392                                         const char *arg);
393
394const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
395                                   const char *arg);
396const char *mgs_set_pin(cmd_parms * parms, void *dummy,
397                                   const char *arg);
398
399const char *mgs_set_srk_pin(cmd_parms * parms, void *dummy,
400                                   const char *arg);
401
402const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
403                                   const char *arg);
404
405const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
406                            const char *arg);
407const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
408                            const char *arg);
409const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
410                            const char *arg);
411const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
412                            const char *arg);
413
414const char *mgs_set_require_section(cmd_parms *cmd,
415                                    void *mconfig, const char *arg);
416void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
417void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
418
419void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
420
421void *mgs_config_dir_create(apr_pool_t *p, char *dir);
422
423const char *mgs_set_require_bytecode(cmd_parms *cmd,
424                                    void *mconfig, const char *arg);
425
426mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
427
428/* mod_gnutls Hooks. */
429
430int mgs_hook_pre_config(apr_pool_t * pconf,
431                        apr_pool_t * plog, apr_pool_t * ptemp);
432
433int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
434                         apr_pool_t * ptemp,
435                         server_rec * base_server);
436
437void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
438
439const char *mgs_hook_http_scheme(const request_rec * r);
440
441apr_port_t mgs_hook_default_port(const request_rec * r);
442
443int mgs_hook_pre_connection(conn_rec * c, void *csd);
444
445int mgs_hook_fixups(request_rec *r);
446
447int mgs_hook_authz(request_rec *r);
448
449#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.