source: mod_gnutls/src/gnutls_hooks.c @ e809fb3

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

Use generic cache functions for OCSP response caching

With this, OCSP stapling works with all supported cache types.

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