source: mod_gnutls/src/gnutls_hooks.c @ f4deac5

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

Warn users about OpenPGP deprecation

OpenPGP support has been deprecated in GnuTLS since version 3.5.9 and
has already been removed completely on the git master branch.

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