source: mod_gnutls/src/gnutls_hooks.c @ 2ceb836

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

Update log messages on session termination (cleanup_gnutls_session, mgs_bye)

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