source: mod_gnutls/src/gnutls_hooks.c @ fa6d0bb

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

Initialize OCSP stapling only if mod_gnutls is enabled for a virtual host

Initializing OCSP stapling fails if there is no suitable certificate
chain configured for a virtual host. Skipping initialization if
GnuTLSEnable is off for a virtual host allows setting the default for
GnuTLSOCSPStapling with a global directive.

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