source: mod_gnutls/include/mod_gnutls.h.in @ 9e35c48

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

Enable/disable TLS per connection in ssl_engine_disable

Previously, ssl_engine_disable set the server wide variable sc->enabled
to GNUTLS_ENABLED_FALSE, leading to mod_gnutls refusing to serve any
connection, including incoming client connections. The general HTTP
handler cannot process raw TLS traffic, so all further requests using
TLS failed.

This commit adds a new element "enabled" to struct mgs_handle_t, which
is used to disable TLS per connection, making it possible to disable TLS
for proxy back end connections while continuing to serve TLS clients.

  • Property mode set to 100644
File size: 12.4 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/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/*
60 * Recent Versions of 2.1 renamed several hooks.
61 * This allows us to compile on 2.0.xx
62 */
63#if AP_SERVER_MINORVERSION_NUMBER >= 2 || (AP_SERVER_MINORVERSION_NUMBER == 1 && AP_SERVER_PATCHLEVEL_NUMBER >= 3)
64        #define USING_2_1_RECENT 1
65#else
66        #define USING_2_1_RECENT 0
67#endif
68
69/* mod_gnutls Cache Types */
70typedef enum {
71        /* No Cache */
72    mgs_cache_none,
73        /* Use Old Berkley DB */
74    mgs_cache_dbm,
75        /* Use Gnu's version of Berkley DB */
76    mgs_cache_gdbm,
77#if HAVE_APR_MEMCACHE
78        /* Use Memcache */
79    mgs_cache_memcache,
80#endif
81    mgs_cache_unset
82} mgs_cache_e;
83
84typedef enum {
85    mgs_cvm_unset,
86    mgs_cvm_cartel,
87    mgs_cvm_msva
88} mgs_client_verification_method_e;
89
90
91/* Directory Configuration Record */
92typedef struct {
93    int client_verify_mode;
94    const char* lua_bytecode;
95    apr_size_t lua_bytecode_len;
96} mgs_dirconf_rec;
97
98
99/* The maximum number of certificates to send in a chain */
100#define MAX_CHAIN_SIZE 8
101/* The maximum number of SANs to read from a x509 certificate */
102#define MAX_CERT_SAN 5
103
104/* Server Configuration Record */
105typedef struct {
106        /* x509 Certificate Structure */
107    gnutls_certificate_credentials_t certs;
108        /* SRP Certificate Structure*/
109    gnutls_srp_server_credentials_t srp_creds;
110        /* Annonymous Certificate Structure */
111    gnutls_anon_server_credentials_t anon_creds;
112        /* Current x509 Certificate CN [Common Name] */
113    char* cert_cn;
114        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
115        char* cert_san[MAX_CERT_SAN];
116        /* A x509 Certificate Chain */
117    gnutls_x509_crt_t *certs_x509_chain;
118        /* Current x509 Certificate Private Key */
119    gnutls_x509_privkey_t privkey_x509;
120        /* OpenPGP Certificate */
121    gnutls_openpgp_crt_t cert_pgp;
122        /* OpenPGP Certificate Private Key */
123    gnutls_openpgp_privkey_t privkey_pgp;
124        /* Number of Certificates in Chain */
125    unsigned int certs_x509_chain_num;
126        /* Is the module enabled? */
127    int enabled;
128    /* Export full certificates to CGI environment: */
129    int export_certificates_size;
130        /* GnuTLS Priorities */
131    gnutls_priority_t priorities;
132        /* GnuTLS DH Parameters */
133    gnutls_dh_params_t dh_params;
134        /* Cache timeout value */
135    int cache_timeout;
136        /* Chose Cache Type */
137    mgs_cache_e cache_type;
138    const char* cache_config;
139    const char* srp_tpasswd_file;
140    const char* srp_tpasswd_conf_file;
141        /* A list of CA Certificates */
142    gnutls_x509_crt_t *ca_list;
143        /* OpenPGP Key Ring */
144    gnutls_openpgp_keyring_t pgp_list;
145        /* CA Certificate list size */
146    unsigned int ca_list_size;
147        /* Client Certificate Verification Mode */
148    int client_verify_mode;
149        /* Client Certificate Verification Method */
150    mgs_client_verification_method_e client_verify_method;
151        /* Last Cache timestamp */
152    apr_time_t last_cache_check;
153        /* GnuTLS uses Session Tickets */
154    int tickets;
155        /* Is mod_proxy enabled? */
156    int proxy_enabled;
157        /* A Plain HTTP request */
158    int non_ssl_request;
159} mgs_srvconf_rec;
160
161/* Character Buffer */
162typedef struct {
163    int length;
164    char *value;
165} mgs_char_buffer_t;
166
167/* GnuTLS Handle */
168typedef struct {
169        /* Server configuration record */
170    mgs_srvconf_rec *sc;
171        /* Connection record */
172    conn_rec* c;
173        /* Is TLS enabled for this connection? */
174    int enabled;
175        /* GnuTLS Session handle */
176    gnutls_session_t session;
177        /* module input status */
178    apr_status_t input_rc;
179        /* Input filter */
180    ap_filter_t *input_filter;
181        /* Input Bucket Brigade */
182    apr_bucket_brigade *input_bb;
183        /* Input Read Type */
184    apr_read_type_e input_block;
185        /* Input Mode */
186    ap_input_mode_t input_mode;
187        /* Input Character Buffer */
188    mgs_char_buffer_t input_cbuf;
189        /* Input Character Array */
190    char input_buffer[AP_IOBUFSIZE];
191        /* module Output status */
192    apr_status_t output_rc;
193        /* Output filter */
194    ap_filter_t *output_filter;
195        /* Output Bucket Brigade */
196    apr_bucket_brigade *output_bb;
197        /* Output character array */
198    char output_buffer[AP_IOBUFSIZE];
199        /* Output buffer length */
200    apr_size_t output_blen;
201        /* Output length */
202    apr_size_t output_length;
203        /* General Status */
204    int status;
205} mgs_handle_t;
206
207
208
209/** Functions in gnutls_io.c **/
210
211/* apr_signal_block() for blocking SIGPIPE */
212apr_status_t apr_signal_block(int signum);
213
214 /* Proxy Support */
215/* An optional function which returns non-zero if the given connection
216is using SSL/TLS. */
217APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
218/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
219 * are used by mod_proxy to enable use of SSL for outgoing
220 * connections. */
221APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
222APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
223int ssl_is_https(conn_rec *c);
224int ssl_proxy_enable(conn_rec *c);
225int ssl_engine_disable(conn_rec *c);
226const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
227    const char *arg);
228apr_status_t mgs_cleanup_pre_config(void *data);
229
230/**
231 * mgs_filter_input will filter the input data
232 * by decrypting it using GnuTLS and passes it cleartext.
233 *
234 * @param f     the filter info record
235 * @param bb    the bucket brigade, where to store the result to
236 * @param mode  what shall we read?
237 * @param block a block index we shall read from?
238 * @return result status
239 */
240apr_status_t mgs_filter_input(ap_filter_t * f,
241                                     apr_bucket_brigade * bb,
242                                     ap_input_mode_t mode,
243                                     apr_read_type_e block,
244                                     apr_off_t readbytes);
245
246/**
247 * mgs_filter_output will filter the encrypt
248 * the incoming bucket using GnuTLS and passes it onto the next filter.
249 *
250 * @param f     the filter info record
251 * @param bb    the bucket brigade, where to store the result to
252 * @return result status
253 */
254apr_status_t mgs_filter_output(ap_filter_t * f,
255                                      apr_bucket_brigade * bb);
256
257
258/**
259 * mgs_transport_read is called from GnuTLS to provide encrypted
260 * data from the client.
261 *
262 * @param ptr     pointer to the filter context
263 * @param buffer  place to put data
264 * @param len     maximum size
265 * @return size   length of the data stored in buffer
266 */
267ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
268                                  void *buffer, size_t len);
269
270/**
271 * mgs_transport_write is called from GnuTLS to
272 * write data to the client.
273 *
274 * @param ptr     pointer to the filter context
275 * @param buffer  buffer to write to the client
276 * @param len     size of the buffer
277 * @return size   length of the data written
278 */
279ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
280                                   const void *buffer, size_t len);
281
282
283int mgs_rehandshake(mgs_handle_t * ctxt);
284
285
286
287/**
288 * Init the Cache after Configuration is done
289 */
290int mgs_cache_post_config(apr_pool_t *p, server_rec *s,
291                                 mgs_srvconf_rec *sc);
292/**
293 * Init the Cache inside each Process
294 */
295int mgs_cache_child_init(apr_pool_t *p, server_rec *s,
296                                mgs_srvconf_rec *sc);
297/**
298 * Setup the Session Caching
299 */
300int mgs_cache_session_init(mgs_handle_t *ctxt);
301
302#define GNUTLS_SESSION_ID_STRING_LEN \
303    ((GNUTLS_MAX_SESSION_ID + 1) * 2)
304
305/**
306 * Convert a SSL Session ID into a Null Terminated Hex Encoded String
307 * @param id raw SSL Session ID
308 * @param idlen Length of the raw Session ID
309 * @param str Location to store the Hex Encoded String
310 * @param strsize The Maximum Length that can be stored in str
311 */
312char *mgs_session_id2sz(unsigned char *id, int idlen,
313                                char *str, int strsize);
314
315/**
316 * Convert a time_t into a Null Terminated String
317 * @param t time_t time
318 * @param str Location to store the Hex Encoded String
319 * @param strsize The Maximum Length that can be stored in str
320 */
321char *mgs_time2sz(time_t t, char *str, int strsize);
322
323
324/* Configuration Functions */
325
326const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
327                                        const char *arg);
328const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
329                                        const char *arg);
330const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
331                                        const char *arg);
332const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
333                                        const char *arg);
334
335const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
336                             const char *arg);
337
338const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
339                                        const char *arg);
340
341const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
342                             const char *arg);
343
344const char *mgs_set_cache(cmd_parms * parms, void *dummy,
345                          const char *type, const char* arg);
346
347const char *mgs_set_cache_timeout(cmd_parms * parms, void *dummy,
348                                  const char *arg);
349
350const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
351                                  const char *arg);
352
353const char *mgs_set_client_verify_method(cmd_parms * parms, void *dummy,
354                                         const char *arg);
355
356const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
357                                   const char *arg);
358
359const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
360                                   const char *arg);
361
362const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
363                            const char *arg);
364const char *mgs_set_export_certificates_size(cmd_parms * parms, void *dummy,
365                            const char *arg);
366const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
367                            const char *arg);
368const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
369                            const char *arg);
370
371const char *mgs_set_require_section(cmd_parms *cmd,
372                                    void *mconfig, const char *arg);
373void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
374void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
375
376void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
377
378void *mgs_config_dir_create(apr_pool_t *p, char *dir);
379
380const char *mgs_set_require_bytecode(cmd_parms *cmd,
381                                    void *mconfig, const char *arg);
382
383mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
384
385/* mod_gnutls Hooks. */
386
387int mgs_hook_pre_config(apr_pool_t * pconf,
388                        apr_pool_t * plog, apr_pool_t * ptemp);
389
390int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
391                         apr_pool_t * ptemp,
392                         server_rec * base_server);
393
394void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
395
396const char *mgs_hook_http_scheme(const request_rec * r);
397
398apr_port_t mgs_hook_default_port(const request_rec * r);
399
400int mgs_hook_pre_connection(conn_rec * c, void *csd);
401
402int mgs_hook_fixups(request_rec *r);
403
404int mgs_hook_authz(request_rec *r);
405
406#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.