source: mod_gnutls/src/gnutls_hooks.c

mod_gnutls/0.12.0
Last change on this file was ac49b95, checked in by Fiona Klute <fiona.klute@…>, 4 months ago

Avoid log spam if connection is aborted while sending

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