source: mod_gnutls/src/gnutls_hooks.c @ 017ef2d

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

Cleanup of post client hello and SNI handling functions

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