source: mod_gnutls/src/gnutls_hooks.c @ 031acac

debian/masterdebian/stretch-backportsjessie-backportsupstream
Last change on this file since 031acac was 031acac, checked in by Nikos Mavrogiannopoulos <nmav@…>, 5 years ago

Use the new (3.1.3+) GnuTLS APIs to obtain private keys.

This allows the loading a private key from a PKCS #11 or a TPM URL
(the GnuTLSPIN and GnuTLSSRKPIN variables should be set), and loading
encrypted private keys in PKCS #8, PKCS #12 or openssl format.

  • Property mode set to 100644
File size: 50.3 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2008 Nikos Mavrogiannopoulos
4 *  Copyright 2011 Dash Shendy
5 *  Copyright 2013-2014 Daniel Kahn Gillmor
6 *
7 *  Licensed under the Apache License, Version 2.0 (the "License");
8 *  you may not use this file except in compliance with the License.
9 *  You may obtain a copy of the License at
10 *
11 *      http://www.apache.org/licenses/LICENSE-2.0
12 *
13 *  Unless required by applicable law or agreed to in writing, software
14 *  distributed under the License is distributed on an "AS IS" BASIS,
15 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 *  See the License for the specific language governing permissions and
17 *  limitations under the License.
18 *
19 */
20
21#include "mod_gnutls.h"
22#include "http_vhost.h"
23#include "ap_mpm.h"
24#include "mod_status.h"
25
26#ifdef ENABLE_MSVA
27#include <msv/msv.h>
28#endif
29
30#ifdef APLOG_USE_MODULE
31APLOG_USE_MODULE(gnutls);
32#endif
33
34#if !USING_2_1_RECENT
35extern server_rec *ap_server_conf;
36#endif
37
38#if MOD_GNUTLS_DEBUG
39static apr_file_t *debug_log_fp;
40#endif
41
42static gnutls_datum_t session_ticket_key = {NULL, 0};
43
44static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
45/* use side==0 for server and side==1 for client */
46static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, int export_cert_size);
47static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, int export_cert_size);
48static const char* mgs_x509_construct_uid(request_rec * pool, gnutls_x509_crt_t cert);
49static int mgs_status_hook(request_rec *r, int flags);
50
51/* Pool Cleanup Function */
52apr_status_t mgs_cleanup_pre_config(void *data) {
53        /* Free all session data */
54    gnutls_free(session_ticket_key.data);
55    session_ticket_key.data = NULL;
56    session_ticket_key.size = 0;
57        /* Deinitialize GnuTLS Library */
58    gnutls_global_deinit();
59    return APR_SUCCESS;
60}
61
62/* Logging Function for Maintainers */
63#if MOD_GNUTLS_DEBUG
64static void gnutls_debug_log_all(int level, const char *str) {
65    apr_file_printf(debug_log_fp, "<%d> %s", level, str);
66}
67#define _gnutls_log apr_file_printf
68#else
69#define _gnutls_log(...)
70#endif
71
72static const char* mgs_readable_cvm(mgs_client_verification_method_e m) {
73    switch(m) {
74    case mgs_cvm_unset:
75        return "unset";
76    case mgs_cvm_cartel:
77        return "cartel";
78    case mgs_cvm_msva:
79        return "msva";
80    }
81    return "unknown";
82}
83
84/* Pre-Configuration HOOK: Runs First */
85int mgs_hook_pre_config(apr_pool_t * pconf, apr_pool_t * plog, apr_pool_t * ptemp) {
86
87/* Maintainer Logging */
88#if MOD_GNUTLS_DEBUG
89    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug", APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, pconf);
90    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
91    gnutls_global_set_log_level(9);
92    gnutls_global_set_log_function(gnutls_debug_log_all);
93    _gnutls_log(debug_log_fp, "gnutls: %s\n", gnutls_check_version(NULL));
94#endif
95
96    int ret;
97
98        /* Check for required GnuTLS Library Version */
99    if (gnutls_check_version(LIBGNUTLS_VERSION) == NULL) {
100                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_check_version() failed. Required: "
101                                        "gnutls-%s Found: gnutls-%s", LIBGNUTLS_VERSION, gnutls_check_version(NULL));
102        return DONE;
103    }
104
105        /* Initialize GnuTLS Library */
106    ret = gnutls_global_init();
107    if (ret < 0) {
108                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_global_init: %s", gnutls_strerror(ret));
109                return DONE;
110    }
111
112        /* Generate a Session Key */
113    ret = gnutls_session_ticket_key_generate(&session_ticket_key);
114    if (ret < 0) {
115                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_session_ticket_key_generate: %s", gnutls_strerror(ret));
116                return DONE;
117    }
118
119    AP_OPTIONAL_HOOK(status_hook, mgs_status_hook, NULL, NULL, APR_HOOK_MIDDLE);
120
121        /* Register a pool clean-up function */
122    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config, apr_pool_cleanup_null);
123
124    return OK;
125}
126
127static int mgs_select_virtual_server_cb(gnutls_session_t session) {
128
129    mgs_handle_t *ctxt = NULL;
130    mgs_srvconf_rec *tsc = NULL;
131    int ret = 0;
132
133    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
134
135    ctxt = gnutls_transport_get_ptr(session);
136
137    /* find the virtual server */
138    tsc = mgs_find_sni_server(session);
139
140    if (tsc != NULL) {
141        // Found a TLS vhost based on the SNI from the client; use it instead.
142        ctxt->sc = tsc;
143        }
144
145    gnutls_certificate_server_set_request(session, ctxt->sc->client_verify_mode);
146
147    /* Set Anon credentials */
148    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, ctxt->sc->certs);
149        /* Set x509 credentials */
150    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
151
152#ifdef ENABLE_SRP
153        /* Set SRP credentials */
154    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
155        gnutls_credentials_set(session, GNUTLS_CRD_SRP, ctxt->sc->srp_creds);
156    }
157#endif
158
159    /* update the priorities - to avoid negotiating a ciphersuite that is not
160     * enabled on this virtual server. Note that here we ignore the version
161     * negotiation.
162     */
163
164    ret = gnutls_priority_set(session, ctxt->sc->priorities);
165    /* actually it shouldn't fail since we have checked at startup */
166    return ret;
167
168}
169
170static int cert_retrieve_fn(gnutls_session_t session,
171                            const gnutls_datum_t * req_ca_rdn, int nreqs,
172                            const gnutls_pk_algorithm_t * pk_algos, int pk_algos_length,
173                            gnutls_pcert_st **pcerts, unsigned int *pcert_length,
174                            gnutls_privkey_t *privkey)
175{
176    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
177
178    mgs_handle_t *ctxt;
179
180    if (session == NULL) {
181                // ERROR INVALID SESSION
182        return -1;
183    }
184
185    ctxt = gnutls_transport_get_ptr(session);
186
187    if (gnutls_certificate_type_get(session) == GNUTLS_CRT_X509) {
188                // X509 CERTIFICATE
189        *pcerts = ctxt->sc->certs_x509_chain;
190        *pcert_length = ctxt->sc->certs_x509_chain_num;
191        *privkey = ctxt->sc->privkey_x509;
192        return 0;
193    } else if (gnutls_certificate_type_get(session) == GNUTLS_CRT_OPENPGP) {
194                // OPENPGP CERTIFICATE
195        *pcerts = ctxt->sc->cert_pgp;
196        *pcert_length = 1;
197        *privkey = ctxt->sc->privkey_pgp;
198        return 0;
199    } else {
200                // UNKNOWN CERTIFICATE
201            return -1;
202        }
203}
204
205/* Read the common name or the alternative name of the certificate.
206 * We only support a single name per certificate.
207 *
208 * Returns negative on error.
209 */
210static int read_crt_cn(server_rec * s, apr_pool_t * p, gnutls_x509_crt_t cert, char **cert_cn) {
211
212    int rv = 0, i;
213    size_t data_len;
214
215
216    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
217    *cert_cn = NULL;
218
219    data_len = 0;
220    rv = gnutls_x509_crt_get_dn_by_oid(cert, GNUTLS_OID_X520_COMMON_NAME, 0, 0, NULL, &data_len);
221
222    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
223        *cert_cn = apr_palloc(p, data_len);
224        rv = gnutls_x509_crt_get_dn_by_oid(cert,
225                GNUTLS_OID_X520_COMMON_NAME,
226                0, 0, *cert_cn,
227                &data_len);
228    } else { /* No CN return subject alternative name */
229        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
230                "No common name found in certificate for '%s:%d'. Looking for subject alternative name...",
231                s->server_hostname, s->port);
232        rv = 0;
233        /* read subject alternative name */
234        for (i = 0; !(rv < 0); i++) {
235            data_len = 0;
236            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
237                    NULL,
238                    &data_len,
239                    NULL);
240
241            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER
242                    && 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
249                        (cert, i, *cert_cn, &data_len, NULL);
250                (*cert_cn)[data_len] = 0;
251
252                if (rv == GNUTLS_SAN_DNSNAME)
253                    break;
254            }
255        }
256    }
257
258    return rv;
259}
260
261static int read_pgpcrt_cn(server_rec * s, apr_pool_t * p,
262        gnutls_openpgp_crt_t cert, char **cert_cn) {
263    int rv = 0;
264    size_t data_len;
265
266
267    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
268    *cert_cn = NULL;
269
270    data_len = 0;
271    rv = gnutls_openpgp_crt_get_name(cert, 0, NULL, &data_len);
272
273    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
274        *cert_cn = apr_palloc(p, data_len);
275        rv = gnutls_openpgp_crt_get_name(cert, 0, *cert_cn,
276                &data_len);
277    } else { /* No CN return subject alternative name */
278        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
279                "No name found in PGP certificate for '%s:%d'.",
280                s->server_hostname, s->port);
281    }
282
283    return rv;
284}
285
286int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog, apr_pool_t * ptemp, server_rec * base_server) {
287
288    int rv;
289    server_rec *s;
290    gnutls_dh_params_t dh_params = NULL;
291    mgs_srvconf_rec *sc;
292    mgs_srvconf_rec *sc_base;
293    void *data = NULL;
294    const char *userdata_key = "mgs_init";
295
296    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
297
298    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
299    if (data == NULL) {
300        apr_pool_userdata_set((const void *) 1, userdata_key, apr_pool_cleanup_null, base_server->process->pool);
301    }
302
303    s = base_server;
304    sc_base = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
305
306
307    rv = mgs_cache_post_config(p, s, sc_base);
308    if (rv != 0) {
309        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
310                "GnuTLS: Post Config for GnuTLSCache Failed."
311                " Shutting Down.");
312        exit(-1);
313    }
314
315    for (s = base_server; s; s = s->next) {
316        sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
317        sc->cache_type = sc_base->cache_type;
318        sc->cache_config = sc_base->cache_config;
319        sc->cache_timeout = sc_base->cache_timeout;
320
321        rv = mgs_load_files(p, s);
322        if (rv != 0) {
323            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
324                "GnuTLS: Loading required files failed."
325                " Shutting Down.");
326            exit(-1);
327        }
328
329        /* defaults for unset values: */
330        if (sc->enabled == GNUTLS_ENABLED_UNSET)
331            sc->enabled = GNUTLS_ENABLED_FALSE;
332        if (sc->tickets == GNUTLS_ENABLED_UNSET)
333            sc->tickets = GNUTLS_ENABLED_TRUE;
334        if (sc->export_certificates_size < 0)
335            sc->export_certificates_size = 0;
336        if (sc->client_verify_mode ==  -1)
337            sc->client_verify_mode = GNUTLS_CERT_IGNORE;
338        if (sc->client_verify_method ==  mgs_cvm_unset)
339            sc->client_verify_method = mgs_cvm_cartel;
340
341        /* Check if the priorities have been set */
342        if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
343            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
344                    "GnuTLS: Host '%s:%d' is missing the GnuTLSPriorities directive!",
345                    s->server_hostname, s->port);
346            exit(-1);
347        }
348
349        /* Check if DH params have been set per host */
350        if (sc->dh_params != NULL) {
351            gnutls_certificate_set_dh_params(sc->certs, sc->dh_params);
352            gnutls_anon_set_server_dh_params(sc->anon_creds, sc->dh_params);
353        } else if (dh_params) {
354            gnutls_certificate_set_dh_params(sc->certs, dh_params);
355            gnutls_anon_set_server_dh_params(sc->anon_creds, dh_params);
356        }
357
358        gnutls_certificate_set_retrieve_function2(sc->certs, cert_retrieve_fn);
359
360        if ((sc->certs_x509_chain == NULL || sc->certs_x509_chain_num < 1) &&
361            sc->cert_pgp == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
362                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
363                                                "GnuTLS: Host '%s:%d' is missing a Certificate File!",
364                                                s->server_hostname, s->port);
365            exit(-1);
366        }
367        if (sc->enabled == GNUTLS_ENABLED_TRUE &&
368            ((sc->certs_x509_chain_num > 0 && sc->privkey_x509 == NULL) ||
369             (sc->cert_crt_pgp[0] != NULL && sc->privkey_pgp == NULL))) {
370                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
371                                                "GnuTLS: Host '%s:%d' is missing a Private Key File!",
372                                                s->server_hostname, s->port);
373            exit(-1);
374        }
375
376        if (sc->enabled == GNUTLS_ENABLED_TRUE) {
377            rv = -1;
378            if (sc->certs_x509_chain_num > 0) {
379                rv = read_crt_cn(s, p, sc->certs_x509_crt_chain[0], &sc->cert_cn);
380            }
381            if (rv < 0 && sc->cert_pgp != NULL) {
382                rv = read_pgpcrt_cn(s, p, sc->cert_crt_pgp[0], &sc->cert_cn);
383                        }
384
385            if (rv < 0) {
386                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
387                                                        "GnuTLS: Cannot find a certificate for host '%s:%d'!",
388                                                        s->server_hostname, s->port);
389                sc->cert_cn = NULL;
390                continue;
391            }
392        }
393    }
394
395
396    ap_add_version_component(p, "mod_gnutls/" MOD_GNUTLS_VERSION);
397
398    {
399        const char* libvers = gnutls_check_version(NULL);
400        char* gnutls_version = NULL;
401        if(libvers && (gnutls_version = apr_psprintf(p, "GnuTLS/%s", libvers))) {
402            ap_add_version_component(p, gnutls_version);
403        } else {
404            // In case we could not create the above string go for the static version instead
405            ap_add_version_component(p, "GnuTLS/" GNUTLS_VERSION "-static");
406        }
407    }
408
409    return OK;
410}
411
412void mgs_hook_child_init(apr_pool_t * p, server_rec *s) {
413    apr_status_t rv = APR_SUCCESS;
414    mgs_srvconf_rec *sc =
415        (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
416
417    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
418    /* if we use PKCS #11 reinitialize it */
419
420    if (mgs_pkcs11_reinit(s) < 0) {
421            ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
422                    "GnuTLS: Failed to reinitialize PKCS #11");
423            exit(-1);
424    }
425
426    if (sc->cache_type != mgs_cache_none) {
427        rv = mgs_cache_child_init(p, s, sc);
428        if (rv != APR_SUCCESS) {
429            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
430                    "GnuTLS: Failed to run Cache Init");
431        }
432    }
433    /* Block SIGPIPE Signals */
434    rv = apr_signal_block(SIGPIPE);
435    if(rv != APR_SUCCESS) {
436        /* error sending output */
437        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
438                "GnuTLS: Error Blocking SIGPIPE Signal!");
439    }
440}
441
442const char *mgs_hook_http_scheme(const request_rec * r) {
443    mgs_srvconf_rec *sc;
444
445    if (r == NULL)
446        return NULL;
447
448    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
449            server->module_config,
450            &gnutls_module);
451
452    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
453    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
454        return NULL;
455    }
456
457    return "https";
458}
459
460apr_port_t mgs_hook_default_port(const request_rec * r) {
461    mgs_srvconf_rec *sc;
462
463    if (r == NULL)
464        return 0;
465
466    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
467            server->module_config,
468            &gnutls_module);
469
470    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
471    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
472        return 0;
473    }
474
475    return 443;
476}
477
478#define MAX_HOST_LEN 255
479
480#if USING_2_1_RECENT
481
482typedef struct {
483    mgs_handle_t *ctxt;
484    mgs_srvconf_rec *sc;
485    const char *sni_name;
486} vhost_cb_rec;
487
488/**
489 * Matches the current vhost's ServerAlias directives
490 *
491 * @param x vhost callback record
492 * @param s server record
493 * @return true if a match, false otherwise
494 *
495 */
496int check_server_aliases(vhost_cb_rec *x, server_rec * s, mgs_srvconf_rec *tsc) {
497        apr_array_header_t *names;
498        int i,rv = 0;
499        char ** name;
500
501        /* Check ServerName First! */
502        if(apr_strnatcasecmp(x->sni_name, s->server_hostname) == 0) {
503                // We have a match, save this server configuration
504                x->sc = tsc;
505                rv = 1;
506        /* Check any ServerAlias directives */
507        } else if(s->names->nelts) {
508                names = s->names;
509                name = (char **)names->elts;
510                for (i = 0; i < names->nelts; ++i) {
511                        if (!name[i]) { continue; }
512                                if (apr_strnatcasecmp(x->sni_name, name[i]) == 0) {
513                                        // We have a match, save this server configuration
514                                        x->sc = tsc;
515                                        rv = 1;
516                        }
517                }
518        /* Wild any ServerAlias Directives */
519        } else if(s->wild_names->nelts) {
520                names = s->wild_names;
521        name = (char **)names->elts;
522                for (i = 0; i < names->nelts; ++i) {
523                        if (!name[i]) { continue; }
524                                if(apr_fnmatch(name[i], x->sni_name ,
525                                                                APR_FNM_CASE_BLIND|
526                                                                APR_FNM_PERIOD|
527                                                                APR_FNM_PATHNAME|
528                                                                APR_FNM_NOESCAPE) == APR_SUCCESS) {
529                                x->sc = tsc;
530                                rv = 1;
531                        }
532                }
533        }
534        return rv;
535}
536
537static int vhost_cb(void *baton, conn_rec * conn, server_rec * s) {
538    mgs_srvconf_rec *tsc;
539    vhost_cb_rec *x = baton;
540    int ret;
541
542    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
543    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
544            &gnutls_module);
545
546    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
547        return 0;
548    }
549
550    if (tsc->certs_x509_chain_num > 0) {
551        /* this check is there to warn administrator of any missing hostname
552         * in the certificate. */
553        ret = gnutls_x509_crt_check_hostname(tsc->certs_x509_crt_chain[0], s->server_hostname);
554        if (0 == ret)
555            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
556                         "GnuTLS: the certificate doesn't match requested hostname "
557                         "'%s'", s->server_hostname);
558    } else {
559        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
560                     "GnuTLS: SNI request for '%s' but no X.509 certs available at all",
561                     s->server_hostname);
562    }
563        return check_server_aliases(x, s, tsc);
564}
565#endif
566
567mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session) {
568    int rv;
569    unsigned int sni_type;
570    size_t data_len = MAX_HOST_LEN;
571    char sni_name[MAX_HOST_LEN];
572    mgs_handle_t *ctxt;
573#if USING_2_1_RECENT
574    vhost_cb_rec cbx;
575#else
576    server_rec *s;
577    mgs_srvconf_rec *tsc;
578#endif
579
580    if (session == NULL)
581        return NULL;
582
583    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
584    ctxt = gnutls_transport_get_ptr(session);
585
586    rv = gnutls_server_name_get(ctxt->session, sni_name,
587            &data_len, &sni_type, 0);
588
589    if (rv != 0) {
590        return NULL;
591    }
592
593    if (sni_type != GNUTLS_NAME_DNS) {
594        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
595                ctxt->c->base_server,
596                "GnuTLS: Unknown type '%d' for SNI: "
597                "'%s'", sni_type, sni_name);
598        return NULL;
599    }
600
601    /**
602     * Code in the Core already sets up the c->base_server as the base
603     * for this IP/Port combo.  Trust that the core did the 'right' thing.
604     */
605#if USING_2_1_RECENT
606    cbx.ctxt = ctxt;
607    cbx.sc = NULL;
608    cbx.sni_name = sni_name;
609
610    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
611    if (rv == 1) {
612        return cbx.sc;
613    }
614#else
615    for (s = ap_server_conf; s; s = s->next) {
616
617        tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
618                &gnutls_module);
619
620        if (tsc->enabled != GNUTLS_ENABLED_TRUE) { continue; }
621
622                                if(check_server_aliases(x, s, tsc)) {
623                                        return tsc;
624                                }
625#endif
626    return NULL;
627}
628
629static void create_gnutls_handle(conn_rec * c) {
630    mgs_handle_t *ctxt;
631    /* Get mod_gnutls Configuration Record */
632    mgs_srvconf_rec *sc =(mgs_srvconf_rec *)
633            ap_get_module_config(c->base_server->module_config,&gnutls_module);
634
635    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
636    ctxt = apr_pcalloc(c->pool, sizeof (*ctxt));
637    ctxt->c = c;
638    ctxt->sc = sc;
639    ctxt->status = 0;
640    ctxt->input_rc = APR_SUCCESS;
641    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
642    ctxt->input_cbuf.length = 0;
643    ctxt->output_rc = APR_SUCCESS;
644    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
645    ctxt->output_blen = 0;
646    ctxt->output_length = 0;
647    /* Initialize GnuTLS Library */
648    gnutls_init(&ctxt->session, GNUTLS_SERVER);
649    /* Initialize Session Tickets */
650    if (session_ticket_key.data != NULL && ctxt->sc->tickets != 0) {
651        gnutls_session_ticket_enable_server(ctxt->session,&session_ticket_key);
652    }
653
654    /* Set Default Priority */
655        gnutls_priority_set_direct (ctxt->session, "NORMAL", NULL);
656    /* Set Handshake function */
657    gnutls_handshake_set_post_client_hello_function(ctxt->session,
658            mgs_select_virtual_server_cb);
659    /* Initialize Session Cache */
660    mgs_cache_session_init(ctxt);
661
662    /* Set this config for this connection */
663    ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
664    /* Set pull, push & ptr functions */
665    gnutls_transport_set_pull_function(ctxt->session,
666            mgs_transport_read);
667    gnutls_transport_set_push_function(ctxt->session,
668            mgs_transport_write);
669    gnutls_transport_set_ptr(ctxt->session, ctxt);
670    /* Add IO filters */
671    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME,
672            ctxt, NULL, c);
673    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
674            ctxt, NULL, c);
675}
676
677int mgs_hook_pre_connection(conn_rec * c, void *csd) {
678    mgs_srvconf_rec *sc;
679
680    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
681
682    sc = (mgs_srvconf_rec *) ap_get_module_config(c->base_server->module_config,
683            &gnutls_module);
684
685    if (sc && (!sc->enabled || sc->proxy_enabled == GNUTLS_ENABLED_TRUE)) {
686        return DECLINED;
687    }
688
689    create_gnutls_handle(c);
690    return OK;
691}
692
693int mgs_hook_fixups(request_rec * r) {
694    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
695    char buf[AP_IOBUFSIZE];
696    const char *tmp;
697    size_t len;
698    mgs_handle_t *ctxt;
699    int rv = OK;
700
701    if (r == NULL)
702        return DECLINED;
703
704    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
705    apr_table_t *env = r->subprocess_env;
706
707    ctxt =
708            ap_get_module_config(r->connection->conn_config,
709            &gnutls_module);
710
711    if (!ctxt || ctxt->session == NULL) {
712        return DECLINED;
713    }
714
715    apr_table_setn(env, "HTTPS", "on");
716
717    apr_table_setn(env, "SSL_VERSION_LIBRARY",
718            "GnuTLS/" LIBGNUTLS_VERSION);
719    apr_table_setn(env, "SSL_VERSION_INTERFACE",
720            "mod_gnutls/" MOD_GNUTLS_VERSION);
721
722    apr_table_setn(env, "SSL_PROTOCOL",
723            gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
724
725    /* should have been called SSL_CIPHERSUITE instead */
726    apr_table_setn(env, "SSL_CIPHER",
727            gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
728                                         gnutls_cipher_get(ctxt->session),
729                                         gnutls_mac_get(ctxt->session)));
730
731    apr_table_setn(env, "SSL_COMPRESS_METHOD",
732            gnutls_compression_get_name(gnutls_compression_get(ctxt->session)));
733
734#ifdef ENABLE_SRP
735    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
736        tmp = gnutls_srp_server_get_username(ctxt->session);
737        apr_table_setn(env, "SSL_SRP_USER", (tmp != NULL) ? tmp : "");
738    } else {
739        apr_table_unset(env, "SSL_SRP_USER");
740    }
741#endif
742
743    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
744        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
745
746    unsigned int key_size = 8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
747    tmp = apr_psprintf(r->pool, "%u", key_size);
748
749    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
750
751    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
752
753    apr_table_setn(env, "SSL_CIPHER_EXPORT",
754            (key_size <= 40) ? "true" : "false");
755
756    int dhsize = gnutls_dh_get_prime_bits(ctxt->session);
757    if (dhsize > 0) {
758        tmp = apr_psprintf(r->pool, "%d", dhsize);
759        apr_table_setn(env, "SSL_DH_PRIME_BITS", tmp);
760    }
761
762    len = sizeof (sbuf);
763    gnutls_session_get_id(ctxt->session, sbuf, &len);
764    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
765    apr_table_setn(env, "SSL_SESSION_ID", apr_pstrdup(r->pool, tmp));
766
767    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
768        mgs_add_common_cert_vars(r, ctxt->sc->certs_x509_crt_chain[0], 0, ctxt->sc->export_certificates_size);
769    } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
770        mgs_add_common_pgpcert_vars(r, ctxt->sc->cert_crt_pgp[0], 0, ctxt->sc->export_certificates_size);
771    }
772
773    return rv;
774}
775
776int mgs_hook_authz(request_rec * r) {
777    int rv;
778    mgs_handle_t *ctxt;
779    mgs_dirconf_rec *dc;
780
781    if (r == NULL)
782        return DECLINED;
783
784    dc = ap_get_module_config(r->per_dir_config, &gnutls_module);
785
786    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
787    ctxt =
788            ap_get_module_config(r->connection->conn_config,
789            &gnutls_module);
790
791    if (!ctxt || ctxt->session == NULL) {
792        return DECLINED;
793    }
794
795    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
796        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
797                "GnuTLS: Directory set to Ignore Client Certificate!");
798    } else {
799        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
800            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
801                    "GnuTLS: Attempting to rehandshake with peer. %d %d",
802                    ctxt->sc->client_verify_mode,
803                    dc->client_verify_mode);
804
805            /* If we already have a client certificate, there's no point in
806             * re-handshaking... */
807            rv = mgs_cert_verify(r, ctxt);
808            if (rv != DECLINED && rv != HTTP_FORBIDDEN)
809                return rv;
810
811            gnutls_certificate_server_set_request
812                    (ctxt->session, dc->client_verify_mode);
813
814            if (mgs_rehandshake(ctxt) != 0) {
815                return HTTP_FORBIDDEN;
816            }
817        } else if (ctxt->sc->client_verify_mode ==
818                GNUTLS_CERT_IGNORE) {
819#if MOD_GNUTLS_DEBUG
820            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
821                    "GnuTLS: Peer is set to IGNORE");
822#endif
823            return DECLINED;
824        }
825        rv = mgs_cert_verify(r, ctxt);
826        if (rv != DECLINED &&
827                (rv != HTTP_FORBIDDEN ||
828                dc->client_verify_mode == GNUTLS_CERT_REQUIRE)) {
829            return rv;
830        }
831    }
832
833    return DECLINED;
834}
835
836/* variables that are not sent by default:
837 *
838 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
839 * SSL_SERVER_CERT      string  PEM-encoded client certificate
840 */
841
842/* @param side is either 0 for SERVER or 1 for CLIENT
843 *
844 * @param export_cert_size (int) maximum size for environment variable
845 * to use for the PEM-encoded certificate (0 means do not export)
846 */
847#define MGS_SIDE(suffix) ((side==0) ? "SSL_SERVER" suffix : "SSL_CLIENT" suffix)
848
849static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, int export_cert_size) {
850    unsigned char sbuf[64]; /* buffer to hold serials */
851    char buf[AP_IOBUFSIZE];
852    const char *tmp;
853    char *tmp2;
854    size_t len;
855    int ret, i;
856
857    if (r == NULL)
858        return;
859
860    apr_table_t *env = r->subprocess_env;
861
862    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
863    if (export_cert_size > 0) {
864        len = 0;
865        ret = gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, NULL, &len);
866        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
867            if (len >= export_cert_size) {
868                apr_table_setn(env, MGS_SIDE("_CERT"), "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
869                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
870                              "GnuTLS: Failed to export too-large X.509 certificate to environment");
871            } else {
872                char* cert_buf = apr_palloc(r->pool, len + 1);
873                if (cert_buf != NULL && gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0) {
874                    cert_buf[len] = 0;
875                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
876                } else {
877                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
878                                  "GnuTLS: failed to export X.509 certificate");
879                }
880            }
881        } else {
882            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
883                          "GnuTLS: dazed and confused about X.509 certificate size");
884        }
885    }
886
887    len = sizeof (buf);
888    gnutls_x509_crt_get_dn(cert, buf, &len);
889    apr_table_setn(env, MGS_SIDE("_S_DN"), apr_pstrmemdup(r->pool, buf, len));
890
891    len = sizeof (buf);
892    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
893    apr_table_setn(env, MGS_SIDE("_I_DN"), apr_pstrmemdup(r->pool, buf, len));
894
895    len = sizeof (sbuf);
896    gnutls_x509_crt_get_serial(cert, sbuf, &len);
897    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
898    apr_table_setn(env, MGS_SIDE("_M_SERIAL"), apr_pstrdup(r->pool, tmp));
899
900    ret = gnutls_x509_crt_get_version(cert);
901    if (ret > 0)
902        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
903                       apr_psprintf(r->pool, "%u", ret));
904
905    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "X.509");
906
907    tmp =
908            mgs_time2sz(gnutls_x509_crt_get_expiration_time
909            (cert), buf, sizeof (buf));
910    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
911
912    tmp =
913            mgs_time2sz(gnutls_x509_crt_get_activation_time
914            (cert), buf, sizeof (buf));
915    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
916
917    ret = gnutls_x509_crt_get_signature_algorithm(cert);
918    if (ret >= 0) {
919        apr_table_setn(env, MGS_SIDE("_A_SIG"),
920                gnutls_sign_algorithm_get_name(ret));
921    }
922
923    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
924    if (ret >= 0) {
925        apr_table_setn(env, MGS_SIDE("_A_KEY"),
926                gnutls_pk_algorithm_get_name(ret));
927    }
928
929    /* export all the alternative names (DNS, RFC822 and URI) */
930    for (i = 0; !(ret < 0); i++) {
931        const char *san, *sanlabel;
932        len = 0;
933        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
934                NULL, &len,
935                NULL);
936
937        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
938            tmp2 = apr_palloc(r->pool, len + 1);
939
940            ret =
941                    gnutls_x509_crt_get_subject_alt_name(cert, i,
942                    tmp2,
943                    &len,
944                    NULL);
945            tmp2[len] = 0;
946
947            sanlabel = apr_psprintf(r->pool, "%s%u", MGS_SIDE("_S_AN"), i);
948            if (ret == GNUTLS_SAN_DNSNAME) {
949                san = apr_psprintf(r->pool, "DNSNAME:%s", tmp2);
950            } else if (ret == GNUTLS_SAN_RFC822NAME) {
951                san = apr_psprintf(r->pool, "RFC822NAME:%s", tmp2);
952            } else if (ret == GNUTLS_SAN_URI) {
953                san = apr_psprintf(r->pool, "URI:%s", tmp2);
954            } else {
955                san = "UNSUPPORTED";
956            }
957            apr_table_setn(env, sanlabel, san);
958        }
959    }
960}
961
962
963/* @param side 0: server, 1: client
964 *
965 * @param export_cert_size (int) maximum size for environment variable
966 * to use for the PEM-encoded certificate (0 means do not export)
967 */
968static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, int export_cert_size) {
969
970        unsigned char sbuf[64]; /* buffer to hold serials */
971    char buf[AP_IOBUFSIZE];
972    const char *tmp;
973    size_t len;
974    int ret;
975
976    if (r == NULL)
977        return;
978
979    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
980    apr_table_t *env = r->subprocess_env;
981
982    if (export_cert_size > 0) {
983        len = 0;
984        ret = gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, NULL, &len);
985        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
986            if (len >= export_cert_size) {
987                apr_table_setn(env, MGS_SIDE("_CERT"),
988                               "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
989                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
990                              "GnuTLS: Failed to export too-large OpenPGP certificate to environment");
991            } else {
992                char* cert_buf = apr_palloc(r->pool, len + 1);
993                if (cert_buf != NULL && gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, cert_buf, &len) >= 0) {
994                    cert_buf[len] = 0;
995                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
996                } else {
997                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
998                                  "GnuTLS: failed to export OpenPGP certificate");
999                }
1000            }
1001        } else {
1002            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1003                          "GnuTLS: dazed and confused about OpenPGP certificate size");
1004        }
1005    }
1006
1007    len = sizeof (buf);
1008    gnutls_openpgp_crt_get_name(cert, 0, buf, &len);
1009    apr_table_setn(env, MGS_SIDE("_NAME"), apr_pstrmemdup(r->pool, buf, len));
1010
1011    len = sizeof (sbuf);
1012    gnutls_openpgp_crt_get_fingerprint(cert, sbuf, &len);
1013    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
1014    apr_table_setn(env, MGS_SIDE("_FINGERPRINT"), apr_pstrdup(r->pool, tmp));
1015
1016    ret = gnutls_openpgp_crt_get_version(cert);
1017    if (ret > 0)
1018        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
1019                       apr_psprintf(r->pool, "%u", ret));
1020
1021    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "OPENPGP");
1022
1023    tmp =
1024            mgs_time2sz(gnutls_openpgp_crt_get_expiration_time
1025            (cert), buf, sizeof (buf));
1026    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
1027
1028    tmp =
1029            mgs_time2sz(gnutls_openpgp_crt_get_creation_time
1030            (cert), buf, sizeof (buf));
1031    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
1032
1033    ret = gnutls_openpgp_crt_get_pk_algorithm(cert, NULL);
1034    if (ret >= 0) {
1035        apr_table_setn(env, MGS_SIDE("_A_KEY"), gnutls_pk_algorithm_get_name(ret));
1036    }
1037
1038}
1039
1040/* TODO: Allow client sending a X.509 certificate chain */
1041static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt) {
1042    const gnutls_datum_t *cert_list;
1043    unsigned int cert_list_size, status;
1044    int rv = GNUTLS_E_NO_CERTIFICATE_FOUND, ret;
1045    unsigned int ch_size = 0;
1046
1047    union {
1048        gnutls_x509_crt_t x509[MAX_CHAIN_SIZE];
1049        gnutls_openpgp_crt_t pgp;
1050    } cert;
1051    apr_time_t expiration_time, cur_time;
1052
1053    if (r == NULL || ctxt == NULL || ctxt->session == NULL)
1054        return HTTP_FORBIDDEN;
1055
1056    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1057    cert_list =
1058            gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
1059
1060    if (cert_list == NULL || cert_list_size == 0) {
1061        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
1062         */
1063        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1064            return OK;
1065
1066        /* no certificate provided by the client, but one was required. */
1067        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1068                "GnuTLS: Failed to Verify Peer: "
1069                "Client did not submit a certificate");
1070        return HTTP_FORBIDDEN;
1071    }
1072
1073    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1074        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1075                "GnuTLS: A Chain of %d certificate(s) was provided for validation",
1076                cert_list_size);
1077
1078        for (ch_size = 0; ch_size < cert_list_size; ch_size++) {
1079            gnutls_x509_crt_init(&cert.x509[ch_size]);
1080            rv = gnutls_x509_crt_import(cert.x509[ch_size],
1081                    &cert_list[ch_size],
1082                    GNUTLS_X509_FMT_DER);
1083            // When failure to import, leave the loop
1084            if (rv != GNUTLS_E_SUCCESS) {
1085                if (ch_size < 1) {
1086                    ap_log_rerror(APLOG_MARK,
1087                            APLOG_INFO, 0, r,
1088                            "GnuTLS: Failed to Verify Peer: "
1089                            "Failed to import peer certificates.");
1090                    ret = HTTP_FORBIDDEN;
1091                    goto exit;
1092                }
1093                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1094                        "GnuTLS: Failed to import some peer certificates. Using %d certificates",
1095                        ch_size);
1096                rv = GNUTLS_E_SUCCESS;
1097                break;
1098            }
1099        }
1100    } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
1101        if (cert_list_size > 1) {
1102            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1103                    "GnuTLS: Failed to Verify Peer: "
1104                    "Chained Client Certificates are not supported.");
1105            return HTTP_FORBIDDEN;
1106        }
1107
1108        gnutls_openpgp_crt_init(&cert.pgp);
1109        rv = gnutls_openpgp_crt_import(cert.pgp, &cert_list[0],
1110                GNUTLS_OPENPGP_FMT_RAW);
1111
1112    } else
1113        return HTTP_FORBIDDEN;
1114
1115    if (rv < 0) {
1116        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1117                "GnuTLS: Failed to Verify Peer: "
1118                "Failed to import peer certificates.");
1119        ret = HTTP_FORBIDDEN;
1120        goto exit;
1121    }
1122
1123    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1124        apr_time_ansi_put(&expiration_time,
1125                gnutls_x509_crt_get_expiration_time
1126                (cert.x509[0]));
1127
1128        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1129                      "GnuTLS: Verifying list of %d certificate(s) via method '%s'",
1130                      ch_size, mgs_readable_cvm(ctxt->sc->client_verify_method));
1131        switch(ctxt->sc->client_verify_method) {
1132        case mgs_cvm_cartel:
1133            rv = gnutls_x509_crt_list_verify(cert.x509, ch_size,
1134                                             ctxt->sc->ca_list,
1135                                             ctxt->sc->ca_list_size,
1136                                             NULL, 0, 0, &status);
1137            break;
1138#ifdef ENABLE_MSVA
1139        case mgs_cvm_msva:
1140        {
1141            struct msv_response* resp = NULL;
1142            struct msv_query q = { .context="https", .peertype="client", .pkctype="x509pem" };
1143            msv_ctxt_t ctx = msv_ctxt_init(NULL);
1144            char cert_pem_buf[10 * 1024];
1145            size_t len = sizeof (cert_pem_buf);
1146
1147            rv = 0;
1148            if (gnutls_x509_crt_export(cert.x509[0], GNUTLS_X509_FMT_PEM, cert_pem_buf, &len) >= 0) {
1149                /* FIXME : put together a name from the cert we received, instead of hard-coding this value: */
1150                q.peername = mgs_x509_construct_uid(r, cert.x509[0]);
1151                q.pkcdata = cert_pem_buf;
1152                rv = msv_query_agent(ctx, q, &resp);
1153                if (rv == LIBMSV_ERROR_SUCCESS) {
1154                    status = 0;
1155                } else if (rv == LIBMSV_ERROR_INVALID) {
1156                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1157                                  "GnuTLS: Monkeysphere validation failed: (message: %s)", resp->message);
1158                    status = GNUTLS_CERT_INVALID;
1159                } else {
1160                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1161                                  "GnuTLS: Error communicating with the Monkeysphere Validation Agent: (%d) %s", rv, msv_strerror(ctx, rv));
1162                    status = GNUTLS_CERT_INVALID;
1163                    rv = -1;
1164                }
1165            } else {
1166                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1167                              "GnuTLS: Could not convert the client certificate to PEM format");
1168                status = GNUTLS_CERT_INVALID;
1169                rv = GNUTLS_E_ASN1_ELEMENT_NOT_FOUND;
1170            }
1171            msv_response_destroy(resp);
1172            msv_ctxt_destroy(ctx);
1173        }
1174            break;
1175#endif
1176        default:
1177            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1178                          "GnuTLS: Failed to Verify X.509 Peer: method '%s' is not supported",
1179                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1180        }
1181
1182    } else {
1183        apr_time_ansi_put(&expiration_time,
1184                gnutls_openpgp_crt_get_expiration_time
1185                (cert.pgp));
1186
1187        switch(ctxt->sc->client_verify_method) {
1188        case mgs_cvm_cartel:
1189            rv = gnutls_openpgp_crt_verify_ring(cert.pgp,
1190                                                ctxt->sc->pgp_list, 0,
1191                                                &status);
1192            break;
1193#ifdef ENABLE_MSVA
1194        case mgs_cvm_msva:
1195            /* need to set status and rv */
1196            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1197                          "GnuTLS:  OpenPGP verification via MSVA is not yet implemented");
1198            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1199            break;
1200#endif
1201        default:
1202            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1203                          "GnuTLS: Failed to Verify OpenPGP Peer: method '%s' is not supported",
1204                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1205        }
1206    }
1207
1208    if (rv < 0) {
1209        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1210                "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1211                rv, gnutls_strerror(rv));
1212        if (rv == GNUTLS_E_NO_CERTIFICATE_FOUND)
1213            ap_log_rerror(APLOG_MARK, APLOG_EMERG, 0, r,
1214                "GnuTLS: No certificate was found for verification. Did you set the GnuTLSX509CAFile or GnuTLSPGPKeyringFile directives?");
1215        ret = HTTP_FORBIDDEN;
1216        goto exit;
1217    }
1218
1219    /* TODO: X509 CRL Verification. */
1220    /* May add later if anyone needs it.
1221     */
1222    /* ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size); */
1223
1224    cur_time = apr_time_now();
1225
1226    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1227        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1228                "GnuTLS: Could not find Signer for Peer Certificate");
1229    }
1230
1231    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1232        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1233                "GnuTLS: Peer's Certificate signer is not a CA");
1234    }
1235
1236    if (status & GNUTLS_CERT_INSECURE_ALGORITHM) {
1237        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1238                "GnuTLS: Peer's Certificate is using insecure algorithms");
1239    }
1240
1241    if (status & GNUTLS_CERT_EXPIRED
1242            || status & GNUTLS_CERT_NOT_ACTIVATED) {
1243        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1244                "GnuTLS: Peer's Certificate signer is expired or not yet activated");
1245    }
1246
1247    if (status & GNUTLS_CERT_INVALID) {
1248        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1249                "GnuTLS: Peer Certificate is invalid.");
1250    } else if (status & GNUTLS_CERT_REVOKED) {
1251        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1252                "GnuTLS: Peer Certificate is revoked.");
1253    }
1254
1255    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509)
1256        mgs_add_common_cert_vars(r, cert.x509[0], 1, ctxt->sc->export_certificates_size);
1257    else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP)
1258        mgs_add_common_pgpcert_vars(r, cert.pgp, 1, ctxt->sc->export_certificates_size);
1259
1260    {
1261        /* days remaining */
1262        unsigned long remain =
1263                (apr_time_sec(expiration_time) -
1264                apr_time_sec(cur_time)) / 86400;
1265        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1266                apr_psprintf(r->pool, "%lu", remain));
1267    }
1268
1269    if (status == 0) {
1270        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1271                "SUCCESS");
1272        ret = OK;
1273    } else {
1274        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1275                "FAILED");
1276        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1277            ret = OK;
1278        else
1279            ret = HTTP_FORBIDDEN;
1280    }
1281
1282exit:
1283    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1284        int i;
1285        for (i = 0; i < ch_size; i++) {
1286            gnutls_x509_crt_deinit(cert.x509[i]);
1287        }
1288    } else if (gnutls_certificate_type_get(ctxt->session) ==
1289            GNUTLS_CRT_OPENPGP)
1290        gnutls_openpgp_crt_deinit(cert.pgp);
1291    return ret;
1292
1293
1294}
1295
1296static const char* mgs_x509_leaf_oid_from_dn(apr_pool_t *pool, const char* oid, gnutls_x509_crt_t cert) {
1297    int rv=GNUTLS_E_SUCCESS, i;
1298    size_t sz=0, lastsz=0;
1299    char* data=NULL;
1300
1301    i = -1;
1302    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1303        i++;
1304        lastsz=sz;
1305        sz=0;
1306        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i, 0, NULL, &sz);
1307    }
1308    if (i > 0) {
1309        data = apr_palloc(pool, lastsz);
1310        sz=lastsz;
1311        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i-1, 0, data, &sz);
1312        if (rv == GNUTLS_E_SUCCESS)
1313            return data;
1314    }
1315    return NULL;
1316}
1317
1318static const char* mgs_x509_first_type_from_san(apr_pool_t *pool, gnutls_x509_subject_alt_name_t target, gnutls_x509_crt_t cert) {
1319    int rv=GNUTLS_E_SUCCESS;
1320    size_t sz;
1321    char* data=NULL;
1322    unsigned int i;
1323    gnutls_x509_subject_alt_name_t thistype;
1324
1325    i = 0;
1326    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1327        sz = 0;
1328        rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, NULL, &sz, &thistype, NULL);
1329        if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && thistype == target) {
1330            data = apr_palloc(pool, sz);
1331            rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, data, &sz, &thistype, NULL);
1332            if (rv == target)
1333                return data;
1334        }
1335        i++;
1336    }
1337    return NULL;
1338}
1339
1340/* Create a string representing a candidate User ID from an X.509
1341 * certificate
1342
1343 * We need this for client certification because a client gives us a
1344 * certificate, but doesn't tell us (in any other way) who they are
1345 * trying to authenticate as.
1346
1347 * TODO: we might need another parallel for OpenPGP, but for that it's
1348 * much simpler: we can just assume that the first User ID marked as
1349 * "primary" (or the first User ID, period) is the identity the user
1350 * is trying to present as.
1351
1352 * one complaint might be "but the user wanted to be another identity,
1353 * which is also in the certificate (e.g. in a SubjectAltName)"
1354 * However, given that any user can regenerate their own X.509
1355 * certificate with their own public key content, they should just do
1356 * so, and not expect us to guess at their identity :)
1357
1358 * This function allocates it's response from the pool given it.  When
1359 * that pool is reclaimed, the response will also be deallocated.
1360
1361 * FIXME: what about extracting a server-style cert
1362 *        (e.g. https://imposter.example) from the DN or any sAN?
1363
1364 * FIXME: what if we want to call this outside the context of a
1365 *        request?  That complicates the logging.
1366 */
1367static const char* mgs_x509_construct_uid(request_rec *r, gnutls_x509_crt_t cert) {
1368    /* basic strategy, assuming humans are the users: we are going to
1369     * try to reconstruct a "conventional" User ID by pulling in a
1370     * name, comment, and e-mail address.
1371     */
1372    apr_pool_t *pool = r->pool;
1373    const char *name=NULL, *comment=NULL, *email=NULL;
1374    const char *ret=NULL;
1375    /* subpool for temporary allocation: */
1376    apr_pool_t *sp=NULL;
1377
1378    if (APR_SUCCESS != apr_pool_create(&sp, pool))
1379        return NULL; /* i'm assuming that libapr would log this kind
1380                      * of error on its own */
1381
1382     /* Name
1383
1384     the name comes from the leaf commonName of the cert's Subject.
1385
1386     (MAYBE: should we look at trying to assemble a candidate from
1387             givenName, surName, suffix, etc?  the "name" field
1388             appears to be case-insensitive, which seems problematic
1389             from what we expect; see:
1390             http://www.itu.int/rec/T-REC-X.520-200102-s/e )
1391
1392     (MAYBE: should we try pulling a commonName or otherName or
1393             something from subjectAltName? see:
1394             https://tools.ietf.org/html/rfc5280#section-4.2.1.6
1395             GnuTLS does not support looking for Common Names in the
1396             SAN yet)
1397     */
1398    name = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_COMMON_NAME, cert);
1399
1400    /* Comment
1401
1402       I am inclined to punt on this for now, as Comment has been so
1403       atrociously misused in OpenPGP.  Perhaps if there is a
1404       pseudonym (OID 2.5.4.65, aka GNUTLS_OID_X520_PSEUDONYM) field
1405       in the subject or sAN?
1406    */
1407    comment = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_PSEUDONYM, cert);
1408
1409    /* E-mail
1410
1411       This should be the the first rfc822Name from the sAN.
1412
1413       failing that, we'll take the leaf email in the certificate's
1414       subject; this is a deprecated use though.
1415     */
1416    email = mgs_x509_first_type_from_san(sp, GNUTLS_SAN_RFC822NAME, cert);
1417    if (email == NULL)
1418        email = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_PKCS9_EMAIL, cert);
1419
1420    /* assemble all the parts: */
1421
1422    /* must have at least a name or an e-mail. */
1423    if (name == NULL && email == NULL) {
1424        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1425                "GnuTLS: Need either a name or an e-mail address to get a User ID from an X.509 certificate.");
1426        goto end;
1427    }
1428    if (name) {
1429        if (comment) {
1430            if (email) {
1431                ret = apr_psprintf(pool, "%s (%s) <%s>", name, comment, email);
1432            } else {
1433                ret = apr_psprintf(pool, "%s (%s)", name, comment);
1434            }
1435        } else {
1436            if (email) {
1437                ret = apr_psprintf(pool, "%s <%s>", name, email);
1438            } else {
1439                ret = apr_pstrdup(pool, name);
1440            }
1441        }
1442    } else {
1443        if (comment) {
1444            ret = apr_psprintf(pool, "(%s) <%s>", comment, email);
1445        } else {
1446            ret = apr_psprintf(pool, "<%s>", email);
1447        }
1448    }
1449
1450end:
1451    apr_pool_destroy(sp);
1452    return ret;
1453}
1454
1455static int mgs_status_hook(request_rec *r, int flags)
1456{
1457    mgs_srvconf_rec *sc;
1458
1459    if (r == NULL)
1460        return OK;
1461
1462    sc = (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config, &gnutls_module);
1463
1464    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1465
1466    ap_rputs("<hr>\n", r);
1467    ap_rputs("<h2>GnuTLS Information:</h2>\n<dl>\n", r);
1468
1469    ap_rprintf(r, "<dt>GnuTLS version:</dt><dd>%s</dd>\n", gnutls_check_version(NULL));
1470    ap_rputs("<dt>Built against:</dt><dd>" GNUTLS_VERSION "</dd>\n", r);
1471    ap_rprintf(r, "<dt>using TLS:</dt><dd>%s</dd>\n", (sc->enabled == GNUTLS_ENABLED_FALSE ? "no" : "yes"));
1472    if (sc->enabled != GNUTLS_ENABLED_FALSE) {
1473        mgs_handle_t* ctxt;
1474        ctxt = ap_get_module_config(r->connection->conn_config, &gnutls_module);
1475        if (ctxt && ctxt->session != NULL) {
1476#if GNUTLS_VERSION_MAJOR < 3
1477            ap_rprintf(r, "<dt>This TLS Session:</dt><dd>%s</dd>\n",
1478                gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
1479                gnutls_cipher_get(ctxt->session),
1480                gnutls_mac_get(ctxt->session)));
1481#else
1482            char* z = NULL;
1483            z = gnutls_session_get_desc(ctxt->session);
1484            if (z) {
1485                ap_rprintf(r, "<dt>This TLS Session:</dt><dd>%s</dd>\n", z);
1486                gnutls_free(z);
1487            }
1488#endif
1489        }
1490    }
1491
1492    ap_rputs("</dl>\n", r);
1493    return OK;
1494}
1495
Note: See TracBrowser for help on using the repository browser.