source: mod_gnutls/src/gnutls_hooks.c @ f21d2a6

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

Changed the semantics of GnuTLSP11Module

That setting instructs gnutls to load only the specified modules. That
protects mod_gnutls from loading unintended PKCS #11 modules.

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