source: mod_gnutls/src/gnutls_hooks.c @ 60868d2

debian/masterproxy-ticket
Last change on this file since 60868d2 was 60868d2, checked in by Fiona Klute <fiona.klute@…>, 23 months ago

Default to NORMAL for the GnuTLS priority settings

This simplifies configuration and should be resonable for most users.

  • Property mode set to 100644
File size: 78.0 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        rv = mgs_load_files(pconf, ptemp, s);
606        if (rv != 0) {
607            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
608                "GnuTLS: Loading required files failed."
609                " Shutting Down.");
610            return HTTP_NOT_FOUND;
611        }
612
613        /* defaults for unset values: */
614        if (sc->enabled == GNUTLS_ENABLED_UNSET)
615            sc->enabled = GNUTLS_ENABLED_FALSE;
616        if (sc->tickets == GNUTLS_ENABLED_UNSET)
617            sc->tickets = GNUTLS_ENABLED_FALSE;
618        if (sc->export_certificates_size < 0)
619            sc->export_certificates_size = 0;
620        if (sc->client_verify_mode == -1)
621            sc->client_verify_mode = GNUTLS_CERT_IGNORE;
622        if (sc->client_verify_method == mgs_cvm_unset)
623            sc->client_verify_method = mgs_cvm_cartel;
624
625        // TODO: None of the stuff below (and neither some above)
626        // makes sense if sc->enabled == GNUTLS_ENABLED_FALSE, we
627        // should just continue to the next host. All code below could
628        // then safely assume sc->enabled == GNUTLS_ENABLED_TRUE.
629
630        sc->ocsp_mutex = sc_base->ocsp_mutex;
631        /* init OCSP configuration unless explicitly disabled */
632        if (sc->enabled && sc->ocsp_staple != GNUTLS_ENABLED_FALSE)
633        {
634            const char *err = mgs_ocsp_configure_stapling(pconf, ptemp, s);
635            if (err != NULL)
636            {
637                /* If OCSP stapling is enabled only by default ignore
638                 * error and disable stapling */
639                if (sc->ocsp_staple == GNUTLS_ENABLED_UNSET)
640                {
641                    ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, s,
642                                 "Cannnot enable OCSP stapling for "
643                                 "host '%s:%d': %s",
644                                 s->server_hostname, s->addrs->host_port, err);
645                    sc->ocsp_staple = GNUTLS_ENABLED_FALSE;
646                }
647                /* If OCSP stapling is explicitly enabled this is a
648                 * critical error. */
649                else
650                {
651                    ap_log_error(APLOG_MARK, APLOG_STARTUP, APR_EINVAL, s,
652                                 "OCSP stapling configuration failed for "
653                                 "host '%s:%d': %s",
654                                 s->server_hostname, s->addrs->host_port, err);
655                    return HTTP_INTERNAL_SERVER_ERROR;
656                }
657            }
658            else
659            {
660                /* Might already be set */
661                sc->ocsp_staple = GNUTLS_ENABLED_TRUE;
662                /* Set up stapling */
663                rv = mgs_ocsp_enable_stapling(pconf, ptemp, s);
664                if (rv != OK && rv != DECLINED)
665                    return rv;
666            }
667        }
668
669        /* Check if the priorities have been set */
670        if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
671            ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
672                         "No GnuTLSPriorities directive for host '%s:%d', "
673                         "using default '%s'.",
674                         s->server_hostname, s->addrs->host_port,
675                         MGS_DEFAULT_PRIORITY);
676            sc->priorities = default_prio;
677        }
678
679        /* Set host DH params from user configuration or defaults */
680        if (sc->dh_params != NULL) {
681            gnutls_certificate_set_dh_params(sc->certs, sc->dh_params);
682            gnutls_anon_set_server_dh_params(sc->anon_creds, sc->dh_params);
683        } else {
684            rv = set_default_dh_param(s);
685            if (rv != OK)
686                return rv;
687        }
688
689        /* The call after this comment is a workaround for bug in
690         * gnutls_certificate_set_retrieve_function2 that ignores
691         * supported certificate types. Should be fixed in GnuTLS
692         * 3.3.12.
693         *
694         * Details:
695         * https://lists.gnupg.org/pipermail/gnutls-devel/2015-January/007377.html
696         * Workaround from:
697         * https://github.com/vanrein/tlspool/commit/4938102d3d1b086491d147e6c8e4e2a02825fc12 */
698#if GNUTLS_VERSION_NUMBER < 0x030312
699        gnutls_certificate_set_retrieve_function(sc->certs, (void *) exit);
700#endif
701
702        gnutls_certificate_set_retrieve_function2(sc->certs, cert_retrieve_fn);
703
704        if ((sc->certs_x509_chain == NULL || sc->certs_x509_chain_num < 1) &&
705            sc->enabled == GNUTLS_ENABLED_TRUE) {
706                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
707                                                "GnuTLS: Host '%s:%d' is missing a Certificate File!",
708                                                s->server_hostname, s->port);
709            return HTTP_UNAUTHORIZED;
710        }
711        if (sc->enabled == GNUTLS_ENABLED_TRUE &&
712            (sc->certs_x509_chain_num > 0 && sc->privkey_x509 == NULL))
713        {
714                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
715                                                "GnuTLS: Host '%s:%d' is missing a Private Key File!",
716                                                s->server_hostname, s->port);
717            return HTTP_UNAUTHORIZED;
718        }
719
720        if (sc->enabled == GNUTLS_ENABLED_TRUE
721            && sc->proxy_enabled == GNUTLS_ENABLED_TRUE
722            && load_proxy_x509_credentials(pconf, ptemp, s) != APR_SUCCESS)
723        {
724            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
725                         "%s: loading proxy credentials for host "
726                         "'%s:%d' failed, exiting!",
727                         __func__, s->server_hostname, s->port);
728            return HTTP_PROXY_AUTHENTICATION_REQUIRED;
729        }
730    }
731
732
733    ap_add_version_component(pconf, "mod_gnutls/" MOD_GNUTLS_VERSION);
734
735    {
736        const char* libvers = gnutls_check_version(NULL);
737        char* gnutls_version = NULL;
738        if(libvers && (gnutls_version = apr_psprintf(pconf, "GnuTLS/%s", libvers))) {
739            ap_add_version_component(pconf, gnutls_version);
740        } else {
741            // In case we could not create the above string go for the static version instead
742            ap_add_version_component(pconf, "GnuTLS/" GNUTLS_VERSION "-static");
743        }
744    }
745
746    return OK;
747}
748
749void mgs_hook_child_init(apr_pool_t *p, server_rec *s)
750{
751    apr_status_t rv = APR_SUCCESS;
752    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
753        ap_get_module_config(s->module_config, &gnutls_module);
754
755    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
756
757    /* if we use PKCS #11 reinitialize it */
758    if (mgs_pkcs11_reinit(s) < 0) {
759            ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
760                    "GnuTLS: Failed to reinitialize PKCS #11");
761            exit(-1);
762    }
763
764    if (sc->cache_enable == GNUTLS_ENABLED_TRUE)
765    {
766        rv = mgs_cache_child_init(p, s, sc->cache, MGS_CACHE_MUTEX_NAME);
767        if (rv != APR_SUCCESS)
768            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
769                    "Child init for session cache failed!");
770    }
771
772    if (sc->ocsp_cache != NULL)
773    {
774        rv = mgs_cache_child_init(p, s, sc->ocsp_cache,
775                                  MGS_OCSP_CACHE_MUTEX_NAME);
776        if (rv != APR_SUCCESS)
777            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
778                    "Child init for OCSP cache failed!");
779    }
780
781    /* reinit OCSP request mutex */
782    const char *lockfile = apr_global_mutex_lockfile(sc->ocsp_mutex);
783    rv = apr_global_mutex_child_init(&sc->ocsp_mutex, lockfile, p);
784    if (rv != APR_SUCCESS)
785        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
786                     "Failed to reinit mutex '" MGS_OCSP_MUTEX_NAME "'.");
787
788    /* Block SIGPIPE Signals */
789    rv = apr_signal_block(SIGPIPE);
790    if(rv != APR_SUCCESS) {
791        /* error sending output */
792        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
793                "GnuTLS: Error Blocking SIGPIPE Signal!");
794    }
795}
796
797const char *mgs_hook_http_scheme(const request_rec * r) {
798    mgs_srvconf_rec *sc;
799
800    if (r == NULL)
801        return NULL;
802
803    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
804            server->module_config,
805            &gnutls_module);
806
807    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
808    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
809        return NULL;
810    }
811
812    return "https";
813}
814
815apr_port_t mgs_hook_default_port(const request_rec * r) {
816    mgs_srvconf_rec *sc;
817
818    if (r == NULL)
819        return 0;
820
821    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
822            server->module_config,
823            &gnutls_module);
824
825    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
826    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
827        return 0;
828    }
829
830    return 443;
831}
832
833/**
834 * Default buffer size for SNI data, including the terminating NULL
835 * byte. The size matches what gnutls-cli uses initially.
836 */
837#define DEFAULT_SNI_HOST_LEN 256
838
839typedef struct {
840    mgs_handle_t *ctxt;
841    mgs_srvconf_rec *sc;
842    const char *sni_name;
843} vhost_cb_rec;
844
845/**
846 * Matches the current vhost's ServerAlias directives
847 *
848 * @param x vhost callback record
849 * @param s server record
850 * @param tsc mod_gnutls server data for `s`
851 *
852 * @return true if a match, false otherwise
853 *
854 */
855int check_server_aliases(vhost_cb_rec *x, server_rec * s, mgs_srvconf_rec *tsc)
856{
857        apr_array_header_t *names;
858        int rv = 0;
859        char ** name;
860
861        /* Check ServerName First! */
862        if(apr_strnatcasecmp(x->sni_name, s->server_hostname) == 0) {
863                // We have a match, save this server configuration
864                x->sc = tsc;
865                rv = 1;
866        /* Check any ServerAlias directives */
867        } else if(s->names->nelts) {
868                names = s->names;
869                name = (char **)names->elts;
870                for (int i = 0; i < names->nelts; ++i)
871        {
872                        if (!name[i]) { continue; }
873                                if (apr_strnatcasecmp(x->sni_name, name[i]) == 0) {
874                                        // We have a match, save this server configuration
875                                        x->sc = tsc;
876                                        rv = 1;
877                        }
878                }
879        /* Wild any ServerAlias Directives */
880        } else if(s->wild_names->nelts) {
881                names = s->wild_names;
882        name = (char **)names->elts;
883                for (int i = 0; i < names->nelts; ++i)
884        {
885                        if (!name[i]) { continue; }
886                                if(apr_fnmatch(name[i], x->sni_name ,
887                                                                APR_FNM_CASE_BLIND|
888                                                                APR_FNM_PERIOD|
889                                                                APR_FNM_PATHNAME|
890                                                                APR_FNM_NOESCAPE) == APR_SUCCESS) {
891                                x->sc = tsc;
892                                rv = 1;
893                        }
894                }
895        }
896        return rv;
897}
898
899static int vhost_cb(void *baton, conn_rec *conn, server_rec * s)
900{
901    mgs_srvconf_rec *tsc;
902    vhost_cb_rec *x = baton;
903    int ret;
904
905    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
906    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
907            &gnutls_module);
908
909    if (tsc->enabled != GNUTLS_ENABLED_TRUE) {
910        return 0;
911    }
912
913    if (tsc->certs_x509_chain_num > 0) {
914        /* this check is there to warn administrator of any missing hostname
915         * in the certificate. */
916        ret = gnutls_x509_crt_check_hostname(tsc->certs_x509_crt_chain[0], s->server_hostname);
917        if (0 == ret)
918            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, conn,
919                          "GnuTLS: the certificate doesn't match requested "
920                          "hostname '%s'", s->server_hostname);
921    } else {
922        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, conn,
923                      "GnuTLS: SNI request for '%s' but no X.509 certs "
924                      "available at all",
925                      s->server_hostname);
926    }
927        return check_server_aliases(x, s, tsc);
928}
929
930/**
931 * Get SNI data from GnuTLS (if any) and search for a matching virtual
932 * host configuration. This method is called from the post client
933 * hello function.
934 *
935 * @param session the GnuTLS session
936 *
937 * @return either the matching mod_gnutls server config, or `NULL`
938 */
939mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session)
940{
941    mgs_handle_t *ctxt = gnutls_session_get_ptr(session);
942
943    char *sni_name = apr_palloc(ctxt->c->pool, DEFAULT_SNI_HOST_LEN);
944    size_t sni_len = DEFAULT_SNI_HOST_LEN;
945    unsigned int sni_type;
946
947    /* Search for a DNS SNI element. Note that RFC 6066 prohibits more
948     * than one server name per type. */
949    int sni_index = -1;
950    int rv = 0;
951    do {
952        /* The sni_index is incremented before each use, so if the
953         * loop terminates with a type match we will have the right
954         * one stored. */
955        rv = gnutls_server_name_get(session, sni_name,
956                                    &sni_len, &sni_type, ++sni_index);
957        if (rv == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
958        {
959            ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_EGENERAL, ctxt->c,
960                          "%s: no DNS SNI found (last index: %d).",
961                          __func__, sni_index);
962            return NULL;
963        }
964    } while (sni_type != GNUTLS_NAME_DNS);
965    /* The (rv == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) path inside
966     * the loop above returns, so if we reach this point we have a DNS
967     * SNI at the current index. */
968
969    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER)
970    {
971        /* Allocate a new buffer of the right size and retry */
972        sni_name = apr_palloc(ctxt->c->pool, sni_len);
973        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
974                      "%s: reallocated SNI data buffer for %" APR_SIZE_T_FMT
975                      " bytes.", __func__, sni_len);
976        rv = gnutls_server_name_get(session, sni_name,
977                                    &sni_len, &sni_type, sni_index);
978    }
979
980    /* Unless there's a bug in the GnuTLS API only GNUTLS_E_IDNA_ERROR
981     * can occur here, but a catch all is safer and no more
982     * complicated. */
983    if (rv != GNUTLS_E_SUCCESS)
984    {
985        ap_log_cerror(APLOG_MARK, APLOG_INFO, APR_EGENERAL, ctxt->c,
986                      "%s: error while getting SNI DNS data: '%s' (%d).",
987                      __func__, gnutls_strerror(rv), rv);
988        return NULL;
989    }
990
991    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
992                  "%s: client requested server '%s'.",
993                  __func__, sni_name);
994
995    /* Search for vhosts matching connection parameters and the
996     * SNI. If a match is found, cbx.sc will contain the mod_gnutls
997     * server config for the vhost. */
998    vhost_cb_rec cbx = {
999        .ctxt = ctxt,
1000        .sc = NULL,
1001        .sni_name = sni_name
1002    };
1003    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
1004    if (rv == 1) {
1005        return cbx.sc;
1006    }
1007    return NULL;
1008}
1009
1010/**
1011 * This function is intended as a cleanup handler for connections
1012 * using GnuTLS. If attached to the connection pool, it ensures that
1013 * session resources are released with the connection pool even if the
1014 * session wasn't terminated properly.
1015 *
1016 * @param data must point to the mgs_handle_t associated with the
1017 * connection
1018 */
1019static apr_status_t cleanup_gnutls_session(void *data)
1020{
1021    /* nothing to do */
1022    if (data == NULL)
1023        return APR_SUCCESS;
1024
1025    /* check if session needs closing */
1026    mgs_handle_t *ctxt = (mgs_handle_t *) data;
1027    if (ctxt->session != NULL)
1028    {
1029        ap_log_cerror(APLOG_MARK, APLOG_WARNING, APR_ECONNABORTED, ctxt->c,
1030                      "%s: connection pool cleanup in progress but %sTLS "
1031                      "session hasn't been terminated, trying to close",
1032                      __func__, IS_PROXY_STR(ctxt));
1033        int ret;
1034        /* Try A Clean Shutdown */
1035        do
1036            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
1037        while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
1038        if (ret != GNUTLS_E_SUCCESS)
1039            ap_log_cerror(APLOG_MARK, APLOG_INFO, APR_EGENERAL, ctxt->c,
1040                          "%s: error while closing TLS %sconnection: %s (%d)",
1041                          __func__, IS_PROXY_STR(ctxt),
1042                          gnutls_strerror(ret), ret);
1043        else
1044            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
1045                          "%s: TLS %sconnection closed.",
1046                          __func__, IS_PROXY_STR(ctxt));
1047        /* De-Initialize Session */
1048        gnutls_deinit(ctxt->session);
1049        ctxt->session = NULL;
1050    }
1051    return APR_SUCCESS;
1052}
1053
1054static void create_gnutls_handle(conn_rec * c)
1055{
1056    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1057
1058    /* Get connection specific configuration */
1059    mgs_handle_t *ctxt = init_gnutls_ctxt(c);
1060    ctxt->enabled = GNUTLS_ENABLED_TRUE;
1061    ctxt->status = 0;
1062    ctxt->input_rc = APR_SUCCESS;
1063    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
1064    ctxt->input_cbuf.length = 0;
1065    ctxt->output_rc = APR_SUCCESS;
1066    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
1067    ctxt->output_blen = 0;
1068    ctxt->output_length = 0;
1069
1070    /* Initialize GnuTLS Library */
1071    int err = 0;
1072    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
1073    {
1074        /* this is an outgoing proxy connection, client mode */
1075        err = gnutls_init(&ctxt->session, GNUTLS_CLIENT);
1076        if (err != GNUTLS_E_SUCCESS)
1077            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1078                          "gnutls_init for proxy connection failed: %s (%d)",
1079                          gnutls_strerror(err), err);
1080    }
1081    else
1082    {
1083        /* incoming connection, server mode */
1084        err = gnutls_init(&ctxt->session, GNUTLS_SERVER);
1085        if (err != GNUTLS_E_SUCCESS)
1086            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1087                          "gnutls_init for server side failed: %s (%d)",
1088                          gnutls_strerror(err), err);
1089        /* Initialize Session Tickets */
1090        if (session_ticket_key.data != NULL &&
1091            ctxt->sc->tickets == GNUTLS_ENABLED_TRUE)
1092        {
1093            err = gnutls_session_ticket_enable_server(ctxt->session, &session_ticket_key);
1094            if (err != GNUTLS_E_SUCCESS)
1095                ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1096                              "gnutls_session_ticket_enable_server failed: %s (%d)",
1097                              gnutls_strerror(err), err);
1098        }
1099    }
1100
1101    /* Ensure TLS session resources are released when the connection
1102     * pool is cleared, if the filters haven't done that already. */
1103    apr_pool_pre_cleanup_register(c->pool, ctxt, cleanup_gnutls_session);
1104
1105    /* Set Default Priority */
1106        err = gnutls_priority_set(ctxt->session, default_prio);
1107    if (err != GNUTLS_E_SUCCESS)
1108        ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1109                      "gnutls_priority_set failed!");
1110    /* Set Handshake function */
1111    gnutls_handshake_set_post_client_hello_function(ctxt->session,
1112            mgs_select_virtual_server_cb);
1113
1114    /* Set GnuTLS user pointer, so we can access the module session
1115     * context in GnuTLS callbacks */
1116    gnutls_session_set_ptr(ctxt->session, ctxt);
1117
1118    /* If mod_gnutls is the TLS server, mgs_select_virtual_server_cb
1119     * will load appropriate credentials during handshake. However,
1120     * when handling a proxy backend connection, mod_gnutls acts as
1121     * TLS client and credentials must be loaded here. */
1122    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
1123    {
1124        /* Set anonymous client credentials for proxy connections */
1125        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_ANON,
1126                               ctxt->sc->anon_client_creds);
1127        /* Set x509 credentials */
1128        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_CERTIFICATE,
1129                               ctxt->sc->proxy_x509_creds);
1130        /* Load priorities from the server configuration */
1131        err = gnutls_priority_set(ctxt->session, ctxt->sc->proxy_priorities);
1132        if (err != GNUTLS_E_SUCCESS)
1133            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1134                          "%s: setting priorities for proxy connection "
1135                          "failed: %s (%d)",
1136                          __func__, gnutls_strerror(err), err);
1137    }
1138
1139    prepare_alpn_proposals(ctxt);
1140
1141    /* Initialize Session Cache */
1142    mgs_cache_session_init(ctxt);
1143
1144    /* Set pull, push & ptr functions */
1145    gnutls_transport_set_pull_function(ctxt->session,
1146            mgs_transport_read);
1147    gnutls_transport_set_push_function(ctxt->session,
1148            mgs_transport_write);
1149    gnutls_transport_set_ptr(ctxt->session, ctxt);
1150    /* Add IO filters */
1151    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME,
1152            ctxt, NULL, c);
1153    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
1154            ctxt, NULL, c);
1155}
1156
1157int mgs_hook_pre_connection(conn_rec * c, void *csd __attribute__((unused)))
1158{
1159    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1160
1161    if (c->master)
1162    {
1163        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, c,
1164                      "%s declined secondary connection", __func__);
1165        return DECLINED;
1166    }
1167
1168    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
1169        ap_get_module_config(c->base_server->module_config, &gnutls_module);
1170    mgs_handle_t *ctxt = (mgs_handle_t *)
1171        ap_get_module_config(c->conn_config, &gnutls_module);
1172
1173    if ((sc && (!sc->enabled))
1174        || (ctxt && ctxt->enabled == GNUTLS_ENABLED_FALSE))
1175    {
1176        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, c, "%s declined connection",
1177                      __func__);
1178        return DECLINED;
1179    }
1180
1181    create_gnutls_handle(c);
1182    return OK;
1183}
1184
1185
1186
1187/**
1188 * process_connection hook: Do a zero byte read to trigger the
1189 * handshake. Doesn't change anything for traditional protocols that
1190 * just do reads, but HTTP/2 needs the TLS handshake and ALPN to
1191 * happen before its process_connection hook runs.
1192 */
1193int mgs_hook_process_connection(conn_rec* c)
1194{
1195    mgs_handle_t *ctxt = (mgs_handle_t *)
1196        ap_get_module_config(c->conn_config, &gnutls_module);
1197
1198    if ((ctxt != NULL) && (ctxt->enabled == GNUTLS_ENABLED_TRUE))
1199    {
1200        /* This connection is supposed to use TLS. Give the filters a
1201         * kick with a zero byte read to trigger the handshake. */
1202        apr_bucket_brigade* temp =
1203            apr_brigade_create(c->pool, c->bucket_alloc);
1204        ap_get_brigade(c->input_filters, temp,
1205                       AP_MODE_INIT, APR_BLOCK_READ, 0);
1206        apr_brigade_destroy(temp);
1207    }
1208    return DECLINED;
1209}
1210
1211
1212
1213int mgs_hook_fixups(request_rec * r) {
1214    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
1215    const char *tmp;
1216    size_t len;
1217    mgs_handle_t *ctxt;
1218    int rv = OK;
1219
1220    if (r == NULL)
1221        return DECLINED;
1222
1223    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1224    apr_table_t *env = r->subprocess_env;
1225
1226    ctxt = get_effective_gnutls_ctxt(r->connection);
1227
1228    if (!ctxt || ctxt->enabled != GNUTLS_ENABLED_TRUE || ctxt->session == NULL)
1229    {
1230        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "request declined in %s", __func__);
1231        return DECLINED;
1232    }
1233
1234    apr_table_setn(env, "HTTPS", "on");
1235
1236    apr_table_setn(env, "SSL_VERSION_LIBRARY",
1237            "GnuTLS/" LIBGNUTLS_VERSION);
1238    apr_table_setn(env, "SSL_VERSION_INTERFACE",
1239            "mod_gnutls/" MOD_GNUTLS_VERSION);
1240
1241    apr_table_setn(env, "SSL_PROTOCOL",
1242            gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
1243
1244    /* should have been called SSL_CIPHERSUITE instead */
1245    apr_table_setn(env, "SSL_CIPHER",
1246            gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
1247                                         gnutls_cipher_get(ctxt->session),
1248                                         gnutls_mac_get(ctxt->session)));
1249
1250#if GNUTLS_VERSION_NUMBER >= 0x030600
1251    /* Compression support has been removed since GnuTLS 3.6.0 */
1252    apr_table_setn(env, "SSL_COMPRESS_METHOD", "NULL");
1253#else
1254    apr_table_setn(env, "SSL_COMPRESS_METHOD",
1255            gnutls_compression_get_name(gnutls_compression_get(ctxt->session)));
1256#endif
1257
1258#ifdef ENABLE_SRP
1259    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
1260        tmp = gnutls_srp_server_get_username(ctxt->session);
1261        apr_table_setn(env, "SSL_SRP_USER", (tmp != NULL) ? tmp : "");
1262    } else {
1263        apr_table_unset(env, "SSL_SRP_USER");
1264    }
1265#endif
1266
1267    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
1268        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
1269
1270    unsigned int key_size = 8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
1271    tmp = apr_psprintf(r->pool, "%u", key_size);
1272
1273    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
1274
1275    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
1276
1277    apr_table_setn(env, "SSL_CIPHER_EXPORT",
1278            (key_size <= 40) ? "true" : "false");
1279
1280    int dhsize = gnutls_dh_get_prime_bits(ctxt->session);
1281    if (dhsize > 0) {
1282        tmp = apr_psprintf(r->pool, "%d", dhsize);
1283        apr_table_setn(env, "SSL_DH_PRIME_BITS", tmp);
1284    }
1285
1286    len = sizeof (sbuf);
1287    gnutls_session_get_id(ctxt->session, sbuf, &len);
1288    apr_table_setn(env, "SSL_SESSION_ID",
1289                   apr_pescape_hex(r->pool, sbuf, len, 0));
1290
1291    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1292        mgs_add_common_cert_vars(r, ctxt->sc->certs_x509_crt_chain[0], 0,
1293                                 ctxt->sc->export_certificates_size);
1294    }
1295
1296    return rv;
1297}
1298
1299int mgs_hook_authz(request_rec * r) {
1300    int rv;
1301    mgs_handle_t *ctxt;
1302    mgs_dirconf_rec *dc;
1303
1304    if (r == NULL)
1305        return DECLINED;
1306
1307    dc = ap_get_module_config(r->per_dir_config, &gnutls_module);
1308
1309    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1310    ctxt = get_effective_gnutls_ctxt(r->connection);
1311
1312    if (!ctxt || ctxt->session == NULL) {
1313        return DECLINED;
1314    }
1315
1316    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
1317        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1318                "GnuTLS: Directory set to Ignore Client Certificate!");
1319    } else {
1320        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
1321            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1322                    "GnuTLS: Attempting to rehandshake with peer. %d %d",
1323                    ctxt->sc->client_verify_mode,
1324                    dc->client_verify_mode);
1325
1326            /* If we already have a client certificate, there's no point in
1327             * re-handshaking... */
1328            rv = mgs_cert_verify(r, ctxt);
1329            if (rv != DECLINED && rv != HTTP_FORBIDDEN)
1330                return rv;
1331
1332            gnutls_certificate_server_set_request
1333                    (ctxt->session, dc->client_verify_mode);
1334
1335            if (mgs_rehandshake(ctxt) != 0) {
1336                return HTTP_FORBIDDEN;
1337            }
1338        } else if (ctxt->sc->client_verify_mode ==
1339                GNUTLS_CERT_IGNORE) {
1340#if MOD_GNUTLS_DEBUG
1341            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1342                    "GnuTLS: Peer is set to IGNORE");
1343#endif
1344            return DECLINED;
1345        }
1346        rv = mgs_cert_verify(r, ctxt);
1347        if (rv != DECLINED
1348            && (rv != HTTP_FORBIDDEN
1349                || dc->client_verify_mode == GNUTLS_CERT_REQUIRE
1350                || (dc->client_verify_mode == -1
1351                    && ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUIRE)))
1352        {
1353            return rv;
1354        }
1355    }
1356
1357    return DECLINED;
1358}
1359
1360/* variables that are not sent by default:
1361 *
1362 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
1363 * SSL_SERVER_CERT      string  PEM-encoded client certificate
1364 */
1365
1366/* @param side is either 0 for SERVER or 1 for CLIENT
1367 *
1368 * @param export_cert_size (int) maximum size for environment variable
1369 * to use for the PEM-encoded certificate (0 means do not export)
1370 */
1371#define MGS_SIDE(suffix) ((side==0) ? "SSL_SERVER" suffix : "SSL_CLIENT" suffix)
1372
1373static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size) {
1374    unsigned char sbuf[64]; /* buffer to hold serials */
1375    char buf[AP_IOBUFSIZE];
1376    const char *tmp;
1377    char *tmp2;
1378    size_t len;
1379    int ret;
1380
1381    if (r == NULL)
1382        return;
1383
1384    apr_table_t *env = r->subprocess_env;
1385
1386    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1387    if (export_cert_size > 0) {
1388        len = 0;
1389        ret = gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, NULL, &len);
1390        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
1391            if (len >= export_cert_size) {
1392                apr_table_setn(env, MGS_SIDE("_CERT"), "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
1393                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1394                              "GnuTLS: Failed to export too-large X.509 certificate to environment");
1395            } else {
1396                char* cert_buf = apr_palloc(r->pool, len + 1);
1397                if (cert_buf != NULL && gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0) {
1398                    cert_buf[len] = 0;
1399                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
1400                } else {
1401                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1402                                  "GnuTLS: failed to export X.509 certificate");
1403                }
1404            }
1405        } else {
1406            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1407                          "GnuTLS: dazed and confused about X.509 certificate size");
1408        }
1409    }
1410
1411    len = sizeof (buf);
1412    gnutls_x509_crt_get_dn(cert, buf, &len);
1413    apr_table_setn(env, MGS_SIDE("_S_DN"), apr_pstrmemdup(r->pool, buf, len));
1414
1415    len = sizeof (buf);
1416    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
1417    apr_table_setn(env, MGS_SIDE("_I_DN"), apr_pstrmemdup(r->pool, buf, len));
1418
1419    len = sizeof (sbuf);
1420    gnutls_x509_crt_get_serial(cert, sbuf, &len);
1421    apr_table_setn(env, MGS_SIDE("_M_SERIAL"),
1422                   apr_pescape_hex(r->pool, sbuf, len, 0));
1423
1424    ret = gnutls_x509_crt_get_version(cert);
1425    if (ret > 0)
1426        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
1427                       apr_psprintf(r->pool, "%u", ret));
1428
1429    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "X.509");
1430
1431    tmp =
1432            mgs_time2sz(gnutls_x509_crt_get_expiration_time
1433            (cert), buf, sizeof (buf));
1434    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
1435
1436    tmp =
1437            mgs_time2sz(gnutls_x509_crt_get_activation_time
1438            (cert), buf, sizeof (buf));
1439    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
1440
1441    ret = gnutls_x509_crt_get_signature_algorithm(cert);
1442    if (ret >= 0) {
1443        apr_table_setn(env, MGS_SIDE("_A_SIG"),
1444                gnutls_sign_algorithm_get_name(ret));
1445    }
1446
1447    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
1448    if (ret >= 0) {
1449        apr_table_setn(env, MGS_SIDE("_A_KEY"),
1450                gnutls_pk_algorithm_get_name(ret));
1451    }
1452
1453    /* export all the alternative names (DNS, RFC822 and URI) */
1454    for (int i = 0; !(ret < 0); i++)
1455    {
1456        const char *san, *sanlabel;
1457        len = 0;
1458        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
1459                NULL, &len,
1460                NULL);
1461
1462        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
1463            tmp2 = apr_palloc(r->pool, len + 1);
1464
1465            ret =
1466                    gnutls_x509_crt_get_subject_alt_name(cert, i,
1467                    tmp2,
1468                    &len,
1469                    NULL);
1470            tmp2[len] = 0;
1471
1472            sanlabel = apr_psprintf(r->pool, "%s%u", MGS_SIDE("_S_AN"), i);
1473            if (ret == GNUTLS_SAN_DNSNAME) {
1474                san = apr_psprintf(r->pool, "DNSNAME:%s", tmp2);
1475            } else if (ret == GNUTLS_SAN_RFC822NAME) {
1476                san = apr_psprintf(r->pool, "RFC822NAME:%s", tmp2);
1477            } else if (ret == GNUTLS_SAN_URI) {
1478                san = apr_psprintf(r->pool, "URI:%s", tmp2);
1479            } else {
1480                san = "UNSUPPORTED";
1481            }
1482            apr_table_setn(env, sanlabel, san);
1483        }
1484    }
1485}
1486
1487
1488
1489/* TODO: Allow client sending a X.509 certificate chain */
1490static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt) {
1491    const gnutls_datum_t *cert_list;
1492    unsigned int cert_list_size;
1493    /* assume the certificate is invalid unless explicitly set
1494     * otherwise */
1495    unsigned int status = GNUTLS_CERT_INVALID;
1496    int rv = GNUTLS_E_NO_CERTIFICATE_FOUND, ret;
1497    unsigned int ch_size = 0;
1498
1499    // TODO: union no longer needed here after removing its "pgp" component.
1500    union {
1501        gnutls_x509_crt_t x509[MAX_CHAIN_SIZE];
1502    } cert;
1503    apr_time_t expiration_time, cur_time;
1504
1505    if (r == NULL || ctxt == NULL || ctxt->session == NULL)
1506        return HTTP_FORBIDDEN;
1507
1508    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1509    cert_list =
1510            gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
1511
1512    if (cert_list == NULL || cert_list_size == 0) {
1513        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
1514         */
1515        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1516            return OK;
1517
1518        /* no certificate provided by the client, but one was required. */
1519        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1520                "GnuTLS: Failed to Verify Peer: "
1521                "Client did not submit a certificate");
1522        return HTTP_FORBIDDEN;
1523    }
1524
1525    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1526        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1527                "GnuTLS: A Chain of %d certificate(s) was provided for validation",
1528                cert_list_size);
1529
1530        for (ch_size = 0; ch_size < cert_list_size; ch_size++) {
1531            gnutls_x509_crt_init(&cert.x509[ch_size]);
1532            rv = gnutls_x509_crt_import(cert.x509[ch_size],
1533                    &cert_list[ch_size],
1534                    GNUTLS_X509_FMT_DER);
1535            // When failure to import, leave the loop
1536            if (rv != GNUTLS_E_SUCCESS) {
1537                if (ch_size < 1) {
1538                    ap_log_rerror(APLOG_MARK,
1539                            APLOG_INFO, 0, r,
1540                            "GnuTLS: Failed to Verify Peer: "
1541                            "Failed to import peer certificates.");
1542                    ret = HTTP_FORBIDDEN;
1543                    goto exit;
1544                }
1545                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1546                        "GnuTLS: Failed to import some peer certificates. Using %d certificates",
1547                        ch_size);
1548                rv = GNUTLS_E_SUCCESS;
1549                break;
1550            }
1551        }
1552    } else
1553        return HTTP_FORBIDDEN;
1554
1555    if (rv < 0) {
1556        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1557                "GnuTLS: Failed to Verify Peer: "
1558                "Failed to import peer certificates.");
1559        ret = HTTP_FORBIDDEN;
1560        goto exit;
1561    }
1562
1563    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1564        apr_time_ansi_put(&expiration_time,
1565                gnutls_x509_crt_get_expiration_time
1566                (cert.x509[0]));
1567
1568        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1569                      "GnuTLS: Verifying list of %d certificate(s) via method '%s'",
1570                      ch_size, mgs_readable_cvm(ctxt->sc->client_verify_method));
1571        switch(ctxt->sc->client_verify_method) {
1572        case mgs_cvm_cartel:
1573            rv = gnutls_x509_crt_list_verify(cert.x509, ch_size,
1574                                             ctxt->sc->ca_list,
1575                                             ctxt->sc->ca_list_size,
1576                                             NULL, 0, 0, &status);
1577            break;
1578#ifdef ENABLE_MSVA
1579        case mgs_cvm_msva:
1580        {
1581            struct msv_response* resp = NULL;
1582            struct msv_query q = { .context="https", .peertype="client", .pkctype="x509pem" };
1583            msv_ctxt_t ctx = msv_ctxt_init(NULL);
1584            char cert_pem_buf[10 * 1024];
1585            size_t len = sizeof (cert_pem_buf);
1586
1587            rv = 0;
1588            if (gnutls_x509_crt_export(cert.x509[0], GNUTLS_X509_FMT_PEM, cert_pem_buf, &len) >= 0) {
1589                /* FIXME : put together a name from the cert we received, instead of hard-coding this value: */
1590                q.peername = mgs_x509_construct_uid(r, cert.x509[0]);
1591                q.pkcdata = cert_pem_buf;
1592                rv = msv_query_agent(ctx, q, &resp);
1593                if (rv == LIBMSV_ERROR_SUCCESS) {
1594                    status = 0;
1595                } else if (rv == LIBMSV_ERROR_INVALID) {
1596                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1597                                  "GnuTLS: Monkeysphere validation failed: (message: %s)", resp->message);
1598                    status = GNUTLS_CERT_INVALID;
1599                } else {
1600                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1601                                  "GnuTLS: Error communicating with the Monkeysphere Validation Agent: (%d) %s", rv, msv_strerror(ctx, rv));
1602                    status = GNUTLS_CERT_INVALID;
1603                    rv = -1;
1604                }
1605            } else {
1606                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1607                              "GnuTLS: Could not convert the client certificate to PEM format");
1608                status = GNUTLS_CERT_INVALID;
1609                rv = GNUTLS_E_ASN1_ELEMENT_NOT_FOUND;
1610            }
1611            msv_response_destroy(resp);
1612            msv_ctxt_destroy(ctx);
1613        }
1614            break;
1615#endif
1616        default:
1617            /* If this block is reached, that indicates a
1618             * configuration error or bug in mod_gnutls (invalid value
1619             * of ctxt->sc->client_verify_method). */
1620            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1621                          "GnuTLS: Failed to Verify X.509 Peer: method '%s' is not supported",
1622                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1623            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1624        }
1625
1626    } else {
1627        /* Unknown certificate type */
1628        rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1629    }
1630
1631    /* "goto exit" at the end of this block skips evaluation of the
1632     * "status" variable */
1633    if (rv < 0) {
1634        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1635                "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1636                rv, gnutls_strerror(rv));
1637        if (rv == GNUTLS_E_NO_CERTIFICATE_FOUND)
1638            ap_log_rerror(APLOG_MARK, APLOG_EMERG, 0, r,
1639                "GnuTLS: No certificate was found for verification. Did you set the GnuTLSClientCAFile directive?");
1640        ret = HTTP_FORBIDDEN;
1641        goto exit;
1642    }
1643
1644    /* TODO: X509 CRL Verification. */
1645    /* May add later if anyone needs it.
1646     */
1647    /* ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size); */
1648
1649    cur_time = apr_time_now();
1650
1651    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1652        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1653                "GnuTLS: Could not find Signer for Peer Certificate");
1654    }
1655
1656    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1657        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1658                "GnuTLS: Peer's Certificate signer is not a CA");
1659    }
1660
1661    if (status & GNUTLS_CERT_INSECURE_ALGORITHM) {
1662        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1663                "GnuTLS: Peer's Certificate is using insecure algorithms");
1664    }
1665
1666    if (status & GNUTLS_CERT_EXPIRED
1667            || status & GNUTLS_CERT_NOT_ACTIVATED) {
1668        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1669                "GnuTLS: Peer's Certificate signer is expired or not yet activated");
1670    }
1671
1672    if (status & GNUTLS_CERT_INVALID) {
1673        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1674                "GnuTLS: Peer Certificate is invalid.");
1675    } else if (status & GNUTLS_CERT_REVOKED) {
1676        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1677                "GnuTLS: Peer Certificate is revoked.");
1678    }
1679
1680    mgs_add_common_cert_vars(r, cert.x509[0], 1, ctxt->sc->export_certificates_size);
1681
1682    {
1683        /* days remaining */
1684        unsigned long remain =
1685                (apr_time_sec(expiration_time) -
1686                apr_time_sec(cur_time)) / 86400;
1687        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1688                apr_psprintf(r->pool, "%lu", remain));
1689    }
1690
1691    if (status == 0) {
1692        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1693                "SUCCESS");
1694        ret = OK;
1695    } else {
1696        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1697                "FAILED");
1698        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1699            ret = OK;
1700        else
1701            ret = HTTP_FORBIDDEN;
1702    }
1703
1704exit:
1705    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509)
1706        for (unsigned int i = 0; i < ch_size; i++)
1707            gnutls_x509_crt_deinit(cert.x509[i]);
1708
1709    return ret;
1710}
1711
1712
1713
1714#ifdef ENABLE_MSVA
1715/* this section of code is used only when trying to talk to the MSVA */
1716static const char* mgs_x509_leaf_oid_from_dn(apr_pool_t *pool, const char* oid, gnutls_x509_crt_t cert) {
1717    int rv=GNUTLS_E_SUCCESS, i;
1718    size_t sz=0, lastsz=0;
1719    char* data=NULL;
1720
1721    i = -1;
1722    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1723        i++;
1724        lastsz=sz;
1725        sz=0;
1726        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i, 0, NULL, &sz);
1727    }
1728    if (i > 0) {
1729        data = apr_palloc(pool, lastsz);
1730        sz=lastsz;
1731        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i-1, 0, data, &sz);
1732        if (rv == GNUTLS_E_SUCCESS)
1733            return data;
1734    }
1735    return NULL;
1736}
1737
1738static const char* mgs_x509_first_type_from_san(apr_pool_t *pool, gnutls_x509_subject_alt_name_t target, gnutls_x509_crt_t cert) {
1739    int rv=GNUTLS_E_SUCCESS;
1740    size_t sz;
1741    char* data=NULL;
1742    unsigned int i;
1743    gnutls_x509_subject_alt_name_t thistype;
1744
1745    i = 0;
1746    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1747        sz = 0;
1748        rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, NULL, &sz, &thistype, NULL);
1749        if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && thistype == target) {
1750            data = apr_palloc(pool, sz);
1751            rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, data, &sz, &thistype, NULL);
1752            if (rv >=0 && (thistype == target))
1753                return data;
1754        }
1755        i++;
1756    }
1757    return NULL;
1758}
1759
1760
1761/* Create a string representing a candidate User ID from an X.509
1762 * certificate
1763
1764 * We need this for client certification because a client gives us a
1765 * certificate, but doesn't tell us (in any other way) who they are
1766 * trying to authenticate as.
1767
1768 * one complaint might be "but the user wanted to be another identity,
1769 * which is also in the certificate (e.g. in a SubjectAltName)"
1770 * However, given that any user can regenerate their own X.509
1771 * certificate with their own public key content, they should just do
1772 * so, and not expect us to guess at their identity :)
1773
1774 * This function allocates it's response from the pool given it.  When
1775 * that pool is reclaimed, the response will also be deallocated.
1776
1777 * FIXME: what about extracting a server-style cert
1778 *        (e.g. https://imposter.example) from the DN or any sAN?
1779
1780 * FIXME: what if we want to call this outside the context of a
1781 *        request?  That complicates the logging.
1782 */
1783static const char* mgs_x509_construct_uid(request_rec *r, gnutls_x509_crt_t cert) {
1784    /* basic strategy, assuming humans are the users: we are going to
1785     * try to reconstruct a "conventional" User ID by pulling in a
1786     * name, comment, and e-mail address.
1787     */
1788    apr_pool_t *pool = r->pool;
1789    const char *name=NULL, *comment=NULL, *email=NULL;
1790    const char *ret=NULL;
1791    /* subpool for temporary allocation: */
1792    apr_pool_t *sp=NULL;
1793
1794    if (APR_SUCCESS != apr_pool_create(&sp, pool))
1795        return NULL; /* i'm assuming that libapr would log this kind
1796                      * of error on its own */
1797
1798     /* Name
1799
1800     the name comes from the leaf commonName of the cert's Subject.
1801
1802     (MAYBE: should we look at trying to assemble a candidate from
1803             givenName, surName, suffix, etc?  the "name" field
1804             appears to be case-insensitive, which seems problematic
1805             from what we expect; see:
1806             http://www.itu.int/rec/T-REC-X.520-200102-s/e )
1807
1808     (MAYBE: should we try pulling a commonName or otherName or
1809             something from subjectAltName? see:
1810             https://tools.ietf.org/html/rfc5280#section-4.2.1.6
1811             GnuTLS does not support looking for Common Names in the
1812             SAN yet)
1813     */
1814    name = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_COMMON_NAME, cert);
1815
1816    /* Comment
1817
1818       I am inclined to punt on this for now, as Comment has been so
1819       atrociously misused in OpenPGP.  Perhaps if there is a
1820       pseudonym (OID 2.5.4.65, aka GNUTLS_OID_X520_PSEUDONYM) field
1821       in the subject or sAN?
1822    */
1823    comment = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_PSEUDONYM, cert);
1824
1825    /* E-mail
1826
1827       This should be the the first rfc822Name from the sAN.
1828
1829       failing that, we'll take the leaf email in the certificate's
1830       subject; this is a deprecated use though.
1831     */
1832    email = mgs_x509_first_type_from_san(sp, GNUTLS_SAN_RFC822NAME, cert);
1833    if (email == NULL)
1834        email = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_PKCS9_EMAIL, cert);
1835
1836    /* assemble all the parts: */
1837
1838    /* must have at least a name or an e-mail. */
1839    if (name == NULL && email == NULL) {
1840        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1841                "GnuTLS: Need either a name or an e-mail address to get a User ID from an X.509 certificate.");
1842        goto end;
1843    }
1844    if (name) {
1845        if (comment) {
1846            if (email) {
1847                ret = apr_psprintf(pool, "%s (%s) <%s>", name, comment, email);
1848            } else {
1849                ret = apr_psprintf(pool, "%s (%s)", name, comment);
1850            }
1851        } else {
1852            if (email) {
1853                ret = apr_psprintf(pool, "%s <%s>", name, email);
1854            } else {
1855                ret = apr_pstrdup(pool, name);
1856            }
1857        }
1858    } else {
1859        if (comment) {
1860            ret = apr_psprintf(pool, "(%s) <%s>", comment, email);
1861        } else {
1862            ret = apr_psprintf(pool, "<%s>", email);
1863        }
1864    }
1865
1866end:
1867    apr_pool_destroy(sp);
1868    return ret;
1869}
1870#endif /* ENABLE_MSVA */
1871
1872
1873
1874/*
1875 * This hook writes the mod_gnutls status message for a mod_status
1876 * report. According to the comments in mod_status.h, the "flags"
1877 * parameter is a bitwise OR of the AP_STATUS_ flags.
1878 *
1879 * Note that this implementation gives flags explicitly requesting a
1880 * simple response priority, e.g. if AP_STATUS_SHORT is set, flags
1881 * requesting an HTML report will be ignored. As of Apache 2.4.10, the
1882 * following flags were defined in mod_status.h:
1883 *
1884 * AP_STATUS_SHORT (short, non-HTML report requested)
1885 * AP_STATUS_NOTABLE (HTML report without tables)
1886 * AP_STATUS_EXTENDED (detailed report)
1887 */
1888static int mgs_status_hook(request_rec *r, int flags)
1889{
1890    if (r == NULL)
1891        return OK;
1892
1893    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
1894        ap_get_module_config(r->server->module_config, &gnutls_module);
1895
1896    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1897
1898    if (flags & AP_STATUS_SHORT)
1899    {
1900        ap_rprintf(r, "Using GnuTLS version: %s\n", gnutls_check_version(NULL));
1901        ap_rputs("Built against GnuTLS version: " GNUTLS_VERSION "\n", r);
1902    }
1903    else
1904    {
1905        ap_rputs("<hr>\n", r);
1906        ap_rputs("<h2>GnuTLS Information:</h2>\n<dl>\n", r);
1907
1908        ap_rprintf(r, "<dt>Using GnuTLS version:</dt><dd>%s</dd>\n",
1909                   gnutls_check_version(NULL));
1910        ap_rputs("<dt>Built against GnuTLS version:</dt><dd>"
1911                 GNUTLS_VERSION "</dd>\n", r);
1912        ap_rprintf(r, "<dt>Using TLS:</dt><dd>%s</dd>\n",
1913                   (sc->enabled == GNUTLS_ENABLED_FALSE ? "no" : "yes"));
1914    }
1915
1916    if (sc->enabled != GNUTLS_ENABLED_FALSE)
1917    {
1918        mgs_handle_t* ctxt = get_effective_gnutls_ctxt(r->connection);
1919        if (ctxt && ctxt->session != NULL)
1920        {
1921            char* s_info = gnutls_session_get_desc(ctxt->session);
1922            if (s_info)
1923            {
1924                if (flags & AP_STATUS_SHORT)
1925                    ap_rprintf(r, "Current TLS session: %s\n", s_info);
1926                else
1927                    ap_rprintf(r, "<dt>Current TLS session:</dt><dd>%s</dd>\n",
1928                               s_info);
1929                gnutls_free(s_info);
1930            }
1931        }
1932    }
1933
1934    if (!(flags & AP_STATUS_SHORT))
1935        ap_rputs("</dl>\n", r);
1936
1937    return OK;
1938}
1939
1940
1941
1942/*
1943 * Callback to check the server certificate for proxy HTTPS
1944 * connections, to be used with
1945 * gnutls_certificate_set_verify_function.
1946
1947 * Returns: 0 if certificate check was successful (certificate
1948 * trusted), non-zero otherwise (error during check or untrusted
1949 * certificate).
1950 */
1951static int gtls_check_server_cert(gnutls_session_t session)
1952{
1953    mgs_handle_t *ctxt = (mgs_handle_t *) gnutls_session_get_ptr(session);
1954    unsigned int status;
1955
1956    /* Get peer hostname from a note left by mod_proxy */
1957    const char *peer_hostname =
1958        apr_table_get(ctxt->c->notes, PROXY_SNI_NOTE);
1959    if (peer_hostname == NULL)
1960        ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
1961                      "%s: " PROXY_SNI_NOTE " NULL, cannot check "
1962                      "peer's hostname", __func__);
1963
1964    /* Verify certificate, including hostname match. Should
1965     * peer_hostname be NULL for some reason, the name is not
1966     * checked. */
1967    int err = gnutls_certificate_verify_peers3(session, peer_hostname,
1968                                               &status);
1969    if (err != GNUTLS_E_SUCCESS)
1970    {
1971        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, ctxt->c,
1972                      "%s: server certificate check failed: %s (%d)",
1973                      __func__, gnutls_strerror(err), err);
1974        return err;
1975    }
1976
1977    if (status == 0)
1978        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, ctxt->c,
1979                      "%s: server certificate is trusted.",
1980                      __func__);
1981    else
1982    {
1983        gnutls_datum_t out;
1984        /* GNUTLS_CRT_X509: ATM, only X509 is supported for proxy
1985         * certs 0: according to function API, the last argument
1986         * should be 0 */
1987        err = gnutls_certificate_verification_status_print(status,
1988                                                           GNUTLS_CRT_X509,
1989                                                           &out, 0);
1990        if (err != GNUTLS_E_SUCCESS)
1991            ap_log_cerror(APLOG_MARK, APLOG_ERR, 0, ctxt->c,
1992                          "%s: server verify print failed: %s (%d)",
1993                          __func__, gnutls_strerror(err), err);
1994        else
1995            ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
1996                          "%s: %s",
1997                          __func__, out.data);
1998        gnutls_free(out.data);
1999    }
2000
2001    return status;
2002}
2003
2004
2005
2006static apr_status_t cleanup_proxy_x509_credentials(void *arg)
2007{
2008    mgs_srvconf_rec *sc = (mgs_srvconf_rec *) arg;
2009
2010    if (sc->proxy_x509_creds)
2011    {
2012        /* This implicitly releases the associated trust list
2013         * sc->proxy_x509_tl, too. */
2014        gnutls_certificate_free_credentials(sc->proxy_x509_creds);
2015        sc->proxy_x509_creds = NULL;
2016        sc->proxy_x509_tl = NULL;
2017    }
2018
2019    if (sc->anon_client_creds)
2020    {
2021        gnutls_anon_free_client_credentials(sc->anon_client_creds);
2022        sc->anon_client_creds = NULL;
2023    }
2024
2025    /* Deinit proxy priorities only if set from
2026     * sc->proxy_priorities_str. Otherwise the server is using the
2027     * default global priority cache, which must not be deinitialized
2028     * here. */
2029    if (sc->proxy_priorities_str && sc->proxy_priorities)
2030    {
2031        gnutls_priority_deinit(sc->proxy_priorities);
2032        sc->proxy_priorities = NULL;
2033    }
2034
2035    return APR_SUCCESS;
2036}
2037
2038
2039
2040static apr_status_t load_proxy_x509_credentials(apr_pool_t *pconf,
2041                                                apr_pool_t *ptemp,
2042                                                server_rec *s)
2043{
2044    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
2045        ap_get_module_config(s->module_config, &gnutls_module);
2046
2047    if (sc == NULL)
2048        return APR_EGENERAL;
2049
2050    apr_status_t ret = APR_EINIT;
2051    int err = GNUTLS_E_SUCCESS;
2052
2053    /* Cleanup function for the GnuTLS structures allocated below */
2054    apr_pool_cleanup_register(pconf, sc, cleanup_proxy_x509_credentials,
2055                              apr_pool_cleanup_null);
2056
2057    /* Function pool, gets destroyed before exit. */
2058    apr_pool_t *pool;
2059    ret = apr_pool_create(&pool, ptemp);
2060    if (ret != APR_SUCCESS)
2061    {
2062        ap_log_error(APLOG_MARK, APLOG_ERR, ret, s,
2063                     "%s: failed to allocate function memory pool.", __func__);
2064        return ret;
2065    }
2066
2067    /* allocate credentials structures */
2068    err = gnutls_certificate_allocate_credentials(&sc->proxy_x509_creds);
2069    if (err != GNUTLS_E_SUCCESS)
2070    {
2071        ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2072                     "%s: Failed to initialize proxy credentials: (%d) %s",
2073                     __func__, err, gnutls_strerror(err));
2074        return APR_EGENERAL;
2075    }
2076    err = gnutls_anon_allocate_client_credentials(&sc->anon_client_creds);
2077    if (err != GNUTLS_E_SUCCESS)
2078    {
2079        ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2080                     "%s: Failed to initialize anon credentials for proxy: "
2081                     "(%d) %s", __func__, err, gnutls_strerror(err));
2082        return APR_EGENERAL;
2083    }
2084
2085    /* Check if the proxy priorities have been set, fail immediately
2086     * if not */
2087    if (sc->proxy_priorities_str == NULL)
2088    {
2089        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
2090                     "No GnuTLSProxyPriorities directive for host '%s:%d', "
2091                     "using default '%s'.",
2092                     s->server_hostname, s->addrs->host_port,
2093                     MGS_DEFAULT_PRIORITY);
2094        sc->proxy_priorities = default_prio;
2095    }
2096    else
2097    {
2098        /* parse proxy priorities */
2099        const char *err_pos = NULL;
2100        err = gnutls_priority_init(&sc->proxy_priorities,
2101                                   sc->proxy_priorities_str, &err_pos);
2102        if (err != GNUTLS_E_SUCCESS)
2103        {
2104            if (ret == GNUTLS_E_INVALID_REQUEST)
2105                ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2106                             "%s: Syntax error parsing proxy priorities "
2107                             "string at: %s",
2108                             __func__, err_pos);
2109            else
2110                ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2111                             "Error setting proxy priorities: %s (%d)",
2112                             gnutls_strerror(err), err);
2113            ret = APR_EGENERAL;
2114        }
2115    }
2116
2117    /* load certificate and key for client auth, if configured */
2118    if (sc->proxy_x509_key_file && sc->proxy_x509_cert_file)
2119    {
2120        char* cert_file = ap_server_root_relative(pool,
2121                                                  sc->proxy_x509_cert_file);
2122        char* key_file = ap_server_root_relative(pool,
2123                                                 sc->proxy_x509_key_file);
2124        err = gnutls_certificate_set_x509_key_file(sc->proxy_x509_creds,
2125                                                   cert_file,
2126                                                   key_file,
2127                                                   GNUTLS_X509_FMT_PEM);
2128        if (err != GNUTLS_E_SUCCESS)
2129        {
2130            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2131                         "%s: loading proxy client credentials failed: %s (%d)",
2132                         __func__, gnutls_strerror(err), err);
2133            ret = APR_EGENERAL;
2134        }
2135    }
2136    else if (!sc->proxy_x509_key_file && sc->proxy_x509_cert_file)
2137    {
2138        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
2139                     "%s: proxy key file not set!", __func__);
2140        ret = APR_EGENERAL;
2141    }
2142    else if (!sc->proxy_x509_cert_file && sc->proxy_x509_key_file)
2143    {
2144        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
2145                     "%s: proxy certificate file not set!", __func__);
2146        ret = APR_EGENERAL;
2147    }
2148    else
2149        /* if both key and cert are NULL, client auth is not used */
2150        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
2151                     "%s: no client credentials for proxy", __func__);
2152
2153    /* must be set if the server certificate is to be checked */
2154    if (sc->proxy_x509_ca_file)
2155    {
2156        /* initialize the trust list */
2157        err = gnutls_x509_trust_list_init(&sc->proxy_x509_tl, 0);
2158        if (err != GNUTLS_E_SUCCESS)
2159        {
2160            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2161                         "%s: gnutls_x509_trust_list_init failed: %s (%d)",
2162                         __func__, gnutls_strerror(err), err);
2163            ret = APR_EGENERAL;
2164        }
2165
2166        char* ca_file = ap_server_root_relative(pool,
2167                                                sc->proxy_x509_ca_file);
2168        /* if no CRL is used, sc->proxy_x509_crl_file is NULL */
2169        char* crl_file = NULL;
2170        if (sc->proxy_x509_crl_file)
2171            crl_file = ap_server_root_relative(pool,
2172                                               sc->proxy_x509_crl_file);
2173
2174        /* returns number of loaded elements */
2175        err = gnutls_x509_trust_list_add_trust_file(sc->proxy_x509_tl,
2176                                                    ca_file,
2177                                                    crl_file,
2178                                                    GNUTLS_X509_FMT_PEM,
2179                                                    0 /* tl_flags */,
2180                                                    0 /* tl_vflags */);
2181        if (err > 0)
2182            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
2183                         "%s: proxy CA trust list: %d structures loaded",
2184                         __func__, err);
2185        else if (err == 0)
2186            ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
2187                         "%s: proxy CA trust list is empty (%d)",
2188                         __func__, err);
2189        else /* err < 0 */
2190        {
2191            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
2192                         "%s: error loading proxy CA trust list: %s (%d)",
2193                         __func__, gnutls_strerror(err), err);
2194            ret = APR_EGENERAL;
2195        }
2196
2197        /* attach trust list to credentials */
2198        gnutls_certificate_set_trust_list(sc->proxy_x509_creds,
2199                                          sc->proxy_x509_tl, 0);
2200    }
2201    else
2202        ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
2203                     "%s: no CA trust list for proxy connections, "
2204                     "TLS connections will fail!", __func__);
2205
2206    gnutls_certificate_set_verify_function(sc->proxy_x509_creds,
2207                                           gtls_check_server_cert);
2208    apr_pool_destroy(pool);
2209    return ret;
2210}
Note: See TracBrowser for help on using the repository browser.