source: mod_gnutls/src/gnutls_hooks.c @ 351b51f

debian/masterdebian/stretch-backportsjessie-backportsupstream
Last change on this file since 351b51f was 01b5d85, checked in by Thomas Klute <thomas2.klute@…>, 5 years ago

Merge branch 'client-verify-fix' into new-gnutls-api

Merge the fix for CVE-2015-2091 [1] for anyone who might want to use
this branch despite broken OpenPGP support.

[1] https://security-tracker.debian.org/tracker/CVE-2015-2091

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