source: mod_gnutls/src/gnutls_hooks.c @ 05e2d9e

proxy-ticket
Last change on this file since 05e2d9e was 05e2d9e, checked in by Fiona Klute <fiona.klute@…>, 7 months ago

Move function declarations for gnutls_io.c into a separate header

  • Property mode set to 100644
File size: 71.6 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/** Key to encrypt session tickets. Must be kept secret. This key is
62 * generated in the `pre_config` hook and thus constant across
63 * forks. The problem with this approach is that it does not support
64 * regular key rotation. */
65static gnutls_datum_t session_ticket_key = {NULL, 0};
66
67
68
69static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
70/** use side==0 for server and side==1 for client */
71static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size);
72mgs_srvconf_rec* mgs_find_sni_server(mgs_handle_t *ctxt);
73static int mgs_status_hook(request_rec *r, int flags);
74#ifdef ENABLE_MSVA
75static const char* mgs_x509_construct_uid(request_rec * pool, gnutls_x509_crt_t cert);
76#endif
77
78/* Pool Cleanup Function */
79apr_status_t mgs_cleanup_pre_config(void *data __attribute__((unused)))
80{
81    /* Free session ticket master key */
82    gnutls_memset(session_ticket_key.data, 0, session_ticket_key.size);
83    gnutls_free(session_ticket_key.data);
84    session_ticket_key.data = NULL;
85    session_ticket_key.size = 0;
86
87    /* Deinit default priority setting */
88    mgs_default_priority_deinit();
89    return APR_SUCCESS;
90}
91
92/* Logging Function for Maintainers */
93#if MOD_GNUTLS_DEBUG
94static void gnutls_debug_log_all(int level, const char *str) {
95    apr_file_printf(debug_log_fp, "<%d> %s", level, str);
96}
97#define _gnutls_log apr_file_printf
98#else
99#define _gnutls_log(...)
100#endif
101
102static const char* mgs_readable_cvm(mgs_client_verification_method_e m) {
103    switch(m) {
104    case mgs_cvm_unset:
105        return "unset";
106    case mgs_cvm_cartel:
107        return "cartel";
108    case mgs_cvm_msva:
109        return "msva";
110    }
111    return "unknown";
112}
113
114/* Pre-Configuration HOOK: Runs First */
115int mgs_hook_pre_config(apr_pool_t * pconf, apr_pool_t * plog, apr_pool_t * ptemp __attribute__((unused))) {
116
117/* Maintainer Logging */
118#if MOD_GNUTLS_DEBUG
119    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug", APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, pconf);
120    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
121    gnutls_global_set_log_level(9);
122    gnutls_global_set_log_function(gnutls_debug_log_all);
123    _gnutls_log(debug_log_fp, "gnutls: %s\n", gnutls_check_version(NULL));
124#endif
125
126    int ret;
127
128        /* Check for required GnuTLS Library Version */
129    if (gnutls_check_version(LIBGNUTLS_VERSION) == NULL) {
130                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_check_version() failed. Required: "
131                                        "gnutls-%s Found: gnutls-%s", LIBGNUTLS_VERSION, gnutls_check_version(NULL));
132        return DONE;
133    }
134
135        /* Generate a Session Key */
136    ret = gnutls_session_ticket_key_generate(&session_ticket_key);
137    if (ret < 0) {
138                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_session_ticket_key_generate: %s", gnutls_strerror(ret));
139                return DONE;
140    }
141
142    /* Initialize default priority setting */
143    ret = mgs_default_priority_init();
144    if (ret < 0)
145    {
146        ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog,
147                      "gnutls_priority_init failed for default '%s': %s (%d)",
148                      MGS_DEFAULT_PRIORITY, gnutls_strerror(ret), ret);
149        return DONE;
150    }
151
152    AP_OPTIONAL_HOOK(status_hook, mgs_status_hook, NULL, NULL, APR_HOOK_MIDDLE);
153
154    ap_mutex_register(pconf, MGS_CACHE_MUTEX_NAME, NULL, APR_LOCK_DEFAULT, 0);
155    ap_mutex_register(pconf, MGS_OCSP_MUTEX_NAME, NULL, APR_LOCK_DEFAULT, 0);
156    ap_mutex_register(pconf, MGS_OCSP_CACHE_MUTEX_NAME, NULL,
157                      APR_LOCK_DEFAULT, 0);
158
159    /* Register a pool clean-up function */
160    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config, apr_pool_cleanup_null);
161
162    return OK;
163}
164
165
166
167/**
168 * Get the list of available protocols for this connection and add it
169 * to the GnuTLS session. Must run before the client hello function.
170 */
171static void prepare_alpn_proposals(mgs_handle_t *ctxt)
172{
173    /* Check if any protocol upgrades are available
174     *
175     * The "report_all" parameter to ap_get_protocol_upgrades() is 0
176     * (report only more preferable protocols) because setting it to 1
177     * doesn't actually report ALL protocols, but only all except the
178     * current one. This way we can at least list the current one as
179     * available by appending it without potentially negotiating a
180     * less preferred protocol. */
181    const apr_array_header_t *pupgrades = NULL;
182    apr_status_t ret =
183        ap_get_protocol_upgrades(ctxt->c, NULL, ctxt->sc->s,
184                                 /*report_all*/ 0, &pupgrades);
185    if (ret != APR_SUCCESS)
186    {
187        ap_log_cerror(APLOG_MARK, APLOG_WARNING, 0, ctxt->c,
188                      "%s: ap_get_protocol_upgrades() failed, "
189                      "cannot configure ALPN!", __func__);
190        return;
191    }
192
193    if (pupgrades == NULL || pupgrades->nelts == 0)
194    {
195        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
196                      "%s: No protocol upgrades available.", __func__);
197        return;
198    }
199
200    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
201                  "%s: Found %d protocol upgrade(s) for ALPN: %s",
202                  __func__, pupgrades->nelts,
203                  apr_array_pstrcat(ctxt->c->pool, pupgrades, ','));
204    gnutls_datum_t *alpn_protos =
205        mgs_str_array_to_datum_array(pupgrades,
206                                     ctxt->c->pool,
207                                     pupgrades->nelts + 1);
208
209    /* Add the current (default) protocol at the end of the list */
210    alpn_protos[pupgrades->nelts].data =
211        (void*) apr_pstrdup(ctxt->c->pool, ap_get_protocol(ctxt->c));
212    alpn_protos[pupgrades->nelts].size =
213        strlen((char*) alpn_protos[pupgrades->nelts].data);
214    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, ctxt->c,
215                  "%s: Adding current protocol %s to ALPN set.",
216                  __func__, alpn_protos[pupgrades->nelts].data);
217
218    gnutls_alpn_set_protocols(ctxt->session,
219                              alpn_protos,
220                              pupgrades->nelts,
221                              GNUTLS_ALPN_SERVER_PRECEDENCE);
222}
223
224
225
226/**
227 * Check if ALPN selected any protocol upgrade, try to switch if so.
228 */
229static int process_alpn_result(mgs_handle_t *ctxt)
230{
231    int ret = 0;
232    gnutls_datum_t alpn_proto;
233    ret = gnutls_alpn_get_selected_protocol(ctxt->session, &alpn_proto);
234    if (ret != GNUTLS_E_SUCCESS)
235    {
236        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
237                      "%s: No ALPN result: %s (%d)",
238                      __func__, gnutls_strerror(ret), ret);
239        return GNUTLS_E_SUCCESS;
240    }
241
242    apr_array_header_t *client_protos =
243        apr_array_make(ctxt->c->pool, 1, sizeof(char *));
244    /* apr_pstrndup to ensure that the protocol is null terminated */
245    APR_ARRAY_PUSH(client_protos, char *) =
246        apr_pstrndup(ctxt->c->pool, (char*) alpn_proto.data, alpn_proto.size);
247    const char *selected =
248        ap_select_protocol(ctxt->c, NULL, ctxt->sc->s, client_protos);
249
250    /* ap_select_protocol() will return NULL if none of the ALPN
251     * proposals matched. GnuTLS negotiated alpn_proto based on the
252     * list provided by the server, but the vhost might have changed
253     * based on SNI. Apache seems to adjust the proposal list to avoid
254     * such issues though.
255     *
256     * GnuTLS will return a fatal "no_application_protocol" alert as
257     * required by RFC 7301 if the post client hello function returns
258     * GNUTLS_E_NO_APPLICATION_PROTOCOL. */
259    if (!selected)
260    {
261        ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_EGENERAL, ctxt->c,
262                      "%s: ap_select_protocol() returned NULL! Please "
263                      "make sure any overlapping vhosts have the same "
264                      "protocols available.",
265                      __func__);
266        return GNUTLS_E_NO_APPLICATION_PROTOCOL;
267    }
268
269    if (strcmp(selected, ap_get_protocol(ctxt->c)) == 0)
270    {
271        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
272                      "%s: Already using protocol '%s', nothing to do.",
273                      __func__, selected);
274        return GNUTLS_E_SUCCESS;
275    }
276
277    ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
278                  "%s: Switching protocol to '%s' based on ALPN.",
279                  __func__, selected);
280    apr_status_t status = ap_switch_protocol(ctxt->c, NULL,
281                                             ctxt->sc->s,
282                                             selected);
283    if (status != APR_SUCCESS)
284    {
285        ap_log_cerror(APLOG_MARK, APLOG_ERR, status, ctxt->c,
286                      "%s: Protocol switch to '%s' failed!",
287                      __func__, selected);
288        return GNUTLS_E_NO_APPLICATION_PROTOCOL;
289    }
290    /* ALPN done! */
291    return GNUTLS_E_SUCCESS;
292}
293
294
295
296/**
297 * (Re-)Load credentials and priorities for the connection. This is
298 * meant to be called after virtual host selection in the pre or post
299 * client hello hook.
300 */
301static int reload_session_credentials(mgs_handle_t *ctxt)
302{
303    int ret = 0;
304
305    gnutls_certificate_server_set_request(ctxt->session,
306                                          ctxt->sc->client_verify_mode);
307
308    /* Set x509 credentials */
309    gnutls_credentials_set(ctxt->session,
310                           GNUTLS_CRD_CERTIFICATE, ctxt->sc->certs);
311    /* Set Anon credentials */
312    gnutls_credentials_set(ctxt->session, GNUTLS_CRD_ANON,
313                           ctxt->sc->anon_creds);
314
315#ifdef ENABLE_SRP
316        /* Set SRP credentials */
317    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
318        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_SRP,
319                               ctxt->sc->srp_creds);
320    }
321#endif
322
323    /* Enable session tickets */
324    if (session_ticket_key.data != NULL &&
325        ctxt->sc->tickets == GNUTLS_ENABLED_TRUE)
326    {
327        ret = gnutls_session_ticket_enable_server(ctxt->session, &session_ticket_key);
328        if (ret != GNUTLS_E_SUCCESS)
329            ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_EGENERAL, ctxt->c,
330                          "gnutls_session_ticket_enable_server failed: %s (%d)",
331                          gnutls_strerror(ret), ret);
332    }
333
334    /* Update the priorities - to avoid negotiating a ciphersuite that is not
335     * enabled on this virtual server. Note that here we ignore the version
336     * negotiation. */
337    ret = gnutls_priority_set(ctxt->session, ctxt->sc->priorities);
338
339    return ret;
340}
341
342
343
344/**
345 * Post client hello hook function for GnuTLS. This function has two
346 * purposes: Firstly, it acts as a fallback for early_sni_hook(), by
347 * parsing SNI and selecting a virtual host based on it if
348 * necessary. Secondly, it calls ALPN processing.
349 *
350 * @param session the TLS session
351 *
352 * @return zero or a GnuTLS error code, as required by GnuTLS hook
353 * definition
354 */
355static int post_client_hello_hook(gnutls_session_t session)
356{
357    int ret = 0;
358    mgs_handle_t *ctxt = gnutls_session_get_ptr(session);
359
360    /* If ctxt->sni_name is set at this point the early_sni_hook()
361     * function ran, found an SNI server name, selected a virtual
362     * host, and set up credentials, so we don't need to do that
363     * again. Otherwise try again, to cover GnuTLS versions < 3.6.3
364     * and pick up future extensions to gnutls_server_name_get(). */
365    if (ctxt->sni_name == NULL)
366    {
367        /* try to find a virtual host */
368        mgs_srvconf_rec *tsc = mgs_find_sni_server(ctxt);
369        if (tsc != NULL)
370        {
371            /* Found a TLS vhost based on the SNI, configure the
372             * connection context. */
373            ctxt->sc = tsc;
374        }
375
376        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
377                      "%s: Loading credentials in post client hello hook",
378                      __func__);
379        reload_session_credentials(ctxt);
380    }
381
382    ret = process_alpn_result(ctxt);
383    if (ret != GNUTLS_E_SUCCESS)
384        return ret;
385
386    /* actually it shouldn't fail since we have checked at startup */
387    return ret;
388}
389
390static int cert_retrieve_fn(gnutls_session_t session,
391                            const struct gnutls_cert_retr_st *info __attribute__((unused)),
392                            gnutls_pcert_st **pcerts,
393                            unsigned int *pcert_length,
394                            gnutls_ocsp_data_st **ocsp,
395                            unsigned int *ocsp_length,
396                            gnutls_privkey_t *privkey,
397                            unsigned int *flags)
398{
399    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
400
401    mgs_handle_t *ctxt;
402
403    if (session == NULL) {
404                // ERROR INVALID SESSION
405        return -1;
406    }
407
408    ctxt = gnutls_transport_get_ptr(session);
409
410    if (gnutls_certificate_type_get(session) == GNUTLS_CRT_X509) {
411                // X509 CERTIFICATE
412        *pcerts = ctxt->sc->certs_x509_chain;
413        *pcert_length = ctxt->sc->certs_x509_chain_num;
414        *ocsp = NULL;
415        *ocsp_length = 0;
416        *privkey = ctxt->sc->privkey_x509;
417        *flags = 0;
418
419        if (ctxt->sc->ocsp_staple == GNUTLS_ENABLED_TRUE)
420        {
421            gnutls_ocsp_data_st *resp =
422                apr_palloc(ctxt->c->pool,
423                           sizeof(gnutls_ocsp_data_st) * ctxt->sc->ocsp_num);
424
425            for (unsigned int i = 0; i < ctxt->sc->ocsp_num; i++)
426            {
427                resp[i].version = 0;
428                resp[i].exptime = 0;
429
430                int ret = mgs_get_ocsp_response(ctxt, ctxt->sc->ocsp[i],
431                                                &resp[i].response);
432                if (ret == GNUTLS_E_SUCCESS)
433                {
434                    ocsp[i] = resp;
435                    *ocsp_length = i + 1;
436                }
437                else
438                    break;
439            }
440        }
441
442        return 0;
443    } else {
444                // UNKNOWN CERTIFICATE
445            return -1;
446        }
447}
448
449
450
451/**
452 * Try to estimate a GnuTLS security parameter based on the given
453 * private key. Any errors are logged.
454 *
455 * @param s The `server_rec` to use for logging
456 *
457 * @param key The private key to use
458 *
459 * @return `gnutls_sec_param_t` as returned by
460 * `gnutls_pk_bits_to_sec_param` for the key properties, or
461 * GNUTLS_SEC_PARAM_UNKNOWN in case of error
462 */
463static gnutls_sec_param_t sec_param_from_privkey(server_rec *server,
464                                                 gnutls_privkey_t key)
465{
466    unsigned int bits = 0;
467    int pk_algo = gnutls_privkey_get_pk_algorithm(key, &bits);
468    if (pk_algo < 0)
469    {
470        ap_log_error(APLOG_MARK, APLOG_ERR, APR_EGENERAL, server,
471                     "%s: Could not get private key parameters: %s (%d)",
472                     __func__, gnutls_strerror(pk_algo), pk_algo);
473        return GNUTLS_SEC_PARAM_UNKNOWN;
474    }
475    return gnutls_pk_bits_to_sec_param(pk_algo, bits);
476}
477
478
479
480/**
481 * Configure the default DH groups to use for the given server. When
482 * compiled against GnuTLS version 3.5.6 or newer the known DH group
483 * matching the GnuTLS security parameter estimated from the private
484 * key is used. Otherwise the ffdhe2048 DH group as defined in RFC
485 * 7919, Appendix A.1 is the default.
486 *
487 * @param server the host to configure
488 *
489 * @return `OK` on success, `HTTP_UNAUTHORIZED` otherwise
490 */
491static int set_default_dh_param(server_rec *server)
492{
493    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
494        ap_get_module_config(server->module_config, &gnutls_module);
495
496    gnutls_sec_param_t seclevel = GNUTLS_SEC_PARAM_UNKNOWN;
497    if (sc->privkey_x509)
498    {
499        seclevel = sec_param_from_privkey(server, sc->privkey_x509);
500        ap_log_error(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, server,
501                     "%s: GnuTLS security param estimated based on "
502                     "private key '%s': %s",
503                     __func__, sc->x509_key_file,
504                     gnutls_sec_param_get_name(seclevel));
505    }
506
507    if (seclevel == GNUTLS_SEC_PARAM_UNKNOWN)
508        seclevel = GNUTLS_SEC_PARAM_MEDIUM;
509    ap_log_error(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, server,
510                 "%s: Setting DH params for security level '%s'.",
511                 __func__, gnutls_sec_param_get_name(seclevel));
512
513    int ret = gnutls_certificate_set_known_dh_params(sc->certs, 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    ret = gnutls_anon_set_server_known_dh_params(sc->anon_creds, seclevel);
522    if (ret < 0)
523    {
524        ap_log_error(APLOG_MARK, APLOG_EMERG, APR_EGENERAL, server,
525                     "%s: setting known DH params failed: %s (%d)",
526                     __func__, gnutls_strerror(ret), ret);
527        return HTTP_UNAUTHORIZED;
528    }
529
530    return OK;
531}
532
533
534
535/**
536 * Pool cleanup hook to release a gnutls_x509_tlsfeatures_t structure.
537 */
538apr_status_t mgs_cleanup_tlsfeatures(void *data)
539{
540    gnutls_x509_tlsfeatures_t feat = *((gnutls_x509_tlsfeatures_t*) data);
541    gnutls_x509_tlsfeatures_deinit(feat);
542    return APR_SUCCESS;
543}
544
545
546
547/**
548 * Post config hook.
549 *
550 * Must return OK or DECLINED on success, something else on
551 * error. These codes are defined in Apache httpd.h along with the
552 * HTTP status codes, so I'm going to use HTTP error codes both for
553 * fun (and to avoid conflicts).
554 */
555int mgs_hook_post_config(apr_pool_t *pconf,
556                         apr_pool_t *plog __attribute__((unused)),
557                         apr_pool_t *ptemp,
558                         server_rec *base_server)
559{
560    int rv;
561    server_rec *s;
562    mgs_srvconf_rec *sc;
563    mgs_srvconf_rec *sc_base;
564    void *data = NULL;
565    const char *userdata_key = "mgs_init";
566
567    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
568
569    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
570    if (data == NULL) {
571        apr_pool_userdata_set((const void *) 1, userdata_key, apr_pool_cleanup_null, base_server->process->pool);
572    }
573
574    s = base_server;
575    sc_base = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
576
577
578    rv = mgs_cache_post_config(pconf, ptemp, s, sc_base);
579    if (rv != APR_SUCCESS)
580    {
581        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
582                     "Post config for cache failed.");
583        return HTTP_INSUFFICIENT_STORAGE;
584    }
585
586    if (sc_base->ocsp_mutex == NULL)
587    {
588        rv = ap_global_mutex_create(&sc_base->ocsp_mutex, NULL,
589                                    MGS_OCSP_MUTEX_NAME, NULL,
590                                    base_server, pconf, 0);
591        if (rv != APR_SUCCESS)
592            return rv;
593    }
594
595    /* If GnuTLSP11Module is set, load the listed PKCS #11
596     * modules. Otherwise system defaults will be used. */
597    if (sc_base->p11_modules != NULL)
598    {
599        rv = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL);
600        if (rv < 0)
601        {
602            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
603                         "GnuTLS: Initializing PKCS #11 "
604                         "failed: %s (%d).",
605                         gnutls_strerror(rv), rv);
606        }
607        else
608        {
609            for (int i = 0; i < sc_base->p11_modules->nelts; i++)
610            {
611                char *p11_module =
612                    APR_ARRAY_IDX(sc_base->p11_modules, i, char *);
613                rv = gnutls_pkcs11_add_provider(p11_module, NULL);
614                if (rv != GNUTLS_E_SUCCESS)
615                    ap_log_error(APLOG_MARK, APLOG_STARTUP, APR_EGENERAL, s,
616                                 "GnuTLS: Loading PKCS #11 provider module %s "
617                                 "failed: %s (%d).",
618                                 p11_module, gnutls_strerror(rv), rv);
619                else
620                    ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
621                                 "%s: PKCS #11 provider module %s loaded.",
622                                 __func__, p11_module);
623            }
624        }
625    }
626
627    sc_base->singleton_wd =
628        mgs_new_singleton_watchdog(base_server, MGS_SINGLETON_WATCHDOG, pconf);
629
630    gnutls_x509_tlsfeatures_t *must_staple =
631        apr_palloc(ptemp, sizeof(gnutls_x509_tlsfeatures_t));
632    gnutls_x509_tlsfeatures_init(must_staple);
633    gnutls_x509_tlsfeatures_add(*must_staple, TLSFEATURE_MUST_STAPLE);
634    apr_pool_cleanup_register(ptemp, must_staple,
635                              mgs_cleanup_tlsfeatures,
636                              apr_pool_cleanup_null);
637
638    for (s = base_server; s; s = s->next)
639    {
640        sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
641        sc->s = s;
642        sc->cache_enable = sc_base->cache_enable;
643        sc->cache = sc_base->cache;
644        if (sc->cache_timeout == MGS_TIMEOUT_UNSET)
645            sc->cache_timeout = sc_base->cache_timeout;
646        sc->ocsp_cache = sc_base->ocsp_cache;
647
648        sc->singleton_wd = sc_base->singleton_wd;
649
650        /* defaults for unset values: */
651        if (sc->enabled == GNUTLS_ENABLED_UNSET)
652            sc->enabled = GNUTLS_ENABLED_FALSE;
653        if (sc->tickets == GNUTLS_ENABLED_UNSET)
654        {
655            /* GnuTLS 3.6.4 introduced automatic master key rotation */
656            if (gnutls_check_version_numeric(3, 6, 4))
657                sc->tickets = GNUTLS_ENABLED_TRUE;
658            else
659                sc->tickets = GNUTLS_ENABLED_FALSE;
660        }
661        if (sc->export_certificates_size < 0)
662            sc->export_certificates_size = 0;
663        if (sc->client_verify_mode == -1)
664            sc->client_verify_mode = GNUTLS_CERT_IGNORE;
665        if (sc->client_verify_method == mgs_cvm_unset)
666            sc->client_verify_method = mgs_cvm_cartel;
667
668        // TODO: None of the stuff below needs to be done if
669        // sc->enabled == GNUTLS_ENABLED_FALSE, we could just continue
670        // to the next host.
671
672        /* Load certificates and stuff (includes parsing priority) */
673        rv = mgs_load_files(pconf, ptemp, s);
674        if (rv != 0) {
675            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
676                         "%s: Loading credentials failed!", __func__);
677            return HTTP_NOT_FOUND;
678        }
679
680        sc->ocsp_mutex = sc_base->ocsp_mutex;
681        /* init OCSP configuration unless explicitly disabled */
682        if (sc->enabled && sc->ocsp_staple != GNUTLS_ENABLED_FALSE)
683        {
684            const char *err = mgs_ocsp_configure_stapling(pconf, ptemp, s);
685            if (err != NULL)
686            {
687                /* If OCSP stapling is enabled only by default ignore
688                 * error and disable stapling */
689                if (sc->ocsp_staple == GNUTLS_ENABLED_UNSET)
690                {
691                    ap_log_error(APLOG_MARK, APLOG_INFO, APR_SUCCESS, s,
692                                 "Cannnot enable OCSP stapling for "
693                                 "host '%s:%d': %s",
694                                 s->server_hostname, s->addrs->host_port, err);
695                    sc->ocsp_staple = GNUTLS_ENABLED_FALSE;
696                }
697                /* If OCSP stapling is explicitly enabled this is a
698                 * critical error. */
699                else
700                {
701                    ap_log_error(APLOG_MARK, APLOG_STARTUP, APR_EINVAL, s,
702                                 "OCSP stapling configuration failed for "
703                                 "host '%s:%d': %s",
704                                 s->server_hostname, s->addrs->host_port, err);
705                    return HTTP_INTERNAL_SERVER_ERROR;
706                }
707            }
708            else
709            {
710                /* Might already be set */
711                sc->ocsp_staple = GNUTLS_ENABLED_TRUE;
712                /* Set up stapling */
713                rv = mgs_ocsp_enable_stapling(pconf, ptemp, s);
714                if (rv != OK && rv != DECLINED)
715                    return rv;
716            }
717        }
718
719        /* Check if the priorities have been set */
720        if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
721            ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
722                         "No GnuTLSPriorities directive for host '%s:%d', "
723                         "using default '%s'.",
724                         s->server_hostname, s->addrs->host_port,
725                         MGS_DEFAULT_PRIORITY);
726            sc->priorities = mgs_get_default_prio();
727        }
728
729        /* Set host DH params from user configuration or defaults */
730        if (sc->dh_params != NULL) {
731            gnutls_certificate_set_dh_params(sc->certs, sc->dh_params);
732            gnutls_anon_set_server_dh_params(sc->anon_creds, sc->dh_params);
733        } else {
734            rv = set_default_dh_param(s);
735            if (rv != OK)
736                return rv;
737        }
738
739        gnutls_certificate_set_retrieve_function3(sc->certs, cert_retrieve_fn);
740
741        if ((sc->certs_x509_chain == NULL || sc->certs_x509_chain_num < 1) &&
742            sc->enabled == GNUTLS_ENABLED_TRUE) {
743                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
744                                                "GnuTLS: Host '%s:%d' is missing a Certificate File!",
745                                                s->server_hostname, s->addrs->host_port);
746            return HTTP_UNAUTHORIZED;
747        }
748        if (sc->enabled == GNUTLS_ENABLED_TRUE &&
749            (sc->certs_x509_chain_num > 0 && sc->privkey_x509 == NULL))
750        {
751                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
752                                                "GnuTLS: Host '%s:%d' is missing a Private Key File!",
753                                                s->server_hostname, s->addrs->host_port);
754            return HTTP_UNAUTHORIZED;
755        }
756
757        if (sc->certs_x509_chain_num > 0
758            && gnutls_x509_tlsfeatures_check_crt(*must_staple,
759                                                 sc->certs_x509_crt_chain[0])
760            && sc->ocsp_staple == GNUTLS_ENABLED_FALSE)
761        {
762            ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
763                         "Must-Staple is set in the host certificate "
764                         "of '%s:%d', but stapling is disabled!",
765                         s->server_hostname, s->addrs->host_port);
766            return HTTP_UNAUTHORIZED;
767        }
768
769        if (sc->enabled == GNUTLS_ENABLED_TRUE
770            && sc->proxy_enabled == GNUTLS_ENABLED_TRUE
771            && load_proxy_x509_credentials(pconf, ptemp, s) != APR_SUCCESS)
772        {
773            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
774                         "%s: loading proxy credentials for host "
775                         "'%s:%d' failed, exiting!",
776                         __func__, s->server_hostname, s->addrs->host_port);
777            return HTTP_PROXY_AUTHENTICATION_REQUIRED;
778        }
779    }
780
781
782    ap_add_version_component(pconf, "mod_gnutls/" MOD_GNUTLS_VERSION);
783
784    {
785        const char* libvers = gnutls_check_version(NULL);
786        char* gnutls_version = NULL;
787        if(libvers && (gnutls_version = apr_psprintf(pconf, "GnuTLS/%s", libvers))) {
788            ap_add_version_component(pconf, gnutls_version);
789        } else {
790            // In case we could not create the above string go for the static version instead
791            ap_add_version_component(pconf, "GnuTLS/" GNUTLS_VERSION "-static");
792        }
793    }
794
795    return OK;
796}
797
798void mgs_hook_child_init(apr_pool_t *p, server_rec *s)
799{
800    apr_status_t rv = APR_SUCCESS;
801    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
802        ap_get_module_config(s->module_config, &gnutls_module);
803
804    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
805
806    /* if we use PKCS #11 reinitialize it */
807    if (mgs_pkcs11_reinit(s) < 0) {
808            ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
809                    "GnuTLS: Failed to reinitialize PKCS #11");
810            exit(-1);
811    }
812
813    if (sc->cache_enable == GNUTLS_ENABLED_TRUE)
814    {
815        rv = mgs_cache_child_init(p, s, sc->cache, MGS_CACHE_MUTEX_NAME);
816        if (rv != APR_SUCCESS)
817            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
818                    "Child init for session cache failed!");
819    }
820
821    if (sc->ocsp_cache != NULL)
822    {
823        rv = mgs_cache_child_init(p, s, sc->ocsp_cache,
824                                  MGS_OCSP_CACHE_MUTEX_NAME);
825        if (rv != APR_SUCCESS)
826            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
827                    "Child init for OCSP cache failed!");
828    }
829
830    /* reinit OCSP request mutex */
831    const char *lockfile = apr_global_mutex_lockfile(sc->ocsp_mutex);
832    rv = apr_global_mutex_child_init(&sc->ocsp_mutex, lockfile, p);
833    if (rv != APR_SUCCESS)
834        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
835                     "Failed to reinit mutex '" MGS_OCSP_MUTEX_NAME "'.");
836
837    /* Block SIGPIPE Signals */
838    rv = apr_signal_block(SIGPIPE);
839    if(rv != APR_SUCCESS) {
840        /* error sending output */
841        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
842                "GnuTLS: Error Blocking SIGPIPE Signal!");
843    }
844}
845
846const char *mgs_hook_http_scheme(const request_rec * r) {
847    mgs_srvconf_rec *sc;
848
849    if (r == NULL)
850        return NULL;
851
852    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
853            server->module_config,
854            &gnutls_module);
855
856    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
857    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
858        return NULL;
859    }
860
861    return "https";
862}
863
864apr_port_t mgs_hook_default_port(const request_rec * r) {
865    mgs_srvconf_rec *sc;
866
867    if (r == NULL)
868        return 0;
869
870    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
871            server->module_config,
872            &gnutls_module);
873
874    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
875    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
876        return 0;
877    }
878
879    return 443;
880}
881
882
883
884typedef struct {
885    mgs_handle_t *ctxt;
886    mgs_srvconf_rec *sc;
887    const char *sni_name;
888} vhost_cb_rec;
889
890/**
891 * Matches the current vhost's ServerAlias directives
892 *
893 * @param x vhost callback record
894 * @param s server record
895 * @param tsc mod_gnutls server data for `s`
896 *
897 * @return true if a match, false otherwise
898 *
899 */
900int check_server_aliases(vhost_cb_rec *x, server_rec * s, mgs_srvconf_rec *tsc)
901{
902    apr_array_header_t *names;
903    int rv = 0;
904    char ** name;
905
906    /* Check ServerName First! */
907    if (strcasecmp(x->sni_name, s->server_hostname) == 0) {
908        // We have a match, save this server configuration
909        x->sc = tsc;
910        rv = 1;
911        /* Check any ServerAlias directives */
912    } else if(s->names->nelts) {
913        names = s->names;
914        name = (char **) names->elts;
915        for (int i = 0; i < names->nelts; ++i)
916        {
917            if (!name[i])
918                continue;
919            if (strcasecmp(x->sni_name, name[i]) == 0)
920            {
921                // We have a match, save this server configuration
922                x->sc = tsc;
923                rv = 1;
924            }
925        }
926        /* ServerAlias directives may contain wildcards, check those last. */
927    } else if(s->wild_names->nelts) {
928        names = s->wild_names;
929        name = (char **) names->elts;
930        for (int i = 0; i < names->nelts; ++i)
931        {
932            if (!name[i])
933                continue;
934            if (ap_strcasecmp_match(x->sni_name, name[i]) == 0)
935            {
936                x->sc = tsc;
937                rv = 1;
938            }
939        }
940    }
941    return rv;
942}
943
944static int vhost_cb(void *baton, conn_rec *conn, server_rec * s)
945{
946    mgs_srvconf_rec *tsc;
947    vhost_cb_rec *x = baton;
948    int ret;
949
950    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
951    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
952            &gnutls_module);
953
954    if (tsc->enabled != GNUTLS_ENABLED_TRUE) {
955        return 0;
956    }
957
958    if (tsc->certs_x509_chain_num > 0) {
959        /* this check is there to warn administrator of any missing hostname
960         * in the certificate. */
961        ret = gnutls_x509_crt_check_hostname(tsc->certs_x509_crt_chain[0], s->server_hostname);
962        if (0 == ret)
963            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, conn,
964                          "GnuTLS: the certificate doesn't match requested "
965                          "hostname '%s'", s->server_hostname);
966    } else {
967        ap_log_cerror(APLOG_MARK, APLOG_INFO, 0, conn,
968                      "GnuTLS: SNI request for '%s' but no X.509 certs "
969                      "available at all",
970                      s->server_hostname);
971    }
972        return check_server_aliases(x, s, tsc);
973}
974
975/**
976 * Get SNI data from GnuTLS (if any) and search for a matching virtual
977 * host configuration. This method is called from the post client
978 * hello function.
979 *
980 * @param ctxt the mod_gnutls connection handle
981 *
982 * @return either the matching mod_gnutls server config, or `NULL`
983 */
984mgs_srvconf_rec *mgs_find_sni_server(mgs_handle_t *ctxt)
985{
986    if (ctxt->sni_name == NULL)
987    {
988        const char *sni_name = mgs_server_name_get(ctxt);
989        if (sni_name != NULL)
990            ctxt->sni_name = sni_name;
991        else
992            return NULL;
993    }
994
995    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
996                  "%s: client requested server '%s'.",
997                  __func__, ctxt->sni_name);
998
999    /* Search for vhosts matching connection parameters and the
1000     * SNI. If a match is found, cbx.sc will contain the mod_gnutls
1001     * server config for the vhost. */
1002    vhost_cb_rec cbx = {
1003        .ctxt = ctxt,
1004        .sc = NULL,
1005        .sni_name = ctxt->sni_name
1006    };
1007    int rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
1008    if (rv == 1) {
1009        return cbx.sc;
1010    }
1011    return NULL;
1012}
1013
1014
1015
1016#ifdef ENABLE_EARLY_SNI
1017/**
1018 * Pre client hello hook function for GnuTLS that implements early SNI
1019 * processing using `gnutls_ext_raw_parse()` (available since GnuTLS
1020 * 3.6.3). Reading the SNI (if any) before GnuTLS processes the client
1021 * hello allows loading virtual host settings that cannot be changed
1022 * in the post client hello hook, including ALPN proposals (required
1023 * for HTTP/2 support using the `Protocols` directive). In addition to
1024 * ALPN this function configures the server credentials.
1025 *
1026 * The function signature is required by the GnuTLS API.
1027 *
1028 * @param session the current session
1029 * @param htype handshake message type
1030 * @param when hook position relative to GnuTLS processing
1031 * @param incoming true if the message is incoming, for client hello
1032 * that means the hook is running on the server
1033 * @param msg raw message data
1034 *
1035 * @return `GNUTLS_E_SUCCESS` or a GnuTLS error code
1036 */
1037static int early_sni_hook(gnutls_session_t session,
1038                          unsigned int htype,
1039                          unsigned when,
1040                          unsigned int incoming,
1041                          const gnutls_datum_t *msg)
1042{
1043    if (!incoming)
1044        return 0;
1045
1046    mgs_handle_t *ctxt = (mgs_handle_t *) gnutls_session_get_ptr(session);
1047
1048    /* This is a hook for pre client hello ONLY! */
1049    if (htype != GNUTLS_HANDSHAKE_CLIENT_HELLO || when != GNUTLS_HOOK_PRE)
1050    {
1051        ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_EINVAL, ctxt->c,
1052                      "%s called outside pre client hello hook, this "
1053                      "indicates a programming error!",
1054                      __func__);
1055        return GNUTLS_E_SELF_TEST_ERROR;
1056    }
1057
1058    int ret = gnutls_ext_raw_parse(session, mgs_sni_ext_hook, msg,
1059                                   GNUTLS_EXT_RAW_FLAG_TLS_CLIENT_HELLO);
1060    if (ret == 0 && ctxt->sni_name != NULL)
1061    {
1062        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
1063                      "%s found SNI name: '%s'",
1064                      __func__, ctxt->sni_name);
1065
1066        /* try to find a virtual host for that name */
1067        mgs_srvconf_rec *tsc = mgs_find_sni_server(ctxt);
1068        if (tsc != NULL)
1069        {
1070            /* Found a TLS vhost based on the SNI, configure the
1071             * connection context. */
1072            ctxt->sc = tsc;
1073            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
1074                          "%s: Selected virtual host %s from early SNI, "
1075                          "connection server is %s.",
1076                          __func__, ctxt->sc->s->server_hostname,
1077                          ctxt->c->base_server->server_hostname);
1078        }
1079    }
1080
1081    reload_session_credentials(ctxt);
1082
1083    prepare_alpn_proposals(ctxt);
1084
1085    return ret;
1086}
1087#endif
1088
1089
1090
1091/**
1092 * This function is intended as a cleanup handler for connections
1093 * using GnuTLS. If attached to the connection pool, it ensures that
1094 * session resources are released with the connection pool even if the
1095 * session wasn't terminated properly.
1096 *
1097 * @param data must point to the mgs_handle_t associated with the
1098 * connection
1099 */
1100static apr_status_t cleanup_gnutls_session(void *data)
1101{
1102    /* nothing to do */
1103    if (data == NULL)
1104        return APR_SUCCESS;
1105
1106    /* check if session needs closing */
1107    mgs_handle_t *ctxt = (mgs_handle_t *) data;
1108    if (ctxt->session != NULL)
1109    {
1110        ap_log_cerror(APLOG_MARK, APLOG_WARNING, APR_ECONNABORTED, ctxt->c,
1111                      "%s: connection pool cleanup in progress but %sTLS "
1112                      "session hasn't been terminated, trying to close",
1113                      __func__, IS_PROXY_STR(ctxt));
1114        int ret;
1115        /* Try A Clean Shutdown */
1116        do
1117            ret = gnutls_bye(ctxt->session, GNUTLS_SHUT_WR);
1118        while (ret == GNUTLS_E_INTERRUPTED || ret == GNUTLS_E_AGAIN);
1119        if (ret != GNUTLS_E_SUCCESS)
1120            ap_log_cerror(APLOG_MARK, APLOG_INFO, APR_EGENERAL, ctxt->c,
1121                          "%s: error while closing TLS %sconnection: %s (%d)",
1122                          __func__, IS_PROXY_STR(ctxt),
1123                          gnutls_strerror(ret), ret);
1124        else
1125            ap_log_cerror(APLOG_MARK, APLOG_DEBUG, APR_SUCCESS, ctxt->c,
1126                          "%s: TLS %sconnection closed.",
1127                          __func__, IS_PROXY_STR(ctxt));
1128        /* De-Initialize Session */
1129        gnutls_deinit(ctxt->session);
1130        ctxt->session = NULL;
1131    }
1132    return APR_SUCCESS;
1133}
1134
1135static void create_gnutls_handle(conn_rec * c)
1136{
1137    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1138
1139    /* Get connection specific configuration */
1140    mgs_handle_t *ctxt = init_gnutls_ctxt(c);
1141    ctxt->enabled = GNUTLS_ENABLED_TRUE;
1142    ctxt->status = 0;
1143    ctxt->input_rc = APR_SUCCESS;
1144    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
1145    ctxt->input_cbuf.length = 0;
1146    ctxt->output_rc = APR_SUCCESS;
1147    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
1148    ctxt->output_blen = 0;
1149    ctxt->output_length = 0;
1150
1151    /* Initialize GnuTLS Library */
1152    int err = 0;
1153    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
1154    {
1155        /* this is an outgoing proxy connection, client mode */
1156        err = gnutls_init(&ctxt->session, GNUTLS_CLIENT);
1157        if (err != GNUTLS_E_SUCCESS)
1158            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1159                          "gnutls_init for proxy connection failed: %s (%d)",
1160                          gnutls_strerror(err), err);
1161    }
1162    else
1163    {
1164        /* incoming connection, server mode */
1165        err = gnutls_init(&ctxt->session, GNUTLS_SERVER);
1166        if (err != GNUTLS_E_SUCCESS)
1167            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1168                          "gnutls_init for server side failed: %s (%d)",
1169                          gnutls_strerror(err), err);
1170    }
1171
1172    /* Ensure TLS session resources are released when the connection
1173     * pool is cleared, if the filters haven't done that already. */
1174    apr_pool_pre_cleanup_register(c->pool, ctxt, cleanup_gnutls_session);
1175
1176    /* Set Default Priority */
1177        err = gnutls_priority_set(ctxt->session, mgs_get_default_prio());
1178    if (err != GNUTLS_E_SUCCESS)
1179        ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1180                      "gnutls_priority_set failed!");
1181
1182#ifdef ENABLE_EARLY_SNI
1183    /* Pre-handshake hook, EXPERIMENTAL */
1184    gnutls_handshake_set_hook_function(ctxt->session,
1185                                       GNUTLS_HANDSHAKE_CLIENT_HELLO,
1186                                       GNUTLS_HOOK_PRE, early_sni_hook);
1187#else
1188    prepare_alpn_proposals(ctxt);
1189#endif
1190
1191    /* Post client hello hook (called after GnuTLS has parsed it) */
1192    gnutls_handshake_set_post_client_hello_function(ctxt->session,
1193            post_client_hello_hook);
1194
1195    /* Set GnuTLS user pointer, so we can access the module session
1196     * context in GnuTLS callbacks */
1197    gnutls_session_set_ptr(ctxt->session, ctxt);
1198
1199    /* If mod_gnutls is the TLS server, early_sni_hook (or
1200     * post_client_hello_hook, if early SNI is not available) will
1201     * load appropriate credentials during the handshake. However,
1202     * when handling a proxy backend connection, mod_gnutls acts as
1203     * TLS client and credentials must be loaded here. */
1204    if (ctxt->is_proxy == GNUTLS_ENABLED_TRUE)
1205    {
1206        /* Set anonymous client credentials for proxy connections */
1207        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_ANON,
1208                               ctxt->sc->anon_client_creds);
1209        /* Set x509 credentials */
1210        gnutls_credentials_set(ctxt->session, GNUTLS_CRD_CERTIFICATE,
1211                               ctxt->sc->proxy_x509_creds);
1212        /* Load priorities from the server configuration */
1213        err = gnutls_priority_set(ctxt->session, ctxt->sc->proxy_priorities);
1214        if (err != GNUTLS_E_SUCCESS)
1215            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c,
1216                          "%s: setting priorities for proxy connection "
1217                          "failed: %s (%d)",
1218                          __func__, gnutls_strerror(err), err);
1219    }
1220
1221    /* Initialize Session Cache */
1222    mgs_cache_session_init(ctxt);
1223
1224    /* Set pull, push & ptr functions */
1225    gnutls_transport_set_pull_function(ctxt->session,
1226            mgs_transport_read);
1227    gnutls_transport_set_push_function(ctxt->session,
1228            mgs_transport_write);
1229    gnutls_transport_set_ptr(ctxt->session, ctxt);
1230    /* Add IO filters */
1231    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME,
1232            ctxt, NULL, c);
1233    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
1234            ctxt, NULL, c);
1235}
1236
1237int mgs_hook_pre_connection(conn_rec * c, void *csd __attribute__((unused)))
1238{
1239    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1240
1241    if (c->master)
1242    {
1243        ap_log_cerror(APLOG_MARK, APLOG_TRACE1, 0, c,
1244                      "%s declined secondary connection", __func__);
1245        return DECLINED;
1246    }
1247
1248    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
1249        ap_get_module_config(c->base_server->module_config, &gnutls_module);
1250    mgs_handle_t *ctxt = (mgs_handle_t *)
1251        ap_get_module_config(c->conn_config, &gnutls_module);
1252
1253    if ((sc && (!sc->enabled))
1254        || (ctxt && ctxt->enabled == GNUTLS_ENABLED_FALSE))
1255    {
1256        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, c, "%s declined connection",
1257                      __func__);
1258        return DECLINED;
1259    }
1260
1261    create_gnutls_handle(c);
1262    return OK;
1263}
1264
1265
1266
1267/**
1268 * process_connection hook: Do a zero byte read to trigger the
1269 * handshake. Doesn't change anything for traditional protocols that
1270 * just do reads, but HTTP/2 needs the TLS handshake and ALPN to
1271 * happen before its process_connection hook runs.
1272 */
1273int mgs_hook_process_connection(conn_rec* c)
1274{
1275    mgs_handle_t *ctxt = (mgs_handle_t *)
1276        ap_get_module_config(c->conn_config, &gnutls_module);
1277
1278    if ((ctxt != NULL) && (ctxt->enabled == GNUTLS_ENABLED_TRUE))
1279    {
1280        /* This connection is supposed to use TLS. Give the filters a
1281         * kick with a zero byte read to trigger the handshake. */
1282        apr_bucket_brigade* temp =
1283            apr_brigade_create(c->pool, c->bucket_alloc);
1284        ap_get_brigade(c->input_filters, temp,
1285                       AP_MODE_INIT, APR_BLOCK_READ, 0);
1286        apr_brigade_destroy(temp);
1287    }
1288    return DECLINED;
1289}
1290
1291
1292
1293/* Post request hook, checks if TLS connection and vhost match */
1294int mgs_req_vhost_check(request_rec *r)
1295{
1296    /* mod_gnutls server record for the request vhost */
1297    mgs_srvconf_rec *r_sc = (mgs_srvconf_rec *)
1298        ap_get_module_config(r->server->module_config, &gnutls_module);
1299    mgs_handle_t *ctxt = get_effective_gnutls_ctxt(r->connection);
1300
1301    /* Nothing to check for non-TLS and outgoing proxy connections */
1302    if (ctxt == NULL || !ctxt->enabled || ctxt->is_proxy)
1303        return DECLINED;
1304
1305    if (ctxt->sc != r_sc)
1306    {
1307        ap_log_cerror(APLOG_MARK, APLOG_ERR, APR_SUCCESS, ctxt->c,
1308                      "%s: Mismatch between handshake and request servers!",
1309                      __func__);
1310        return HTTP_MISDIRECTED_REQUEST;
1311    }
1312
1313    if (!ctxt->sni_name)
1314        return DECLINED;
1315
1316    /* Got an SNI name, so verify it matches. */
1317    ap_log_cerror(APLOG_MARK, APLOG_TRACE1, APR_SUCCESS, ctxt->c,
1318                  "%s: Checking request hostname against SNI name '%s'.",
1319                  __func__, ctxt->sni_name);
1320
1321    if (!r->hostname)
1322    {
1323        ap_log_cerror(APLOG_MARK, APLOG_ERR, 0, r->connection,
1324                      "Client requested '%s' via SNI, but provided "
1325                      "no hostname in HTTP request!", ctxt->sni_name);
1326        return HTTP_MISDIRECTED_REQUEST;
1327    }
1328
1329    if (strcasecmp(r->hostname, ctxt->sni_name) != 0)
1330    {
1331        ap_log_cerror(APLOG_MARK, APLOG_ERR, 0, r->connection,
1332                      "Client requested '%s' via SNI, but '%s' in "
1333                      "the HTTP request!", ctxt->sni_name, r->hostname);
1334        return HTTP_MISDIRECTED_REQUEST;
1335    }
1336
1337    return DECLINED;
1338}
1339
1340
1341
1342int mgs_hook_fixups(request_rec * r) {
1343    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
1344    const char *tmp;
1345    size_t len;
1346    mgs_handle_t *ctxt;
1347    int rv = OK;
1348
1349    if (r == NULL)
1350        return DECLINED;
1351
1352    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1353    apr_table_t *env = r->subprocess_env;
1354
1355    ctxt = get_effective_gnutls_ctxt(r->connection);
1356
1357    if (!ctxt || ctxt->enabled != GNUTLS_ENABLED_TRUE || ctxt->session == NULL)
1358    {
1359        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "request declined in %s", __func__);
1360        return DECLINED;
1361    }
1362
1363    apr_table_setn(env, "HTTPS", "on");
1364
1365    apr_table_setn(env, "SSL_VERSION_LIBRARY",
1366            "GnuTLS/" LIBGNUTLS_VERSION);
1367    apr_table_setn(env, "SSL_VERSION_INTERFACE",
1368            "mod_gnutls/" MOD_GNUTLS_VERSION);
1369
1370    apr_table_setn(env, "SSL_PROTOCOL",
1371            gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
1372
1373    /* should have been called SSL_CIPHERSUITE instead */
1374    apr_table_setn(env, "SSL_CIPHER",
1375            gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
1376                                         gnutls_cipher_get(ctxt->session),
1377                                         gnutls_mac_get(ctxt->session)));
1378
1379    /* Compression support has been removed since GnuTLS 3.6.0 */
1380    apr_table_setn(env, "SSL_COMPRESS_METHOD", "NULL");
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.