source: mod_gnutls/src/gnutls_hooks.c @ bd24203

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

Explicitly build trust list for proxy connections

This change provides direct access to the trust list, which is required
for loading a CRL later.

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