source: mod_gnutls/src/gnutls_hooks.c @ bac1a32

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

Order, log message, and style fixes

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