source: mod_gnutls/src/gnutls_hooks.c @ e6f648a

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