source: mod_gnutls/src/gnutls_hooks.c @ cf6f974

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

mgs_get_ocsp_response: Accept request information from cert_retrieve_fn

With this the certificate retrieve function could request multiple
responses for stapling if it had the request information.

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