source: mod_gnutls/src/gnutls_hooks.c @ 87d507b

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

Overwrite session ticket key before releasing it

Private key material must not remain in released memory.

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