source: mod_gnutls/src/gnutls_hooks.c @ 08817d0

debian/masterdebian/stretch-backportsupstream
Last change on this file since 08817d0 was 04e6e65, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

Move declarations of cache-related functions to a dedicated header

This should make the code a little easier to understand, especially
regarding where these functions are used.

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