source: mod_gnutls/src/gnutls_hooks.c @ 0fcba60

debian/masterproxy-ticket
Last change on this file since 0fcba60 was 0fcba60, checked in by Fiona Klute <fiona.klute@…>, 22 months ago

Move compiled default priorities to gnutls_util.[hc]

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