source: mod_gnutls/src/gnutls_hooks.c @ 4d4a406

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

New config option: GnuTLSOCSPStapling

This flag option enables/disables OCSP stapling, instead of enabling
stapling if a response file is set.

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