source: mod_gnutls/src/gnutls_hooks.c @ aa68232

debian/masterdebian/stretch-backportsupstream
Last change on this file since aa68232 was aa68232, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

Move global cache mutex into the private cache struct

  • Property mode set to 100644
File size: 69.1 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2008, 2014 Nikos Mavrogiannopoulos
4 *  Copyright 2011 Dash Shendy
5 *  Copyright 2013-2014 Daniel Kahn Gillmor
6 *  Copyright 2015-2016 Thomas Klute
7 *
8 *  Licensed under the Apache License, Version 2.0 (the "License");
9 *  you may not use this file except in compliance with the License.
10 *  You may obtain a copy of the License at
11 *
12 *      http://www.apache.org/licenses/LICENSE-2.0
13 *
14 *  Unless required by applicable law or agreed to in writing, software
15 *  distributed under the License is distributed on an "AS IS" BASIS,
16 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 *  See the License for the specific language governing permissions and
18 *  limitations under the License.
19 *
20 */
21
22#include "mod_gnutls.h"
23#include "gnutls_cache.h"
24#include "gnutls_ocsp.h"
25#include "http_vhost.h"
26#include "ap_mpm.h"
27#include "mod_status.h"
28#include <util_mutex.h>
29#include <apr_escape.h>
30
31#ifdef ENABLE_MSVA
32#include <msv/msv.h>
33#endif
34
35#ifdef APLOG_USE_MODULE
36APLOG_USE_MODULE(gnutls);
37#endif
38
39#if MOD_GNUTLS_DEBUG
40static apr_file_t *debug_log_fp;
41#endif
42
43#define IS_PROXY_STR(c) \
44    ((c->is_proxy == GNUTLS_ENABLED_TRUE) ? "proxy " : "")
45
46static gnutls_datum_t session_ticket_key = {NULL, 0};
47
48static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
49/* use side==0 for server and side==1 for client */
50static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size);
51static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, size_t export_cert_size);
52static int mgs_status_hook(request_rec *r, int flags);
53#ifdef ENABLE_MSVA
54static const char* mgs_x509_construct_uid(request_rec * pool, gnutls_x509_crt_t cert);
55#endif
56static int load_proxy_x509_credentials(server_rec *s);
57
58/* Pool Cleanup Function */
59apr_status_t mgs_cleanup_pre_config(void *data __attribute__((unused))) {
60        /* Free all session data */
61    gnutls_free(session_ticket_key.data);
62    session_ticket_key.data = NULL;
63    session_ticket_key.size = 0;
64        /* Deinitialize GnuTLS Library */
65    gnutls_global_deinit();
66    return APR_SUCCESS;
67}
68
69/* Logging Function for Maintainers */
70#if MOD_GNUTLS_DEBUG
71static void gnutls_debug_log_all(int level, const char *str) {
72    apr_file_printf(debug_log_fp, "<%d> %s", level, str);
73}
74#define _gnutls_log apr_file_printf
75#else
76#define _gnutls_log(...)
77#endif
78
79static const char* mgs_readable_cvm(mgs_client_verification_method_e m) {
80    switch(m) {
81    case mgs_cvm_unset:
82        return "unset";
83    case mgs_cvm_cartel:
84        return "cartel";
85    case mgs_cvm_msva:
86        return "msva";
87    }
88    return "unknown";
89}
90
91/* Pre-Configuration HOOK: Runs First */
92int mgs_hook_pre_config(apr_pool_t * pconf, apr_pool_t * plog, apr_pool_t * ptemp __attribute__((unused))) {
93
94/* Maintainer Logging */
95#if MOD_GNUTLS_DEBUG
96    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug", APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, pconf);
97    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
98    gnutls_global_set_log_level(9);
99    gnutls_global_set_log_function(gnutls_debug_log_all);
100    _gnutls_log(debug_log_fp, "gnutls: %s\n", gnutls_check_version(NULL));
101#endif
102
103    int ret;
104
105        /* Check for required GnuTLS Library Version */
106    if (gnutls_check_version(LIBGNUTLS_VERSION) == NULL) {
107                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_check_version() failed. Required: "
108                                        "gnutls-%s Found: gnutls-%s", LIBGNUTLS_VERSION, gnutls_check_version(NULL));
109        return DONE;
110    }
111
112        /* Initialize GnuTLS Library */
113    ret = gnutls_global_init();
114    if (ret < 0) {
115                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_global_init: %s", gnutls_strerror(ret));
116                return DONE;
117    }
118
119        /* Generate a Session Key */
120    ret = gnutls_session_ticket_key_generate(&session_ticket_key);
121    if (ret < 0) {
122                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_session_ticket_key_generate: %s", gnutls_strerror(ret));
123                return DONE;
124    }
125
126    AP_OPTIONAL_HOOK(status_hook, mgs_status_hook, NULL, NULL, APR_HOOK_MIDDLE);
127
128    ap_mutex_register(pconf, MGS_CACHE_MUTEX_NAME, NULL, APR_LOCK_DEFAULT, 0);
129
130    /* Register a pool clean-up function */
131    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config, apr_pool_cleanup_null);
132
133    return OK;
134}
135
136static int mgs_select_virtual_server_cb(gnutls_session_t session) {
137
138    mgs_handle_t *ctxt = NULL;
139    mgs_srvconf_rec *tsc = NULL;
140    int ret = 0;
141
142    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
143
144    ctxt = gnutls_transport_get_ptr(session);
145
146    /* find the virtual server */
147    tsc = mgs_find_sni_server(session);
148
149    if (tsc != NULL) {
150        // Found a TLS vhost based on the SNI from the client; use it instead.
151        ctxt->sc = tsc;
152        }
153
154    gnutls_certificate_server_set_request(session, ctxt->sc->client_verify_mode);
155
156    /* Set x509 credentials */
157    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, ctxt->sc->certs);
158    /* Set Anon credentials */
159    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
160
161    if (ctxt->sc->ocsp_response_file != NULL)
162    {
163        gnutls_certificate_set_ocsp_status_request_function(ctxt->sc->certs,
164                                                            mgs_get_ocsp_response,
165                                                            ctxt);
166    }
167
168#ifdef ENABLE_SRP
169        /* Set SRP credentials */
170    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
171        gnutls_credentials_set(session, GNUTLS_CRD_SRP, ctxt->sc->srp_creds);
172    }
173#endif
174
175    /* update the priorities - to avoid negotiating a ciphersuite that is not
176     * enabled on this virtual server. Note that here we ignore the version
177     * negotiation.
178     */
179
180    ret = gnutls_priority_set(session, ctxt->sc->priorities);
181    /* actually it shouldn't fail since we have checked at startup */
182    return ret;
183
184}
185
186static int cert_retrieve_fn(gnutls_session_t session,
187                            const gnutls_datum_t * req_ca_rdn __attribute__((unused)),
188                            int nreqs __attribute__((unused)),
189                            const gnutls_pk_algorithm_t * pk_algos __attribute__((unused)),
190                            int pk_algos_length __attribute__((unused)),
191                            gnutls_pcert_st **pcerts,
192                            unsigned int *pcert_length,
193                            gnutls_privkey_t *privkey)
194{
195    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
196
197    mgs_handle_t *ctxt;
198
199    if (session == NULL) {
200                // ERROR INVALID SESSION
201        return -1;
202    }
203
204    ctxt = gnutls_transport_get_ptr(session);
205
206    if (gnutls_certificate_type_get(session) == GNUTLS_CRT_X509) {
207                // X509 CERTIFICATE
208        *pcerts = ctxt->sc->certs_x509_chain;
209        *pcert_length = ctxt->sc->certs_x509_chain_num;
210        *privkey = ctxt->sc->privkey_x509;
211        return 0;
212    } else if (gnutls_certificate_type_get(session) == GNUTLS_CRT_OPENPGP) {
213                // OPENPGP CERTIFICATE
214        *pcerts = ctxt->sc->cert_pgp;
215        *pcert_length = 1;
216        *privkey = ctxt->sc->privkey_pgp;
217        return 0;
218    } else {
219                // UNKNOWN CERTIFICATE
220            return -1;
221        }
222}
223
224/* Read the common name or the alternative name of the certificate.
225 * We only support a single name per certificate.
226 *
227 * Returns negative on error.
228 */
229static int read_crt_cn(server_rec * s, apr_pool_t * p, gnutls_x509_crt_t cert, char **cert_cn) {
230
231    int rv = 0;
232    size_t data_len;
233
234
235    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
236    *cert_cn = NULL;
237
238    data_len = 0;
239    rv = gnutls_x509_crt_get_dn_by_oid(cert, GNUTLS_OID_X520_COMMON_NAME, 0, 0, NULL, &data_len);
240
241    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
242        *cert_cn = apr_palloc(p, data_len);
243        rv = gnutls_x509_crt_get_dn_by_oid(cert,
244                GNUTLS_OID_X520_COMMON_NAME,
245                0, 0, *cert_cn,
246                &data_len);
247    } else { /* No CN return subject alternative name */
248        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
249                "No common name found in certificate for '%s:%d'. Looking for subject alternative name...",
250                s->server_hostname, s->port);
251        rv = 0;
252        /* read subject alternative name */
253        for (int i = 0; !(rv < 0); i++)
254        {
255            data_len = 0;
256            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
257                    NULL,
258                    &data_len,
259                    NULL);
260
261            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER
262                    && data_len > 1) {
263                /* FIXME: not very efficient. What if we have several alt names
264                 * before DNSName?
265                 */
266                *cert_cn = apr_palloc(p, data_len + 1);
267
268                rv = gnutls_x509_crt_get_subject_alt_name
269                        (cert, i, *cert_cn, &data_len, NULL);
270                (*cert_cn)[data_len] = 0;
271
272                if (rv == GNUTLS_SAN_DNSNAME)
273                    break;
274            }
275        }
276    }
277
278    return rv;
279}
280
281static int read_pgpcrt_cn(server_rec * s, apr_pool_t * p,
282        gnutls_openpgp_crt_t cert, char **cert_cn) {
283    int rv = 0;
284    size_t data_len;
285
286
287    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
288    *cert_cn = NULL;
289
290    data_len = 0;
291    rv = gnutls_openpgp_crt_get_name(cert, 0, NULL, &data_len);
292
293    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
294        *cert_cn = apr_palloc(p, data_len);
295        rv = gnutls_openpgp_crt_get_name(cert, 0, *cert_cn,
296                &data_len);
297    } else { /* No CN return subject alternative name */
298        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
299                "No name found in PGP certificate for '%s:%d'.",
300                s->server_hostname, s->port);
301    }
302
303    return rv;
304}
305
306/*
307 * Must return OK or DECLINED on success, something else on
308 * error. These codes are defined in Apache httpd.h along with the
309 * HTTP status codes, so I'm going to use HTTP error codes both for
310 * fun (and to avoid conflicts).
311 */
312int mgs_hook_post_config(apr_pool_t *pconf,
313                         apr_pool_t *plog __attribute__((unused)),
314                         apr_pool_t *ptemp __attribute__((unused)),
315                         server_rec *base_server)
316{
317    int rv;
318    server_rec *s;
319    gnutls_dh_params_t dh_params = NULL;
320    mgs_srvconf_rec *sc;
321    mgs_srvconf_rec *sc_base;
322    void *data = NULL;
323    const char *userdata_key = "mgs_init";
324
325    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
326
327    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
328    if (data == NULL) {
329        apr_pool_userdata_set((const void *) 1, userdata_key, apr_pool_cleanup_null, base_server->process->pool);
330    }
331
332    s = base_server;
333    sc_base = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
334
335
336    rv = mgs_cache_post_config(pconf, s, sc_base);
337    if (rv != APR_SUCCESS)
338    {
339        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
340                     "Post config for cache failed.");
341        return HTTP_INSUFFICIENT_STORAGE;
342    }
343
344    /* If GnuTLSP11Module is set, load the listed PKCS #11
345     * modules. Otherwise system defaults will be used. */
346    if (sc_base->p11_modules != NULL)
347    {
348        rv = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL);
349        if (rv < 0)
350        {
351            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
352                         "GnuTLS: Initializing PKCS #11 "
353                         "failed: %s (%d).",
354                         gnutls_strerror(rv), rv);
355        }
356        else
357        {
358            for (int i = 0; i < sc_base->p11_modules->nelts; i++)
359            {
360                char *p11_module =
361                    APR_ARRAY_IDX(sc_base->p11_modules, i, char *);
362                rv = gnutls_pkcs11_add_provider(p11_module, NULL);
363                if (rv != GNUTLS_E_SUCCESS)
364                    ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
365                                 "GnuTLS: Loading PKCS #11 provider module %s "
366                                 "failed: %s (%d).",
367                                 p11_module, gnutls_strerror(rv), rv);
368            }
369        }
370    }
371
372    for (s = base_server; s; s = s->next) {
373        sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
374        sc->cache_type = sc_base->cache_type;
375        sc->cache_config = sc_base->cache_config;
376        sc->cache_timeout = sc_base->cache_timeout;
377        sc->cache = sc_base->cache;
378
379        rv = mgs_load_files(pconf, s);
380        if (rv != 0) {
381            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
382                "GnuTLS: Loading required files failed."
383                " Shutting Down.");
384            return HTTP_NOT_FOUND;
385        }
386
387        /* init OCSP trust list if OCSP is enabled */
388        if (sc->ocsp_response_file != NULL)
389        {
390            rv = mgs_ocsp_post_config_server(pconf, ptemp, s);
391            if (rv != OK && rv != DECLINED)
392                return rv;
393        }
394
395        /* defaults for unset values: */
396        if (sc->enabled == GNUTLS_ENABLED_UNSET)
397            sc->enabled = GNUTLS_ENABLED_FALSE;
398        if (sc->tickets == GNUTLS_ENABLED_UNSET)
399            sc->tickets = GNUTLS_ENABLED_TRUE;
400        if (sc->export_certificates_size < 0)
401            sc->export_certificates_size = 0;
402        if (sc->client_verify_mode == -1)
403            sc->client_verify_mode = GNUTLS_CERT_IGNORE;
404        if (sc->client_verify_method == mgs_cvm_unset)
405            sc->client_verify_method = mgs_cvm_cartel;
406
407        /* Check if the priorities have been set */
408        if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
409            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
410                    "GnuTLS: Host '%s:%d' is missing the GnuTLSPriorities directive!",
411                    s->server_hostname, s->port);
412            return HTTP_NOT_ACCEPTABLE;
413        }
414
415        /* Check if DH params have been set per host */
416        if (sc->dh_params != NULL) {
417            gnutls_certificate_set_dh_params(sc->certs, sc->dh_params);
418            gnutls_anon_set_server_dh_params(sc->anon_creds, sc->dh_params);
419        } else if (dh_params) {
420            gnutls_certificate_set_dh_params(sc->certs, dh_params);
421            gnutls_anon_set_server_dh_params(sc->anon_creds, dh_params);
422        }
423
424        /* The call after this comment is a workaround for bug in
425         * gnutls_certificate_set_retrieve_function2 that ignores
426         * supported certificate types. Should be fixed in GnuTLS
427         * 3.3.12.
428         *
429         * Details:
430         * https://lists.gnupg.org/pipermail/gnutls-devel/2015-January/007377.html
431         * Workaround from:
432         * https://github.com/vanrein/tlspool/commit/4938102d3d1b086491d147e6c8e4e2a02825fc12 */
433#if GNUTLS_VERSION_NUMBER < 0x030312
434        gnutls_certificate_set_retrieve_function(sc->certs, (void *) exit);
435#endif
436
437        gnutls_certificate_set_retrieve_function2(sc->certs, cert_retrieve_fn);
438
439        if ((sc->certs_x509_chain == NULL || sc->certs_x509_chain_num < 1) &&
440            sc->cert_pgp == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
441                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
442                                                "GnuTLS: Host '%s:%d' is missing a Certificate File!",
443                                                s->server_hostname, s->port);
444            return HTTP_UNAUTHORIZED;
445        }
446        if (sc->enabled == GNUTLS_ENABLED_TRUE &&
447            ((sc->certs_x509_chain_num > 0 && sc->privkey_x509 == NULL) ||
448             (sc->cert_crt_pgp[0] != NULL && sc->privkey_pgp == NULL))) {
449                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
450                                                "GnuTLS: Host '%s:%d' is missing a Private Key File!",
451                                                s->server_hostname, s->port);
452            return HTTP_UNAUTHORIZED;
453        }
454
455        if (sc->enabled == GNUTLS_ENABLED_TRUE) {
456            rv = -1;
457            if (sc->certs_x509_chain_num > 0) {
458                rv = read_crt_cn(s, pconf, sc->certs_x509_crt_chain[0], &sc->cert_cn);
459            }
460            if (rv < 0 && sc->cert_pgp != NULL) {
461                rv = read_pgpcrt_cn(s, pconf, sc->cert_crt_pgp[0], &sc->cert_cn);
462                        }
463
464            if (rv < 0) {
465                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
466                                                        "GnuTLS: Cannot find a certificate for host '%s:%d'!",
467                                                        s->server_hostname, s->port);
468                sc->cert_cn = NULL;
469                continue;
470            }
471        }
472
473        if (sc->enabled == GNUTLS_ENABLED_TRUE
474            && sc->proxy_enabled == GNUTLS_ENABLED_TRUE
475            && load_proxy_x509_credentials(s) != APR_SUCCESS)
476        {
477            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
478                         "%s: loading proxy credentials for host "
479                         "'%s:%d' failed, exiting!",
480                         __func__, s->server_hostname, s->port);
481            return HTTP_PROXY_AUTHENTICATION_REQUIRED;
482        }
483    }
484
485
486    ap_add_version_component(pconf, "mod_gnutls/" MOD_GNUTLS_VERSION);
487
488    {
489        const char* libvers = gnutls_check_version(NULL);
490        char* gnutls_version = NULL;
491        if(libvers && (gnutls_version = apr_psprintf(pconf, "GnuTLS/%s", libvers))) {
492            ap_add_version_component(pconf, gnutls_version);
493        } else {
494            // In case we could not create the above string go for the static version instead
495            ap_add_version_component(pconf, "GnuTLS/" GNUTLS_VERSION "-static");
496        }
497    }
498
499    return OK;
500}
501
502void mgs_hook_child_init(apr_pool_t *p, server_rec *s)
503{
504    apr_status_t rv = APR_SUCCESS;
505    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
506        ap_get_module_config(s->module_config, &gnutls_module);
507
508    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
509
510    /* if we use PKCS #11 reinitialize it */
511    if (mgs_pkcs11_reinit(s) < 0) {
512            ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
513                    "GnuTLS: Failed to reinitialize PKCS #11");
514            exit(-1);
515    }
516
517    if (sc->cache_type != mgs_cache_none) {
518        rv = mgs_cache_child_init(p, s, sc);
519        if (rv != APR_SUCCESS) {
520            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
521                    "GnuTLS: Failed to run Cache Init");
522        }
523    }
524
525    /* Block SIGPIPE Signals */
526    rv = apr_signal_block(SIGPIPE);
527    if(rv != APR_SUCCESS) {
528        /* error sending output */
529        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
530                "GnuTLS: Error Blocking SIGPIPE Signal!");
531    }
532}
533
534const char *mgs_hook_http_scheme(const request_rec * r) {
535    mgs_srvconf_rec *sc;
536
537    if (r == NULL)
538        return NULL;
539
540    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
541            server->module_config,
542            &gnutls_module);
543
544    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
545    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
546        return NULL;
547    }
548
549    return "https";
550}
551
552apr_port_t mgs_hook_default_port(const request_rec * r) {
553    mgs_srvconf_rec *sc;
554
555    if (r == NULL)
556        return 0;
557
558    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
559            server->module_config,
560            &gnutls_module);
561
562    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
563    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
564        return 0;
565    }
566
567    return 443;
568}
569
570#define MAX_HOST_LEN 255
571
572typedef struct {
573    mgs_handle_t *ctxt;
574    mgs_srvconf_rec *sc;
575    const char *sni_name;
576} vhost_cb_rec;
577
578/**
579 * Matches the current vhost's ServerAlias directives
580 *
581 * @param x vhost callback record
582 * @param s server record
583 * @return true if a match, false otherwise
584 *
585 */
586int check_server_aliases(vhost_cb_rec *x, server_rec * s, mgs_srvconf_rec *tsc) {
587        apr_array_header_t *names;
588        int rv = 0;
589        char ** name;
590
591        /* Check ServerName First! */
592        if(apr_strnatcasecmp(x->sni_name, s->server_hostname) == 0) {
593                // We have a match, save this server configuration
594                x->sc = tsc;
595                rv = 1;
596        /* Check any ServerAlias directives */
597        } else if(s->names->nelts) {
598                names = s->names;
599                name = (char **)names->elts;
600                for (int i = 0; i < names->nelts; ++i)
601        {
602                        if (!name[i]) { continue; }
603                                if (apr_strnatcasecmp(x->sni_name, name[i]) == 0) {
604                                        // We have a match, save this server configuration
605                                        x->sc = tsc;
606                                        rv = 1;
607                        }
608                }
609        /* Wild any ServerAlias Directives */
610        } else if(s->wild_names->nelts) {
611                names = s->wild_names;
612        name = (char **)names->elts;
613                for (int i = 0; i < names->nelts; ++i)
614        {
615                        if (!name[i]) { continue; }
616                                if(apr_fnmatch(name[i], x->sni_name ,
617                                                                APR_FNM_CASE_BLIND|
618                                                                APR_FNM_PERIOD|
619                                                                APR_FNM_PATHNAME|
620                                                                APR_FNM_NOESCAPE) == APR_SUCCESS) {
621                                x->sc = tsc;
622                                rv = 1;
623                        }
624                }
625        }
626        return rv;
627}
628
629static int vhost_cb(void *baton, conn_rec *conn, server_rec * s)
630{
631    mgs_srvconf_rec *tsc;
632    vhost_cb_rec *x = baton;
633    int ret;
634
635    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
636    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
637            &gnutls_module);
638
639    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
640        return 0;
641    }
642
643    if (tsc->certs_x509_chain_num > 0) {
644        /* this check is there to warn administrator of any missing hostname
645         * in the certificate. */
646        ret = gnutls_x509_crt_check_hostname(tsc->certs_x509_crt_chain[0], s->server_hostname);
647        if (0 == ret)
648            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, conn,
649                          "GnuTLS: the certificate doesn't match requested "
650                          "hostname '%s'", s->server_hostname);
651    } else {
652        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, conn,
653                      "GnuTLS: SNI request for '%s' but no X.509 certs "
654                      "available at all",
655                      s->server_hostname);
656    }
657        return check_server_aliases(x, s, tsc);
658}
659
660mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session)
661{
662    int rv;
663    unsigned int sni_type;
664    size_t data_len = MAX_HOST_LEN;
665    char sni_name[MAX_HOST_LEN];
666    mgs_handle_t *ctxt;
667    vhost_cb_rec cbx;
668
669    if (session == NULL)
670        return NULL;
671
672    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
673    ctxt = gnutls_transport_get_ptr(session);
674
675    rv = gnutls_server_name_get(ctxt->session, sni_name,
676            &data_len, &sni_type, 0);
677
678    if (rv != 0) {
679        return NULL;
680    }
681
682    if (sni_type != GNUTLS_NAME_DNS) {
683        ap_log_cerror(APLOG_MARK, APLOG_CRIT, 0, ctxt->c,
684                      "GnuTLS: Unknown type '%d' for SNI: '%s'",
685                      sni_type, sni_name);
686        return NULL;
687    }
688
689    /**
690     * Code in the Core already sets up the c->base_server as the base
691     * for this IP/Port combo.  Trust that the core did the 'right' thing.
692     */
693    cbx.ctxt = ctxt;
694    cbx.sc = NULL;
695    cbx.sni_name = sni_name;
696
697    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
698    if (rv == 1) {
699        return cbx.sc;
700    }
701    return NULL;
702}
703
704/**
705 * This function is intended as a cleanup handler for connections
706 * using GnuTLS. If attached to the connection pool, it ensures that
707 * session resources are released with the connection pool even if the
708 * session wasn't terminated properly.
709 *
710 * @param data must point to the mgs_handle_t associated with the
711 * connection
712 */
713static apr_status_t cleanup_gnutls_session(void *data)
714{
715    /* nothing to do */
716    if (data == NULL)
717        return APR_SUCCESS;
718
719    /* check if session needs closing */
720    mgs_handle_t *ctxt = (mgs_handle_t *) data;
721    if (ctxt->session != NULL)
722    {
723        ap_log_cerror(APLOG_MARK, APLOG_WARNING, APR_ECONNABORTED, ctxt->c,
724                      "%s: connection pool cleanup in progress but %sTLS "
725                      "session hasn't been terminated, trying to close",
726                      __func__, IS_PROXY_STR(ctxt));
727        int ret;
728        /* Try A Clean Shutdown */
729        do
730            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
731        while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
732        if (ret != GNUTLS_E_SUCCESS)
733            ap_log_cerror(APLOG_MARK, APLOG_INFO, APR_EGENERAL, ctxt->c,
734                          "%s: error while closing TLS %sconnection: %s (%d)",
735                          __func__, IS_PROXY_STR(ctxt),
736                          gnutls_strerror(ret), ret);
737        else
738            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
739                          "%s: TLS %sconnection closed.",
740                          __func__, IS_PROXY_STR(ctxt));
741        /* De-Initialize Session */
742        gnutls_deinit(ctxt->session);
743        ctxt->session = NULL;
744    }
745    return APR_SUCCESS;
746}
747
748static void create_gnutls_handle(conn_rec * c)
749{
750    /* Get mod_gnutls server configuration */
751    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
752            ap_get_module_config(c->base_server->module_config, &gnutls_module);
753
754    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
755
756    /* Get connection specific configuration */
757    mgs_handle_t *ctxt = (mgs_handle_t *) ap_get_module_config(c->conn_config, &gnutls_module);
758    if (ctxt == NULL)
759    {
760        ctxt = apr_pcalloc(c->pool, sizeof (*ctxt));
761        ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
762        ctxt->is_proxy = GNUTLS_ENABLED_FALSE;
763    }
764    ctxt->enabled = GNUTLS_ENABLED_TRUE;
765    ctxt->c = c;
766    ctxt->sc = sc;
767    ctxt->status = 0;
768    ctxt->input_rc = APR_SUCCESS;
769    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
770    ctxt->input_cbuf.length = 0;
771    ctxt->output_rc = APR_SUCCESS;
772    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
773    ctxt->output_blen = 0;
774    ctxt->output_length = 0;
775
776    /* Initialize GnuTLS Library */
777    int err = 0;
778    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
779    {
780        /* this is an outgoing proxy connection, client mode */
781        err = gnutls_init(&ctxt->session, GNUTLS_CLIENT);
782        if (err != GNUTLS_E_SUCCESS)
783            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
784                          "gnutls_init for proxy connection failed: %s (%d)",
785                          gnutls_strerror(err), err);
786        err = gnutls_session_ticket_enable_client(ctxt->session);
787        if (err != GNUTLS_E_SUCCESS)
788            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
789                          "gnutls_session_ticket_enable_client failed: %s (%d)",
790                          gnutls_strerror(err), err);
791    }
792    else
793    {
794        /* incoming connection, server mode */
795        err = gnutls_init(&ctxt->session, GNUTLS_SERVER);
796        if (err != GNUTLS_E_SUCCESS)
797            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
798                          "gnutls_init for server side failed: %s (%d)",
799                          gnutls_strerror(err), err);
800        /* Initialize Session Tickets */
801        if (session_ticket_key.data != NULL && ctxt->sc->tickets != 0)
802        {
803            err = gnutls_session_ticket_enable_server(ctxt->session, &session_ticket_key);
804            if (err != GNUTLS_E_SUCCESS)
805                ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
806                              "gnutls_session_ticket_enable_server failed: %s (%d)",
807                              gnutls_strerror(err), err);
808        }
809    }
810
811    /* Ensure TLS session resources are released when the connection
812     * pool is cleared, if the filters haven't done that already. */
813    apr_pool_pre_cleanup_register(c->pool, ctxt, cleanup_gnutls_session);
814
815    /* Set Default Priority */
816        err = gnutls_priority_set_direct(ctxt->session, "NORMAL", NULL);
817    if (err != GNUTLS_E_SUCCESS)
818        ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c, "gnutls_priority_set_direct failed!");
819    /* Set Handshake function */
820    gnutls_handshake_set_post_client_hello_function(ctxt->session,
821            mgs_select_virtual_server_cb);
822
823    /* Set GnuTLS user pointer, so we can access the module session
824     * context in GnuTLS callbacks */
825    gnutls_session_set_ptr(ctxt->session, ctxt);
826
827    /* If mod_gnutls is the TLS server, mgs_select_virtual_server_cb
828     * will load appropriate credentials during handshake. However,
829     * when handling a proxy backend connection, mod_gnutls acts as
830     * TLS client and credentials must be loaded here. */
831    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
832    {
833        /* Set anonymous client credentials for proxy connections */
834        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_ANON,
835                               ctxt->sc->anon_client_creds);
836        /* Set x509 credentials */
837        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_CERTIFICATE,
838                               ctxt->sc->proxy_x509_creds);
839        /* Load priorities from the server configuration */
840        err = gnutls_priority_set(ctxt->session, ctxt->sc->proxy_priorities);
841        if (err != GNUTLS_E_SUCCESS)
842            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
843                          "%s: setting priorities for proxy connection "
844                          "failed: %s (%d)",
845                          __func__, gnutls_strerror(err), err);
846    }
847
848    /* Initialize Session Cache */
849    mgs_cache_session_init(ctxt);
850
851    /* Set pull, push & ptr functions */
852    gnutls_transport_set_pull_function(ctxt->session,
853            mgs_transport_read);
854    gnutls_transport_set_push_function(ctxt->session,
855            mgs_transport_write);
856    gnutls_transport_set_ptr(ctxt->session, ctxt);
857    /* Add IO filters */
858    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME,
859            ctxt, NULL, c);
860    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
861            ctxt, NULL, c);
862}
863
864int mgs_hook_pre_connection(conn_rec * c, void *csd __attribute__((unused)))
865{
866    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
867
868    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
869        ap_get_module_config(c->base_server->module_config, &gnutls_module);
870    mgs_handle_t *ctxt = (mgs_handle_t *)
871        ap_get_module_config(c->conn_config, &gnutls_module);
872
873    if ((sc && (!sc->enabled)) || (ctxt && ctxt->enabled == GNUTLS_ENABLED_FALSE))
874    {
875        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, c, "%s declined connection",
876                      __func__);
877        return DECLINED;
878    }
879
880    create_gnutls_handle(c);
881    return OK;
882}
883
884int mgs_hook_fixups(request_rec * r) {
885    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
886    const char *tmp;
887    size_t len;
888    mgs_handle_t *ctxt;
889    int rv = OK;
890
891    if (r == NULL)
892        return DECLINED;
893
894    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
895    apr_table_t *env = r->subprocess_env;
896
897    ctxt = ap_get_module_config(r->connection->conn_config,
898                                &gnutls_module);
899
900    if (!ctxt || ctxt->enabled != GNUTLS_ENABLED_TRUE || ctxt->session == NULL)
901    {
902        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "request declined in %s", __func__);
903        return DECLINED;
904    }
905
906    apr_table_setn(env, "HTTPS", "on");
907
908    apr_table_setn(env, "SSL_VERSION_LIBRARY",
909            "GnuTLS/" LIBGNUTLS_VERSION);
910    apr_table_setn(env, "SSL_VERSION_INTERFACE",
911            "mod_gnutls/" MOD_GNUTLS_VERSION);
912
913    apr_table_setn(env, "SSL_PROTOCOL",
914            gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
915
916    /* should have been called SSL_CIPHERSUITE instead */
917    apr_table_setn(env, "SSL_CIPHER",
918            gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
919                                         gnutls_cipher_get(ctxt->session),
920                                         gnutls_mac_get(ctxt->session)));
921
922    apr_table_setn(env, "SSL_COMPRESS_METHOD",
923            gnutls_compression_get_name(gnutls_compression_get(ctxt->session)));
924
925#ifdef ENABLE_SRP
926    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
927        tmp = gnutls_srp_server_get_username(ctxt->session);
928        apr_table_setn(env, "SSL_SRP_USER", (tmp != NULL) ? tmp : "");
929    } else {
930        apr_table_unset(env, "SSL_SRP_USER");
931    }
932#endif
933
934    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
935        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
936
937    unsigned int key_size = 8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
938    tmp = apr_psprintf(r->pool, "%u", key_size);
939
940    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
941
942    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
943
944    apr_table_setn(env, "SSL_CIPHER_EXPORT",
945            (key_size <= 40) ? "true" : "false");
946
947    int dhsize = gnutls_dh_get_prime_bits(ctxt->session);
948    if (dhsize > 0) {
949        tmp = apr_psprintf(r->pool, "%d", dhsize);
950        apr_table_setn(env, "SSL_DH_PRIME_BITS", tmp);
951    }
952
953    len = sizeof (sbuf);
954    gnutls_session_get_id(ctxt->session, sbuf, &len);
955    apr_table_setn(env, "SSL_SESSION_ID",
956                   apr_pescape_hex(r->pool, sbuf, len, 0));
957
958    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
959        mgs_add_common_cert_vars(r, ctxt->sc->certs_x509_crt_chain[0], 0, ctxt->sc->export_certificates_size);
960    } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
961        mgs_add_common_pgpcert_vars(r, ctxt->sc->cert_crt_pgp[0], 0, ctxt->sc->export_certificates_size);
962    }
963
964    return rv;
965}
966
967int mgs_hook_authz(request_rec * r) {
968    int rv;
969    mgs_handle_t *ctxt;
970    mgs_dirconf_rec *dc;
971
972    if (r == NULL)
973        return DECLINED;
974
975    dc = ap_get_module_config(r->per_dir_config, &gnutls_module);
976
977    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
978    ctxt =
979            ap_get_module_config(r->connection->conn_config,
980            &gnutls_module);
981
982    if (!ctxt || ctxt->session == NULL) {
983        return DECLINED;
984    }
985
986    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
987        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
988                "GnuTLS: Directory set to Ignore Client Certificate!");
989    } else {
990        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
991            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
992                    "GnuTLS: Attempting to rehandshake with peer. %d %d",
993                    ctxt->sc->client_verify_mode,
994                    dc->client_verify_mode);
995
996            /* If we already have a client certificate, there's no point in
997             * re-handshaking... */
998            rv = mgs_cert_verify(r, ctxt);
999            if (rv != DECLINED && rv != HTTP_FORBIDDEN)
1000                return rv;
1001
1002            gnutls_certificate_server_set_request
1003                    (ctxt->session, dc->client_verify_mode);
1004
1005            if (mgs_rehandshake(ctxt) != 0) {
1006                return HTTP_FORBIDDEN;
1007            }
1008        } else if (ctxt->sc->client_verify_mode ==
1009                GNUTLS_CERT_IGNORE) {
1010#if MOD_GNUTLS_DEBUG
1011            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1012                    "GnuTLS: Peer is set to IGNORE");
1013#endif
1014            return DECLINED;
1015        }
1016        rv = mgs_cert_verify(r, ctxt);
1017        if (rv != DECLINED
1018            && (rv != HTTP_FORBIDDEN
1019                || dc->client_verify_mode == GNUTLS_CERT_REQUIRE
1020                || (dc->client_verify_mode == -1
1021                    && ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUIRE)))
1022        {
1023            return rv;
1024        }
1025    }
1026
1027    return DECLINED;
1028}
1029
1030/* variables that are not sent by default:
1031 *
1032 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
1033 * SSL_SERVER_CERT      string  PEM-encoded client certificate
1034 */
1035
1036/* @param side is either 0 for SERVER or 1 for CLIENT
1037 *
1038 * @param export_cert_size (int) maximum size for environment variable
1039 * to use for the PEM-encoded certificate (0 means do not export)
1040 */
1041#define MGS_SIDE(suffix) ((side==0) ? "SSL_SERVER" suffix : "SSL_CLIENT" suffix)
1042
1043static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size) {
1044    unsigned char sbuf[64]; /* buffer to hold serials */
1045    char buf[AP_IOBUFSIZE];
1046    const char *tmp;
1047    char *tmp2;
1048    size_t len;
1049    int ret;
1050
1051    if (r == NULL)
1052        return;
1053
1054    apr_table_t *env = r->subprocess_env;
1055
1056    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1057    if (export_cert_size > 0) {
1058        len = 0;
1059        ret = gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, NULL, &len);
1060        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
1061            if (len >= export_cert_size) {
1062                apr_table_setn(env, MGS_SIDE("_CERT"), "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
1063                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1064                              "GnuTLS: Failed to export too-large X.509 certificate to environment");
1065            } else {
1066                char* cert_buf = apr_palloc(r->pool, len + 1);
1067                if (cert_buf != NULL && gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0) {
1068                    cert_buf[len] = 0;
1069                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
1070                } else {
1071                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1072                                  "GnuTLS: failed to export X.509 certificate");
1073                }
1074            }
1075        } else {
1076            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1077                          "GnuTLS: dazed and confused about X.509 certificate size");
1078        }
1079    }
1080
1081    len = sizeof (buf);
1082    gnutls_x509_crt_get_dn(cert, buf, &len);
1083    apr_table_setn(env, MGS_SIDE("_S_DN"), apr_pstrmemdup(r->pool, buf, len));
1084
1085    len = sizeof (buf);
1086    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
1087    apr_table_setn(env, MGS_SIDE("_I_DN"), apr_pstrmemdup(r->pool, buf, len));
1088
1089    len = sizeof (sbuf);
1090    gnutls_x509_crt_get_serial(cert, sbuf, &len);
1091    apr_table_setn(env, MGS_SIDE("_M_SERIAL"),
1092                   apr_pescape_hex(r->pool, sbuf, len, 0));
1093
1094    ret = gnutls_x509_crt_get_version(cert);
1095    if (ret > 0)
1096        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
1097                       apr_psprintf(r->pool, "%u", ret));
1098
1099    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "X.509");
1100
1101    tmp =
1102            mgs_time2sz(gnutls_x509_crt_get_expiration_time
1103            (cert), buf, sizeof (buf));
1104    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
1105
1106    tmp =
1107            mgs_time2sz(gnutls_x509_crt_get_activation_time
1108            (cert), buf, sizeof (buf));
1109    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
1110
1111    ret = gnutls_x509_crt_get_signature_algorithm(cert);
1112    if (ret >= 0) {
1113        apr_table_setn(env, MGS_SIDE("_A_SIG"),
1114                gnutls_sign_algorithm_get_name(ret));
1115    }
1116
1117    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
1118    if (ret >= 0) {
1119        apr_table_setn(env, MGS_SIDE("_A_KEY"),
1120                gnutls_pk_algorithm_get_name(ret));
1121    }
1122
1123    /* export all the alternative names (DNS, RFC822 and URI) */
1124    for (int i = 0; !(ret < 0); i++)
1125    {
1126        const char *san, *sanlabel;
1127        len = 0;
1128        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
1129                NULL, &len,
1130                NULL);
1131
1132        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
1133            tmp2 = apr_palloc(r->pool, len + 1);
1134
1135            ret =
1136                    gnutls_x509_crt_get_subject_alt_name(cert, i,
1137                    tmp2,
1138                    &len,
1139                    NULL);
1140            tmp2[len] = 0;
1141
1142            sanlabel = apr_psprintf(r->pool, "%s%u", MGS_SIDE("_S_AN"), i);
1143            if (ret == GNUTLS_SAN_DNSNAME) {
1144                san = apr_psprintf(r->pool, "DNSNAME:%s", tmp2);
1145            } else if (ret == GNUTLS_SAN_RFC822NAME) {
1146                san = apr_psprintf(r->pool, "RFC822NAME:%s", tmp2);
1147            } else if (ret == GNUTLS_SAN_URI) {
1148                san = apr_psprintf(r->pool, "URI:%s", tmp2);
1149            } else {
1150                san = "UNSUPPORTED";
1151            }
1152            apr_table_setn(env, sanlabel, san);
1153        }
1154    }
1155}
1156
1157
1158/* @param side 0: server, 1: client
1159 *
1160 * @param export_cert_size (int) maximum size for environment variable
1161 * to use for the PEM-encoded certificate (0 means do not export)
1162 */
1163static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, size_t export_cert_size) {
1164
1165        unsigned char sbuf[64]; /* buffer to hold serials */
1166    char buf[AP_IOBUFSIZE];
1167    const char *tmp;
1168    size_t len;
1169    int ret;
1170
1171    if (r == NULL)
1172        return;
1173
1174    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1175    apr_table_t *env = r->subprocess_env;
1176
1177    if (export_cert_size > 0) {
1178        len = 0;
1179        ret = gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, NULL, &len);
1180        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
1181            if (len >= export_cert_size) {
1182                apr_table_setn(env, MGS_SIDE("_CERT"),
1183                               "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
1184                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1185                              "GnuTLS: Failed to export too-large OpenPGP certificate to environment");
1186            } else {
1187                char* cert_buf = apr_palloc(r->pool, len + 1);
1188                if (cert_buf != NULL && gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, cert_buf, &len) >= 0) {
1189                    cert_buf[len] = 0;
1190                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
1191                } else {
1192                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1193                                  "GnuTLS: failed to export OpenPGP certificate");
1194                }
1195            }
1196        } else {
1197            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1198                          "GnuTLS: dazed and confused about OpenPGP certificate size");
1199        }
1200    }
1201
1202    len = sizeof (buf);
1203    gnutls_openpgp_crt_get_name(cert, 0, buf, &len);
1204    apr_table_setn(env, MGS_SIDE("_NAME"), apr_pstrmemdup(r->pool, buf, len));
1205
1206    len = sizeof (sbuf);
1207    gnutls_openpgp_crt_get_fingerprint(cert, sbuf, &len);
1208    apr_table_setn(env, MGS_SIDE("_FINGERPRINT"),
1209                   apr_pescape_hex(r->pool, sbuf, len, 0));
1210
1211    ret = gnutls_openpgp_crt_get_version(cert);
1212    if (ret > 0)
1213        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
1214                       apr_psprintf(r->pool, "%u", ret));
1215
1216    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "OPENPGP");
1217
1218    tmp =
1219            mgs_time2sz(gnutls_openpgp_crt_get_expiration_time
1220            (cert), buf, sizeof (buf));
1221    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
1222
1223    tmp =
1224            mgs_time2sz(gnutls_openpgp_crt_get_creation_time
1225            (cert), buf, sizeof (buf));
1226    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
1227
1228    ret = gnutls_openpgp_crt_get_pk_algorithm(cert, NULL);
1229    if (ret >= 0) {
1230        apr_table_setn(env, MGS_SIDE("_A_KEY"), gnutls_pk_algorithm_get_name(ret));
1231    }
1232
1233}
1234
1235/* TODO: Allow client sending a X.509 certificate chain */
1236static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt) {
1237    const gnutls_datum_t *cert_list;
1238    unsigned int cert_list_size;
1239    /* assume the certificate is invalid unless explicitly set
1240     * otherwise */
1241    unsigned int status = GNUTLS_CERT_INVALID;
1242    int rv = GNUTLS_E_NO_CERTIFICATE_FOUND, ret;
1243    unsigned int ch_size = 0;
1244
1245    union {
1246        gnutls_x509_crt_t x509[MAX_CHAIN_SIZE];
1247        gnutls_openpgp_crt_t pgp;
1248    } cert;
1249    apr_time_t expiration_time, cur_time;
1250
1251    if (r == NULL || ctxt == NULL || ctxt->session == NULL)
1252        return HTTP_FORBIDDEN;
1253
1254    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1255    cert_list =
1256            gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
1257
1258    if (cert_list == NULL || cert_list_size == 0) {
1259        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
1260         */
1261        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1262            return OK;
1263
1264        /* no certificate provided by the client, but one was required. */
1265        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1266                "GnuTLS: Failed to Verify Peer: "
1267                "Client did not submit a certificate");
1268        return HTTP_FORBIDDEN;
1269    }
1270
1271    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1272        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1273                "GnuTLS: A Chain of %d certificate(s) was provided for validation",
1274                cert_list_size);
1275
1276        for (ch_size = 0; ch_size < cert_list_size; ch_size++) {
1277            gnutls_x509_crt_init(&cert.x509[ch_size]);
1278            rv = gnutls_x509_crt_import(cert.x509[ch_size],
1279                    &cert_list[ch_size],
1280                    GNUTLS_X509_FMT_DER);
1281            // When failure to import, leave the loop
1282            if (rv != GNUTLS_E_SUCCESS) {
1283                if (ch_size < 1) {
1284                    ap_log_rerror(APLOG_MARK,
1285                            APLOG_INFO, 0, r,
1286                            "GnuTLS: Failed to Verify Peer: "
1287                            "Failed to import peer certificates.");
1288                    ret = HTTP_FORBIDDEN;
1289                    goto exit;
1290                }
1291                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1292                        "GnuTLS: Failed to import some peer certificates. Using %d certificates",
1293                        ch_size);
1294                rv = GNUTLS_E_SUCCESS;
1295                break;
1296            }
1297        }
1298    } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
1299        if (cert_list_size > 1) {
1300            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1301                    "GnuTLS: Failed to Verify Peer: "
1302                    "Chained Client Certificates are not supported.");
1303            return HTTP_FORBIDDEN;
1304        }
1305
1306        gnutls_openpgp_crt_init(&cert.pgp);
1307        rv = gnutls_openpgp_crt_import(cert.pgp, &cert_list[0],
1308                GNUTLS_OPENPGP_FMT_RAW);
1309
1310    } else
1311        return HTTP_FORBIDDEN;
1312
1313    if (rv < 0) {
1314        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1315                "GnuTLS: Failed to Verify Peer: "
1316                "Failed to import peer certificates.");
1317        ret = HTTP_FORBIDDEN;
1318        goto exit;
1319    }
1320
1321    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1322        apr_time_ansi_put(&expiration_time,
1323                gnutls_x509_crt_get_expiration_time
1324                (cert.x509[0]));
1325
1326        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1327                      "GnuTLS: Verifying list of %d certificate(s) via method '%s'",
1328                      ch_size, mgs_readable_cvm(ctxt->sc->client_verify_method));
1329        switch(ctxt->sc->client_verify_method) {
1330        case mgs_cvm_cartel:
1331            rv = gnutls_x509_crt_list_verify(cert.x509, ch_size,
1332                                             ctxt->sc->ca_list,
1333                                             ctxt->sc->ca_list_size,
1334                                             NULL, 0, 0, &status);
1335            break;
1336#ifdef ENABLE_MSVA
1337        case mgs_cvm_msva:
1338        {
1339            struct msv_response* resp = NULL;
1340            struct msv_query q = { .context="https", .peertype="client", .pkctype="x509pem" };
1341            msv_ctxt_t ctx = msv_ctxt_init(NULL);
1342            char cert_pem_buf[10 * 1024];
1343            size_t len = sizeof (cert_pem_buf);
1344
1345            rv = 0;
1346            if (gnutls_x509_crt_export(cert.x509[0], GNUTLS_X509_FMT_PEM, cert_pem_buf, &len) >= 0) {
1347                /* FIXME : put together a name from the cert we received, instead of hard-coding this value: */
1348                q.peername = mgs_x509_construct_uid(r, cert.x509[0]);
1349                q.pkcdata = cert_pem_buf;
1350                rv = msv_query_agent(ctx, q, &resp);
1351                if (rv == LIBMSV_ERROR_SUCCESS) {
1352                    status = 0;
1353                } else if (rv == LIBMSV_ERROR_INVALID) {
1354                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1355                                  "GnuTLS: Monkeysphere validation failed: (message: %s)", resp->message);
1356                    status = GNUTLS_CERT_INVALID;
1357                } else {
1358                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1359                                  "GnuTLS: Error communicating with the Monkeysphere Validation Agent: (%d) %s", rv, msv_strerror(ctx, rv));
1360                    status = GNUTLS_CERT_INVALID;
1361                    rv = -1;
1362                }
1363            } else {
1364                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1365                              "GnuTLS: Could not convert the client certificate to PEM format");
1366                status = GNUTLS_CERT_INVALID;
1367                rv = GNUTLS_E_ASN1_ELEMENT_NOT_FOUND;
1368            }
1369            msv_response_destroy(resp);
1370            msv_ctxt_destroy(ctx);
1371        }
1372            break;
1373#endif
1374        default:
1375            /* If this block is reached, that indicates a
1376             * configuration error or bug in mod_gnutls (invalid value
1377             * of ctxt->sc->client_verify_method). */
1378            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1379                          "GnuTLS: Failed to Verify X.509 Peer: method '%s' is not supported",
1380                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1381            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1382        }
1383
1384    } else {
1385        apr_time_ansi_put(&expiration_time,
1386                gnutls_openpgp_crt_get_expiration_time
1387                (cert.pgp));
1388
1389        switch(ctxt->sc->client_verify_method) {
1390        case mgs_cvm_cartel:
1391            rv = gnutls_openpgp_crt_verify_ring(cert.pgp,
1392                                                ctxt->sc->pgp_list, 0,
1393                                                &status);
1394            break;
1395#ifdef ENABLE_MSVA
1396        case mgs_cvm_msva:
1397            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1398                          "GnuTLS:  OpenPGP verification via MSVA is not yet implemented");
1399            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1400            break;
1401#endif
1402        default:
1403            /* If this block is reached, that indicates a
1404             * configuration error or bug in mod_gnutls (invalid value
1405             * of ctxt->sc->client_verify_method). */
1406            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1407                          "GnuTLS: Failed to Verify OpenPGP Peer: method '%s' is not supported",
1408                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1409            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1410        }
1411    }
1412
1413    /* "goto exit" at the end of this block skips evaluation of the
1414     * "status" variable */
1415    if (rv < 0) {
1416        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1417                "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1418                rv, gnutls_strerror(rv));
1419        if (rv == GNUTLS_E_NO_CERTIFICATE_FOUND)
1420            ap_log_rerror(APLOG_MARK, APLOG_EMERG, 0, r,
1421                "GnuTLS: No certificate was found for verification. Did you set the GnuTLSX509CAFile or GnuTLSPGPKeyringFile directives?");
1422        ret = HTTP_FORBIDDEN;
1423        goto exit;
1424    }
1425
1426    /* TODO: X509 CRL Verification. */
1427    /* May add later if anyone needs it.
1428     */
1429    /* ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size); */
1430
1431    cur_time = apr_time_now();
1432
1433    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1434        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1435                "GnuTLS: Could not find Signer for Peer Certificate");
1436    }
1437
1438    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1439        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1440                "GnuTLS: Peer's Certificate signer is not a CA");
1441    }
1442
1443    if (status & GNUTLS_CERT_INSECURE_ALGORITHM) {
1444        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1445                "GnuTLS: Peer's Certificate is using insecure algorithms");
1446    }
1447
1448    if (status & GNUTLS_CERT_EXPIRED
1449            || status & GNUTLS_CERT_NOT_ACTIVATED) {
1450        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1451                "GnuTLS: Peer's Certificate signer is expired or not yet activated");
1452    }
1453
1454    if (status & GNUTLS_CERT_INVALID) {
1455        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1456                "GnuTLS: Peer Certificate is invalid.");
1457    } else if (status & GNUTLS_CERT_REVOKED) {
1458        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1459                "GnuTLS: Peer Certificate is revoked.");
1460    }
1461
1462    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509)
1463        mgs_add_common_cert_vars(r, cert.x509[0], 1, ctxt->sc->export_certificates_size);
1464    else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP)
1465        mgs_add_common_pgpcert_vars(r, cert.pgp, 1, ctxt->sc->export_certificates_size);
1466
1467    {
1468        /* days remaining */
1469        unsigned long remain =
1470                (apr_time_sec(expiration_time) -
1471                apr_time_sec(cur_time)) / 86400;
1472        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1473                apr_psprintf(r->pool, "%lu", remain));
1474    }
1475
1476    if (status == 0) {
1477        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1478                "SUCCESS");
1479        ret = OK;
1480    } else {
1481        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1482                "FAILED");
1483        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1484            ret = OK;
1485        else
1486            ret = HTTP_FORBIDDEN;
1487    }
1488
1489exit:
1490    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509)
1491        for (unsigned int i = 0; i < ch_size; i++)
1492            gnutls_x509_crt_deinit(cert.x509[i]);
1493    else if (gnutls_certificate_type_get(ctxt->session) ==
1494             GNUTLS_CRT_OPENPGP)
1495        gnutls_openpgp_crt_deinit(cert.pgp);
1496    return ret;
1497}
1498
1499
1500
1501#ifdef ENABLE_MSVA
1502/* this section of code is used only when trying to talk to the MSVA */
1503static const char* mgs_x509_leaf_oid_from_dn(apr_pool_t *pool, const char* oid, gnutls_x509_crt_t cert) {
1504    int rv=GNUTLS_E_SUCCESS, i;
1505    size_t sz=0, lastsz=0;
1506    char* data=NULL;
1507
1508    i = -1;
1509    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1510        i++;
1511        lastsz=sz;
1512        sz=0;
1513        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i, 0, NULL, &sz);
1514    }
1515    if (i > 0) {
1516        data = apr_palloc(pool, lastsz);
1517        sz=lastsz;
1518        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i-1, 0, data, &sz);
1519        if (rv == GNUTLS_E_SUCCESS)
1520            return data;
1521    }
1522    return NULL;
1523}
1524
1525static const char* mgs_x509_first_type_from_san(apr_pool_t *pool, gnutls_x509_subject_alt_name_t target, gnutls_x509_crt_t cert) {
1526    int rv=GNUTLS_E_SUCCESS;
1527    size_t sz;
1528    char* data=NULL;
1529    unsigned int i;
1530    gnutls_x509_subject_alt_name_t thistype;
1531
1532    i = 0;
1533    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1534        sz = 0;
1535        rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, NULL, &sz, &thistype, NULL);
1536        if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && thistype == target) {
1537            data = apr_palloc(pool, sz);
1538            rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, data, &sz, &thistype, NULL);
1539            if (rv >=0 && (thistype == target))
1540                return data;
1541        }
1542        i++;
1543    }
1544    return NULL;
1545}
1546
1547
1548/* Create a string representing a candidate User ID from an X.509
1549 * certificate
1550
1551 * We need this for client certification because a client gives us a
1552 * certificate, but doesn't tell us (in any other way) who they are
1553 * trying to authenticate as.
1554
1555 * TODO: we might need another parallel for OpenPGP, but for that it's
1556 * much simpler: we can just assume that the first User ID marked as
1557 * "primary" (or the first User ID, period) is the identity the user
1558 * is trying to present as.
1559
1560 * one complaint might be "but the user wanted to be another identity,
1561 * which is also in the certificate (e.g. in a SubjectAltName)"
1562 * However, given that any user can regenerate their own X.509
1563 * certificate with their own public key content, they should just do
1564 * so, and not expect us to guess at their identity :)
1565
1566 * This function allocates it's response from the pool given it.  When
1567 * that pool is reclaimed, the response will also be deallocated.
1568
1569 * FIXME: what about extracting a server-style cert
1570 *        (e.g. https://imposter.example) from the DN or any sAN?
1571
1572 * FIXME: what if we want to call this outside the context of a
1573 *        request?  That complicates the logging.
1574 */
1575static const char* mgs_x509_construct_uid(request_rec *r, gnutls_x509_crt_t cert) {
1576    /* basic strategy, assuming humans are the users: we are going to
1577     * try to reconstruct a "conventional" User ID by pulling in a
1578     * name, comment, and e-mail address.
1579     */
1580    apr_pool_t *pool = r->pool;
1581    const char *name=NULL, *comment=NULL, *email=NULL;
1582    const char *ret=NULL;
1583    /* subpool for temporary allocation: */
1584    apr_pool_t *sp=NULL;
1585
1586    if (APR_SUCCESS != apr_pool_create(&sp, pool))
1587        return NULL; /* i'm assuming that libapr would log this kind
1588                      * of error on its own */
1589
1590     /* Name
1591
1592     the name comes from the leaf commonName of the cert's Subject.
1593
1594     (MAYBE: should we look at trying to assemble a candidate from
1595             givenName, surName, suffix, etc?  the "name" field
1596             appears to be case-insensitive, which seems problematic
1597             from what we expect; see:
1598             http://www.itu.int/rec/T-REC-X.520-200102-s/e )
1599
1600     (MAYBE: should we try pulling a commonName or otherName or
1601             something from subjectAltName? see:
1602             https://tools.ietf.org/html/rfc5280#section-4.2.1.6
1603             GnuTLS does not support looking for Common Names in the
1604             SAN yet)
1605     */
1606    name = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_COMMON_NAME, cert);
1607
1608    /* Comment
1609
1610       I am inclined to punt on this for now, as Comment has been so
1611       atrociously misused in OpenPGP.  Perhaps if there is a
1612       pseudonym (OID 2.5.4.65, aka GNUTLS_OID_X520_PSEUDONYM) field
1613       in the subject or sAN?
1614    */
1615    comment = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_PSEUDONYM, cert);
1616
1617    /* E-mail
1618
1619       This should be the the first rfc822Name from the sAN.
1620
1621       failing that, we'll take the leaf email in the certificate's
1622       subject; this is a deprecated use though.
1623     */
1624    email = mgs_x509_first_type_from_san(sp, GNUTLS_SAN_RFC822NAME, cert);
1625    if (email == NULL)
1626        email = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_PKCS9_EMAIL, cert);
1627
1628    /* assemble all the parts: */
1629
1630    /* must have at least a name or an e-mail. */
1631    if (name == NULL && email == NULL) {
1632        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1633                "GnuTLS: Need either a name or an e-mail address to get a User ID from an X.509 certificate.");
1634        goto end;
1635    }
1636    if (name) {
1637        if (comment) {
1638            if (email) {
1639                ret = apr_psprintf(pool, "%s (%s) <%s>", name, comment, email);
1640            } else {
1641                ret = apr_psprintf(pool, "%s (%s)", name, comment);
1642            }
1643        } else {
1644            if (email) {
1645                ret = apr_psprintf(pool, "%s <%s>", name, email);
1646            } else {
1647                ret = apr_pstrdup(pool, name);
1648            }
1649        }
1650    } else {
1651        if (comment) {
1652            ret = apr_psprintf(pool, "(%s) <%s>", comment, email);
1653        } else {
1654            ret = apr_psprintf(pool, "<%s>", email);
1655        }
1656    }
1657
1658end:
1659    apr_pool_destroy(sp);
1660    return ret;
1661}
1662#endif /* ENABLE_MSVA */
1663
1664
1665
1666/*
1667 * This hook writes the mod_gnutls status message for a mod_status
1668 * report. According to the comments in mod_status.h, the "flags"
1669 * parameter is a bitwise OR of the AP_STATUS_ flags.
1670 *
1671 * Note that this implementation gives flags explicitly requesting a
1672 * simple response priority, e.g. if AP_STATUS_SHORT is set, flags
1673 * requesting an HTML report will be ignored. As of Apache 2.4.10, the
1674 * following flags were defined in mod_status.h:
1675 *
1676 * AP_STATUS_SHORT (short, non-HTML report requested)
1677 * AP_STATUS_NOTABLE (HTML report without tables)
1678 * AP_STATUS_EXTENDED (detailed report)
1679 */
1680static int mgs_status_hook(request_rec *r, int flags)
1681{
1682    if (r == NULL)
1683        return OK;
1684
1685    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
1686        ap_get_module_config(r->server->module_config, &gnutls_module);
1687
1688    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1689
1690    if (flags & AP_STATUS_SHORT)
1691    {
1692        ap_rprintf(r, "Using GnuTLS version: %s\n", gnutls_check_version(NULL));
1693        ap_rputs("Built against GnuTLS version: " GNUTLS_VERSION "\n", r);
1694    }
1695    else
1696    {
1697        ap_rputs("<hr>\n", r);
1698        ap_rputs("<h2>GnuTLS Information:</h2>\n<dl>\n", r);
1699
1700        ap_rprintf(r, "<dt>Using GnuTLS version:</dt><dd>%s</dd>\n",
1701                   gnutls_check_version(NULL));
1702        ap_rputs("<dt>Built against GnuTLS version:</dt><dd>"
1703                 GNUTLS_VERSION "</dd>\n", r);
1704        ap_rprintf(r, "<dt>Using TLS:</dt><dd>%s</dd>\n",
1705                   (sc->enabled == GNUTLS_ENABLED_FALSE ? "no" : "yes"));
1706    }
1707
1708    if (sc->enabled != GNUTLS_ENABLED_FALSE)
1709    {
1710        mgs_handle_t* ctxt =
1711            ap_get_module_config(r->connection->conn_config, &gnutls_module);
1712        if (ctxt && ctxt->session != NULL)
1713        {
1714            char* s_info = gnutls_session_get_desc(ctxt->session);
1715            if (s_info)
1716            {
1717                if (flags & AP_STATUS_SHORT)
1718                    ap_rprintf(r, "Current TLS session: %s\n", s_info);
1719                else
1720                    ap_rprintf(r, "<dt>Current TLS session:</dt><dd>%s</dd>\n",
1721                               s_info);
1722                gnutls_free(s_info);
1723            }
1724        }
1725    }
1726
1727    if (!(flags & AP_STATUS_SHORT))
1728        ap_rputs("</dl>\n", r);
1729
1730    return OK;
1731}
1732
1733
1734
1735/*
1736 * Callback to check the server certificate for proxy HTTPS
1737 * connections, to be used with
1738 * gnutls_certificate_set_verify_function.
1739
1740 * Returns: 0 if certificate check was successful (certificate
1741 * trusted), non-zero otherwise (error during check or untrusted
1742 * certificate).
1743 */
1744static int gtls_check_server_cert(gnutls_session_t session)
1745{
1746    mgs_handle_t *ctxt = (mgs_handle_t *) gnutls_session_get_ptr(session);
1747    unsigned int status;
1748
1749    /* Get peer hostname from a note left by mod_proxy */
1750    const char *peer_hostname =
1751        apr_table_get(ctxt->c->notes, "proxy-request-hostname");
1752    if (peer_hostname == NULL)
1753        ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
1754                      "%s: proxy-request-hostname is NULL, cannot check "
1755                      "peer's hostname", __func__);
1756
1757    /* Verify certificate, including hostname match. Should
1758     * peer_hostname be NULL for some reason, the name is not
1759     * checked. */
1760    int err = gnutls_certificate_verify_peers3(session, peer_hostname,
1761                                               &status);
1762    if (err != GNUTLS_E_SUCCESS)
1763    {
1764        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
1765                      "%s: server certificate check failed: %s (%d)",
1766                      __func__, gnutls_strerror(err), err);
1767        return err;
1768    }
1769
1770    gnutls_datum_t * out = gnutls_malloc(sizeof(gnutls_datum_t));
1771    /* GNUTLS_CRT_X509: ATM, only X509 is supported for proxy certs
1772     * 0: according to function API, the last argument should be 0 */
1773    err = gnutls_certificate_verification_status_print(status, GNUTLS_CRT_X509,
1774                                                       out, 0);
1775    if (err != GNUTLS_E_SUCCESS)
1776        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
1777                      "%s: server verify print failed: %s (%d)",
1778                      __func__, gnutls_strerror(err), err);
1779    else
1780    {
1781        /* If the certificate is trusted, logging the result is just
1782         * nice for debugging. But if the back end server provided an
1783         * untrusted certificate, warn! */
1784        int level = (status == 0 ? APLOG_DEBUG : APLOG_WARNING);
1785        ap_log_cerror(APLOG_MARK, level, 0, ctxt->c,
1786                      "%s: server certificate verify result: %s",
1787                      __func__, out->data);
1788    }
1789
1790    gnutls_free(out);
1791    return status;
1792}
1793
1794
1795
1796static apr_status_t load_proxy_x509_credentials(server_rec *s)
1797{
1798    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
1799        ap_get_module_config(s->module_config, &gnutls_module);
1800
1801    if (sc == NULL)
1802        return APR_EGENERAL;
1803
1804    apr_status_t ret = APR_SUCCESS;
1805    int err = GNUTLS_E_SUCCESS;
1806
1807    /* Function pool, gets destroyed before exit. */
1808    apr_pool_t *pool;
1809    ret = apr_pool_create(&pool, s->process->pool);
1810    if (ret != APR_SUCCESS)
1811    {
1812        ap_log_error(APLOG_MARK, APLOG_ERR, ret, s,
1813                     "%s: failed to allocate function memory pool.", __func__);
1814        return ret;
1815    }
1816
1817    /* allocate credentials structures */
1818    err = gnutls_certificate_allocate_credentials(&sc->proxy_x509_creds);
1819    if (err != GNUTLS_E_SUCCESS)
1820    {
1821        ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1822                     "%s: Failed to initialize proxy credentials: (%d) %s",
1823                     __func__, err, gnutls_strerror(err));
1824        return APR_EGENERAL;
1825    }
1826    err = gnutls_anon_allocate_client_credentials(&sc->anon_client_creds);
1827    if (err != GNUTLS_E_SUCCESS)
1828    {
1829        ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1830                     "%s: Failed to initialize anon credentials for proxy: "
1831                     "(%d) %s", __func__, err, gnutls_strerror(err));
1832        return APR_EGENERAL;
1833    }
1834
1835    /* Check if the proxy priorities have been set, fail immediately
1836     * if not */
1837    if (sc->proxy_priorities_str == NULL)
1838    {
1839        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
1840                     "Host '%s:%d' is missing the GnuTLSProxyPriorities "
1841                     "directive!",
1842                     s->server_hostname, s->port);
1843        return APR_EGENERAL;
1844    }
1845    /* parse proxy priorities */
1846    const char *err_pos = NULL;
1847    err = gnutls_priority_init(&sc->proxy_priorities,
1848                               sc->proxy_priorities_str, &err_pos);
1849    if (err != GNUTLS_E_SUCCESS)
1850    {
1851        if (ret == GNUTLS_E_INVALID_REQUEST)
1852            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1853                         "%s: Syntax error parsing proxy priorities "
1854                         "string at: %s",
1855                         __func__, err_pos);
1856        else
1857            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1858                         "Error setting proxy priorities: %s (%d)",
1859                         gnutls_strerror(err), err);
1860        ret = APR_EGENERAL;
1861    }
1862
1863    /* load certificate and key for client auth, if configured */
1864    if (sc->proxy_x509_key_file && sc->proxy_x509_cert_file)
1865    {
1866        char* cert_file = ap_server_root_relative(pool,
1867                                                  sc->proxy_x509_cert_file);
1868        char* key_file = ap_server_root_relative(pool,
1869                                                 sc->proxy_x509_key_file);
1870        err = gnutls_certificate_set_x509_key_file(sc->proxy_x509_creds,
1871                                                   cert_file,
1872                                                   key_file,
1873                                                   GNUTLS_X509_FMT_PEM);
1874        if (err != GNUTLS_E_SUCCESS)
1875        {
1876            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1877                         "%s: loading proxy client credentials failed: %s (%d)",
1878                         __func__, gnutls_strerror(err), err);
1879            ret = APR_EGENERAL;
1880        }
1881    }
1882    else if (!sc->proxy_x509_key_file && sc->proxy_x509_cert_file)
1883    {
1884        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
1885                     "%s: proxy key file not set!", __func__);
1886        ret = APR_EGENERAL;
1887    }
1888    else if (!sc->proxy_x509_cert_file && sc->proxy_x509_key_file)
1889    {
1890        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
1891                     "%s: proxy certificate file not set!", __func__);
1892        ret = APR_EGENERAL;
1893    }
1894    else
1895        /* if both key and cert are NULL, client auth is not used */
1896        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
1897                     "%s: no client credentials for proxy", __func__);
1898
1899    /* must be set if the server certificate is to be checked */
1900    if (sc->proxy_x509_ca_file)
1901    {
1902        /* initialize the trust list */
1903        err = gnutls_x509_trust_list_init(&sc->proxy_x509_tl, 0);
1904        if (err != GNUTLS_E_SUCCESS)
1905        {
1906            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1907                         "%s: gnutls_x509_trust_list_init failed: %s (%d)",
1908                         __func__, gnutls_strerror(err), err);
1909            ret = APR_EGENERAL;
1910        }
1911
1912        char* ca_file = ap_server_root_relative(pool,
1913                                                sc->proxy_x509_ca_file);
1914        /* if no CRL is used, sc->proxy_x509_crl_file is NULL */
1915        char* crl_file = NULL;
1916        if (sc->proxy_x509_crl_file)
1917            crl_file = ap_server_root_relative(pool,
1918                                               sc->proxy_x509_crl_file);
1919
1920        /* returns number of loaded elements */
1921        err = gnutls_x509_trust_list_add_trust_file(sc->proxy_x509_tl,
1922                                                    ca_file,
1923                                                    crl_file,
1924                                                    GNUTLS_X509_FMT_PEM,
1925                                                    0 /* tl_flags */,
1926                                                    0 /* tl_vflags */);
1927        if (err > 0)
1928            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
1929                         "%s: proxy CA trust list: %d structures loaded",
1930                         __func__, err);
1931        else if (err == 0)
1932            ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
1933                         "%s: proxy CA trust list is empty (%d)",
1934                         __func__, err);
1935        else /* err < 0 */
1936        {
1937            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1938                         "%s: error loading proxy CA trust list: %s (%d)",
1939                         __func__, gnutls_strerror(err), err);
1940            ret = APR_EGENERAL;
1941        }
1942
1943        /* attach trust list to credentials */
1944        gnutls_certificate_set_trust_list(sc->proxy_x509_creds,
1945                                          sc->proxy_x509_tl, 0);
1946    }
1947    else
1948        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
1949                     "%s: no CA trust list for proxy connections, "
1950                     "TLS connections will fail!", __func__);
1951
1952    gnutls_certificate_set_verify_function(sc->proxy_x509_creds,
1953                                           gtls_check_server_cert);
1954    apr_pool_destroy(pool);
1955    return ret;
1956}
Note: See TracBrowser for help on using the repository browser.