source: mod_gnutls/src/gnutls_hooks.c @ a208cd3

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

better logging

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