source: mod_gnutls/src/gnutls_hooks.c @ 4f7edd5

debian/masterdebian/stretch-backportsproxy-ticketupstream
Last change on this file since 4f7edd5 was 4f7edd5, checked in by Thomas Klute <thomas2.klute@…>, 4 years ago

Remove log for mutex creation errors (core logs them at emergency level)

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