source: mod_gnutls/src/gnutls_hooks.c @ fad7695

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

Store OCSP trust list in server config

This avoids recreating the trust list whenever an OCSP response has to
be verified.

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