source: mod_gnutls/src/gnutls_hooks.c @ adceac0

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

Remove unneeded server variables "cert_cn" and "cert_san"

"cert_san" wasn't used or assigned at all, "cert_cn" filled but used
only in a redundant check for assignment and a log message that's
better served by the server name of the virtual host.

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