source: mod_gnutls/src/gnutls_hooks.c @ 07d548d

debian/masterdebian/stretch-backportsjessie-backportsupstream
Last change on this file since 07d548d was 07d548d, checked in by Thomas Klute <thomas2.klute@…>, 5 years ago

Properly use SSLProxyEngine option

ssl_proxy_enable now checks if SSLProxyEngine is enabled, and fails with
an error log entry if not. If it is, TLS is enabled in the mod_gnutls
connection structure.

The pre connection hook (mgs_hook_pre_connection) is changed such that
it does not decline any connection whatsoever if TLS proxy is enabled.

Not that actually using TLS in a proxy backend is still unsupported and
will NOT work.

  • Property mode set to 100644
File size: 53.7 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2008 Nikos Mavrogiannopoulos
4 *  Copyright 2011 Dash Shendy
5 *  Copyright 2013-2014 Daniel Kahn Gillmor
6 *
7 *  Licensed under the Apache License, Version 2.0 (the "License");
8 *  you may not use this file except in compliance with the License.
9 *  You may obtain a copy of the License at
10 *
11 *      http://www.apache.org/licenses/LICENSE-2.0
12 *
13 *  Unless required by applicable law or agreed to in writing, software
14 *  distributed under the License is distributed on an "AS IS" BASIS,
15 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 *  See the License for the specific language governing permissions and
17 *  limitations under the License.
18 *
19 */
20
21#include "mod_gnutls.h"
22#include "http_vhost.h"
23#include "ap_mpm.h"
24#include "mod_status.h"
25
26#ifdef ENABLE_MSVA
27#include <msv/msv.h>
28#endif
29
30#ifdef APLOG_USE_MODULE
31APLOG_USE_MODULE(gnutls);
32#endif
33
34#if !USING_2_1_RECENT
35extern server_rec *ap_server_conf;
36#endif
37
38#if MOD_GNUTLS_DEBUG
39static apr_file_t *debug_log_fp;
40#endif
41
42static gnutls_datum_t session_ticket_key = {NULL, 0};
43
44static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
45/* use side==0 for server and side==1 for client */
46static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size);
47static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, size_t export_cert_size);
48static int mgs_status_hook(request_rec *r, int flags);
49#ifdef ENABLE_MSVA
50static const char* mgs_x509_construct_uid(request_rec * pool, gnutls_x509_crt_t cert);
51#endif
52
53/* Pool Cleanup Function */
54apr_status_t mgs_cleanup_pre_config(void *data __attribute__((unused))) {
55        /* Free all session data */
56    gnutls_free(session_ticket_key.data);
57    session_ticket_key.data = NULL;
58    session_ticket_key.size = 0;
59        /* Deinitialize GnuTLS Library */
60    gnutls_global_deinit();
61    return APR_SUCCESS;
62}
63
64/* Logging Function for Maintainers */
65#if MOD_GNUTLS_DEBUG
66static void gnutls_debug_log_all(int level, const char *str) {
67    apr_file_printf(debug_log_fp, "<%d> %s", level, str);
68}
69#define _gnutls_log apr_file_printf
70#else
71#define _gnutls_log(...)
72#endif
73
74static const char* mgs_readable_cvm(mgs_client_verification_method_e m) {
75    switch(m) {
76    case mgs_cvm_unset:
77        return "unset";
78    case mgs_cvm_cartel:
79        return "cartel";
80    case mgs_cvm_msva:
81        return "msva";
82    }
83    return "unknown";
84}
85
86/* Pre-Configuration HOOK: Runs First */
87int mgs_hook_pre_config(apr_pool_t * pconf, apr_pool_t * plog, apr_pool_t * ptemp __attribute__((unused))) {
88
89/* Maintainer Logging */
90#if MOD_GNUTLS_DEBUG
91    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug", APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, pconf);
92    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
93    gnutls_global_set_log_level(9);
94    gnutls_global_set_log_function(gnutls_debug_log_all);
95    _gnutls_log(debug_log_fp, "gnutls: %s\n", gnutls_check_version(NULL));
96#endif
97
98    int ret;
99
100        /* Check for required GnuTLS Library Version */
101    if (gnutls_check_version(LIBGNUTLS_VERSION) == NULL) {
102                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_check_version() failed. Required: "
103                                        "gnutls-%s Found: gnutls-%s", LIBGNUTLS_VERSION, gnutls_check_version(NULL));
104        return DONE;
105    }
106
107        /* Initialize GnuTLS Library */
108    ret = gnutls_global_init();
109    if (ret < 0) {
110                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_global_init: %s", gnutls_strerror(ret));
111                return DONE;
112    }
113
114        /* Generate a Session Key */
115    ret = gnutls_session_ticket_key_generate(&session_ticket_key);
116    if (ret < 0) {
117                ap_log_perror(APLOG_MARK, APLOG_EMERG, 0, plog, "gnutls_session_ticket_key_generate: %s", gnutls_strerror(ret));
118                return DONE;
119    }
120
121    AP_OPTIONAL_HOOK(status_hook, mgs_status_hook, NULL, NULL, APR_HOOK_MIDDLE);
122
123        /* Register a pool clean-up function */
124    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config, apr_pool_cleanup_null);
125
126    return OK;
127}
128
129static int mgs_select_virtual_server_cb(gnutls_session_t session) {
130
131    mgs_handle_t *ctxt = NULL;
132    mgs_srvconf_rec *tsc = NULL;
133    int ret = 0;
134
135    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
136
137    ctxt = gnutls_transport_get_ptr(session);
138
139    /* find the virtual server */
140    tsc = mgs_find_sni_server(session);
141
142    if (tsc != NULL) {
143        // Found a TLS vhost based on the SNI from the client; use it instead.
144        ctxt->sc = tsc;
145        }
146
147    gnutls_certificate_server_set_request(session, ctxt->sc->client_verify_mode);
148
149    /* Set Anon credentials */
150    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, ctxt->sc->certs);
151        /* Set x509 credentials */
152    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
153
154#ifdef ENABLE_SRP
155        /* Set SRP credentials */
156    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
157        gnutls_credentials_set(session, GNUTLS_CRD_SRP, ctxt->sc->srp_creds);
158    }
159#endif
160
161    /* update the priorities - to avoid negotiating a ciphersuite that is not
162     * enabled on this virtual server. Note that here we ignore the version
163     * negotiation.
164     */
165
166    ret = gnutls_priority_set(session, ctxt->sc->priorities);
167    /* actually it shouldn't fail since we have checked at startup */
168    return ret;
169
170}
171
172static int cert_retrieve_fn(gnutls_session_t session,
173                                                        const gnutls_datum_t * req_ca_rdn __attribute__((unused)), int nreqs __attribute__((unused)),
174                                                        const gnutls_pk_algorithm_t * pk_algos __attribute__((unused)), int pk_algos_length __attribute__((unused)),
175                                                        gnutls_retr2_st *ret) {
176
177
178        _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
179
180        mgs_handle_t *ctxt;
181
182    if (session == NULL) {
183                // ERROR INVALID SESSION
184                ret->ncerts = 0;
185                ret->deinit_all = 1;
186        return -1;
187        }
188    ctxt = gnutls_transport_get_ptr(session);
189
190    if (gnutls_certificate_type_get(session) == GNUTLS_CRT_X509) {
191                // X509 CERTIFICATE
192                ret->cert_type = GNUTLS_CRT_X509;
193                ret->key_type = GNUTLS_PRIVKEY_X509;
194        ret->ncerts = ctxt->sc->certs_x509_chain_num;
195        ret->deinit_all = 0;
196        ret->cert.x509 = ctxt->sc->certs_x509_chain;
197        ret->key.x509 = ctxt->sc->privkey_x509;
198        return 0;
199    } else if (gnutls_certificate_type_get(session) == GNUTLS_CRT_OPENPGP) {
200                // OPENPGP CERTIFICATE
201                ret->cert_type = GNUTLS_CRT_OPENPGP;
202                ret->key_type = GNUTLS_PRIVKEY_OPENPGP;
203        ret->ncerts = 1;
204        ret->deinit_all = 0;
205        ret->cert.pgp = ctxt->sc->cert_pgp;
206        ret->key.pgp = ctxt->sc->privkey_pgp;
207        return 0;
208    } else {
209                // UNKNOWN CERTIFICATE
210                ret->ncerts = 0;
211                ret->deinit_all = 1;
212            return -1;
213        }
214}
215
216/* 2048-bit group parameters from SRP specification */
217const char static_dh_params[] = "-----BEGIN DH PARAMETERS-----\n"
218        "MIIBBwKCAQCsa9tBMkqam/Fm3l4TiVgvr3K2ZRmH7gf8MZKUPbVgUKNzKcu0oJnt\n"
219        "gZPgdXdnoT3VIxKrSwMxDc1/SKnaBP1Q6Ag5ae23Z7DPYJUXmhY6s2YaBfvV+qro\n"
220        "KRipli8Lk7hV+XmT7Jde6qgNdArb9P90c1nQQdXDPqcdKB5EaxR3O8qXtDoj+4AW\n"
221        "dr0gekNsZIHx0rkHhxdGGludMuaI+HdIVEUjtSSw1X1ep3onddLs+gMs+9v1L7N4\n"
222        "YWAnkATleuavh05zA85TKZzMBBx7wwjYKlaY86jQw4JxrjX46dv7tpS1yAPYn3rk\n"
223        "Nd4jbVJfVHWbZeNy/NaO8g+nER+eSv9zAgEC\n"
224        "-----END DH PARAMETERS-----\n";
225
226/* Read the common name or the alternative name of the certificate.
227 * We only support a single name per certificate.
228 *
229 * Returns negative on error.
230 */
231static int read_crt_cn(server_rec * s, apr_pool_t * p, gnutls_x509_crt_t cert, char **cert_cn) {
232
233    int rv = 0, i;
234    size_t data_len;
235
236
237    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
238    *cert_cn = NULL;
239
240    data_len = 0;
241    rv = gnutls_x509_crt_get_dn_by_oid(cert, GNUTLS_OID_X520_COMMON_NAME, 0, 0, NULL, &data_len);
242
243    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
244        *cert_cn = apr_palloc(p, data_len);
245        rv = gnutls_x509_crt_get_dn_by_oid(cert,
246                GNUTLS_OID_X520_COMMON_NAME,
247                0, 0, *cert_cn,
248                &data_len);
249    } else { /* No CN return subject alternative name */
250        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
251                "No common name found in certificate for '%s:%d'. Looking for subject alternative name...",
252                s->server_hostname, s->port);
253        rv = 0;
254        /* read subject alternative name */
255        for (i = 0; !(rv < 0); i++) {
256            data_len = 0;
257            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
258                    NULL,
259                    &data_len,
260                    NULL);
261
262            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER
263                    && data_len > 1) {
264                /* FIXME: not very efficient. What if we have several alt names
265                 * before DNSName?
266                 */
267                *cert_cn = apr_palloc(p, data_len + 1);
268
269                rv = gnutls_x509_crt_get_subject_alt_name
270                        (cert, i, *cert_cn, &data_len, NULL);
271                (*cert_cn)[data_len] = 0;
272
273                if (rv == GNUTLS_SAN_DNSNAME)
274                    break;
275            }
276        }
277    }
278
279    return rv;
280}
281
282static int read_pgpcrt_cn(server_rec * s, apr_pool_t * p,
283        gnutls_openpgp_crt_t cert, char **cert_cn) {
284    int rv = 0;
285    size_t data_len;
286
287
288    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
289    *cert_cn = NULL;
290
291    data_len = 0;
292    rv = gnutls_openpgp_crt_get_name(cert, 0, NULL, &data_len);
293
294    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
295        *cert_cn = apr_palloc(p, data_len);
296        rv = gnutls_openpgp_crt_get_name(cert, 0, *cert_cn,
297                &data_len);
298    } else { /* No CN return subject alternative name */
299        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
300                "No name found in PGP certificate for '%s:%d'.",
301                s->server_hostname, s->port);
302    }
303
304    return rv;
305}
306
307int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog __attribute__((unused)), apr_pool_t * ptemp __attribute__((unused)), server_rec * base_server) {
308
309    int rv;
310    server_rec *s;
311    gnutls_dh_params_t dh_params = NULL;
312    mgs_srvconf_rec *sc;
313    mgs_srvconf_rec *sc_base;
314    void *data = NULL;
315    const char *userdata_key = "mgs_init";
316
317    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
318
319    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
320    if (data == NULL) {
321        apr_pool_userdata_set((const void *) 1, userdata_key, apr_pool_cleanup_null, base_server->process->pool);
322    }
323
324
325    s = base_server;
326    sc_base = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
327
328    gnutls_dh_params_init(&dh_params);
329
330    if (sc_base->dh_params == NULL) {
331        gnutls_datum_t pdata = {
332            (void *) static_dh_params,
333            sizeof(static_dh_params)
334        };
335        rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata, GNUTLS_X509_FMT_PEM);
336        /* Generate DH Params
337        int dh_bits = gnutls_sec_param_to_pk_bits(GNUTLS_PK_DH,
338                GNUTLS_SEC_PARAM_NORMAL);
339        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
340            "GnuTLS: Generating DH Params of %i bits.  "
341            "To avoid this use GnuTLSDHFile to specify DH Params for this host",
342            dh_bits);
343#if MOD_GNUTLS_DEBUG
344            ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
345                    "GnuTLS: Generated DH Params of %i bits",dh_bits);
346#endif
347        rv = gnutls_dh_params_generate2 (dh_params,dh_bits);
348        */
349        if (rv < 0) {
350            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
351                    "GnuTLS: Unable to generate or load DH Params: (%d) %s",
352                    rv, gnutls_strerror(rv));
353            exit(rv);
354        }
355    } else {
356        dh_params = sc_base->dh_params;
357    }
358
359    rv = mgs_cache_post_config(p, s, sc_base);
360    if (rv != 0) {
361        ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
362                "GnuTLS: Post Config for GnuTLSCache Failed."
363                " Shutting Down.");
364        exit(-1);
365    }
366
367    for (s = base_server; s; s = s->next) {
368        sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config, &gnutls_module);
369        sc->cache_type = sc_base->cache_type;
370        sc->cache_config = sc_base->cache_config;
371        sc->cache_timeout = sc_base->cache_timeout;
372
373        /* defaults for unset values: */
374        if (sc->enabled == GNUTLS_ENABLED_UNSET)
375            sc->enabled = GNUTLS_ENABLED_FALSE;
376        if (sc->tickets == GNUTLS_ENABLED_UNSET)
377            sc->tickets = GNUTLS_ENABLED_TRUE;
378        if (sc->export_certificates_size < 0)
379            sc->export_certificates_size = 0;
380        if (sc->client_verify_mode ==  -1)
381            sc->client_verify_mode = GNUTLS_CERT_IGNORE;
382        if (sc->client_verify_method ==  mgs_cvm_unset)
383            sc->client_verify_method = mgs_cvm_cartel;
384
385
386        /* Check if the priorities have been set */
387        if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
388            ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
389                    "GnuTLS: Host '%s:%d' is missing the GnuTLSPriorities directive!",
390                    s->server_hostname, s->port);
391            exit(-1);
392        }
393
394        /* Check if DH params have been set per host */
395        if (sc->dh_params != NULL) {
396            gnutls_certificate_set_dh_params(sc->certs, sc->dh_params);
397            gnutls_anon_set_server_dh_params(sc->anon_creds, sc->dh_params);
398        } else if (dh_params) {
399            gnutls_certificate_set_dh_params(sc->certs, dh_params);
400            gnutls_anon_set_server_dh_params(sc->anon_creds, dh_params);
401        }
402
403        gnutls_certificate_set_retrieve_function(sc->certs, cert_retrieve_fn);
404
405#ifdef ENABLE_SRP
406        if (sc->srp_tpasswd_conf_file != NULL
407                && sc->srp_tpasswd_file != NULL) {
408            rv = gnutls_srp_set_server_credentials_file
409                    (sc->srp_creds, sc->srp_tpasswd_file,
410                    sc->srp_tpasswd_conf_file);
411
412            if (rv < 0 && sc->enabled == GNUTLS_ENABLED_TRUE) {
413                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0,
414                        s,
415                        "[GnuTLS] - Host '%s:%d' is missing a "
416                        "SRP password or conf File!",
417                        s->server_hostname, s->port);
418                exit(-1);
419            }
420        }
421#endif
422
423        if ((sc->certs_x509_chain == NULL || sc->certs_x509_chain_num < 1) &&
424            sc->cert_pgp == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
425                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
426                                                "[GnuTLS] - Host '%s:%d' is missing a Certificate File!",
427                                                s->server_hostname, s->port);
428            exit(-1);
429        }
430
431        if (sc->enabled == GNUTLS_ENABLED_TRUE &&
432            ((sc->certs_x509_chain != NULL && sc->certs_x509_chain_num > 0 && sc->privkey_x509 == NULL) ||
433             (sc->cert_pgp != NULL && sc->privkey_pgp == NULL))) {
434                        ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
435                                                "[GnuTLS] - Host '%s:%d' is missing a Private Key File!",
436                                                s->server_hostname, s->port);
437            exit(-1);
438        }
439
440        if (sc->enabled == GNUTLS_ENABLED_TRUE) {
441            rv = -1;
442            if (sc->certs_x509_chain_num > 0) {
443                rv = read_crt_cn(s, p, sc->certs_x509_chain[0], &sc->cert_cn);
444            }
445            if (rv < 0 && sc->cert_pgp != NULL) {
446                rv = read_pgpcrt_cn(s, p, sc->cert_pgp, &sc->cert_cn);
447                        }
448
449            if (rv < 0) {
450                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
451                                                        "[GnuTLS] - Cannot find a certificate for host '%s:%d'!",
452                                                        s->server_hostname, s->port);
453                sc->cert_cn = NULL;
454                continue;
455            }
456        }
457    }
458
459
460    ap_add_version_component(p, "mod_gnutls/" MOD_GNUTLS_VERSION);
461
462    {
463        const char* libvers = gnutls_check_version(NULL);
464        char* gnutls_version = NULL;
465        if(libvers && (gnutls_version = apr_psprintf(p, "GnuTLS/%s", libvers))) {
466            ap_add_version_component(p, gnutls_version);
467        } else {
468            // In case we could not create the above string go for the static version instead
469            ap_add_version_component(p, "GnuTLS/" GNUTLS_VERSION "-static");
470        }
471    }
472
473    return OK;
474}
475
476void mgs_hook_child_init(apr_pool_t * p, server_rec * s) {
477    apr_status_t rv = APR_SUCCESS;
478    mgs_srvconf_rec *sc = ap_get_module_config(s->module_config,
479            &gnutls_module);
480
481    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
482    if (sc->cache_type != mgs_cache_none) {
483        rv = mgs_cache_child_init(p, s, sc);
484        if (rv != APR_SUCCESS) {
485            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
486                    "[GnuTLS] - Failed to run Cache Init");
487        }
488    }
489    /* Block SIGPIPE Signals */
490    rv = apr_signal_block(SIGPIPE);
491    if(rv != APR_SUCCESS) {
492        /* error sending output */
493        ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
494                "GnuTLS: Error Blocking SIGPIPE Signal!");
495    }
496}
497
498const char *mgs_hook_http_scheme(const request_rec * r) {
499    mgs_srvconf_rec *sc;
500
501    if (r == NULL)
502        return NULL;
503
504    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
505            server->module_config,
506            &gnutls_module);
507
508    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
509    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
510        return NULL;
511    }
512
513    return "https";
514}
515
516apr_port_t mgs_hook_default_port(const request_rec * r) {
517    mgs_srvconf_rec *sc;
518
519    if (r == NULL)
520        return 0;
521
522    sc = (mgs_srvconf_rec *) ap_get_module_config(r->
523            server->module_config,
524            &gnutls_module);
525
526    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
527    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
528        return 0;
529    }
530
531    return 443;
532}
533
534#define MAX_HOST_LEN 255
535
536#if USING_2_1_RECENT
537
538typedef struct {
539    mgs_handle_t *ctxt;
540    mgs_srvconf_rec *sc;
541    const char *sni_name;
542} vhost_cb_rec;
543
544/**
545 * Matches the current vhost's ServerAlias directives
546 *
547 * @param x vhost callback record
548 * @param s server record
549 * @return true if a match, false otherwise
550 *
551 */
552int check_server_aliases(vhost_cb_rec *x, server_rec * s, mgs_srvconf_rec *tsc) {
553        apr_array_header_t *names;
554        int i,rv = 0;
555        char ** name;
556
557        /* Check ServerName First! */
558        if(apr_strnatcasecmp(x->sni_name, s->server_hostname) == 0) {
559                // We have a match, save this server configuration
560                x->sc = tsc;
561                rv = 1;
562        /* Check any ServerAlias directives */
563        } else if(s->names->nelts) {
564                names = s->names;
565                name = (char **)names->elts;
566                for (i = 0; i < names->nelts; ++i) {
567                        if (!name[i]) { continue; }
568                                if (apr_strnatcasecmp(x->sni_name, name[i]) == 0) {
569                                        // We have a match, save this server configuration
570                                        x->sc = tsc;
571                                        rv = 1;
572                        }
573                }
574        /* Wild any ServerAlias Directives */
575        } else if(s->wild_names->nelts) {
576                names = s->wild_names;
577        name = (char **)names->elts;
578                for (i = 0; i < names->nelts; ++i) {
579                        if (!name[i]) { continue; }
580                                if(apr_fnmatch(name[i], x->sni_name ,
581                                                                APR_FNM_CASE_BLIND|
582                                                                APR_FNM_PERIOD|
583                                                                APR_FNM_PATHNAME|
584                                                                APR_FNM_NOESCAPE) == APR_SUCCESS) {
585                                x->sc = tsc;
586                                rv = 1;
587                        }
588                }
589        }
590        return rv;
591}
592
593static int vhost_cb(void *baton, conn_rec * conn __attribute__((unused)), server_rec * s) {
594    mgs_srvconf_rec *tsc;
595    vhost_cb_rec *x = baton;
596    int ret;
597
598    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
599    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
600            &gnutls_module);
601
602    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
603        return 0;
604    }
605
606    if (tsc->certs_x509_chain_num > 0) {
607        /* why are we doing this check? */
608        ret = gnutls_x509_crt_check_hostname(tsc->certs_x509_chain[0], s->server_hostname);
609        if (0 == ret)
610            ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
611                         "GnuTLS: Error checking certificate for hostname "
612                         "'%s'", s->server_hostname);
613    } else {
614        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
615                     "GnuTLS: SNI request for '%s' but no X.509 certs available at all",
616                     s->server_hostname);
617    }
618        return check_server_aliases(x, s, tsc);
619}
620#endif
621
622mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session) {
623    int rv;
624    unsigned int sni_type;
625    size_t data_len = MAX_HOST_LEN;
626    char sni_name[MAX_HOST_LEN];
627    mgs_handle_t *ctxt;
628#if USING_2_1_RECENT
629    vhost_cb_rec cbx;
630#else
631    server_rec *s;
632    mgs_srvconf_rec *tsc;
633#endif
634
635    if (session == NULL)
636        return NULL;
637
638    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
639    ctxt = gnutls_transport_get_ptr(session);
640
641    rv = gnutls_server_name_get(ctxt->session, sni_name,
642            &data_len, &sni_type, 0);
643
644    if (rv != 0) {
645        return NULL;
646    }
647
648    if (sni_type != GNUTLS_NAME_DNS) {
649        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
650                ctxt->c->base_server,
651                "GnuTLS: Unknown type '%d' for SNI: "
652                "'%s'", sni_type, sni_name);
653        return NULL;
654    }
655
656    /**
657     * Code in the Core already sets up the c->base_server as the base
658     * for this IP/Port combo.  Trust that the core did the 'right' thing.
659     */
660#if USING_2_1_RECENT
661    cbx.ctxt = ctxt;
662    cbx.sc = NULL;
663    cbx.sni_name = sni_name;
664
665    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
666    if (rv == 1) {
667        return cbx.sc;
668    }
669#else
670    for (s = ap_server_conf; s; s = s->next) {
671
672        tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
673                &gnutls_module);
674
675        if (tsc->enabled != GNUTLS_ENABLED_TRUE) { continue; }
676
677                                if(check_server_aliases(x, s, tsc)) {
678                                        return tsc;
679                                }
680#endif
681    return NULL;
682}
683
684static void create_gnutls_handle(conn_rec * c)
685{
686    /* Get mod_gnutls server configuration */
687    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
688            ap_get_module_config(c->base_server->module_config, &gnutls_module);
689
690    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
691
692    /* Get connection specific configuration */
693    mgs_handle_t *ctxt = (mgs_handle_t *) ap_get_module_config(c->conn_config, &gnutls_module);
694    if (ctxt == NULL)
695    {
696        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, c, "%s: allocating connection memory", __func__);
697        ctxt = apr_pcalloc(c->pool, sizeof (*ctxt));
698        ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
699    }
700    ctxt->enabled = GNUTLS_ENABLED_TRUE;
701    ctxt->c = c;
702    ctxt->sc = sc;
703    ctxt->status = 0;
704    ctxt->input_rc = APR_SUCCESS;
705    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
706    ctxt->input_cbuf.length = 0;
707    ctxt->output_rc = APR_SUCCESS;
708    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
709    ctxt->output_blen = 0;
710    ctxt->output_length = 0;
711
712    /* Initialize GnuTLS Library */
713    int err = gnutls_init(&ctxt->session, GNUTLS_SERVER);
714    if (err != GNUTLS_E_SUCCESS)
715        ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c, "gnutls_init failed!");
716    /* Initialize Session Tickets */
717    if (session_ticket_key.data != NULL && ctxt->sc->tickets != 0) {
718        err = gnutls_session_ticket_enable_server(ctxt->session, &session_ticket_key);
719        if (err != GNUTLS_E_SUCCESS)
720            ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c, "gnutls_session_ticket_enable_server failed!");
721    }
722
723    /* Set Default Priority */
724        err = gnutls_priority_set_direct(ctxt->session, "NORMAL", NULL);
725    if (err != GNUTLS_E_SUCCESS)
726        ap_log_cerror(APLOG_MARK, APLOG_ERR, err, c, "gnutls_priority_set_direct failed!");
727    /* Set Handshake function */
728    gnutls_handshake_set_post_client_hello_function(ctxt->session,
729            mgs_select_virtual_server_cb);
730    /* Initialize Session Cache */
731    mgs_cache_session_init(ctxt);
732
733    /* Set pull, push & ptr functions */
734    gnutls_transport_set_pull_function(ctxt->session,
735            mgs_transport_read);
736    gnutls_transport_set_push_function(ctxt->session,
737            mgs_transport_write);
738    gnutls_transport_set_ptr(ctxt->session, ctxt);
739    /* Add IO filters */
740    ctxt->input_filter = ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME,
741            ctxt, NULL, c);
742    ctxt->output_filter = ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME,
743            ctxt, NULL, c);
744}
745
746int mgs_hook_pre_connection(conn_rec * c, void *csd __attribute__((unused)))
747{
748    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
749
750    mgs_srvconf_rec *sc = (mgs_srvconf_rec *)
751        ap_get_module_config(c->base_server->module_config, &gnutls_module);
752    mgs_handle_t *ctxt = (mgs_handle_t *)
753        ap_get_module_config(c->conn_config, &gnutls_module);
754
755    if ((sc && (!sc->enabled)) || (ctxt && ctxt->enabled == GNUTLS_ENABLED_FALSE))
756    {
757        ap_log_cerror(APLOG_MARK, APLOG_DEBUG, 0, c, "%s declined connection",
758                      __func__);
759        return DECLINED;
760    }
761
762    create_gnutls_handle(c);
763    return OK;
764}
765
766int mgs_hook_fixups(request_rec * r) {
767    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
768    char buf[AP_IOBUFSIZE];
769    const char *tmp;
770    size_t len;
771    mgs_handle_t *ctxt;
772    int rv = OK;
773
774    if (r == NULL)
775        return DECLINED;
776
777    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
778    apr_table_t *env = r->subprocess_env;
779
780    ctxt = ap_get_module_config(r->connection->conn_config,
781                                &gnutls_module);
782
783    if (!ctxt || ctxt->enabled != GNUTLS_ENABLED_TRUE || ctxt->session == NULL)
784    {
785        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "request declined in %s", __func__);
786        return DECLINED;
787    }
788
789    apr_table_setn(env, "HTTPS", "on");
790
791    apr_table_setn(env, "SSL_VERSION_LIBRARY",
792            "GnuTLS/" LIBGNUTLS_VERSION);
793    apr_table_setn(env, "SSL_VERSION_INTERFACE",
794            "mod_gnutls/" MOD_GNUTLS_VERSION);
795
796    apr_table_setn(env, "SSL_PROTOCOL",
797            gnutls_protocol_get_name(gnutls_protocol_get_version(ctxt->session)));
798
799    /* should have been called SSL_CIPHERSUITE instead */
800    apr_table_setn(env, "SSL_CIPHER",
801            gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
802                                         gnutls_cipher_get(ctxt->session),
803                                         gnutls_mac_get(ctxt->session)));
804
805    apr_table_setn(env, "SSL_COMPRESS_METHOD",
806            gnutls_compression_get_name(gnutls_compression_get(ctxt->session)));
807
808#ifdef ENABLE_SRP
809    if (ctxt->sc->srp_tpasswd_conf_file != NULL && ctxt->sc->srp_tpasswd_file != NULL) {
810        tmp = gnutls_srp_server_get_username(ctxt->session);
811        apr_table_setn(env, "SSL_SRP_USER", (tmp != NULL) ? tmp : "");
812    } else {
813        apr_table_unset(env, "SSL_SRP_USER");
814    }
815#endif
816
817    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
818        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
819
820    unsigned int key_size = 8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
821    tmp = apr_psprintf(r->pool, "%u", key_size);
822
823    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
824
825    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
826
827    apr_table_setn(env, "SSL_CIPHER_EXPORT",
828            (key_size <= 40) ? "true" : "false");
829
830    int dhsize = gnutls_dh_get_prime_bits(ctxt->session);
831    if (dhsize > 0) {
832        tmp = apr_psprintf(r->pool, "%d", dhsize);
833        apr_table_setn(env, "SSL_DH_PRIME_BITS", tmp);
834    }
835
836    len = sizeof (sbuf);
837    gnutls_session_get_id(ctxt->session, sbuf, &len);
838    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
839    apr_table_setn(env, "SSL_SESSION_ID", apr_pstrdup(r->pool, tmp));
840
841    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
842                mgs_add_common_cert_vars(r, ctxt->sc->certs_x509_chain[0], 0, ctxt->sc->export_certificates_size);
843        } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
844        mgs_add_common_pgpcert_vars(r, ctxt->sc->cert_pgp, 0, ctxt->sc->export_certificates_size);
845        }
846
847    return rv;
848}
849
850int mgs_hook_authz(request_rec * r) {
851    int rv;
852    mgs_handle_t *ctxt;
853    mgs_dirconf_rec *dc;
854
855    if (r == NULL)
856        return DECLINED;
857
858    dc = ap_get_module_config(r->per_dir_config, &gnutls_module);
859
860    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
861    ctxt =
862            ap_get_module_config(r->connection->conn_config,
863            &gnutls_module);
864
865    if (!ctxt || ctxt->session == NULL) {
866        return DECLINED;
867    }
868
869    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
870        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
871                "GnuTLS: Directory set to Ignore Client Certificate!");
872    } else {
873        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
874            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
875                    "GnuTLS: Attempting to rehandshake with peer. %d %d",
876                    ctxt->sc->client_verify_mode,
877                    dc->client_verify_mode);
878
879            /* If we already have a client certificate, there's no point in
880             * re-handshaking... */
881            rv = mgs_cert_verify(r, ctxt);
882            if (rv != DECLINED && rv != HTTP_FORBIDDEN)
883                return rv;
884
885            gnutls_certificate_server_set_request
886                    (ctxt->session, dc->client_verify_mode);
887
888            if (mgs_rehandshake(ctxt) != 0) {
889                return HTTP_FORBIDDEN;
890            }
891        } else if (ctxt->sc->client_verify_mode ==
892                GNUTLS_CERT_IGNORE) {
893#if MOD_GNUTLS_DEBUG
894            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
895                    "GnuTLS: Peer is set to IGNORE");
896#endif
897            return DECLINED;
898        }
899        rv = mgs_cert_verify(r, ctxt);
900        if (rv != DECLINED &&
901                (rv != HTTP_FORBIDDEN ||
902                dc->client_verify_mode == GNUTLS_CERT_REQUIRE)) {
903            return rv;
904        }
905    }
906
907    return DECLINED;
908}
909
910/* variables that are not sent by default:
911 *
912 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
913 * SSL_SERVER_CERT      string  PEM-encoded client certificate
914 */
915
916/* @param side is either 0 for SERVER or 1 for CLIENT
917 *
918 * @param export_cert_size (int) maximum size for environment variable
919 * to use for the PEM-encoded certificate (0 means do not export)
920 */
921#define MGS_SIDE(suffix) ((side==0) ? "SSL_SERVER" suffix : "SSL_CLIENT" suffix)
922
923static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side, size_t export_cert_size) {
924    unsigned char sbuf[64]; /* buffer to hold serials */
925    char buf[AP_IOBUFSIZE];
926    const char *tmp;
927    char *tmp2;
928    size_t len;
929    int ret, i;
930
931    if (r == NULL)
932        return;
933
934    apr_table_t *env = r->subprocess_env;
935
936    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
937    if (export_cert_size > 0) {
938        len = 0;
939        ret = gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, NULL, &len);
940        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
941            if (len >= export_cert_size) {
942                apr_table_setn(env, MGS_SIDE("_CERT"), "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
943                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
944                              "GnuTLS: Failed to export too-large X.509 certificate to environment");
945            } else {
946                char* cert_buf = apr_palloc(r->pool, len + 1);
947                if (cert_buf != NULL && gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0) {
948                    cert_buf[len] = 0;
949                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
950                } else {
951                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
952                                  "GnuTLS: failed to export X.509 certificate");
953                }
954            }
955        } else {
956            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
957                          "GnuTLS: dazed and confused about X.509 certificate size");
958        }
959    }
960
961    len = sizeof (buf);
962    gnutls_x509_crt_get_dn(cert, buf, &len);
963    apr_table_setn(env, MGS_SIDE("_S_DN"), apr_pstrmemdup(r->pool, buf, len));
964
965    len = sizeof (buf);
966    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
967    apr_table_setn(env, MGS_SIDE("_I_DN"), apr_pstrmemdup(r->pool, buf, len));
968
969    len = sizeof (sbuf);
970    gnutls_x509_crt_get_serial(cert, sbuf, &len);
971    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
972    apr_table_setn(env, MGS_SIDE("_M_SERIAL"), apr_pstrdup(r->pool, tmp));
973
974    ret = gnutls_x509_crt_get_version(cert);
975    if (ret > 0)
976        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
977                       apr_psprintf(r->pool, "%u", ret));
978
979    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "X.509");
980
981    tmp =
982            mgs_time2sz(gnutls_x509_crt_get_expiration_time
983            (cert), buf, sizeof (buf));
984    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
985
986    tmp =
987            mgs_time2sz(gnutls_x509_crt_get_activation_time
988            (cert), buf, sizeof (buf));
989    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
990
991    ret = gnutls_x509_crt_get_signature_algorithm(cert);
992    if (ret >= 0) {
993        apr_table_setn(env, MGS_SIDE("_A_SIG"),
994                gnutls_sign_algorithm_get_name(ret));
995    }
996
997    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
998    if (ret >= 0) {
999        apr_table_setn(env, MGS_SIDE("_A_KEY"),
1000                gnutls_pk_algorithm_get_name(ret));
1001    }
1002
1003    /* export all the alternative names (DNS, RFC822 and URI) */
1004    for (i = 0; !(ret < 0); i++) {
1005        const char *san, *sanlabel;
1006        len = 0;
1007        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
1008                NULL, &len,
1009                NULL);
1010
1011        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
1012            tmp2 = apr_palloc(r->pool, len + 1);
1013
1014            ret =
1015                    gnutls_x509_crt_get_subject_alt_name(cert, i,
1016                    tmp2,
1017                    &len,
1018                    NULL);
1019            tmp2[len] = 0;
1020
1021            sanlabel = apr_psprintf(r->pool, "%s%u", MGS_SIDE("_S_AN"), i);
1022            if (ret == GNUTLS_SAN_DNSNAME) {
1023                san = apr_psprintf(r->pool, "DNSNAME:%s", tmp2);
1024            } else if (ret == GNUTLS_SAN_RFC822NAME) {
1025                san = apr_psprintf(r->pool, "RFC822NAME:%s", tmp2);
1026            } else if (ret == GNUTLS_SAN_URI) {
1027                san = apr_psprintf(r->pool, "URI:%s", tmp2);
1028            } else {
1029                san = "UNSUPPORTED";
1030            }
1031            apr_table_setn(env, sanlabel, san);
1032        }
1033    }
1034}
1035
1036
1037/* @param side 0: server, 1: client
1038 *
1039 * @param export_cert_size (int) maximum size for environment variable
1040 * to use for the PEM-encoded certificate (0 means do not export)
1041 */
1042static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side, size_t export_cert_size) {
1043
1044        unsigned char sbuf[64]; /* buffer to hold serials */
1045    char buf[AP_IOBUFSIZE];
1046    const char *tmp;
1047    size_t len;
1048    int ret;
1049
1050    if (r == NULL)
1051        return;
1052
1053    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1054    apr_table_t *env = r->subprocess_env;
1055
1056    if (export_cert_size > 0) {
1057        len = 0;
1058        ret = gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, NULL, &len);
1059        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER) {
1060            if (len >= export_cert_size) {
1061                apr_table_setn(env, MGS_SIDE("_CERT"),
1062                               "GNUTLS_CERTIFICATE_SIZE_LIMIT_EXCEEDED");
1063                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1064                              "GnuTLS: Failed to export too-large OpenPGP certificate to environment");
1065            } else {
1066                char* cert_buf = apr_palloc(r->pool, len + 1);
1067                if (cert_buf != NULL && gnutls_openpgp_crt_export(cert, GNUTLS_OPENPGP_FMT_BASE64, cert_buf, &len) >= 0) {
1068                    cert_buf[len] = 0;
1069                    apr_table_setn(env, MGS_SIDE("_CERT"), cert_buf);
1070                } else {
1071                    ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1072                                  "GnuTLS: failed to export OpenPGP certificate");
1073                }
1074            }
1075        } else {
1076            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1077                          "GnuTLS: dazed and confused about OpenPGP certificate size");
1078        }
1079    }
1080
1081    len = sizeof (buf);
1082    gnutls_openpgp_crt_get_name(cert, 0, buf, &len);
1083    apr_table_setn(env, MGS_SIDE("_NAME"), apr_pstrmemdup(r->pool, buf, len));
1084
1085    len = sizeof (sbuf);
1086    gnutls_openpgp_crt_get_fingerprint(cert, sbuf, &len);
1087    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof (buf));
1088    apr_table_setn(env, MGS_SIDE("_FINGERPRINT"), apr_pstrdup(r->pool, tmp));
1089
1090    ret = gnutls_openpgp_crt_get_version(cert);
1091    if (ret > 0)
1092        apr_table_setn(env, MGS_SIDE("_M_VERSION"),
1093                       apr_psprintf(r->pool, "%u", ret));
1094
1095    apr_table_setn(env, MGS_SIDE("_CERT_TYPE"), "OPENPGP");
1096
1097    tmp =
1098            mgs_time2sz(gnutls_openpgp_crt_get_expiration_time
1099            (cert), buf, sizeof (buf));
1100    apr_table_setn(env, MGS_SIDE("_V_END"), apr_pstrdup(r->pool, tmp));
1101
1102    tmp =
1103            mgs_time2sz(gnutls_openpgp_crt_get_creation_time
1104            (cert), buf, sizeof (buf));
1105    apr_table_setn(env, MGS_SIDE("_V_START"), apr_pstrdup(r->pool, tmp));
1106
1107    ret = gnutls_openpgp_crt_get_pk_algorithm(cert, NULL);
1108    if (ret >= 0) {
1109        apr_table_setn(env, MGS_SIDE("_A_KEY"), gnutls_pk_algorithm_get_name(ret));
1110    }
1111
1112}
1113
1114/* TODO: Allow client sending a X.509 certificate chain */
1115static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt) {
1116    const gnutls_datum_t *cert_list;
1117    unsigned int cert_list_size, status;
1118    int rv = GNUTLS_E_NO_CERTIFICATE_FOUND, ret;
1119    unsigned int ch_size = 0;
1120
1121    union {
1122        gnutls_x509_crt_t x509[MAX_CHAIN_SIZE];
1123        gnutls_openpgp_crt_t pgp;
1124    } cert;
1125    apr_time_t expiration_time, cur_time;
1126
1127    if (r == NULL || ctxt == NULL || ctxt->session == NULL)
1128        return HTTP_FORBIDDEN;
1129
1130    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1131    cert_list =
1132            gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
1133
1134    if (cert_list == NULL || cert_list_size == 0) {
1135        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
1136         */
1137        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1138            return OK;
1139
1140        /* no certificate provided by the client, but one was required. */
1141        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1142                "GnuTLS: Failed to Verify Peer: "
1143                "Client did not submit a certificate");
1144        return HTTP_FORBIDDEN;
1145    }
1146
1147    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1148        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1149                "GnuTLS: A Chain of %d certificate(s) was provided for validation",
1150                cert_list_size);
1151
1152        for (ch_size = 0; ch_size < cert_list_size; ch_size++) {
1153            gnutls_x509_crt_init(&cert.x509[ch_size]);
1154            rv = gnutls_x509_crt_import(cert.x509[ch_size],
1155                    &cert_list[ch_size],
1156                    GNUTLS_X509_FMT_DER);
1157            // When failure to import, leave the loop
1158            if (rv != GNUTLS_E_SUCCESS) {
1159                if (ch_size < 1) {
1160                    ap_log_rerror(APLOG_MARK,
1161                            APLOG_INFO, 0, r,
1162                            "GnuTLS: Failed to Verify Peer: "
1163                            "Failed to import peer certificates.");
1164                    ret = HTTP_FORBIDDEN;
1165                    goto exit;
1166                }
1167                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1168                        "GnuTLS: Failed to import some peer certificates. Using %d certificates",
1169                        ch_size);
1170                rv = GNUTLS_E_SUCCESS;
1171                break;
1172            }
1173        }
1174    } else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP) {
1175        if (cert_list_size > 1) {
1176            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1177                    "GnuTLS: Failed to Verify Peer: "
1178                    "Chained Client Certificates are not supported.");
1179            return HTTP_FORBIDDEN;
1180        }
1181
1182        gnutls_openpgp_crt_init(&cert.pgp);
1183        rv = gnutls_openpgp_crt_import(cert.pgp, &cert_list[0],
1184                GNUTLS_OPENPGP_FMT_RAW);
1185
1186    } else
1187        return HTTP_FORBIDDEN;
1188
1189    if (rv < 0) {
1190        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1191                "GnuTLS: Failed to Verify Peer: "
1192                "Failed to import peer certificates.");
1193        ret = HTTP_FORBIDDEN;
1194        goto exit;
1195    }
1196
1197    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1198        apr_time_ansi_put(&expiration_time,
1199                gnutls_x509_crt_get_expiration_time
1200                (cert.x509[0]));
1201
1202        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1203                      "GnuTLS: Verifying list of %d certificate(s) via method '%s'",
1204                      ch_size, mgs_readable_cvm(ctxt->sc->client_verify_method));
1205        switch(ctxt->sc->client_verify_method) {
1206        case mgs_cvm_cartel:
1207            rv = gnutls_x509_crt_list_verify(cert.x509, ch_size,
1208                                             ctxt->sc->ca_list,
1209                                             ctxt->sc->ca_list_size,
1210                                             NULL, 0, 0, &status);
1211            break;
1212#ifdef ENABLE_MSVA
1213        case mgs_cvm_msva:
1214        {
1215            struct msv_response* resp = NULL;
1216            struct msv_query q = { .context="https", .peertype="client", .pkctype="x509pem" };
1217            msv_ctxt_t ctx = msv_ctxt_init(NULL);
1218            char cert_pem_buf[10 * 1024];
1219            size_t len = sizeof (cert_pem_buf);
1220
1221            rv = 0;
1222            if (gnutls_x509_crt_export(cert.x509[0], GNUTLS_X509_FMT_PEM, cert_pem_buf, &len) >= 0) {
1223                /* FIXME : put together a name from the cert we received, instead of hard-coding this value: */
1224                q.peername = mgs_x509_construct_uid(r, cert.x509[0]);
1225                q.pkcdata = cert_pem_buf;
1226                rv = msv_query_agent(ctx, q, &resp);
1227                if (rv == LIBMSV_ERROR_SUCCESS) {
1228                    status = 0;
1229                } else if (rv == LIBMSV_ERROR_INVALID) {
1230                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1231                                  "GnuTLS: Monkeysphere validation failed: (message: %s)", resp->message);
1232                    status = GNUTLS_CERT_INVALID;
1233                } else {
1234                    ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1235                                  "GnuTLS: Error communicating with the Monkeysphere Validation Agent: (%d) %s", rv, msv_strerror(ctx, rv));
1236                    status = GNUTLS_CERT_INVALID;
1237                    rv = -1;
1238                }
1239            } else {
1240                ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1241                              "GnuTLS: Could not convert the client certificate to PEM format");
1242                status = GNUTLS_CERT_INVALID;
1243                rv = GNUTLS_E_ASN1_ELEMENT_NOT_FOUND;
1244            }
1245            msv_response_destroy(resp);
1246            msv_ctxt_destroy(ctx);
1247        }
1248            break;
1249#endif
1250        default:
1251            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1252                          "GnuTLS: Failed to Verify X.509 Peer: method '%s' is not supported",
1253                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1254        }
1255
1256    } else {
1257        apr_time_ansi_put(&expiration_time,
1258                gnutls_openpgp_crt_get_expiration_time
1259                (cert.pgp));
1260
1261        switch(ctxt->sc->client_verify_method) {
1262        case mgs_cvm_cartel:
1263            rv = gnutls_openpgp_crt_verify_ring(cert.pgp,
1264                                                ctxt->sc->pgp_list, 0,
1265                                                &status);
1266            break;
1267#ifdef ENABLE_MSVA
1268        case mgs_cvm_msva:
1269            /* need to set status and rv */
1270            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1271                          "GnuTLS:  OpenPGP verification via MSVA is not yet implemented");
1272            rv = GNUTLS_E_UNIMPLEMENTED_FEATURE;
1273            break;
1274#endif
1275        default:
1276            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1277                          "GnuTLS: Failed to Verify OpenPGP Peer: method '%s' is not supported",
1278                          mgs_readable_cvm(ctxt->sc->client_verify_method));
1279        }
1280    }
1281
1282    if (rv < 0) {
1283        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1284                "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1285                rv, gnutls_strerror(rv));
1286        if (rv == GNUTLS_E_NO_CERTIFICATE_FOUND)
1287            ap_log_rerror(APLOG_MARK, APLOG_EMERG, 0, r,
1288                "GnuTLS: No certificate was found for verification. Did you set the GnuTLSX509CAFile or GnuTLSPGPKeyringFile directives?");
1289        ret = HTTP_FORBIDDEN;
1290        goto exit;
1291    }
1292
1293    /* TODO: X509 CRL Verification. */
1294    /* May add later if anyone needs it.
1295     */
1296    /* ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size); */
1297
1298    cur_time = apr_time_now();
1299
1300    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1301        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1302                "GnuTLS: Could not find Signer for Peer Certificate");
1303    }
1304
1305    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1306        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1307                "GnuTLS: Peer's Certificate signer is not a CA");
1308    }
1309
1310    if (status & GNUTLS_CERT_INSECURE_ALGORITHM) {
1311        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1312                "GnuTLS: Peer's Certificate is using insecure algorithms");
1313    }
1314
1315    if (status & GNUTLS_CERT_EXPIRED
1316            || status & GNUTLS_CERT_NOT_ACTIVATED) {
1317        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1318                "GnuTLS: Peer's Certificate signer is expired or not yet activated");
1319    }
1320
1321    if (status & GNUTLS_CERT_INVALID) {
1322        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1323                "GnuTLS: Peer Certificate is invalid.");
1324    } else if (status & GNUTLS_CERT_REVOKED) {
1325        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1326                "GnuTLS: Peer Certificate is revoked.");
1327    }
1328
1329    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509)
1330        mgs_add_common_cert_vars(r, cert.x509[0], 1, ctxt->sc->export_certificates_size);
1331    else if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_OPENPGP)
1332        mgs_add_common_pgpcert_vars(r, cert.pgp, 1, ctxt->sc->export_certificates_size);
1333
1334    {
1335        /* days remaining */
1336        unsigned long remain =
1337                (apr_time_sec(expiration_time) -
1338                apr_time_sec(cur_time)) / 86400;
1339        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1340                apr_psprintf(r->pool, "%lu", remain));
1341    }
1342
1343    if (status == 0) {
1344        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1345                "SUCCESS");
1346        ret = OK;
1347    } else {
1348        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY",
1349                "FAILED");
1350        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1351            ret = OK;
1352        else
1353            ret = HTTP_FORBIDDEN;
1354    }
1355
1356exit:
1357    if (gnutls_certificate_type_get(ctxt->session) == GNUTLS_CRT_X509) {
1358        unsigned int i;
1359        for (i = 0; i < ch_size; i++) {
1360            gnutls_x509_crt_deinit(cert.x509[i]);
1361        }
1362    } else if (gnutls_certificate_type_get(ctxt->session) ==
1363            GNUTLS_CRT_OPENPGP)
1364        gnutls_openpgp_crt_deinit(cert.pgp);
1365    return ret;
1366
1367
1368}
1369
1370#ifdef ENABLE_MSVA
1371/* this section of code is used only when trying to talk to the MSVA */
1372static const char* mgs_x509_leaf_oid_from_dn(apr_pool_t *pool, const char* oid, gnutls_x509_crt_t cert) {
1373    int rv=GNUTLS_E_SUCCESS, i;
1374    size_t sz=0, lastsz=0;
1375    char* data=NULL;
1376
1377    i = -1;
1378    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1379        i++;
1380        lastsz=sz;
1381        sz=0;
1382        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i, 0, NULL, &sz);
1383    }
1384    if (i > 0) {
1385        data = apr_palloc(pool, lastsz);
1386        sz=lastsz;
1387        rv = gnutls_x509_crt_get_dn_by_oid (cert, oid, i-1, 0, data, &sz);
1388        if (rv == GNUTLS_E_SUCCESS)
1389            return data;
1390    }
1391    return NULL;
1392}
1393
1394static const char* mgs_x509_first_type_from_san(apr_pool_t *pool, gnutls_x509_subject_alt_name_t target, gnutls_x509_crt_t cert) {
1395    int rv=GNUTLS_E_SUCCESS;
1396    size_t sz;
1397    char* data=NULL;
1398    unsigned int i;
1399    gnutls_x509_subject_alt_name_t thistype;
1400
1401    i = 0;
1402    while(rv != GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) {
1403        sz = 0;
1404        rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, NULL, &sz, &thistype, NULL);
1405        if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && thistype == target) {
1406            data = apr_palloc(pool, sz);
1407            rv = gnutls_x509_crt_get_subject_alt_name2(cert, i, data, &sz, &thistype, NULL);
1408            if (rv >=0 && (thistype == target))
1409                return data;
1410        }
1411        i++;
1412    }
1413    return NULL;
1414}
1415
1416
1417/* Create a string representing a candidate User ID from an X.509
1418 * certificate
1419
1420 * We need this for client certification because a client gives us a
1421 * certificate, but doesn't tell us (in any other way) who they are
1422 * trying to authenticate as.
1423
1424 * TODO: we might need another parallel for OpenPGP, but for that it's
1425 * much simpler: we can just assume that the first User ID marked as
1426 * "primary" (or the first User ID, period) is the identity the user
1427 * is trying to present as.
1428
1429 * one complaint might be "but the user wanted to be another identity,
1430 * which is also in the certificate (e.g. in a SubjectAltName)"
1431 * However, given that any user can regenerate their own X.509
1432 * certificate with their own public key content, they should just do
1433 * so, and not expect us to guess at their identity :)
1434
1435 * This function allocates it's response from the pool given it.  When
1436 * that pool is reclaimed, the response will also be deallocated.
1437
1438 * FIXME: what about extracting a server-style cert
1439 *        (e.g. https://imposter.example) from the DN or any sAN?
1440
1441 * FIXME: what if we want to call this outside the context of a
1442 *        request?  That complicates the logging.
1443 */
1444static const char* mgs_x509_construct_uid(request_rec *r, gnutls_x509_crt_t cert) {
1445    /* basic strategy, assuming humans are the users: we are going to
1446     * try to reconstruct a "conventional" User ID by pulling in a
1447     * name, comment, and e-mail address.
1448     */
1449    apr_pool_t *pool = r->pool;
1450    const char *name=NULL, *comment=NULL, *email=NULL;
1451    const char *ret=NULL;
1452    /* subpool for temporary allocation: */
1453    apr_pool_t *sp=NULL;
1454
1455    if (APR_SUCCESS != apr_pool_create(&sp, pool))
1456        return NULL; /* i'm assuming that libapr would log this kind
1457                      * of error on its own */
1458
1459     /* Name
1460
1461     the name comes from the leaf commonName of the cert's Subject.
1462
1463     (MAYBE: should we look at trying to assemble a candidate from
1464             givenName, surName, suffix, etc?  the "name" field
1465             appears to be case-insensitive, which seems problematic
1466             from what we expect; see:
1467             http://www.itu.int/rec/T-REC-X.520-200102-s/e )
1468
1469     (MAYBE: should we try pulling a commonName or otherName or
1470             something from subjectAltName? see:
1471             https://tools.ietf.org/html/rfc5280#section-4.2.1.6
1472             GnuTLS does not support looking for Common Names in the
1473             SAN yet)
1474     */
1475    name = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_COMMON_NAME, cert);
1476
1477    /* Comment
1478
1479       I am inclined to punt on this for now, as Comment has been so
1480       atrociously misused in OpenPGP.  Perhaps if there is a
1481       pseudonym (OID 2.5.4.65, aka GNUTLS_OID_X520_PSEUDONYM) field
1482       in the subject or sAN?
1483    */
1484    comment = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_X520_PSEUDONYM, cert);
1485
1486    /* E-mail
1487
1488       This should be the the first rfc822Name from the sAN.
1489
1490       failing that, we'll take the leaf email in the certificate's
1491       subject; this is a deprecated use though.
1492     */
1493    email = mgs_x509_first_type_from_san(sp, GNUTLS_SAN_RFC822NAME, cert);
1494    if (email == NULL)
1495        email = mgs_x509_leaf_oid_from_dn(sp, GNUTLS_OID_PKCS9_EMAIL, cert);
1496
1497    /* assemble all the parts: */
1498
1499    /* must have at least a name or an e-mail. */
1500    if (name == NULL && email == NULL) {
1501        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1502                "GnuTLS: Need either a name or an e-mail address to get a User ID from an X.509 certificate.");
1503        goto end;
1504    }
1505    if (name) {
1506        if (comment) {
1507            if (email) {
1508                ret = apr_psprintf(pool, "%s (%s) <%s>", name, comment, email);
1509            } else {
1510                ret = apr_psprintf(pool, "%s (%s)", name, comment);
1511            }
1512        } else {
1513            if (email) {
1514                ret = apr_psprintf(pool, "%s <%s>", name, email);
1515            } else {
1516                ret = apr_pstrdup(pool, name);
1517            }
1518        }
1519    } else {
1520        if (comment) {
1521            ret = apr_psprintf(pool, "(%s) <%s>", comment, email);
1522        } else {
1523            ret = apr_psprintf(pool, "<%s>", email);
1524        }
1525    }
1526
1527end:
1528    apr_pool_destroy(sp);
1529    return ret;
1530}
1531#endif /* ENABLE_MSVA */
1532
1533static int mgs_status_hook(request_rec *r, int flags __attribute__((unused)))
1534{
1535    mgs_srvconf_rec *sc;
1536
1537    if (r == NULL)
1538        return OK;
1539
1540    sc = (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config, &gnutls_module);
1541
1542    _gnutls_log(debug_log_fp, "%s: %d\n", __func__, __LINE__);
1543
1544    ap_rputs("<hr>\n", r);
1545    ap_rputs("<h2>GnuTLS Information:</h2>\n<dl>\n", r);
1546
1547    ap_rprintf(r, "<dt>GnuTLS version:</dt><dd>%s</dd>\n", gnutls_check_version(NULL));
1548    ap_rputs("<dt>Built against:</dt><dd>" GNUTLS_VERSION "</dd>\n", r);
1549    ap_rprintf(r, "<dt>using TLS:</dt><dd>%s</dd>\n", (sc->enabled == GNUTLS_ENABLED_FALSE ? "no" : "yes"));
1550    if (sc->enabled != GNUTLS_ENABLED_FALSE) {
1551        mgs_handle_t* ctxt;
1552        ctxt = ap_get_module_config(r->connection->conn_config, &gnutls_module);
1553        if (ctxt && ctxt->session != NULL) {
1554#if GNUTLS_VERSION_MAJOR < 3
1555            ap_rprintf(r, "<dt>This TLS Session:</dt><dd>%s</dd>\n",
1556                gnutls_cipher_suite_get_name(gnutls_kx_get(ctxt->session),
1557                gnutls_cipher_get(ctxt->session),
1558                gnutls_mac_get(ctxt->session)));
1559#else
1560            char* z = NULL;
1561            z = gnutls_session_get_desc(ctxt->session);
1562            if (z) {
1563                ap_rprintf(r, "<dt>This TLS Session:</dt><dd>%s</dd>\n", z);
1564                gnutls_free(z);
1565            }
1566#endif
1567        }
1568    }
1569
1570    ap_rputs("</dl>\n", r);
1571    return OK;
1572}
1573
Note: See TracBrowser for help on using the repository browser.