source: mod_gnutls/src/gnutls_hooks.c @ b55bf71

asynciodebian/masterdebian/stretch-backportsjessie-backportsproxy-ticketupstream
Last change on this file since b55bf71 was b55bf71, checked in by Daniel Kahn Gillmor <dkg@…>, 7 years ago

accept the e-mail address in the cert Subject if no sAN e-mail is present

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