source: mod_gnutls/src/mod_gnutls.c @ fcb122d

debian/masterdebian/stretch-backportsjessie-backportsmsvaupstream
Last change on this file since fcb122d was fcb122d, checked in by Paul Querna <chip@…>, 15 years ago

checkpoint the work so far. The DBM cache needs a little more work.

  • Property mode set to 100644
File size: 19.1 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#include "mod_gnutls.h"
19
20#if APR_HAS_THREADS
21GCRY_THREAD_OPTION_PTHREAD_IMPL;
22#endif
23
24static apr_file_t* debug_log_fp;
25
26static apr_status_t mod_gnutls_cleanup_pre_config(void *data)
27{
28    gnutls_global_deinit();
29    return APR_SUCCESS;
30}
31
32static void gnutls_debug_log_all( int level, const char* str)
33{
34    apr_file_printf(debug_log_fp, "<%d> %s\n", level, str);
35}
36
37static int mod_gnutls_hook_pre_config(apr_pool_t * pconf,
38                                      apr_pool_t * plog, apr_pool_t * ptemp)
39{
40
41#if APR_HAS_THREADS
42    /* TODO: Check MPM Type here */
43    gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
44#endif
45
46    gnutls_global_init();
47
48    apr_pool_cleanup_register(pconf, NULL, mod_gnutls_cleanup_pre_config,
49                              apr_pool_cleanup_null);
50
51    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug",
52                  APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT, pconf);
53
54    gnutls_global_set_log_level(9);
55    gnutls_global_set_log_function(gnutls_debug_log_all);
56
57    return OK;
58}
59
60
61static gnutls_datum load_params(const char* file, server_rec* s, 
62                                apr_pool_t* pool) 
63{
64    gnutls_datum ret = { NULL, 0 };
65    apr_file_t* fp;
66    apr_finfo_t finfo;
67    apr_status_t rv;
68    apr_size_t br = 0;
69
70    rv = apr_file_open(&fp, file, APR_READ|APR_BINARY, APR_OS_DEFAULT, 
71                       pool);
72    if (rv != APR_SUCCESS) {
73        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s, 
74                     "GnuTLS failed to load params file at: %s", file);
75        return ret;
76    }
77
78    rv = apr_file_info_get(&finfo, APR_FINFO_SIZE, fp);
79
80    if (rv != APR_SUCCESS) {
81        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s, 
82                     "GnuTLS failed to stat params file at: %s", file);
83        return ret;
84    }
85
86    ret.data = apr_palloc(pool, finfo.size+1);
87    rv = apr_file_read_full(fp, ret.data, finfo.size, &br);
88
89    if (rv != APR_SUCCESS) {
90        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s, 
91                     "GnuTLS failed to read params file at: %s", file);
92        return ret;
93    }
94
95    ret.data[br] = '\0';
96    ret.size = br;
97
98    return ret;
99}
100
101static int mod_gnutls_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
102                                       apr_pool_t * ptemp,
103                                       server_rec * base_server)
104{
105    int rv;
106    server_rec *s;
107    gnutls_dh_params_t dh_params;
108    gnutls_rsa_params_t rsa_params;
109    mod_gnutls_srvconf_rec *sc;
110    mod_gnutls_srvconf_rec *sc_base;
111    void *data = NULL;
112    int first_run = 0;
113    const char *userdata_key = "mod_gnutls_init";
114         
115    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
116    if (data == NULL) {
117        first_run = 1;
118        apr_pool_userdata_set((const void *)1, userdata_key, 
119                              apr_pool_cleanup_null, 
120                              base_server->process->pool);
121    }
122
123
124    if (!first_run) {
125        gnutls_datum pdata;
126        apr_pool_t* tpool;
127        s = base_server;
128        sc_base = (mod_gnutls_srvconf_rec *) ap_get_module_config(s->module_config,
129                                                             &gnutls_module);
130
131        apr_pool_create(&tpool, p);
132
133        gnutls_dh_params_init(&dh_params);
134
135        pdata = load_params(sc_base->dh_params_file, s, tpool);
136
137        if (pdata.size != 0) {
138            rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata, 
139                                               GNUTLS_X509_FMT_PEM);
140            if (rv != 0) {
141                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s, 
142                             "GnuTLS: Unable to load DH Params: (%d) %s",
143                             rv, gnutls_strerror(rv));
144                exit(rv);
145            }
146        }
147        else {
148            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s, 
149                         "GnuTLS: Unable to load DH Params."
150                         " Shutting Down.");
151            exit(-1);
152        }
153        apr_pool_clear(tpool);
154
155        gnutls_rsa_params_init(&rsa_params);
156
157        pdata = load_params(sc_base->rsa_params_file, s, tpool);
158
159        if (pdata.size != 0) {
160            rv = gnutls_rsa_params_import_pkcs1(rsa_params, &pdata, 
161                                                GNUTLS_X509_FMT_PEM);
162            if (rv != 0) {
163                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s, 
164                             "GnuTLS: Unable to load RSA Params: (%d) %s",
165                             rv, gnutls_strerror(rv));
166                exit(rv);
167            }
168        }
169        else {
170            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s, 
171                         "GnuTLS: Unable to load RSA Params."
172                         " Shutting Down.");
173            exit(-1);
174        }
175
176        apr_pool_destroy(tpool);
177        rv = mod_gnutls_cache_post_config(p, s, sc_base);
178        if (rv != 0) {
179            ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s, 
180                         "GnuTLS: Post Config for GnuTLSCache Failed."
181                         " Shutting Down.");
182            exit(-1);
183        }
184         
185        for (s = base_server; s; s = s->next) {
186            sc = (mod_gnutls_srvconf_rec *) ap_get_module_config(s->module_config,
187                                                                 &gnutls_module);
188            sc->cache_type = sc_base->cache_type;
189            sc->cache_config = sc_base->cache_config;
190
191            if (sc->cert_file != NULL && sc->key_file != NULL) {
192                rv = gnutls_certificate_set_x509_key_file(sc->certs, sc->cert_file,
193                                                 sc->key_file,
194                                                 GNUTLS_X509_FMT_PEM);
195                if (rv != 0) {
196                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
197                         "[GnuTLS] - Host '%s:%d' has an invalid key or certificate:"
198                         "(%s,%s) (%d) %s",
199                         s->server_hostname, s->port, sc->cert_file, sc->key_file,
200                         rv, gnutls_strerror(rv));
201                }
202                else {
203                    gnutls_certificate_set_rsa_export_params(sc->certs, 
204                                                     rsa_params);
205                    gnutls_certificate_set_dh_params(sc->certs, dh_params);
206                }
207            }
208            else if (sc->enabled == GNUTLS_ENABLED_TRUE) {
209                ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
210                             "[GnuTLS] - Host '%s:%d' is missing a "
211                             "Cert and Key File!",
212                         s->server_hostname, s->port);
213            }
214        }
215    } /* first_run */
216
217    ap_add_version_component(p, "GnuTLS/" LIBGNUTLS_VERSION);
218
219    return OK;
220}
221
222static void mod_gnutls_hook_child_init(apr_pool_t *p, server_rec *s)
223{
224    apr_status_t rv = APR_SUCCESS;
225    mod_gnutls_srvconf_rec *sc = ap_get_module_config(s->module_config,
226                                                      &gnutls_module);
227
228    if (sc->cache_type != mod_gnutls_cache_none) {
229        rv = mod_gnutls_cache_child_init(p, s, sc);
230        if(rv != APR_SUCCESS) {
231            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
232                             "[GnuTLS] - Failed to run Cache Init");
233        }
234    }
235    else {
236        ap_log_error(APLOG_MARK, APLOG_CRIT, 0, s,
237                     "[GnuTLS] - No Cache Configured. Hint: GnuTLSCache");
238    }
239}
240
241static const char *mod_gnutls_hook_http_scheme(const request_rec * r)
242{
243    mod_gnutls_srvconf_rec *sc =
244        (mod_gnutls_srvconf_rec *) ap_get_module_config(r->server->
245                                                        module_config,
246                                                        &gnutls_module);
247
248    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
249        return NULL;
250    }
251
252    return "https";
253}
254
255static apr_port_t mod_gnutls_hook_default_port(const request_rec * r)
256{
257    mod_gnutls_srvconf_rec *sc =
258        (mod_gnutls_srvconf_rec *) ap_get_module_config(r->server->
259                                                        module_config,
260                                                        &gnutls_module);
261
262    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
263        return 0;
264    }
265
266    return 443;
267}
268
269static mod_gnutls_handle_t* create_gnutls_handle(apr_pool_t* pool, conn_rec * c)
270{
271    mod_gnutls_handle_t *ctxt;
272    mod_gnutls_srvconf_rec *sc =
273        (mod_gnutls_srvconf_rec *) ap_get_module_config(c->base_server->
274                                                        module_config,
275                                                        &gnutls_module);
276
277    ctxt = apr_pcalloc(pool, sizeof(*ctxt));
278    ctxt->c = c;
279    ctxt->sc = sc;
280    ctxt->status = 0;
281
282    ctxt->input_rc = APR_SUCCESS;
283    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
284    ctxt->input_cbuf.length = 0;
285
286    ctxt->output_rc = APR_SUCCESS;
287    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
288    ctxt->output_blen = 0;
289    ctxt->output_length = 0;
290
291    gnutls_init(&ctxt->session, GNUTLS_SERVER);
292
293    gnutls_protocol_set_priority(ctxt->session, sc->protocol);
294    gnutls_cipher_set_priority(ctxt->session, sc->ciphers);
295    gnutls_compression_set_priority(ctxt->session, sc->compression);
296    gnutls_kx_set_priority(ctxt->session, sc->key_exchange);
297    gnutls_mac_set_priority(ctxt->session, sc->macs);
298    gnutls_certificate_type_set_priority(ctxt->session, sc->cert_types);
299
300    gnutls_credentials_set(ctxt->session, GNUTLS_CRD_CERTIFICATE, sc->certs);
301
302//  if(anon) {
303//    gnutls_credentials_set(ctxt->session, GNUTLS_CRD_ANON, sc->anoncred);
304//  }
305
306    gnutls_certificate_server_set_request(ctxt->session, GNUTLS_CERT_IGNORE);
307
308    mod_gnutls_cache_session_init(ctxt);
309    return ctxt;
310}
311
312static int mod_gnutls_hook_pre_connection(conn_rec * c, void *csd)
313{
314    mod_gnutls_handle_t *ctxt;
315    mod_gnutls_srvconf_rec *sc =
316        (mod_gnutls_srvconf_rec *) ap_get_module_config(c->base_server->
317                                                        module_config,
318                                                        &gnutls_module);
319
320    if (!(sc && (sc->enabled == GNUTLS_ENABLED_TRUE))) {
321        return DECLINED;
322    }
323
324    ctxt = create_gnutls_handle(c->pool, c);
325
326    ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
327
328    gnutls_transport_set_pull_function(ctxt->session,
329                                       mod_gnutls_transport_read);
330    gnutls_transport_set_push_function(ctxt->session,
331                                       mod_gnutls_transport_write);
332    gnutls_transport_set_ptr(ctxt->session, ctxt);
333   
334    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME, ctxt, 
335                                             NULL, c);
336    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME, ctxt,
337                                               NULL, c);
338
339    return OK;
340}
341
342static int mod_gnutls_hook_fixups(request_rec *r)
343{
344    const char* tmp;
345    mod_gnutls_handle_t *ctxt;
346    apr_table_t *env = r->subprocess_env;
347
348    ctxt = ap_get_module_config(r->connection->conn_config, &gnutls_module);
349
350    if(!ctxt) {
351        return DECLINED;
352    }
353
354    apr_table_setn(env, "HTTPS", "on");
355    apr_table_setn(env, "SSL_PROTOCOL",
356                   gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
357    apr_table_setn(env, "SSL_CIPHER",
358                   gnutls_cipher_get_name(gnutls_cipher_get(ctxt->session)));
359
360    tmp = apr_psprintf(r->pool, "%d",
361              8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session)));
362
363    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
364    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
365
366    return OK;
367}
368
369static const char *gnutls_set_cert_file(cmd_parms * parms, void *dummy,
370                                        const char *arg)
371{
372    mod_gnutls_srvconf_rec *sc =
373        (mod_gnutls_srvconf_rec *) ap_get_module_config(parms->server->
374                                                        module_config,
375                                                        &gnutls_module);
376    sc->cert_file = ap_server_root_relative(parms->pool, arg);
377    return NULL;
378}
379
380static const char *gnutls_set_key_file(cmd_parms * parms, void *dummy,
381                                       const char *arg)
382{
383    mod_gnutls_srvconf_rec *sc =
384        (mod_gnutls_srvconf_rec *) ap_get_module_config(parms->server->
385                                                        module_config,
386                                                        &gnutls_module);
387    sc->key_file = ap_server_root_relative(parms->pool, arg);
388    return NULL;
389}
390
391static const char *gnutls_set_cache(cmd_parms * parms, void *dummy,
392                                       const char *type, const char* arg)
393{
394    const char* err;
395    mod_gnutls_srvconf_rec *sc = ap_get_module_config(parms->server->
396                                                        module_config,
397                                                        &gnutls_module);
398    if ((err = ap_check_cmd_context(parms, GLOBAL_ONLY))) {
399        return err;
400    }
401
402    if (strcasecmp("none", type) == 0) {
403        sc->cache_type = mod_gnutls_cache_none;
404    }
405    else if (strcasecmp("dbm", type) == 0) {
406        sc->cache_type = mod_gnutls_cache_dbm;
407    }
408#if HAVE_APR_MEMCACHE
409    else if (strcasecmp("memcache", type) == 0) {
410        sc->cache_type = mod_gnutls_cache_memcache;
411    }
412#endif
413    else {
414        return "Invalid Type for GnuTLSCache!";
415    }
416
417    if (sc->cache_type == mod_gnutls_cache_dbm) {
418        sc->cache_config = ap_server_root_relative(parms->pool, arg);
419    }
420    else {
421        sc->cache_config = apr_pstrdup(parms->pool, arg);
422    }
423
424    return NULL;
425}
426
427static const char *gnutls_set_enabled(cmd_parms * parms, void *dummy,
428                                      const char *arg)
429{
430    mod_gnutls_srvconf_rec *sc =
431        (mod_gnutls_srvconf_rec *) ap_get_module_config(parms->server->
432                                                        module_config,
433                                                        &gnutls_module);
434    if (!strcasecmp(arg, "On")) {
435        sc->enabled = GNUTLS_ENABLED_TRUE;
436    }
437    else if (!strcasecmp(arg, "Off")) {
438        sc->enabled = GNUTLS_ENABLED_FALSE;
439    }
440    else {
441        return "GnuTLSEnable must be set to 'On' or 'Off'";
442    }
443
444    return NULL;
445}
446
447static const command_rec gnutls_cmds[] = {
448    AP_INIT_TAKE1("GnuTLSCertificateFile", gnutls_set_cert_file,
449                  NULL,
450                  RSRC_CONF,
451                  "SSL Server Key file"),
452    AP_INIT_TAKE1("GnuTLSKeyFile", gnutls_set_key_file,
453                  NULL,
454                  RSRC_CONF,
455                  "SSL Server Certificate file"),
456    AP_INIT_TAKE2("GnuTLSCache", gnutls_set_cache,
457                  NULL,
458                  RSRC_CONF,
459                  "Cache Configuration"),
460    AP_INIT_TAKE1("GnuTLSEnable", gnutls_set_enabled,
461                  NULL, RSRC_CONF,
462                  "Whether this server has GnuTLS Enabled. Default: Off"),
463
464    {NULL}
465};
466
467/* TODO: CACertificateFile & Client Authentication
468 *    AP_INIT_TAKE1("GnuTLSCACertificateFile", ap_set_server_string_slot,
469 *                 (void *) APR_OFFSETOF(gnutls_srvconf_rec, key_file), NULL,
470 *                 RSRC_CONF,
471 *                 "CA"),
472 */
473
474static void gnutls_hooks(apr_pool_t * p)
475{
476    ap_hook_pre_connection(mod_gnutls_hook_pre_connection, NULL, NULL,
477                           APR_HOOK_MIDDLE);
478    ap_hook_post_config(mod_gnutls_hook_post_config, NULL, NULL,
479                        APR_HOOK_MIDDLE);
480    ap_hook_child_init(mod_gnutls_hook_child_init, NULL, NULL,
481                        APR_HOOK_MIDDLE);
482    ap_hook_http_scheme(mod_gnutls_hook_http_scheme, NULL, NULL,
483                        APR_HOOK_MIDDLE);
484    ap_hook_default_port(mod_gnutls_hook_default_port, NULL, NULL,
485                         APR_HOOK_MIDDLE);
486    ap_hook_pre_config(mod_gnutls_hook_pre_config, NULL, NULL,
487                       APR_HOOK_MIDDLE);
488
489    ap_hook_fixups(mod_gnutls_hook_fixups, NULL, NULL, APR_HOOK_MIDDLE);
490
491    /* TODO: HTTP Upgrade Filter */
492    /* ap_register_output_filter ("UPGRADE_FILTER",
493     *          ssl_io_filter_Upgrade, NULL, AP_FTYPE_PROTOCOL + 5);
494     */
495    ap_register_input_filter(GNUTLS_INPUT_FILTER_NAME,
496                             mod_gnutls_filter_input, NULL,
497                             AP_FTYPE_CONNECTION + 5);
498    ap_register_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
499                              mod_gnutls_filter_output, NULL,
500                              AP_FTYPE_CONNECTION + 5);
501}
502
503static void *gnutls_config_server_create(apr_pool_t * p, server_rec * s)
504{
505    int i;
506    mod_gnutls_srvconf_rec *sc = apr_pcalloc(p, sizeof(*sc));
507
508    sc->enabled = GNUTLS_ENABLED_FALSE;
509
510    gnutls_certificate_allocate_credentials(&sc->certs);
511    gnutls_anon_allocate_server_credentials(&sc->anoncred);
512    sc->key_file = NULL;
513    sc->cert_file = NULL;
514    sc->cache_timeout = apr_time_from_sec(3600);
515    sc->cache_type = mod_gnutls_cache_dbm;
516    sc->cache_config = ap_server_root_relative(p, "conf/gnutls_cache");
517
518    /* TODO: Make this Configurable ! */
519    sc->dh_params_file = ap_server_root_relative(p, "conf/dhfile");
520    sc->rsa_params_file = ap_server_root_relative(p, "conf/rsafile");
521
522    /* TODO: Make this Configurable ! */
523    /* meh. mod_ssl uses a flex based parser for this part.. sigh */
524    i = 0;
525    sc->ciphers[i++] = GNUTLS_CIPHER_AES_256_CBC;
526    sc->ciphers[i++] = GNUTLS_CIPHER_AES_128_CBC;
527    sc->ciphers[i++] = GNUTLS_CIPHER_ARCFOUR_128;
528    sc->ciphers[i++] = GNUTLS_CIPHER_3DES_CBC;
529    sc->ciphers[i++] = GNUTLS_CIPHER_ARCFOUR_40;
530    sc->ciphers[i] = 0;
531
532    i = 0;
533    sc->key_exchange[i++] = GNUTLS_KX_RSA;
534    sc->key_exchange[i++] = GNUTLS_KX_RSA_EXPORT;
535    sc->key_exchange[i++] = GNUTLS_KX_DHE_DSS;
536    sc->key_exchange[i++] = GNUTLS_KX_DHE_RSA;
537    sc->key_exchange[i++] = GNUTLS_KX_ANON_DH;
538    sc->key_exchange[i++] = GNUTLS_KX_SRP;
539    sc->key_exchange[i++] = GNUTLS_KX_SRP_RSA;
540    sc->key_exchange[i++] = GNUTLS_KX_SRP_DSS;
541    sc->key_exchange[i] = 0;
542
543    i = 0;
544    sc->macs[i++] = GNUTLS_MAC_SHA;
545    sc->macs[i++] = GNUTLS_MAC_MD5;
546    sc->macs[i++] = GNUTLS_MAC_RMD160;
547    sc->macs[i] = 0;
548
549    i = 0;
550    sc->protocol[i++] = GNUTLS_TLS1_1;
551    sc->protocol[i++] = GNUTLS_TLS1;
552    sc->protocol[i++] = GNUTLS_SSL3;
553    sc->protocol[i] = 0;
554
555    i = 0;
556    sc->compression[i++] = GNUTLS_COMP_NULL;
557    sc->compression[i++] = GNUTLS_COMP_ZLIB;
558    sc->compression[i++] = GNUTLS_COMP_LZO;
559    sc->compression[i] = 0;
560
561    i = 0;
562    sc->cert_types[i++] = GNUTLS_CRT_X509;
563    sc->cert_types[i] = 0;
564 
565    return sc;
566}
567
568
569
570module AP_MODULE_DECLARE_DATA gnutls_module = {
571    STANDARD20_MODULE_STUFF,
572    NULL,
573    NULL,
574    gnutls_config_server_create,
575    NULL,
576/*    gnutls_config_server_merge, */
577    gnutls_cmds,
578    gnutls_hooks
579};
Note: See TracBrowser for help on using the repository browser.