source: mod_gnutls/src/gnutls_hooks.c @ 65c84e5

asyncioproxy-ticket
Last change on this file since 65c84e5 was 65c84e5, checked in by Fiona Klute <fiona.klute@…>, 18 months ago

Set certificates via gnutls_certificate_set_retrieve_function3()

The new API allows stapling multiple OCSP responses (to be implemented
later). Requires GnuTLS 3.6.3 or newer.

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