source: mod_gnutls/src/gnutls_hooks.c @ e389b85

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

Remove obsolete global GnuTLS (de)init calls

These calls have been obsolete since GnuTLS 3.3.0, the oldest version
mod_gnutls is currently compatible with.

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