source: mod_gnutls/src/gnutls_hooks.c @ 70d014b

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

Deinit proxy credentials on config pool cleanup

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