source: mod_gnutls/src/gnutls_hooks.c @ 994a5fb

debian/masterdebian/stretch-backportsproxy-ticketupstream
Last change on this file since 994a5fb was 994a5fb, checked in by Thomas Klute <thomas2.klute@…>, 3 years ago

Do not reconfigure OCSP status callback on each connection

The callback is a property of the credentials, not the session, so
rewriting it during each handshake will create problems with parallel
connections on one virtual host. Set the callback once during
post_config instead, and get the mod_gnutls session context from the
GnuTLS session pointer instead of the callback pointer.

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