source: mod_gnutls/src/gnutls_hooks.c @ 88df24d

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

Update GnuTLSP11Module documentation for stricter semantics

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