source: mod_gnutls/src/gnutls_hooks.c @ 671b64f

debian/masterdebian/stretch-backportsjessie-backportsupstream
Last change on this file since 671b64f was 671b64f, checked in by Daniel Kahn Gillmor <dkg@…>, 6 years ago

remove all trailing whitespace

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