source: mod_gnutls/src/gnutls_hooks.c @ 92ac36e

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

Remove dead code in DH parameters setup

The dh_params variable in mgs_hook_post_config was initialized to NULL
and never changed, so the "if(dh_params)" branch was never taken.

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