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

debian/masterdebian/stretch-backportsjessie-backportsmsvaproxy-ticketupstream
Last change on this file since 8bd529f was 8bd529f, checked in by Nokis Mavrogiannopoulos <nmav@…>, 13 years ago

print error if preconfiguration fails

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