source: mod_gnutls/src/gnutls_hooks.c @ 81018a4

asyncioproxy-ticket
Last change on this file since 81018a4 was 81018a4, checked in by Fiona Klute <fiona.klute@…>, 2 years ago

Remove compatibility code for GnuTLS version before 3.6.3

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