source: mod_gnutls/src/gnutls_hooks.c @ f52f1b4

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

Allow GnuTLSCacheTimeout in virtual host config

I'm not sure if anyone needs this, but it simplifies timeout
configuration handling and is certainly not a bad thing.

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