source: mod_gnutls/src/gnutls_hooks.c @ 7921dc7

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

Remove OpenPGP authentication

OpenPGP authentication was removed from GnuTLS a while ago, follow suit.

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