source: mod_gnutls/src/gnutls_hooks.c @ d04f7da

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

Version guards for gnutls_privkey_import_openpgp_raw workaround

The invalid free bug in gnutls_privkey_import_openpgp_raw should be
fixed in GnuTLS 3.3.12 [1], so add appropriate version guards and use
the workaround only with older versions.

[1] https://github.com/nmav/mod_gnutls/commit/031acac9c6541034777f8917633164b51f6bd10a#commitcomment-10581365

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