source: mod_gnutls/src/gnutls_hooks.c @ 2226711

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

report the missing GnuTLSPriorities for the gnutls enabled hosts only.

  • Property mode set to 100644
File size: 28.6 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2007 Nikos Mavrogiannopoulos
4 *
5 *  Licensed under the Apache License, Version 2.0 (the "License");
6 *  you may not use this file except in compliance with the License.
7 *  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 *
17 */
18
19#include "mod_gnutls.h"
20#include "http_vhost.h"
21#include "ap_mpm.h"
22
23#if !USING_2_1_RECENT
24extern server_rec *ap_server_conf;
25#endif
26
27#if APR_HAS_THREADS
28GCRY_THREAD_OPTION_PTHREAD_IMPL;
29#endif
30
31#if MOD_GNUTLS_DEBUG
32static apr_file_t *debug_log_fp;
33#endif
34
35static int mpm_is_threaded;
36
37static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
38/* use side==0 for server and side==1 for client */
39static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt 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{
60
61#if APR_HAS_THREADS
62    ap_mpm_query(AP_MPMQ_IS_THREADED, &mpm_is_threaded);
63    if (mpm_is_threaded) {
64        gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
65    }
66#else
67    mpm_is_threaded = 0;
68#endif
69
70    gnutls_global_init();
71
72    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config,
73                              apr_pool_cleanup_null);
74
75#if MOD_GNUTLS_DEBUG
76    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug",
77                  APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT,
78                  pconf);
79
80    gnutls_global_set_log_level(9);
81    gnutls_global_set_log_function(gnutls_debug_log_all);
82#endif
83
84    return OK;
85}
86
87
88static gnutls_datum
89load_params(const char *file, server_rec * s, apr_pool_t * pool)
90{
91    gnutls_datum ret = { NULL, 0 };
92    apr_file_t *fp;
93    apr_finfo_t finfo;
94    apr_status_t rv;
95    apr_size_t br = 0;
96
97    rv = apr_file_open(&fp, file, APR_READ | APR_BINARY, APR_OS_DEFAULT,
98                       pool);
99    if (rv != APR_SUCCESS) {
100        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
101                     "GnuTLS failed to load params file at: %s. Will use internal params.",
102                     file);
103        return ret;
104    }
105
106    rv = apr_file_info_get(&finfo, APR_FINFO_SIZE, fp);
107
108    if (rv != APR_SUCCESS) {
109        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
110                     "GnuTLS failed to stat params file at: %s", file);
111        return ret;
112    }
113
114    ret.data = apr_palloc(pool, finfo.size + 1);
115    rv = apr_file_read_full(fp, ret.data, finfo.size, &br);
116
117    if (rv != APR_SUCCESS) {
118        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
119                     "GnuTLS failed to read params file at: %s", file);
120        return ret;
121    }
122    apr_file_close(fp);
123    ret.data[br] = '\0';
124    ret.size = br;
125
126    return ret;
127}
128
129/* We don't support openpgp certificates, yet */
130const static int cert_type_prio[2] = { GNUTLS_CRT_X509, 0 };
131
132static int mgs_select_virtual_server_cb(gnutls_session_t session)
133{
134    mgs_handle_t *ctxt;
135    mgs_srvconf_rec *tsc;
136    int ret;
137
138    ctxt = gnutls_transport_get_ptr(session);
139
140    /* find the virtual server */
141    tsc = mgs_find_sni_server(session);
142
143    if (tsc != NULL)
144        ctxt->sc = tsc;
145
146    gnutls_certificate_server_set_request(session,
147                                          ctxt->sc->client_verify_mode);
148
149    /* set the new server credentials
150     */
151
152    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE,
153                           ctxt->sc->certs);
154
155    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
156
157    if (ctxt->sc->srp_tpasswd_conf_file != NULL
158        && ctxt->sc->srp_tpasswd_file != NULL) {
159        gnutls_credentials_set(session, GNUTLS_CRD_SRP,
160                               ctxt->sc->srp_creds);
161    }
162
163    /* update the priorities - to avoid negotiating a ciphersuite that is not
164     * enabled on this virtual server. Note that here we ignore the version
165     * negotiation.
166     */
167    ret = gnutls_priority_set(session, ctxt->sc->priorities);
168    gnutls_certificate_type_set_priority(session, cert_type_prio);
169
170
171    /* actually it shouldn't fail since we have checked at startup */
172    if (ret < 0)
173        return ret;
174
175    /* allow separate caches per virtual host. Actually allowing the same is a
176     * bad idea, since they might have different security requirements.
177     */
178    mgs_cache_session_init(ctxt);
179
180    return 0;
181}
182
183static int cert_retrieve_fn(gnutls_session_t session, gnutls_retr_st * ret)
184{
185    mgs_handle_t *ctxt;
186
187    ctxt = gnutls_transport_get_ptr(session);
188
189    ret->type = GNUTLS_CRT_X509;
190    ret->ncerts = 1;
191    ret->deinit_all = 0;
192
193    ret->cert.x509 = &ctxt->sc->cert_x509;
194    ret->key.x509 = ctxt->sc->privkey_x509;
195    return 0;
196}
197
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 cert, char **cert_cn)
214{
215    int rv = 0, i;
216    size_t data_len;
217
218
219    *cert_cn = NULL;
220
221    rv = gnutls_x509_crt_get_dn_by_oid(cert,
222                                       GNUTLS_OID_X520_COMMON_NAME,
223                                       0, 0, NULL, &data_len);
224
225    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
226        *cert_cn = apr_palloc(p, data_len);
227        rv = gnutls_x509_crt_get_dn_by_oid(cert,
228                                           GNUTLS_OID_X520_COMMON_NAME, 0,
229                                           0, *cert_cn, &data_len);
230    } else {                    /* No CN return subject alternative name */
231        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
232                     "No common name found in certificate for '%s:%d'. Looking for subject alternative name.",
233                     s->server_hostname, s->port);
234        rv = 0;
235        /* read subject alternative name */
236        for (i = 0; !(rv < 0); i++) {
237            data_len = 0;
238            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
239                                                      NULL, &data_len,
240                                                      NULL);
241
242            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
243                /* FIXME: not very efficient. What if we have several alt names
244                 * before DNSName?
245                 */
246                *cert_cn = apr_palloc(p, data_len + 1);
247
248                rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
249                                                          *cert_cn,
250                                                          &data_len, NULL);
251                (*cert_cn)[data_len] = 0;
252
253                if (rv == GNUTLS_SAN_DNSNAME)
254                    break;
255            }
256        }
257    }
258
259    return rv;
260
261}
262
263int
264mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
265                     apr_pool_t * ptemp, server_rec * base_server)
266{
267    int rv;
268    server_rec *s;
269    gnutls_dh_params_t dh_params = NULL;
270    gnutls_rsa_params_t rsa_params = NULL;
271    mgs_srvconf_rec *sc;
272    mgs_srvconf_rec *sc_base;
273    void *data = NULL;
274    int first_run = 0;
275    const char *userdata_key = "mgs_init";
276
277    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
278    if (data == NULL) {
279        first_run = 1;
280        apr_pool_userdata_set((const void *) 1, userdata_key,
281                              apr_pool_cleanup_null,
282                              base_server->process->pool);
283    }
284
285
286    {
287        gnutls_datum pdata = { NULL, 0 };
288        apr_pool_t *tpool;
289        s = base_server;
290        sc_base =
291            (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
292                                                     &gnutls_module);
293
294        apr_pool_create(&tpool, p);
295
296
297        gnutls_dh_params_init(&dh_params);
298
299        if (sc_base->dh_params_file)
300            pdata = load_params(sc_base->dh_params_file, s, tpool);
301
302        if (pdata.size != 0) {
303            rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata,
304                                               GNUTLS_X509_FMT_PEM);
305            if (rv != 0) {
306                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
307                             "GnuTLS: Unable to load DH Params: (%d) %s",
308                             rv, gnutls_strerror(rv));
309                exit(rv);
310            }
311        } else {
312            /* If the file does not exist use internal parameters
313             */
314            pdata.data = (void *) static_dh_params;
315            pdata.size = sizeof(static_dh_params);
316            rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata,
317                                               GNUTLS_X509_FMT_PEM);
318
319            if (rv < 0) {
320                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
321                             "GnuTLS: Unable to load internal DH Params."
322                             " Shutting down.");
323                exit(-1);
324            }
325        }
326        apr_pool_clear(tpool);
327
328        pdata.data = NULL;
329        pdata.size = 0;
330
331        if (sc_base->rsa_params_file)
332            pdata = load_params(sc_base->rsa_params_file, s, tpool);
333
334        if (pdata.size != 0) {
335            gnutls_rsa_params_init(&rsa_params);
336            rv = gnutls_rsa_params_import_pkcs1(rsa_params, &pdata,
337                                                GNUTLS_X509_FMT_PEM);
338            if (rv != 0) {
339                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
340                             "GnuTLS: Unable to load RSA Params: (%d) %s",
341                             rv, gnutls_strerror(rv));
342                exit(rv);
343            }
344        }
345        /* not an error but RSA-EXPORT ciphersuites are not available
346         */
347
348        apr_pool_destroy(tpool);
349        rv = mgs_cache_post_config(p, s, sc_base);
350        if (rv != 0) {
351            ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
352                         "GnuTLS: Post Config for GnuTLSCache Failed."
353                         " Shutting Down.");
354            exit(-1);
355        }
356
357        for (s = base_server; s; s = s->next) {
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            if (rsa_params != NULL)
372                gnutls_certificate_set_rsa_export_params(sc->certs,
373                                                         rsa_params);
374           
375            if (dh_params != NULL) /* not needed but anyway */
376                gnutls_certificate_set_dh_params(sc->certs, dh_params);
377
378
379            gnutls_anon_set_server_dh_params(sc->anon_creds, dh_params);
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->cert_x509 == 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->cert_x509, &sc->cert_cn);
421                if (rv < 0) {
422                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
423                                 "[GnuTLS] - Cannot find a certificate for host '%s:%d'!",
424                                 s->server_hostname, s->port);
425                    sc->cert_cn = NULL;
426                    continue;
427                }
428            }
429        }
430    }
431
432    ap_add_version_component(p, "mod_gnutls/" MOD_GNUTLS_VERSION);
433
434    return OK;
435}
436
437void mgs_hook_child_init(apr_pool_t * p, server_rec * s)
438{
439    apr_status_t rv = APR_SUCCESS;
440    mgs_srvconf_rec *sc = ap_get_module_config(s->module_config,
441                                               &gnutls_module);
442
443    if (sc->cache_type != mgs_cache_none) {
444        rv = mgs_cache_child_init(p, s, sc);
445        if (rv != APR_SUCCESS) {
446            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
447                         "[GnuTLS] - Failed to run Cache Init");
448        }
449    } else {
450        ap_log_error(APLOG_MARK, APLOG_CRIT, 0, s,
451                     "[GnuTLS] - No Cache Configured. Hint: GnuTLSCache");
452    }
453}
454
455const char *mgs_hook_http_scheme(const request_rec * r)
456{
457    mgs_srvconf_rec *sc =
458        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
459                                                 &gnutls_module);
460
461    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
462        return NULL;
463    }
464
465    return "https";
466}
467
468apr_port_t mgs_hook_default_port(const request_rec * r)
469{
470    mgs_srvconf_rec *sc =
471        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
472                                                 &gnutls_module);
473
474    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
475        return 0;
476    }
477
478    return 443;
479}
480
481#define MAX_HOST_LEN 255
482
483#if USING_2_1_RECENT
484typedef struct {
485    mgs_handle_t *ctxt;
486    mgs_srvconf_rec *sc;
487    const char *sni_name;
488} vhost_cb_rec;
489
490static int vhost_cb(void *baton, conn_rec * conn, server_rec * s)
491{
492    mgs_srvconf_rec *tsc;
493    vhost_cb_rec *x = baton;
494
495    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
496                                                   &gnutls_module);
497
498    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
499        return 0;
500    }
501
502    /* The CN can contain a * -- this will match those too. */
503    if (ap_strcasecmp_match(x->sni_name, tsc->cert_cn) == 0) {
504        /* found a match */
505#if MOD_GNUTLS_DEBUG
506        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
507                     x->ctxt->c->base_server,
508                     "GnuTLS: Virtual Host CB: "
509                     "'%s' == '%s'", tsc->cert_cn, x->sni_name);
510#endif
511        /* Because we actually change the server used here, we need to reset
512         * things like ClientVerify.
513         */
514        x->sc = tsc;
515        /* Shit. Crap. Dammit. We *really* should rehandshake here, as our
516         * certificate structure *should* change when the server changes.
517         * acccckkkkkk.
518         */
519        return 1;
520    } else {
521#if MOD_GNUTLS_DEBUG
522        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
523                     x->ctxt->c->base_server,
524                     "GnuTLS: Virtual Host CB: "
525                     "'%s' != '%s'", tsc->cert_cn, x->sni_name);
526#endif
527
528    }
529    return 0;
530}
531#endif
532
533mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session)
534{
535    int rv;
536    unsigned int sni_type;
537    size_t data_len = MAX_HOST_LEN;
538    char sni_name[MAX_HOST_LEN];
539    mgs_handle_t *ctxt;
540#if USING_2_1_RECENT
541    vhost_cb_rec cbx;
542#else
543    server_rec *s;
544    mgs_srvconf_rec *tsc;
545#endif
546
547    ctxt = gnutls_transport_get_ptr(session);
548
549    sni_type = gnutls_certificate_type_get(session);
550    if (sni_type != GNUTLS_CRT_X509) {
551        /* In theory, we could support OpenPGP Certificates. Theory != code. */
552        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
553                     ctxt->c->base_server,
554                     "GnuTLS: Only x509 Certificates are currently supported.");
555        return NULL;
556    }
557
558    rv = gnutls_server_name_get(ctxt->session, sni_name,
559                                &data_len, &sni_type, 0);
560
561    if (rv != 0) {
562        return NULL;
563    }
564
565    if (sni_type != GNUTLS_NAME_DNS) {
566        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
567                     ctxt->c->base_server,
568                     "GnuTLS: Unknown type '%d' for SNI: "
569                     "'%s'", sni_type, sni_name);
570        return NULL;
571    }
572
573    /**
574     * Code in the Core already sets up the c->base_server as the base
575     * for this IP/Port combo.  Trust that the core did the 'right' thing.
576     */
577#if USING_2_1_RECENT
578    cbx.ctxt = ctxt;
579    cbx.sc = NULL;
580    cbx.sni_name = sni_name;
581
582    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
583    if (rv == 1) {
584        return cbx.sc;
585    }
586#else
587    for (s = ap_server_conf; s; s = s->next) {
588
589        tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
590                                                       &gnutls_module);
591        if (tsc->enabled != GNUTLS_ENABLED_TRUE) {
592            continue;
593        }
594#if MOD_GNUTLS_DEBUG
595        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
596                     ctxt->c->base_server,
597                     "GnuTLS: sni-x509 cn: %s/%d pk: %s s: 0x%08X s->n: 0x%08X  sc: 0x%08X",
598                     tsc->cert_cn, rv,
599                     gnutls_pk_algorithm_get_name
600                     (gnutls_x509_privkey_get_pk_algorithm
601                      (ctxt->sc->privkey_x509)), (unsigned int) s,
602                     (unsigned int) s->next, (unsigned int) tsc);
603#endif
604        /* The CN can contain a * -- this will match those too. */
605        if (ap_strcasecmp_match(sni_name, tsc->cert_cn) == 0) {
606#if MOD_GNUTLS_DEBUG
607            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
608                         ctxt->c->base_server,
609                         "GnuTLS: Virtual Host: "
610                         "'%s' == '%s'", tsc->cert_cn, sni_name);
611#endif
612            return tsc;
613        }
614    }
615#endif
616    return NULL;
617}
618
619
620static const int protocol_priority[] = {
621    GNUTLS_TLS1_1, GNUTLS_TLS1_0, GNUTLS_SSL3, 0
622};
623
624
625static mgs_handle_t *create_gnutls_handle(apr_pool_t * pool, conn_rec * c)
626{
627    mgs_handle_t *ctxt;
628    mgs_srvconf_rec *sc =
629        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
630                                                 module_config,
631                                                 &gnutls_module);
632
633    ctxt = apr_pcalloc(pool, sizeof(*ctxt));
634    ctxt->c = c;
635    ctxt->sc = sc;
636    ctxt->status = 0;
637
638    ctxt->input_rc = APR_SUCCESS;
639    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
640    ctxt->input_cbuf.length = 0;
641
642    ctxt->output_rc = APR_SUCCESS;
643    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
644    ctxt->output_blen = 0;
645    ctxt->output_length = 0;
646
647    gnutls_init(&ctxt->session, GNUTLS_SERVER);
648
649    /* because we don't set any default priorities here (we set later at
650     * the user hello callback) we need to at least set this in order for
651     * gnutls to be able to read packets.
652     */
653    gnutls_protocol_set_priority(ctxt->session, protocol_priority);
654
655    gnutls_handshake_set_post_client_hello_function(ctxt->session,
656                                                    mgs_select_virtual_server_cb);
657
658    return ctxt;
659}
660
661int mgs_hook_pre_connection(conn_rec * c, void *csd)
662{
663    mgs_handle_t *ctxt;
664    mgs_srvconf_rec *sc =
665        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
666                                                 module_config,
667                                                 &gnutls_module);
668
669    if (!(sc && (sc->enabled == GNUTLS_ENABLED_TRUE))) {
670        return DECLINED;
671    }
672
673    ctxt = create_gnutls_handle(c->pool, c);
674
675    ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
676
677    gnutls_transport_set_pull_function(ctxt->session, mgs_transport_read);
678    gnutls_transport_set_push_function(ctxt->session, mgs_transport_write);
679    gnutls_transport_set_ptr(ctxt->session, ctxt);
680
681    ctxt->input_filter =
682        ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME, ctxt, NULL, c);
683    ctxt->output_filter =
684        ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME, ctxt, NULL, c);
685
686    return OK;
687}
688
689int mgs_hook_fixups(request_rec * r)
690{
691    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
692    char buf[AP_IOBUFSIZE];
693    const char *tmp;
694    size_t len;
695    mgs_handle_t *ctxt;
696    int rv = OK;
697
698    apr_table_t *env = r->subprocess_env;
699
700    ctxt =
701        ap_get_module_config(r->connection->conn_config, &gnutls_module);
702
703    if (!ctxt) {
704        return DECLINED;
705    }
706
707    apr_table_setn(env, "HTTPS", "on");
708
709    apr_table_setn(env, "SSL_VERSION_LIBRARY",
710                   "GnuTLS/" LIBGNUTLS_VERSION);
711    apr_table_setn(env, "SSL_VERSION_INTERFACE",
712                   "mod_gnutls/" MOD_GNUTLS_VERSION);
713
714    apr_table_setn(env, "SSL_PROTOCOL",
715                   gnutls_protocol_get_name(gnutls_protocol_get_version
716                                            (ctxt->session)));
717
718    /* should have been called SSL_CIPHERSUITE instead */
719    apr_table_setn(env, "SSL_CIPHER",
720                   gnutls_cipher_suite_get_name(gnutls_kx_get
721                                                (ctxt->session),
722                                                gnutls_cipher_get(ctxt->
723                                                                  session),
724                                                gnutls_mac_get(ctxt->
725                                                               session)));
726
727    apr_table_setn(env, "SSL_COMPRESS_METHOD",
728                   gnutls_compression_get_name(gnutls_compression_get
729                                               (ctxt->session)));
730
731    apr_table_setn(env, "SSL_SRP_USER",
732                   gnutls_srp_server_get_username(ctxt->session));
733
734    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
735        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
736
737    unsigned int key_size =
738        8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
739    tmp = apr_psprintf(r->pool, "%u", key_size);
740
741    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
742
743    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
744
745    apr_table_setn(env, "SSL_CIPHER_EXPORT",
746                   (key_size <= 40) ? "true" : "false");
747
748    len = sizeof(sbuf);
749    gnutls_session_get_id(ctxt->session, sbuf, &len);
750    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
751    apr_table_setn(env, "SSL_SESSION_ID", apr_pstrdup(r->pool, tmp));
752
753    mgs_add_common_cert_vars(r, ctxt->sc->cert_x509, 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 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, "_S_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_SAN%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_SAN%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_SAN%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_SAN%u", MGS_SIDE, i), 
917                       "UNSUPPORTED");
918            }
919        }
920    }
921
922
923}
924
925
926static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt)
927{
928    const gnutls_datum_t *cert_list;
929    unsigned int cert_list_size, status, expired;
930    int rv, ret;
931    gnutls_x509_crt_t cert;
932    apr_time_t activation_time, expiration_time, cur_time;
933
934    cert_list =
935        gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
936
937    if (cert_list == NULL || cert_list_size == 0) {
938        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
939         */
940        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
941            return OK;
942
943        /* no certificate provided by the client, but one was required. */
944        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
945                      "GnuTLS: Failed to Verify Peer: "
946                      "Client did not submit a certificate");
947        return HTTP_FORBIDDEN;
948    }
949
950    if (cert_list_size > 1) {
951        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
952                      "GnuTLS: Failed to Verify Peer: "
953                      "Chained Client Certificates are not supported.");
954        return HTTP_FORBIDDEN;
955    }
956
957    gnutls_x509_crt_init(&cert);
958    rv = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
959    if (rv < 0) {
960        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
961                      "GnuTLS: Failed to Verify Peer: "
962                      "Failed to import peer certificates.");
963        ret = HTTP_FORBIDDEN;
964        goto exit;
965    }
966
967    apr_time_ansi_put(&expiration_time,
968                      gnutls_x509_crt_get_expiration_time(cert));
969    apr_time_ansi_put(&activation_time,
970                      gnutls_x509_crt_get_activation_time(cert));
971
972    rv = gnutls_x509_crt_verify(cert, ctxt->sc->ca_list,
973                                ctxt->sc->ca_list_size, 0, &status);
974
975    if (rv < 0) {
976        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
977                      "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
978                      rv, gnutls_strerror(rv));
979        ret = HTTP_FORBIDDEN;
980        goto exit;
981    }
982
983    expired = 0;
984    cur_time = apr_time_now();
985    if (activation_time > cur_time) {
986        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
987                      "GnuTLS: Failed to Verify Peer: "
988                      "Peer Certificate is not yet activated.");
989        expired = 1;
990    }
991
992    if (expiration_time < cur_time) {
993        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
994                      "GnuTLS: Failed to Verify Peer: "
995                      "Peer Certificate is expired.");
996        expired = 1;
997    }
998
999    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1000        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1001                      "GnuTLS: Could not find Signer for Peer Certificate");
1002    }
1003
1004    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1005        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1006                      "GnuTLS: Peer's Certificate signer is not a CA");
1007    }
1008
1009    if (status & GNUTLS_CERT_INVALID) {
1010        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1011                      "GnuTLS: Peer Certificate is invalid.");
1012    } else if (status & GNUTLS_CERT_REVOKED) {
1013        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1014                      "GnuTLS: Peer Certificate is revoked.");
1015    }
1016
1017    /* TODO: Further Verification. */
1018    /* Revocation is X.509 non workable paradigm, I really doubt implementation
1019     * is worth doing --nmav
1020     */
1021/// ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size);
1022
1023//    mgs_hook_fixups(r);
1024//    rv = mgs_authz_lua(r);
1025
1026    mgs_add_common_cert_vars(r, cert, 1,
1027                             ctxt->sc->export_certificates_enabled);
1028
1029    {
1030        /* days remaining */
1031        unsigned long remain =
1032            (apr_time_sec(expiration_time) -
1033             apr_time_sec(cur_time)) / 86400;
1034        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1035                       apr_psprintf(r->pool, "%lu", remain));
1036    }
1037
1038    if (status == 0 && expired == 0) {
1039        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "SUCCESS");
1040        ret = OK;
1041    } else {
1042        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "FAILED");
1043        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1044            ret = OK;
1045        else
1046            ret = HTTP_FORBIDDEN;
1047    }
1048
1049  exit:
1050    gnutls_x509_crt_deinit(cert);
1051    return ret;
1052
1053
1054}
Note: See TracBrowser for help on using the repository browser.