source: mod_gnutls/src/gnutls_hooks.c @ 1897a1c

asynciodebian/masterdebian/stretch-backportsjessie-backportsmsvaproxy-ticketupstream
Last change on this file since 1897a1c was 1897a1c, checked in by Nokis Mavrogiannopoulos <nmav@…>, 12 years ago

depend on main libgnutls library (and gnutls 2.4.x)

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