source: mod_gnutls/src/gnutls_hooks.c @ 746e993

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

Formatting fix for PKCS #11 module loading

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