source: mod_gnutls/src/gnutls_hooks.c @ 556783e

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

Provide OCSP response via gnutls_certificate_retrieve_function3 callback

This replaces the old OCSP callback function, which is still used
internally.

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