source: mod_gnutls/src/gnutls_hooks.c

mod_gnutls/0.9.1
Last change on this file was 6200f6f, checked in by Fiona Klute <fiona.klute@…>, 11 months ago

Switch server based on early SNI only if a name was found

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