source: mod_gnutls/src/gnutls_hooks.c @ f06c148

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

Simplify wildcard match for virtual host aliases

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