source: mod_gnutls/src/gnutls_hooks.c @ 9cee2e9

debian/masterdebian/stretch-backportsupstream
Last change on this file since 9cee2e9 was 9cee2e9, checked in by Fiona Klute <fiona.klute@…>, 19 months ago

Support ALPN (required for secure HTTP/2)

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