source: mod_gnutls/src/gnutls_hooks.c @ 8df5b25

debian/masterdebian/stretch-backportsjessie-backportsupstream upstream/0.4.3
Last change on this file since 8df5b25 was 8df5b25, checked in by Daniel Kahn Gillmor <dkg@…>, 8 years ago

Imported Upstream version 0.4.3

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