source: mod_gnutls/src/gnutls_hooks.c @ 94cb972

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

Minimal OCSP stapling implementation using externally provided response

Works if the configured file contains a valid and current OCSP
response. Note that the module does not yet check those conditions,
the file is just read and forwarded to GnuTLS.

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