source: mod_gnutls/src/gnutls_hooks.c @ babdb29

debian/masterproxy-ticket
Last change on this file since babdb29 was babdb29, checked in by Fiona Klute <fiona.klute@…>, 2 years ago

Initialize and clean up the OCSP cache, following session cache patterns

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