source: mod_gnutls/src/gnutls_hooks.c @ eced11a

debian/masterproxy-ticket
Last change on this file since eced11a was eced11a, checked in by Fiona Klute <fiona.klute@…>, 2 years ago

Remove server variable ocsp_cache_enable

There is no need to explicitly disable the OCSP cache: It will be used
if OCSP stapling is enabled, and not used otherwise.

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