source: mod_gnutls/src/gnutls_hooks.c @ 8913410

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

Remove stale support code for Apache versions before 2.2

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