source: mod_gnutls/src/gnutls_hooks.c @ 26b08fd

debian/masterdebian/stretch-backportsjessie-backportsmsvaupstream
Last change on this file since 26b08fd was 26b08fd, checked in by Nokis Mavrogiannopoulos <nmav@…>, 12 years ago

updated README file to account for openpgp keys --patch by Jack Bates

  • Property mode set to 100644
File size: 33.9 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2007 Nikos Mavrogiannopoulos
4 *
5 *  Licensed under the Apache License, Version 2.0 (the "License");
6 *  you may not use this file except in compliance with the License.
7 *  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 *
17 */
18
19#include "mod_gnutls.h"
20#include "http_vhost.h"
21#include "ap_mpm.h"
22
23#if !USING_2_1_RECENT
24extern server_rec *ap_server_conf;
25#endif
26
27#if APR_HAS_THREADS
28GCRY_THREAD_OPTION_PTHREAD_IMPL;
29#endif
30
31#if MOD_GNUTLS_DEBUG
32static apr_file_t *debug_log_fp;
33#endif
34
35static int mpm_is_threaded;
36
37static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
38/* use side==0 for server and side==1 for client */
39static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert,
40                                     int side,
41                                     int export_certificates_enabled);
42static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert,
43                                     int side,
44                                     int export_certificates_enabled);
45
46static apr_status_t mgs_cleanup_pre_config(void *data)
47{
48    gnutls_global_deinit();
49    return APR_SUCCESS;
50}
51
52#if MOD_GNUTLS_DEBUG
53static void gnutls_debug_log_all(int level, const char *str)
54{
55    apr_file_printf(debug_log_fp, "<%d> %s\n", level, str);
56}
57#endif
58
59int
60mgs_hook_pre_config(apr_pool_t * pconf,
61                    apr_pool_t * plog, apr_pool_t * ptemp)
62{
63int ret;
64
65#if MOD_GNUTLS_DEBUG
66    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug",
67                  APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT,
68                  pconf);
69
70    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
71
72    gnutls_global_set_log_level(9);
73    gnutls_global_set_log_function(gnutls_debug_log_all);
74    apr_file_printf(debug_log_fp, "gnutls: %s\n", gnutls_check_version(NULL));
75#endif
76
77#if APR_HAS_THREADS
78    ap_mpm_query(AP_MPMQ_IS_THREADED, &mpm_is_threaded);
79    if (mpm_is_threaded) {
80        gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
81    }
82#else
83    mpm_is_threaded = 0;
84#endif
85
86    if (gnutls_check_version(LIBGNUTLS_VERSION)==NULL) {
87        apr_file_printf(debug_log_fp, "gnutls_check_version() failed. Required: gnutls-%s Found: gnutls-%s\n", 
88          LIBGNUTLS_VERSION, gnutls_check_version(NULL));
89        return -3;
90    }
91
92    ret = gnutls_global_init();
93    if (ret < 0) {
94        apr_file_printf(debug_log_fp, "gnutls_global_init: %s\n", gnutls_strerror(ret));
95        return -3;
96    }
97
98    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config,
99                              apr_pool_cleanup_null);
100
101
102    return OK;
103}
104
105static int mgs_select_virtual_server_cb(gnutls_session_t session)
106{
107    mgs_handle_t *ctxt;
108    mgs_srvconf_rec *tsc;
109    int ret;
110    int cprio[2];
111
112    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
113
114    ctxt = gnutls_transport_get_ptr(session);
115
116    /* find the virtual server */
117    tsc = mgs_find_sni_server(session);
118
119    if (tsc != NULL)
120        ctxt->sc = tsc;
121
122    gnutls_certificate_server_set_request(session,
123                                          ctxt->sc->client_verify_mode);
124
125    /* set the new server credentials
126     */
127
128    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE,
129                           ctxt->sc->certs);
130
131    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
132
133#ifdef ENABLE_SRP
134    if (ctxt->sc->srp_tpasswd_conf_file != NULL
135        && ctxt->sc->srp_tpasswd_file != NULL) {
136        gnutls_credentials_set(session, GNUTLS_CRD_SRP,
137                               ctxt->sc->srp_creds);
138    }
139#endif
140
141    /* update the priorities - to avoid negotiating a ciphersuite that is not
142     * enabled on this virtual server. Note that here we ignore the version
143     * negotiation.
144     */
145    ret = gnutls_priority_set(session, ctxt->sc->priorities);
146    /* actually it shouldn't fail since we have checked at startup */
147    if (ret < 0)
148        return ret;
149
150    /* If both certificate types are not present disallow them from
151     * being negotiated.
152     */
153    if (ctxt->sc->certs_x509[0] != NULL && ctxt->sc->cert_pgp == NULL) {
154        cprio[0] = GNUTLS_CRT_X509;
155        cprio[1] = 0;
156        gnutls_certificate_type_set_priority( session, cprio);
157    } else if (ctxt->sc->cert_pgp != NULL && ctxt->sc->certs_x509[0]==NULL) {
158        cprio[0] = GNUTLS_CRT_OPENPGP;
159        cprio[1] = 0;
160        gnutls_certificate_type_set_priority( session, cprio);
161    }
162
163    return 0;
164}
165
166static int cert_retrieve_fn(gnutls_session_t session, gnutls_retr_st * ret)
167{
168    mgs_handle_t *ctxt;
169
170    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
171    ctxt = gnutls_transport_get_ptr(session);
172
173    if (ctxt == NULL)
174        return GNUTLS_E_INTERNAL_ERROR;
175
176    if (gnutls_certificate_type_get( session) == GNUTLS_CRT_X509) {
177        ret->type = GNUTLS_CRT_X509;
178        ret->ncerts = ctxt->sc->certs_x509_num;
179        ret->deinit_all = 0;
180
181        ret->cert.x509 = ctxt->sc->certs_x509;
182        ret->key.x509 = ctxt->sc->privkey_x509;
183       
184        return 0;
185    } else if (gnutls_certificate_type_get( session) == GNUTLS_CRT_OPENPGP) {
186        ret->type = GNUTLS_CRT_OPENPGP;
187        ret->ncerts = 1;
188        ret->deinit_all = 0;
189
190        ret->cert.pgp = ctxt->sc->cert_pgp;
191        ret->key.pgp = ctxt->sc->privkey_pgp;
192
193        return 0;
194   
195    }
196
197    return GNUTLS_E_INTERNAL_ERROR;
198}
199
200/* 2048-bit group parameters from SRP specification */
201const char static_dh_params[] = "-----BEGIN DH PARAMETERS-----\n"
202    "MIIBBwKCAQCsa9tBMkqam/Fm3l4TiVgvr3K2ZRmH7gf8MZKUPbVgUKNzKcu0oJnt\n"
203    "gZPgdXdnoT3VIxKrSwMxDc1/SKnaBP1Q6Ag5ae23Z7DPYJUXmhY6s2YaBfvV+qro\n"
204    "KRipli8Lk7hV+XmT7Jde6qgNdArb9P90c1nQQdXDPqcdKB5EaxR3O8qXtDoj+4AW\n"
205    "dr0gekNsZIHx0rkHhxdGGludMuaI+HdIVEUjtSSw1X1ep3onddLs+gMs+9v1L7N4\n"
206    "YWAnkATleuavh05zA85TKZzMBBx7wwjYKlaY86jQw4JxrjX46dv7tpS1yAPYn3rk\n"
207    "Nd4jbVJfVHWbZeNy/NaO8g+nER+eSv9zAgEC\n"
208    "-----END DH PARAMETERS-----\n";
209
210/* Read the common name or the alternative name of the certificate.
211 * We only support a single name per certificate.
212 *
213 * Returns negative on error.
214 */
215static int read_crt_cn(server_rec * s, apr_pool_t * p,
216                       gnutls_x509_crt_t cert, char **cert_cn)
217{
218    int rv = 0, i;
219    size_t data_len;
220
221
222    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
223    *cert_cn = NULL;
224
225    data_len = 0;
226    rv = gnutls_x509_crt_get_dn_by_oid(cert,
227                                       GNUTLS_OID_X520_COMMON_NAME,
228                                       0, 0, NULL, &data_len);
229
230    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
231        *cert_cn = apr_palloc(p, data_len);
232        rv = gnutls_x509_crt_get_dn_by_oid(cert,
233                                           GNUTLS_OID_X520_COMMON_NAME, 0,
234                                           0, *cert_cn, &data_len);
235    } else {                    /* No CN return subject alternative name */
236        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
237                     "No common name found in certificate for '%s:%d'. Looking for subject alternative name...",
238                     s->server_hostname, s->port);
239        rv = 0;
240        /* read subject alternative name */
241        for (i = 0; !(rv < 0); i++) {
242            data_len = 0;
243            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
244                                                      NULL, &data_len,
245                                                      NULL);
246
247            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
248                /* FIXME: not very efficient. What if we have several alt names
249                 * before DNSName?
250                 */
251                *cert_cn = apr_palloc(p, data_len + 1);
252
253                rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
254                                                          *cert_cn,
255                                                          &data_len, NULL);
256                (*cert_cn)[data_len] = 0;
257
258                if (rv == GNUTLS_SAN_DNSNAME)
259                    break;
260            }
261        }
262    }
263
264    return rv;
265}
266
267static int read_pgpcrt_cn(server_rec * s, apr_pool_t * p,
268                       gnutls_openpgp_crt_t cert, char **cert_cn)
269{
270    int rv = 0;
271    size_t data_len;
272
273
274    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
275    *cert_cn = NULL;
276
277    data_len = 0;
278    rv = gnutls_openpgp_crt_get_name(cert, 0, NULL, &data_len);
279
280    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
281        *cert_cn = apr_palloc(p, data_len);
282        rv = gnutls_openpgp_crt_get_name(cert, 0, *cert_cn, &data_len);
283    } else {                    /* No CN return subject alternative name */
284        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
285                     "No name found in PGP certificate for '%s:%d'.",
286                     s->server_hostname, s->port);
287    }
288
289    return rv;
290}
291
292
293int
294mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
295                     apr_pool_t * ptemp, server_rec * base_server)
296{
297    int rv;
298    server_rec *s;
299    gnutls_dh_params_t dh_params = NULL;
300    gnutls_rsa_params_t rsa_params = NULL;
301    mgs_srvconf_rec *sc;
302    mgs_srvconf_rec *sc_base;
303    void *data = NULL;
304    int first_run = 0;
305    const char *userdata_key = "mgs_init";
306
307    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
308    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
309    if (data == NULL) {
310        first_run = 1;
311        apr_pool_userdata_set((const void *) 1, userdata_key,
312                              apr_pool_cleanup_null,
313                              base_server->process->pool);
314    }
315
316
317    {
318        s = base_server;
319        sc_base =
320            (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
321                                                     &gnutls_module);
322
323        gnutls_dh_params_init(&dh_params);
324
325        if (sc_base->dh_params == NULL) {
326            gnutls_datum pdata = { (void *) static_dh_params, sizeof(static_dh_params) };
327            /* loading defaults */
328            rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata,
329                                               GNUTLS_X509_FMT_PEM);
330
331            if (rv < 0) {
332                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
333                     "GnuTLS: Unable to load DH Params: (%d) %s",
334                     rv, gnutls_strerror(rv));
335                exit(rv);
336            }
337        } else dh_params = sc_base->dh_params;
338
339        if (sc_base->rsa_params != NULL) 
340            rsa_params = sc_base->rsa_params;
341
342        /* else not an error but RSA-EXPORT ciphersuites are not available
343         */
344
345        rv = mgs_cache_post_config(p, s, sc_base);
346        if (rv != 0) {
347            ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
348                         "GnuTLS: Post Config for GnuTLSCache Failed."
349                         " Shutting Down.");
350            exit(-1);
351        }
352
353        for (s = base_server; s; s = s->next) {
354            void *load = NULL;
355            sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
356                                                          &gnutls_module);
357            sc->cache_type = sc_base->cache_type;
358            sc->cache_config = sc_base->cache_config;
359
360            /* Check if the priorities have been set */
361            if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
362                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
363                     "GnuTLS: Host '%s:%d' is missing the GnuTLSPriorities directive!",
364                             s->server_hostname, s->port);
365                exit(-1);
366            }
367           
368            /* Check if DH or RSA params have been set per host */
369            if (sc->rsa_params != NULL)
370                load = sc->rsa_params;
371            else if (rsa_params) load = rsa_params;
372           
373            if (load != NULL)
374                gnutls_certificate_set_rsa_export_params(sc->certs, load);
375
376
377            load = NULL;
378            if (sc->dh_params != NULL)
379                load = sc->dh_params;
380            else if (dh_params) load = dh_params;
381           
382            if (load != NULL) { /* not needed but anyway */
383                gnutls_certificate_set_dh_params(sc->certs, load);
384                gnutls_anon_set_server_dh_params(sc->anon_creds, load);
385            }
386
387            gnutls_certificate_server_set_retrieve_function(sc->certs,
388                                                            cert_retrieve_fn);
389
390#ifdef ENABLE_SRP
391            if (sc->srp_tpasswd_conf_file != NULL
392                && sc->srp_tpasswd_file != NULL) {
393                rv = gnutls_srp_set_server_credentials_file(sc->srp_creds,
394                                                            sc->
395                                                            srp_tpasswd_file,
396                                                            sc->
397                                                            srp_tpasswd_conf_file);
398
399                if (rv < 0 && sc->enabled == GNUTLS_ENABLED_TRUE) {
400                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
401                                 "[GnuTLS] - Host '%s:%d' is missing a "
402                                 "SRP password or conf File!",
403                                 s->server_hostname, s->port);
404                    exit(-1);
405                }
406            }
407#endif
408
409            if (sc->certs_x509[0] == NULL
410                && sc->enabled == GNUTLS_ENABLED_TRUE) {
411                ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
412                             "[GnuTLS] - Host '%s:%d' is missing a "
413                             "Certificate File!", s->server_hostname,
414                             s->port);
415                exit(-1);
416            }
417
418            if (sc->privkey_x509 == NULL
419                && sc->enabled == GNUTLS_ENABLED_TRUE) {
420                ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
421                             "[GnuTLS] - Host '%s:%d' is missing a "
422                             "Private Key File!",
423                             s->server_hostname, s->port);
424                exit(-1);
425            }
426
427            if (sc->enabled == GNUTLS_ENABLED_TRUE) {
428                rv = read_crt_cn(s, p, sc->certs_x509[0], &sc->cert_cn);
429                if (rv < 0 && sc->cert_pgp != NULL)  /* try openpgp certificate */
430                    rv = read_pgpcrt_cn(s, p, sc->cert_pgp, &sc->cert_cn);
431
432                if (rv < 0) {
433                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
434                                 "[GnuTLS] - Cannot find a certificate for host '%s:%d'!",
435                                 s->server_hostname, s->port);
436                    sc->cert_cn = NULL;
437                    continue;
438                }
439            }
440        }
441    }
442
443    ap_add_version_component(p, "mod_gnutls/" MOD_GNUTLS_VERSION);
444
445    return OK;
446}
447
448void mgs_hook_child_init(apr_pool_t * p, server_rec * s)
449{
450    apr_status_t rv = APR_SUCCESS;
451    mgs_srvconf_rec *sc = ap_get_module_config(s->module_config,
452                                               &gnutls_module);
453
454    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
455    if (sc->cache_type != mgs_cache_none) {
456        rv = mgs_cache_child_init(p, s, sc);
457        if (rv != APR_SUCCESS) {
458            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
459                         "[GnuTLS] - Failed to run Cache Init");
460        }
461    } else {
462        ap_log_error(APLOG_MARK, APLOG_CRIT, 0, s,
463                     "[GnuTLS] - No Cache Configured. Hint: GnuTLSCache");
464    }
465}
466
467const char *mgs_hook_http_scheme(const request_rec * r)
468{
469    mgs_srvconf_rec *sc =
470        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
471                                                 &gnutls_module);
472
473    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
474    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
475        return NULL;
476    }
477
478    return "https";
479}
480
481apr_port_t mgs_hook_default_port(const request_rec * r)
482{
483    mgs_srvconf_rec *sc =
484        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
485                                                 &gnutls_module);
486
487    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
488    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
489        return 0;
490    }
491
492    return 443;
493}
494
495#define MAX_HOST_LEN 255
496
497#if USING_2_1_RECENT
498typedef struct {
499    mgs_handle_t *ctxt;
500    mgs_srvconf_rec *sc;
501    const char *sni_name;
502} vhost_cb_rec;
503
504static int vhost_cb(void *baton, conn_rec * conn, server_rec * s)
505{
506    mgs_srvconf_rec *tsc;
507    vhost_cb_rec *x = baton;
508
509    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
510    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
511                                                   &gnutls_module);
512
513    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
514        return 0;
515    }
516
517    /* The CN can contain a * -- this will match those too. */
518    if (ap_strcasecmp_match(x->sni_name, tsc->cert_cn) == 0) {
519        /* found a match */
520#if MOD_GNUTLS_DEBUG
521        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
522                     x->ctxt->c->base_server,
523                     "GnuTLS: Virtual Host CB: "
524                     "'%s' == '%s'", tsc->cert_cn, x->sni_name);
525#endif
526        /* Because we actually change the server used here, we need to reset
527         * things like ClientVerify.
528         */
529        x->sc = tsc;
530        /* Shit. Crap. Dammit. We *really* should rehandshake here, as our
531         * certificate structure *should* change when the server changes.
532         * acccckkkkkk.
533         */
534        return 1;
535    } else {
536#if MOD_GNUTLS_DEBUG
537        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
538                     x->ctxt->c->base_server,
539                     "GnuTLS: Virtual Host CB: "
540                     "'%s' != '%s'", tsc->cert_cn, x->sni_name);
541#endif
542
543    }
544    return 0;
545}
546#endif
547
548mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session)
549{
550    int rv;
551    unsigned int sni_type;
552    size_t data_len = MAX_HOST_LEN;
553    char sni_name[MAX_HOST_LEN];
554    mgs_handle_t *ctxt;
555#if USING_2_1_RECENT
556    vhost_cb_rec cbx;
557#else
558    server_rec *s;
559    mgs_srvconf_rec *tsc;
560#endif
561
562    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
563    ctxt = gnutls_transport_get_ptr(session);
564
565    rv = gnutls_server_name_get(ctxt->session, sni_name,
566                                &data_len, &sni_type, 0);
567
568    if (rv != 0) {
569        return NULL;
570    }
571
572    if (sni_type != GNUTLS_NAME_DNS) {
573        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
574                     ctxt->c->base_server,
575                     "GnuTLS: Unknown type '%d' for SNI: "
576                     "'%s'", sni_type, sni_name);
577        return NULL;
578    }
579
580    /**
581     * Code in the Core already sets up the c->base_server as the base
582     * for this IP/Port combo.  Trust that the core did the 'right' thing.
583     */
584#if USING_2_1_RECENT
585    cbx.ctxt = ctxt;
586    cbx.sc = NULL;
587    cbx.sni_name = sni_name;
588
589    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
590    if (rv == 1) {
591        return cbx.sc;
592    }
593#else
594    for (s = ap_server_conf; s; s = s->next) {
595
596        tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
597                                                       &gnutls_module);
598        if (tsc->enabled != GNUTLS_ENABLED_TRUE) {
599            continue;
600        }
601#if MOD_GNUTLS_DEBUG
602        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
603                     ctxt->c->base_server,
604                     "GnuTLS: sni-x509 cn: %s/%d pk: %s s: 0x%08X s->n: 0x%08X  sc: 0x%08X",
605                     tsc->cert_cn, rv,
606                     gnutls_pk_algorithm_get_name
607                     (gnutls_x509_privkey_get_pk_algorithm
608                      (ctxt->sc->privkey_x509)), (unsigned int) s,
609                     (unsigned int) s->next, (unsigned int) tsc);
610#endif
611        /* The CN can contain a * -- this will match those too. */
612        if (ap_strcasecmp_match(sni_name, tsc->cert_cn) == 0) {
613#if MOD_GNUTLS_DEBUG
614            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
615                         ctxt->c->base_server,
616                         "GnuTLS: Virtual Host: "
617                         "'%s' == '%s'", tsc->cert_cn, sni_name);
618#endif
619            return tsc;
620        }
621    }
622#endif
623    return NULL;
624}
625
626
627static const int protocol_priority[] = {
628    GNUTLS_TLS1_1, GNUTLS_TLS1_0, GNUTLS_SSL3, 0
629};
630
631
632static mgs_handle_t *create_gnutls_handle(apr_pool_t * pool, conn_rec * c)
633{
634    mgs_handle_t *ctxt;
635    mgs_srvconf_rec *sc =
636        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
637                                                 module_config,
638                                                 &gnutls_module);
639
640    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
641    ctxt = apr_pcalloc(pool, sizeof(*ctxt));
642    ctxt->c = c;
643    ctxt->sc = sc;
644    ctxt->status = 0;
645
646    ctxt->input_rc = APR_SUCCESS;
647    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
648    ctxt->input_cbuf.length = 0;
649
650    ctxt->output_rc = APR_SUCCESS;
651    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
652    ctxt->output_blen = 0;
653    ctxt->output_length = 0;
654
655    gnutls_init(&ctxt->session, GNUTLS_SERVER);
656
657    /* because we don't set any default priorities here (we set later at
658     * the user hello callback) we need to at least set this in order for
659     * gnutls to be able to read packets.
660     */
661    gnutls_protocol_set_priority(ctxt->session, protocol_priority);
662
663    gnutls_handshake_set_post_client_hello_function(ctxt->session,
664                                                    mgs_select_virtual_server_cb);
665
666    mgs_cache_session_init(ctxt);
667
668    return ctxt;
669}
670
671int mgs_hook_pre_connection(conn_rec * c, void *csd)
672{
673    mgs_handle_t *ctxt;
674    mgs_srvconf_rec *sc =
675        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
676                                                 module_config,
677                                                 &gnutls_module);
678
679    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
680    if (!(sc && (sc->enabled == GNUTLS_ENABLED_TRUE))) {
681        return DECLINED;
682    }
683
684    ctxt = create_gnutls_handle(c->pool, c);
685
686    ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
687
688    gnutls_transport_set_pull_function(ctxt->session, mgs_transport_read);
689    gnutls_transport_set_push_function(ctxt->session, mgs_transport_write);
690    gnutls_transport_set_ptr(ctxt->session, ctxt);
691
692    ctxt->input_filter =
693        ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME, ctxt, NULL, c);
694    ctxt->output_filter =
695        ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME, ctxt, NULL, c);
696
697    return OK;
698}
699
700int mgs_hook_fixups(request_rec * r)
701{
702    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
703    char buf[AP_IOBUFSIZE];
704    const char *tmp;
705    size_t len;
706    mgs_handle_t *ctxt;
707    int rv = OK;
708
709    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
710    apr_table_t *env = r->subprocess_env;
711
712    ctxt =
713        ap_get_module_config(r->connection->conn_config, &gnutls_module);
714
715    if (!ctxt) {
716        return DECLINED;
717    }
718
719    apr_table_setn(env, "HTTPS", "on");
720
721    apr_table_setn(env, "SSL_VERSION_LIBRARY",
722                   "GnuTLS/" LIBGNUTLS_VERSION);
723    apr_table_setn(env, "SSL_VERSION_INTERFACE",
724                   "mod_gnutls/" MOD_GNUTLS_VERSION);
725
726    apr_table_setn(env, "SSL_PROTOCOL",
727                   gnutls_protocol_get_name(gnutls_protocol_get_version
728                                            (ctxt->session)));
729
730    /* should have been called SSL_CIPHERSUITE instead */
731    apr_table_setn(env, "SSL_CIPHER",
732                   gnutls_cipher_suite_get_name(gnutls_kx_get
733                                                (ctxt->session),
734                                                gnutls_cipher_get(ctxt->
735                                                                  session),
736                                                gnutls_mac_get(ctxt->
737                                                               session)));
738
739    apr_table_setn(env, "SSL_COMPRESS_METHOD",
740                   gnutls_compression_get_name(gnutls_compression_get
741                                               (ctxt->session)));
742
743#ifdef ENABLE_SRP
744    apr_table_setn(env, "SSL_SRP_USER",
745                   gnutls_srp_server_get_username(ctxt->session));
746#endif
747
748    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
749        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
750
751    unsigned int key_size =
752        8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
753    tmp = apr_psprintf(r->pool, "%u", key_size);
754
755    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
756
757    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
758
759    apr_table_setn(env, "SSL_CIPHER_EXPORT",
760                   (key_size <= 40) ? "true" : "false");
761
762    len = sizeof(sbuf);
763    gnutls_session_get_id(ctxt->session, sbuf, &len);
764    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
765    apr_table_setn(env, "SSL_SESSION_ID", apr_pstrdup(r->pool, tmp));
766
767    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
768        mgs_add_common_cert_vars(r, ctxt->sc->certs_x509[0], 0,
769                             ctxt->sc->export_certificates_enabled);
770    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
771        mgs_add_common_pgpcert_vars(r, ctxt->sc->cert_pgp, 0,
772                             ctxt->sc->export_certificates_enabled);
773
774    return rv;
775}
776
777int mgs_hook_authz(request_rec * r)
778{
779    int rv;
780    mgs_handle_t *ctxt;
781    mgs_dirconf_rec *dc = ap_get_module_config(r->per_dir_config,
782                                               &gnutls_module);
783
784    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
785    ctxt =
786        ap_get_module_config(r->connection->conn_config, &gnutls_module);
787
788    if (!ctxt) {
789        return DECLINED;
790    }
791
792    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
793        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
794                      "GnuTLS: Directory set to Ignore Client Certificate!");
795    } else {
796        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
797            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
798                          "GnuTLS: Attempting to rehandshake with peer. %d %d",
799                          ctxt->sc->client_verify_mode,
800                          dc->client_verify_mode);
801
802            gnutls_certificate_server_set_request(ctxt->session,
803                                                  dc->client_verify_mode);
804
805            if (mgs_rehandshake(ctxt) != 0) {
806                return HTTP_FORBIDDEN;
807            }
808        } else if (ctxt->sc->client_verify_mode == GNUTLS_CERT_IGNORE) {
809#if MOD_GNUTLS_DEBUG
810            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
811                          "GnuTLS: Peer is set to IGNORE");
812#endif
813        } else {
814            rv = mgs_cert_verify(r, ctxt);
815            if (rv != DECLINED) {
816                return rv;
817            }
818        }
819    }
820
821    return DECLINED;
822}
823
824/* variables that are not sent by default:
825 *
826 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
827 * SSL_SERVER_CERT      string  PEM-encoded client certificate
828 */
829
830/* side is either 0 for SERVER or 1 for CLIENT
831 */
832#define MGS_SIDE ((side==0)?"SSL_SERVER":"SSL_CLIENT")
833static void
834mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side,
835                         int export_certificates_enabled)
836{
837    unsigned char sbuf[64];     /* buffer to hold serials */
838    char buf[AP_IOBUFSIZE];
839    const char *tmp;
840    char *tmp2;
841    size_t len;
842    int ret, i;
843
844    apr_table_t *env = r->subprocess_env;
845
846    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
847    if (export_certificates_enabled != 0) {
848        char cert_buf[10 * 1024];
849        len = sizeof(cert_buf);
850
851        if (gnutls_x509_crt_export
852            (cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0)
853            apr_table_setn(env,
854                           apr_pstrcat(r->pool, MGS_SIDE, "_CERT", NULL),
855                           apr_pstrmemdup(r->pool, cert_buf, len));
856
857    }
858
859    len = sizeof(buf);
860    gnutls_x509_crt_get_dn(cert, buf, &len);
861    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_S_DN", NULL),
862                   apr_pstrmemdup(r->pool, buf, len));
863
864    len = sizeof(buf);
865    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
866    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_I_DN", NULL),
867                   apr_pstrmemdup(r->pool, buf, len));
868
869    len = sizeof(sbuf);
870    gnutls_x509_crt_get_serial(cert, sbuf, &len);
871    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
872    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_M_SERIAL", NULL),
873                   apr_pstrdup(r->pool, tmp));
874
875    ret = gnutls_x509_crt_get_version(cert);
876    if (ret > 0)
877        apr_table_setn(env,
878                       apr_pstrcat(r->pool, MGS_SIDE, "_M_VERSION", NULL),
879                       apr_psprintf(r->pool, "%u", ret));
880
881    apr_table_setn(env,
882       apr_pstrcat(r->pool, MGS_SIDE, "_CERT_TYPE", NULL), "X.509");
883
884    tmp =
885        mgs_time2sz(gnutls_x509_crt_get_expiration_time
886                    (cert), buf, sizeof(buf));
887    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_END", NULL),
888                   apr_pstrdup(r->pool, tmp));
889
890    tmp =
891        mgs_time2sz(gnutls_x509_crt_get_activation_time
892                    (cert), buf, sizeof(buf));
893    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_START", NULL),
894                   apr_pstrdup(r->pool, tmp));
895
896    ret = gnutls_x509_crt_get_signature_algorithm(cert);
897    if (ret >= 0) {
898        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_SIG", NULL),
899                       gnutls_sign_algorithm_get_name(ret));
900    }
901
902    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
903    if (ret >= 0) {
904        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_KEY", NULL),
905                       gnutls_pk_algorithm_get_name(ret));
906    }
907
908    /* export all the alternative names (DNS, RFC822 and URI) */
909    for (i = 0; !(ret < 0); i++) {
910        len = 0;
911        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
912                                                   NULL, &len, NULL);
913
914        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
915            tmp2 = apr_palloc(r->pool, len + 1);
916
917            ret =
918                gnutls_x509_crt_get_subject_alt_name(cert, i, tmp2, &len,
919                                                     NULL);
920            tmp2[len] = 0;
921
922            if (ret == GNUTLS_SAN_DNSNAME) {
923                apr_table_setn(env,
924                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
925                       apr_psprintf(r->pool, "DNSNAME:%s", tmp2));
926            } else if (ret == GNUTLS_SAN_RFC822NAME) {
927                apr_table_setn(env,
928                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
929                       apr_psprintf(r->pool, "RFC822NAME:%s", tmp2));
930            } else if (ret == GNUTLS_SAN_URI) {
931                apr_table_setn(env,
932                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
933                       apr_psprintf(r->pool, "URI:%s", tmp2));
934            } else {
935                apr_table_setn(env,
936                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
937                       "UNSUPPORTED");
938            }
939        }
940    }
941}
942
943static void
944mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side,
945                         int export_certificates_enabled)
946{
947    unsigned char sbuf[64];     /* buffer to hold serials */
948    char buf[AP_IOBUFSIZE];
949    const char *tmp;
950    size_t len;
951    int ret;
952
953    apr_file_printf(debug_log_fp,   "%s: %d\n", __func__, __LINE__);
954    apr_table_t *env = r->subprocess_env;
955
956    if (export_certificates_enabled != 0) {
957        char cert_buf[10 * 1024];
958        len = sizeof(cert_buf);
959
960        if (gnutls_openpgp_crt_export
961            (cert, GNUTLS_OPENPGP_FMT_BASE64, cert_buf, &len) >= 0)
962            apr_table_setn(env,
963                           apr_pstrcat(r->pool, MGS_SIDE, "_CERT", NULL),
964                           apr_pstrmemdup(r->pool, cert_buf, len));
965
966    }
967
968    len = sizeof(buf);
969    gnutls_openpgp_crt_get_name(cert, 0, buf, &len);
970    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_NAME", NULL),
971                   apr_pstrmemdup(r->pool, buf, len));
972
973    len = sizeof(sbuf);
974    gnutls_openpgp_crt_get_fingerprint(cert, sbuf, &len);
975    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
976    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_FINGERPRINT", NULL),
977                   apr_pstrdup(r->pool, tmp));
978
979    ret = gnutls_openpgp_crt_get_version(cert);
980    if (ret > 0)
981        apr_table_setn(env,
982                       apr_pstrcat(r->pool, MGS_SIDE, "_M_VERSION", NULL),
983                       apr_psprintf(r->pool, "%u", ret));
984
985    apr_table_setn(env,
986       apr_pstrcat(r->pool, MGS_SIDE, "_CERT_TYPE", NULL), "OPENPGP");
987
988    tmp =
989        mgs_time2sz(gnutls_openpgp_crt_get_expiration_time
990                    (cert), buf, sizeof(buf));
991    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_END", NULL),
992                   apr_pstrdup(r->pool, tmp));
993
994    tmp =
995        mgs_time2sz(gnutls_openpgp_crt_get_creation_time
996                    (cert), buf, sizeof(buf));
997    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_START", NULL),
998                   apr_pstrdup(r->pool, tmp));
999
1000    ret = gnutls_openpgp_crt_get_pk_algorithm(cert, NULL);
1001    if (ret >= 0) {
1002        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_KEY", NULL),
1003                       gnutls_pk_algorithm_get_name(ret));
1004    }
1005
1006}
1007
1008/* TODO: Allow client sending a X.509 certificate chain */
1009static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt)
1010{
1011    const gnutls_datum_t *cert_list;
1012    unsigned int cert_list_size, status, expired;
1013    int rv, ret;
1014    union {
1015      gnutls_x509_crt_t x509;
1016      gnutls_openpgp_crt_t pgp;
1017    } cert;
1018    apr_time_t activation_time, expiration_time, cur_time;
1019
1020    apr_file_printf(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1021    cert_list =
1022        gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
1023
1024    if (cert_list == NULL || cert_list_size == 0) {
1025        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
1026         */
1027        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1028            return OK;
1029
1030        /* no certificate provided by the client, but one was required. */
1031        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1032                      "GnuTLS: Failed to Verify Peer: "
1033                      "Client did not submit a certificate");
1034        return HTTP_FORBIDDEN;
1035    }
1036
1037    if (cert_list_size > 1) {
1038        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1039                      "GnuTLS: Failed to Verify Peer: "
1040                      "Chained Client Certificates are not supported.");
1041        return HTTP_FORBIDDEN;
1042    }
1043
1044    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509) {
1045        gnutls_x509_crt_init(&cert.x509);
1046        rv = gnutls_x509_crt_import(cert.x509, &cert_list[0], GNUTLS_X509_FMT_DER);
1047    } else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP) {
1048        gnutls_openpgp_crt_init(&cert.pgp);
1049        rv = gnutls_openpgp_crt_import(cert.pgp, &cert_list[0], GNUTLS_OPENPGP_FMT_RAW);
1050    } else return HTTP_FORBIDDEN;
1051 
1052    if (rv < 0) {
1053       ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1054                      "GnuTLS: Failed to Verify Peer: "
1055                      "Failed to import peer certificates.");
1056       ret = HTTP_FORBIDDEN;
1057       goto exit;
1058    }
1059
1060    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509) {
1061        apr_time_ansi_put(&expiration_time,
1062                      gnutls_x509_crt_get_expiration_time(cert.x509));
1063        apr_time_ansi_put(&activation_time,
1064                      gnutls_x509_crt_get_activation_time(cert.x509));
1065
1066        rv = gnutls_x509_crt_verify(cert.x509, ctxt->sc->ca_list,
1067                                ctxt->sc->ca_list_size, 0, &status);
1068    } else {
1069        apr_time_ansi_put(&expiration_time,
1070                      gnutls_openpgp_crt_get_expiration_time(cert.pgp));
1071        apr_time_ansi_put(&activation_time,
1072                      gnutls_openpgp_crt_get_creation_time(cert.pgp));
1073
1074        rv = gnutls_openpgp_crt_verify_ring(cert.pgp, ctxt->sc->pgp_list,
1075                      0, &status);
1076    }
1077
1078    if (rv < 0) {
1079        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1080                      "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1081                      rv, gnutls_strerror(rv));
1082        if (rv == GNUTLS_E_NO_CERTIFICATE_FOUND)
1083            ap_log_rerror(APLOG_MARK, APLOG_EMERG, 0, r,
1084                      "GnuTLS: No certificate was found for verification. Did you set the GnuTLSX509CAFile or GnuTLSPGPKeyringFile directives?");
1085        ret = HTTP_FORBIDDEN;
1086        goto exit;
1087    }
1088
1089    /* TODO: X509 CRL Verification. */
1090    /* May add later if anyone needs it.
1091     */
1092    /* ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size); */
1093
1094    expired = 0;
1095    cur_time = apr_time_now();
1096    if (activation_time > cur_time) {
1097        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1098                      "GnuTLS: Failed to Verify Peer: "
1099                      "Peer Certificate is not yet activated.");
1100        expired = 1;
1101    }
1102
1103    if (expiration_time < cur_time) {
1104        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1105                      "GnuTLS: Failed to Verify Peer: "
1106                      "Peer Certificate is expired.");
1107        expired = 1;
1108    }
1109
1110    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1111        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1112                      "GnuTLS: Could not find Signer for Peer Certificate");
1113    }
1114
1115    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1116        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1117                      "GnuTLS: Peer's Certificate signer is not a CA");
1118    }
1119
1120    if (status & GNUTLS_CERT_INVALID) {
1121        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1122                      "GnuTLS: Peer Certificate is invalid.");
1123    } else if (status & GNUTLS_CERT_REVOKED) {
1124        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1125                      "GnuTLS: Peer Certificate is revoked.");
1126    }
1127
1128    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
1129        mgs_add_common_cert_vars(r, cert.x509, 1,
1130                             ctxt->sc->export_certificates_enabled);
1131    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
1132        mgs_add_common_pgpcert_vars(r, cert.pgp, 1,
1133                             ctxt->sc->export_certificates_enabled);
1134
1135    {
1136        /* days remaining */
1137        unsigned long remain =
1138            (apr_time_sec(expiration_time) -
1139             apr_time_sec(cur_time)) / 86400;
1140        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1141                       apr_psprintf(r->pool, "%lu", remain));
1142    }
1143
1144    if (status == 0 && expired == 0) {
1145        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "SUCCESS");
1146        ret = OK;
1147    } else {
1148        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "FAILED");
1149        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1150            ret = OK;
1151        else
1152            ret = HTTP_FORBIDDEN;
1153    }
1154
1155  exit:
1156    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
1157        gnutls_x509_crt_deinit(cert.x509);
1158    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
1159        gnutls_openpgp_crt_deinit(cert.pgp);
1160    return ret;
1161
1162
1163}
Note: See TracBrowser for help on using the repository browser.