source: mod_gnutls/src/gnutls_hooks.c @ 9ca1f21

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

Allow loading more than one PKCS #11 module using GnuTLSP11Module

This commit allows multiple modules to be loaded using the
GnuTLSP11Module directive. Each occurrence of GnuTLSP11Module causes the
given module to be added to a list, and all modules on that list are
loaded.

Commit f21d2a6dba6378b18d015dde88193fcad70d8728 disabled modules
configured through the system wide p11-kit configuration if
GnuTLSP11Module is set. With that change, using multiple PKCS #11
modules required using the system configuration, since only one module
could be loaded using GnuTLSP11Module.

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