source: mod_gnutls/src/gnutls_hooks.c @ 44e8944

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

Allocate memory for X.509 and PGP certificates only when needed

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