source: mod_gnutls/src/gnutls_hooks.c @ 4133f2d

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

Unify argument handling in mgs_set_priorities

Just store the argument in mgs_set_priorities for both front end and
proxy priorities. Like the front end priorities, the gnutls_priority_t
structure for proxy connections now gets initialized when the
credentials are loaded (load_proxy_x509_credentials in gnutls_hooks.c).

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