source: mod_gnutls/src/gnutls_hooks.c @ e5bbda4

debian/masterdebian/stretch-backportsjessie-backportsmsvaupstream
Last change on this file since e5bbda4 was e5bbda4, checked in by Nokis Mavrogiannopoulos <nmav@…>, 12 years ago

Initial support for openpgp keys

  • Property mode set to 100644
File size: 32.3 KB
Line 
1/**
2 *  Copyright 2004-2005 Paul Querna
3 *  Copyright 2007 Nikos Mavrogiannopoulos
4 *
5 *  Licensed under the Apache License, Version 2.0 (the "License");
6 *  you may not use this file except in compliance with the License.
7 *  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 *
17 */
18
19#include "mod_gnutls.h"
20#include "http_vhost.h"
21#include "ap_mpm.h"
22
23#if !USING_2_1_RECENT
24extern server_rec *ap_server_conf;
25#endif
26
27#if APR_HAS_THREADS
28GCRY_THREAD_OPTION_PTHREAD_IMPL;
29#endif
30
31#if MOD_GNUTLS_DEBUG
32static apr_file_t *debug_log_fp;
33#endif
34
35static int mpm_is_threaded;
36
37static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt);
38/* use side==0 for server and side==1 for client */
39static void mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert,
40                                     int side,
41                                     int export_certificates_enabled);
42static void mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert,
43                                     int side,
44                                     int export_certificates_enabled);
45
46static apr_status_t mgs_cleanup_pre_config(void *data)
47{
48    gnutls_global_deinit();
49    return APR_SUCCESS;
50}
51
52#if MOD_GNUTLS_DEBUG
53static void gnutls_debug_log_all(int level, const char *str)
54{
55    apr_file_printf(debug_log_fp, "<%d> %s\n", level, str);
56}
57#endif
58
59int
60mgs_hook_pre_config(apr_pool_t * pconf,
61                    apr_pool_t * plog, apr_pool_t * ptemp)
62{
63int ret;
64
65#if APR_HAS_THREADS
66    ap_mpm_query(AP_MPMQ_IS_THREADED, &mpm_is_threaded);
67    if (mpm_is_threaded) {
68        gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
69    }
70#else
71    mpm_is_threaded = 0;
72#endif
73
74    ret = gnutls_global_init();
75    if (ret < 0) /* FIXME: can we print here? */
76        exit(ret);
77
78    ret = gnutls_global_init_extra();
79    if (ret < 0) /* FIXME: can we print here? */
80        exit(ret);
81                                           
82    apr_pool_cleanup_register(pconf, NULL, mgs_cleanup_pre_config,
83                              apr_pool_cleanup_null);
84
85#if MOD_GNUTLS_DEBUG
86    apr_file_open(&debug_log_fp, "/tmp/gnutls_debug",
87                  APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT,
88                  pconf);
89
90    gnutls_global_set_log_level(9);
91    gnutls_global_set_log_function(gnutls_debug_log_all);
92#endif
93
94    return OK;
95}
96
97static int mgs_select_virtual_server_cb(gnutls_session_t session)
98{
99    mgs_handle_t *ctxt;
100    mgs_srvconf_rec *tsc;
101    int ret;
102    int cprio[3] = { GNUTLS_CRT_X509, GNUTLS_CRT_OPENPGP, 0 };
103
104    ctxt = gnutls_transport_get_ptr(session);
105
106    /* find the virtual server */
107    tsc = mgs_find_sni_server(session);
108
109    if (tsc != NULL)
110        ctxt->sc = tsc;
111
112    gnutls_certificate_server_set_request(session,
113                                          ctxt->sc->client_verify_mode);
114
115    /* set the new server credentials
116     */
117
118    gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE,
119                           ctxt->sc->certs);
120
121    gnutls_credentials_set(session, GNUTLS_CRD_ANON, ctxt->sc->anon_creds);
122
123    if (ctxt->sc->srp_tpasswd_conf_file != NULL
124        && ctxt->sc->srp_tpasswd_file != NULL) {
125        gnutls_credentials_set(session, GNUTLS_CRD_SRP,
126                               ctxt->sc->srp_creds);
127    }
128
129    /* update the priorities - to avoid negotiating a ciphersuite that is not
130     * enabled on this virtual server. Note that here we ignore the version
131     * negotiation.
132     */
133    ret = gnutls_priority_set(session, ctxt->sc->priorities);
134
135    /* Do not allow the user to override certificate priorities. We know
136     * better if the certificate of certain type is enabled. */
137    if (ctxt->sc->cert_pgp != NULL && ctxt->sc->certs_x509[0] != NULL) {
138        gnutls_certificate_type_set_priority( session, cprio);
139    } else if (ctxt->sc->certs_x509[0] != NULL) {
140        cprio[0] = GNUTLS_CRT_X509;
141        cprio[1] = 0;
142        gnutls_certificate_type_set_priority( session, cprio);
143    } else if (ctxt->sc->cert_pgp != NULL) {
144        cprio[0] = GNUTLS_CRT_OPENPGP;
145        cprio[1] = 0;
146        gnutls_certificate_type_set_priority( session, cprio);
147    }
148
149    /* actually it shouldn't fail since we have checked at startup */
150    if (ret < 0)
151        return ret;
152
153
154    return 0;
155}
156
157static int cert_retrieve_fn(gnutls_session_t session, gnutls_retr_st * ret)
158{
159    mgs_handle_t *ctxt;
160
161    ctxt = gnutls_transport_get_ptr(session);
162
163    if (gnutls_certificate_type_get( session) == GNUTLS_CRT_X509) {
164        ret->type = GNUTLS_CRT_X509;
165        ret->ncerts = ctxt->sc->certs_x509_num;
166        ret->deinit_all = 0;
167
168        ret->cert.x509 = ctxt->sc->certs_x509;
169        ret->key.x509 = ctxt->sc->privkey_x509;
170       
171        return 0;
172    } else if (gnutls_certificate_type_get( session) == GNUTLS_CRT_OPENPGP) {
173        ret->type = GNUTLS_CRT_OPENPGP;
174        ret->ncerts = 1;
175        ret->deinit_all = 0;
176
177        ret->cert.pgp = ctxt->sc->cert_pgp;
178        ret->key.pgp = ctxt->sc->privkey_pgp;
179
180        return 0;
181   
182    }
183
184    return GNUTLS_E_INTERNAL_ERROR;
185}
186
187const char static_dh_params[] = "-----BEGIN DH PARAMETERS-----\n"
188    "MIIBBwKCAQCsa9tBMkqam/Fm3l4TiVgvr3K2ZRmH7gf8MZKUPbVgUKNzKcu0oJnt\n"
189    "gZPgdXdnoT3VIxKrSwMxDc1/SKnaBP1Q6Ag5ae23Z7DPYJUXmhY6s2YaBfvV+qro\n"
190    "KRipli8Lk7hV+XmT7Jde6qgNdArb9P90c1nQQdXDPqcdKB5EaxR3O8qXtDoj+4AW\n"
191    "dr0gekNsZIHx0rkHhxdGGludMuaI+HdIVEUjtSSw1X1ep3onddLs+gMs+9v1L7N4\n"
192    "YWAnkATleuavh05zA85TKZzMBBx7wwjYKlaY86jQw4JxrjX46dv7tpS1yAPYn3rk\n"
193    "Nd4jbVJfVHWbZeNy/NaO8g+nER+eSv9zAgEC\n"
194    "-----END DH PARAMETERS-----\n";
195
196/* Read the common name or the alternative name of the certificate.
197 * We only support a single name per certificate.
198 *
199 * Returns negative on error.
200 */
201static int read_crt_cn(server_rec * s, apr_pool_t * p,
202                       gnutls_x509_crt_t cert, char **cert_cn)
203{
204    int rv = 0, i;
205    size_t data_len;
206
207
208    *cert_cn = NULL;
209
210    data_len = 0;
211    rv = gnutls_x509_crt_get_dn_by_oid(cert,
212                                       GNUTLS_OID_X520_COMMON_NAME,
213                                       0, 0, NULL, &data_len);
214
215    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
216        *cert_cn = apr_palloc(p, data_len);
217        rv = gnutls_x509_crt_get_dn_by_oid(cert,
218                                           GNUTLS_OID_X520_COMMON_NAME, 0,
219                                           0, *cert_cn, &data_len);
220    } else {                    /* No CN return subject alternative name */
221        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
222                     "No common name found in certificate for '%s:%d'. Looking for subject alternative name...",
223                     s->server_hostname, s->port);
224        rv = 0;
225        /* read subject alternative name */
226        for (i = 0; !(rv < 0); i++) {
227            data_len = 0;
228            rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
229                                                      NULL, &data_len,
230                                                      NULL);
231
232            if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
233                /* FIXME: not very efficient. What if we have several alt names
234                 * before DNSName?
235                 */
236                *cert_cn = apr_palloc(p, data_len + 1);
237
238                rv = gnutls_x509_crt_get_subject_alt_name(cert, i,
239                                                          *cert_cn,
240                                                          &data_len, NULL);
241                (*cert_cn)[data_len] = 0;
242
243                if (rv == GNUTLS_SAN_DNSNAME)
244                    break;
245            }
246        }
247    }
248
249    return rv;
250}
251
252static int read_pgpcrt_cn(server_rec * s, apr_pool_t * p,
253                       gnutls_openpgp_crt_t cert, char **cert_cn)
254{
255    int rv = 0;
256    size_t data_len;
257
258
259    *cert_cn = NULL;
260
261    data_len = 0;
262    rv = gnutls_openpgp_crt_get_name(cert, 0, NULL, &data_len);
263
264    if (rv == GNUTLS_E_SHORT_MEMORY_BUFFER && data_len > 1) {
265        *cert_cn = apr_palloc(p, data_len);
266        rv = gnutls_openpgp_crt_get_name(cert, 0, *cert_cn, &data_len);
267    } else {                    /* No CN return subject alternative name */
268        ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
269                     "No name found in PGP certificate for '%s:%d'.",
270                     s->server_hostname, s->port);
271    }
272
273    return rv;
274}
275
276
277int
278mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
279                     apr_pool_t * ptemp, server_rec * base_server)
280{
281    int rv;
282    server_rec *s;
283    gnutls_dh_params_t dh_params = NULL;
284    gnutls_rsa_params_t rsa_params = NULL;
285    mgs_srvconf_rec *sc;
286    mgs_srvconf_rec *sc_base;
287    void *data = NULL;
288    int first_run = 0;
289    const char *userdata_key = "mgs_init";
290
291    apr_pool_userdata_get(&data, userdata_key, base_server->process->pool);
292    if (data == NULL) {
293        first_run = 1;
294        apr_pool_userdata_set((const void *) 1, userdata_key,
295                              apr_pool_cleanup_null,
296                              base_server->process->pool);
297    }
298
299
300    {
301        s = base_server;
302        sc_base =
303            (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
304                                                     &gnutls_module);
305
306        gnutls_dh_params_init(&dh_params);
307
308        if (sc_base->dh_params == NULL) {
309            gnutls_datum pdata = { (void *) static_dh_params, sizeof(static_dh_params) };
310            /* loading defaults */
311            rv = gnutls_dh_params_import_pkcs3(dh_params, &pdata,
312                                               GNUTLS_X509_FMT_PEM);
313
314            if (rv < 0) {
315                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
316                     "GnuTLS: Unable to load DH Params: (%d) %s",
317                     rv, gnutls_strerror(rv));
318                exit(rv);
319            }
320        } else dh_params = sc_base->dh_params;
321
322        if (sc_base->rsa_params != NULL) 
323            rsa_params = sc_base->rsa_params;
324
325        /* else not an error but RSA-EXPORT ciphersuites are not available
326         */
327
328        rv = mgs_cache_post_config(p, s, sc_base);
329        if (rv != 0) {
330            ap_log_error(APLOG_MARK, APLOG_STARTUP, rv, s,
331                         "GnuTLS: Post Config for GnuTLSCache Failed."
332                         " Shutting Down.");
333            exit(-1);
334        }
335
336        for (s = base_server; s; s = s->next) {
337            void *load = NULL;
338            sc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
339                                                          &gnutls_module);
340            sc->cache_type = sc_base->cache_type;
341            sc->cache_config = sc_base->cache_config;
342
343            /* Check if the priorities have been set */
344            if (sc->priorities == NULL && sc->enabled == GNUTLS_ENABLED_TRUE) {
345                ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, s,
346                     "GnuTLS: Host '%s:%d' is missing the GnuTLSPriorities directive!",
347                             s->server_hostname, s->port);
348                exit(-1);
349            }
350           
351            /* Check if DH or RSA params have been set per host */
352            if (sc->rsa_params != NULL)
353                load = sc->rsa_params;
354            else if (rsa_params) load = rsa_params;
355           
356            if (load != NULL)
357                gnutls_certificate_set_rsa_export_params(sc->certs, load);
358
359
360            load = NULL;
361            if (sc->dh_params != NULL)
362                load = sc->dh_params;
363            else if (dh_params) load = dh_params;
364           
365            if (load != NULL) { /* not needed but anyway */
366                gnutls_certificate_set_dh_params(sc->certs, load);
367                gnutls_anon_set_server_dh_params(sc->anon_creds, load);
368            }
369
370            gnutls_certificate_server_set_retrieve_function(sc->certs,
371                                                            cert_retrieve_fn);
372
373            if (sc->srp_tpasswd_conf_file != NULL
374                && sc->srp_tpasswd_file != NULL) {
375                rv = gnutls_srp_set_server_credentials_file(sc->srp_creds,
376                                                            sc->
377                                                            srp_tpasswd_file,
378                                                            sc->
379                                                            srp_tpasswd_conf_file);
380
381                if (rv < 0 && sc->enabled == GNUTLS_ENABLED_TRUE) {
382                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
383                                 "[GnuTLS] - Host '%s:%d' is missing a "
384                                 "SRP password or conf File!",
385                                 s->server_hostname, s->port);
386                    exit(-1);
387                }
388            }
389
390            if (sc->certs_x509[0] == NULL
391                && sc->enabled == GNUTLS_ENABLED_TRUE) {
392                ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
393                             "[GnuTLS] - Host '%s:%d' is missing a "
394                             "Certificate File!", s->server_hostname,
395                             s->port);
396                exit(-1);
397            }
398
399            if (sc->privkey_x509 == NULL
400                && sc->enabled == GNUTLS_ENABLED_TRUE) {
401                ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
402                             "[GnuTLS] - Host '%s:%d' is missing a "
403                             "Private Key File!",
404                             s->server_hostname, s->port);
405                exit(-1);
406            }
407
408            if (sc->enabled == GNUTLS_ENABLED_TRUE) {
409                rv = read_crt_cn(s, p, sc->certs_x509[0], &sc->cert_cn);
410                if (rv < 0)  /* try openpgp certificate */
411                    rv = read_pgpcrt_cn(s, p, sc->cert_pgp, &sc->cert_cn);
412
413                if (rv < 0) {
414                    ap_log_error(APLOG_MARK, APLOG_EMERG, 0, s,
415                                 "[GnuTLS] - Cannot find a certificate for host '%s:%d'!",
416                                 s->server_hostname, s->port);
417                    sc->cert_cn = NULL;
418                    continue;
419                }
420            }
421        }
422    }
423
424    ap_add_version_component(p, "mod_gnutls/" MOD_GNUTLS_VERSION);
425
426    return OK;
427}
428
429void mgs_hook_child_init(apr_pool_t * p, server_rec * s)
430{
431    apr_status_t rv = APR_SUCCESS;
432    mgs_srvconf_rec *sc = ap_get_module_config(s->module_config,
433                                               &gnutls_module);
434
435    if (sc->cache_type != mgs_cache_none) {
436        rv = mgs_cache_child_init(p, s, sc);
437        if (rv != APR_SUCCESS) {
438            ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s,
439                         "[GnuTLS] - Failed to run Cache Init");
440        }
441    } else {
442        ap_log_error(APLOG_MARK, APLOG_CRIT, 0, s,
443                     "[GnuTLS] - No Cache Configured. Hint: GnuTLSCache");
444    }
445}
446
447const char *mgs_hook_http_scheme(const request_rec * r)
448{
449    mgs_srvconf_rec *sc =
450        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
451                                                 &gnutls_module);
452
453    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
454        return NULL;
455    }
456
457    return "https";
458}
459
460apr_port_t mgs_hook_default_port(const request_rec * r)
461{
462    mgs_srvconf_rec *sc =
463        (mgs_srvconf_rec *) ap_get_module_config(r->server->module_config,
464                                                 &gnutls_module);
465
466    if (sc->enabled == GNUTLS_ENABLED_FALSE) {
467        return 0;
468    }
469
470    return 443;
471}
472
473#define MAX_HOST_LEN 255
474
475#if USING_2_1_RECENT
476typedef struct {
477    mgs_handle_t *ctxt;
478    mgs_srvconf_rec *sc;
479    const char *sni_name;
480} vhost_cb_rec;
481
482static int vhost_cb(void *baton, conn_rec * conn, server_rec * s)
483{
484    mgs_srvconf_rec *tsc;
485    vhost_cb_rec *x = baton;
486
487    tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
488                                                   &gnutls_module);
489
490    if (tsc->enabled != GNUTLS_ENABLED_TRUE || tsc->cert_cn == NULL) {
491        return 0;
492    }
493
494    /* The CN can contain a * -- this will match those too. */
495    if (ap_strcasecmp_match(x->sni_name, tsc->cert_cn) == 0) {
496        /* found a match */
497#if MOD_GNUTLS_DEBUG
498        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
499                     x->ctxt->c->base_server,
500                     "GnuTLS: Virtual Host CB: "
501                     "'%s' == '%s'", tsc->cert_cn, x->sni_name);
502#endif
503        /* Because we actually change the server used here, we need to reset
504         * things like ClientVerify.
505         */
506        x->sc = tsc;
507        /* Shit. Crap. Dammit. We *really* should rehandshake here, as our
508         * certificate structure *should* change when the server changes.
509         * acccckkkkkk.
510         */
511        return 1;
512    } else {
513#if MOD_GNUTLS_DEBUG
514        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
515                     x->ctxt->c->base_server,
516                     "GnuTLS: Virtual Host CB: "
517                     "'%s' != '%s'", tsc->cert_cn, x->sni_name);
518#endif
519
520    }
521    return 0;
522}
523#endif
524
525mgs_srvconf_rec *mgs_find_sni_server(gnutls_session_t session)
526{
527    int rv;
528    unsigned int sni_type;
529    size_t data_len = MAX_HOST_LEN;
530    char sni_name[MAX_HOST_LEN];
531    mgs_handle_t *ctxt;
532#if USING_2_1_RECENT
533    vhost_cb_rec cbx;
534#else
535    server_rec *s;
536    mgs_srvconf_rec *tsc;
537#endif
538
539    ctxt = gnutls_transport_get_ptr(session);
540
541    rv = gnutls_server_name_get(ctxt->session, sni_name,
542                                &data_len, &sni_type, 0);
543
544    if (rv != 0) {
545        return NULL;
546    }
547
548    if (sni_type != GNUTLS_NAME_DNS) {
549        ap_log_error(APLOG_MARK, APLOG_CRIT, 0,
550                     ctxt->c->base_server,
551                     "GnuTLS: Unknown type '%d' for SNI: "
552                     "'%s'", sni_type, sni_name);
553        return NULL;
554    }
555
556    /**
557     * Code in the Core already sets up the c->base_server as the base
558     * for this IP/Port combo.  Trust that the core did the 'right' thing.
559     */
560#if USING_2_1_RECENT
561    cbx.ctxt = ctxt;
562    cbx.sc = NULL;
563    cbx.sni_name = sni_name;
564
565    rv = ap_vhost_iterate_given_conn(ctxt->c, vhost_cb, &cbx);
566    if (rv == 1) {
567        return cbx.sc;
568    }
569#else
570    for (s = ap_server_conf; s; s = s->next) {
571
572        tsc = (mgs_srvconf_rec *) ap_get_module_config(s->module_config,
573                                                       &gnutls_module);
574        if (tsc->enabled != GNUTLS_ENABLED_TRUE) {
575            continue;
576        }
577#if MOD_GNUTLS_DEBUG
578        ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
579                     ctxt->c->base_server,
580                     "GnuTLS: sni-x509 cn: %s/%d pk: %s s: 0x%08X s->n: 0x%08X  sc: 0x%08X",
581                     tsc->cert_cn, rv,
582                     gnutls_pk_algorithm_get_name
583                     (gnutls_x509_privkey_get_pk_algorithm
584                      (ctxt->sc->privkey_x509)), (unsigned int) s,
585                     (unsigned int) s->next, (unsigned int) tsc);
586#endif
587        /* The CN can contain a * -- this will match those too. */
588        if (ap_strcasecmp_match(sni_name, tsc->cert_cn) == 0) {
589#if MOD_GNUTLS_DEBUG
590            ap_log_error(APLOG_MARK, APLOG_DEBUG, 0,
591                         ctxt->c->base_server,
592                         "GnuTLS: Virtual Host: "
593                         "'%s' == '%s'", tsc->cert_cn, sni_name);
594#endif
595            return tsc;
596        }
597    }
598#endif
599    return NULL;
600}
601
602
603static const int protocol_priority[] = {
604    GNUTLS_TLS1_1, GNUTLS_TLS1_0, GNUTLS_SSL3, 0
605};
606
607
608static mgs_handle_t *create_gnutls_handle(apr_pool_t * pool, conn_rec * c)
609{
610    mgs_handle_t *ctxt;
611    mgs_srvconf_rec *sc =
612        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
613                                                 module_config,
614                                                 &gnutls_module);
615
616    ctxt = apr_pcalloc(pool, sizeof(*ctxt));
617    ctxt->c = c;
618    ctxt->sc = sc;
619    ctxt->status = 0;
620
621    ctxt->input_rc = APR_SUCCESS;
622    ctxt->input_bb = apr_brigade_create(c->pool, c->bucket_alloc);
623    ctxt->input_cbuf.length = 0;
624
625    ctxt->output_rc = APR_SUCCESS;
626    ctxt->output_bb = apr_brigade_create(c->pool, c->bucket_alloc);
627    ctxt->output_blen = 0;
628    ctxt->output_length = 0;
629
630    gnutls_init(&ctxt->session, GNUTLS_SERVER);
631
632    /* because we don't set any default priorities here (we set later at
633     * the user hello callback) we need to at least set this in order for
634     * gnutls to be able to read packets.
635     */
636    gnutls_protocol_set_priority(ctxt->session, protocol_priority);
637
638    gnutls_handshake_set_post_client_hello_function(ctxt->session,
639                                                    mgs_select_virtual_server_cb);
640
641    mgs_cache_session_init(ctxt);
642
643    return ctxt;
644}
645
646int mgs_hook_pre_connection(conn_rec * c, void *csd)
647{
648    mgs_handle_t *ctxt;
649    mgs_srvconf_rec *sc =
650        (mgs_srvconf_rec *) ap_get_module_config(c->base_server->
651                                                 module_config,
652                                                 &gnutls_module);
653
654    if (!(sc && (sc->enabled == GNUTLS_ENABLED_TRUE))) {
655        return DECLINED;
656    }
657
658    ctxt = create_gnutls_handle(c->pool, c);
659
660    ap_set_module_config(c->conn_config, &gnutls_module, ctxt);
661
662    gnutls_transport_set_pull_function(ctxt->session, mgs_transport_read);
663    gnutls_transport_set_push_function(ctxt->session, mgs_transport_write);
664    gnutls_transport_set_ptr(ctxt->session, ctxt);
665
666    ctxt->input_filter =
667        ap_add_input_filter(GNUTLS_INPUT_FILTER_NAME, ctxt, NULL, c);
668    ctxt->output_filter =
669        ap_add_output_filter(GNUTLS_OUTPUT_FILTER_NAME, ctxt, NULL, c);
670
671    return OK;
672}
673
674int mgs_hook_fixups(request_rec * r)
675{
676    unsigned char sbuf[GNUTLS_MAX_SESSION_ID];
677    char buf[AP_IOBUFSIZE];
678    const char *tmp;
679    size_t len;
680    mgs_handle_t *ctxt;
681    int rv = OK;
682
683    apr_table_t *env = r->subprocess_env;
684
685    ctxt =
686        ap_get_module_config(r->connection->conn_config, &gnutls_module);
687
688    if (!ctxt) {
689        return DECLINED;
690    }
691
692    apr_table_setn(env, "HTTPS", "on");
693
694    apr_table_setn(env, "SSL_VERSION_LIBRARY",
695                   "GnuTLS/" LIBGNUTLS_VERSION);
696    apr_table_setn(env, "SSL_VERSION_INTERFACE",
697                   "mod_gnutls/" MOD_GNUTLS_VERSION);
698
699    apr_table_setn(env, "SSL_PROTOCOL",
700                   gnutls_protocol_get_name(gnutls_protocol_get_version
701                                            (ctxt->session)));
702
703    /* should have been called SSL_CIPHERSUITE instead */
704    apr_table_setn(env, "SSL_CIPHER",
705                   gnutls_cipher_suite_get_name(gnutls_kx_get
706                                                (ctxt->session),
707                                                gnutls_cipher_get(ctxt->
708                                                                  session),
709                                                gnutls_mac_get(ctxt->
710                                                               session)));
711
712    apr_table_setn(env, "SSL_COMPRESS_METHOD",
713                   gnutls_compression_get_name(gnutls_compression_get
714                                               (ctxt->session)));
715
716    apr_table_setn(env, "SSL_SRP_USER",
717                   gnutls_srp_server_get_username(ctxt->session));
718
719    if (apr_table_get(env, "SSL_CLIENT_VERIFY") == NULL)
720        apr_table_setn(env, "SSL_CLIENT_VERIFY", "NONE");
721
722    unsigned int key_size =
723        8 * gnutls_cipher_get_key_size(gnutls_cipher_get(ctxt->session));
724    tmp = apr_psprintf(r->pool, "%u", key_size);
725
726    apr_table_setn(env, "SSL_CIPHER_USEKEYSIZE", tmp);
727
728    apr_table_setn(env, "SSL_CIPHER_ALGKEYSIZE", tmp);
729
730    apr_table_setn(env, "SSL_CIPHER_EXPORT",
731                   (key_size <= 40) ? "true" : "false");
732
733    len = sizeof(sbuf);
734    gnutls_session_get_id(ctxt->session, sbuf, &len);
735    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
736    apr_table_setn(env, "SSL_SESSION_ID", apr_pstrdup(r->pool, tmp));
737
738    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
739        mgs_add_common_cert_vars(r, ctxt->sc->certs_x509[0], 0,
740                             ctxt->sc->export_certificates_enabled);
741    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
742        mgs_add_common_pgpcert_vars(r, ctxt->sc->cert_pgp, 0,
743                             ctxt->sc->export_certificates_enabled);
744
745    return rv;
746}
747
748int mgs_hook_authz(request_rec * r)
749{
750    int rv;
751    mgs_handle_t *ctxt;
752    mgs_dirconf_rec *dc = ap_get_module_config(r->per_dir_config,
753                                               &gnutls_module);
754
755    ctxt =
756        ap_get_module_config(r->connection->conn_config, &gnutls_module);
757
758    if (!ctxt) {
759        return DECLINED;
760    }
761
762    if (dc->client_verify_mode == GNUTLS_CERT_IGNORE) {
763        ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
764                      "GnuTLS: Directory set to Ignore Client Certificate!");
765    } else {
766        if (ctxt->sc->client_verify_mode < dc->client_verify_mode) {
767            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
768                          "GnuTLS: Attempting to rehandshake with peer. %d %d",
769                          ctxt->sc->client_verify_mode,
770                          dc->client_verify_mode);
771
772            gnutls_certificate_server_set_request(ctxt->session,
773                                                  dc->client_verify_mode);
774
775            if (mgs_rehandshake(ctxt) != 0) {
776                return HTTP_FORBIDDEN;
777            }
778        } else if (ctxt->sc->client_verify_mode == GNUTLS_CERT_IGNORE) {
779#if MOD_GNUTLS_DEBUG
780            ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
781                          "GnuTLS: Peer is set to IGNORE");
782#endif
783        } else {
784            rv = mgs_cert_verify(r, ctxt);
785            if (rv != DECLINED) {
786                return rv;
787            }
788        }
789    }
790
791    return DECLINED;
792}
793
794/* variables that are not sent by default:
795 *
796 * SSL_CLIENT_CERT      string  PEM-encoded client certificate
797 * SSL_SERVER_CERT      string  PEM-encoded client certificate
798 */
799
800/* side is either 0 for SERVER or 1 for CLIENT
801 */
802#define MGS_SIDE ((side==0)?"SSL_SERVER":"SSL_CLIENT")
803static void
804mgs_add_common_cert_vars(request_rec * r, gnutls_x509_crt_t cert, int side,
805                         int export_certificates_enabled)
806{
807    unsigned char sbuf[64];     /* buffer to hold serials */
808    char buf[AP_IOBUFSIZE];
809    const char *tmp;
810    char *tmp2;
811    size_t len;
812    int ret, i;
813
814    apr_table_t *env = r->subprocess_env;
815
816    if (export_certificates_enabled != 0) {
817        char cert_buf[10 * 1024];
818        len = sizeof(cert_buf);
819
820        if (gnutls_x509_crt_export
821            (cert, GNUTLS_X509_FMT_PEM, cert_buf, &len) >= 0)
822            apr_table_setn(env,
823                           apr_pstrcat(r->pool, MGS_SIDE, "_CERT", NULL),
824                           apr_pstrmemdup(r->pool, cert_buf, len));
825
826    }
827
828    len = sizeof(buf);
829    gnutls_x509_crt_get_dn(cert, buf, &len);
830    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_S_DN", NULL),
831                   apr_pstrmemdup(r->pool, buf, len));
832
833    len = sizeof(buf);
834    gnutls_x509_crt_get_issuer_dn(cert, buf, &len);
835    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_I_DN", NULL),
836                   apr_pstrmemdup(r->pool, buf, len));
837
838    len = sizeof(sbuf);
839    gnutls_x509_crt_get_serial(cert, sbuf, &len);
840    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
841    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_M_SERIAL", NULL),
842                   apr_pstrdup(r->pool, tmp));
843
844    ret = gnutls_x509_crt_get_version(cert);
845    if (ret > 0)
846        apr_table_setn(env,
847                       apr_pstrcat(r->pool, MGS_SIDE, "_M_VERSION", NULL),
848                       apr_psprintf(r->pool, "%u", ret));
849
850    apr_table_setn(env,
851       apr_pstrcat(r->pool, MGS_SIDE, "_CERT_TYPE", NULL), "X.509");
852
853    tmp =
854        mgs_time2sz(gnutls_x509_crt_get_expiration_time
855                    (cert), buf, sizeof(buf));
856    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_END", NULL),
857                   apr_pstrdup(r->pool, tmp));
858
859    tmp =
860        mgs_time2sz(gnutls_x509_crt_get_activation_time
861                    (cert), buf, sizeof(buf));
862    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_START", NULL),
863                   apr_pstrdup(r->pool, tmp));
864
865    ret = gnutls_x509_crt_get_signature_algorithm(cert);
866    if (ret >= 0) {
867        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_SIG", NULL),
868                       gnutls_sign_algorithm_get_name(ret));
869    }
870
871    ret = gnutls_x509_crt_get_pk_algorithm(cert, NULL);
872    if (ret >= 0) {
873        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_KEY", NULL),
874                       gnutls_pk_algorithm_get_name(ret));
875    }
876
877    /* export all the alternative names (DNS, RFC822 and URI) */
878    for (i = 0; !(ret < 0); i++) {
879        len = 0;
880        ret = gnutls_x509_crt_get_subject_alt_name(cert, i,
881                                                   NULL, &len, NULL);
882
883        if (ret == GNUTLS_E_SHORT_MEMORY_BUFFER && len > 1) {
884            tmp2 = apr_palloc(r->pool, len + 1);
885
886            ret =
887                gnutls_x509_crt_get_subject_alt_name(cert, i, tmp2, &len,
888                                                     NULL);
889            tmp2[len] = 0;
890
891            if (ret == GNUTLS_SAN_DNSNAME) {
892                apr_table_setn(env,
893                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
894                       apr_psprintf(r->pool, "DNSNAME:%s", tmp2));
895            } else if (ret == GNUTLS_SAN_RFC822NAME) {
896                apr_table_setn(env,
897                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
898                       apr_psprintf(r->pool, "RFC822NAME:%s", tmp2));
899            } else if (ret == GNUTLS_SAN_URI) {
900                apr_table_setn(env,
901                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
902                       apr_psprintf(r->pool, "URI:%s", tmp2));
903            } else {
904                apr_table_setn(env,
905                       apr_psprintf(r->pool, "%s_S_AN%u", MGS_SIDE, i), 
906                       "UNSUPPORTED");
907            }
908        }
909    }
910}
911
912static void
913mgs_add_common_pgpcert_vars(request_rec * r, gnutls_openpgp_crt_t cert, int side,
914                         int export_certificates_enabled)
915{
916    unsigned char sbuf[64];     /* buffer to hold serials */
917    char buf[AP_IOBUFSIZE];
918    const char *tmp;
919    size_t len;
920    int ret;
921
922    apr_table_t *env = r->subprocess_env;
923
924    if (export_certificates_enabled != 0) {
925        char cert_buf[10 * 1024];
926        len = sizeof(cert_buf);
927
928        if (gnutls_openpgp_crt_export
929            (cert, GNUTLS_OPENPGP_FMT_BASE64, cert_buf, &len) >= 0)
930            apr_table_setn(env,
931                           apr_pstrcat(r->pool, MGS_SIDE, "_CERT", NULL),
932                           apr_pstrmemdup(r->pool, cert_buf, len));
933
934    }
935
936    len = sizeof(buf);
937    gnutls_openpgp_crt_get_name(cert, 0, buf, &len);
938    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_NAME", NULL),
939                   apr_pstrmemdup(r->pool, buf, len));
940
941    len = sizeof(sbuf);
942    gnutls_openpgp_crt_get_fingerprint(cert, sbuf, &len);
943    tmp = mgs_session_id2sz(sbuf, len, buf, sizeof(buf));
944    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_FINGERPRINT", NULL),
945                   apr_pstrdup(r->pool, tmp));
946
947    ret = gnutls_openpgp_crt_get_version(cert);
948    if (ret > 0)
949        apr_table_setn(env,
950                       apr_pstrcat(r->pool, MGS_SIDE, "_M_VERSION", NULL),
951                       apr_psprintf(r->pool, "%u", ret));
952
953    apr_table_setn(env,
954       apr_pstrcat(r->pool, MGS_SIDE, "_CERT_TYPE", NULL), "OPENPGP");
955
956    tmp =
957        mgs_time2sz(gnutls_openpgp_crt_get_expiration_time
958                    (cert), buf, sizeof(buf));
959    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_END", NULL),
960                   apr_pstrdup(r->pool, tmp));
961
962    tmp =
963        mgs_time2sz(gnutls_openpgp_crt_get_creation_time
964                    (cert), buf, sizeof(buf));
965    apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_V_START", NULL),
966                   apr_pstrdup(r->pool, tmp));
967
968    ret = gnutls_openpgp_crt_get_pk_algorithm(cert, NULL);
969    if (ret >= 0) {
970        apr_table_setn(env, apr_pstrcat(r->pool, MGS_SIDE, "_A_KEY", NULL),
971                       gnutls_pk_algorithm_get_name(ret));
972    }
973
974}
975
976/* FIXME: Allow client sending a certificate chain */
977static int mgs_cert_verify(request_rec * r, mgs_handle_t * ctxt)
978{
979    const gnutls_datum_t *cert_list;
980    unsigned int cert_list_size, status, expired;
981    int rv, ret;
982    union {
983      gnutls_x509_crt_t x509;
984      gnutls_openpgp_crt_t pgp;
985    } cert;
986    apr_time_t activation_time, expiration_time, cur_time;
987
988    cert_list =
989        gnutls_certificate_get_peers(ctxt->session, &cert_list_size);
990
991    if (cert_list == NULL || cert_list_size == 0) {
992        /* It is perfectly OK for a client not to send a certificate if on REQUEST mode
993         */
994        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
995            return OK;
996
997        /* no certificate provided by the client, but one was required. */
998        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
999                      "GnuTLS: Failed to Verify Peer: "
1000                      "Client did not submit a certificate");
1001        return HTTP_FORBIDDEN;
1002    }
1003
1004    if (cert_list_size > 1) {
1005        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1006                      "GnuTLS: Failed to Verify Peer: "
1007                      "Chained Client Certificates are not supported.");
1008        return HTTP_FORBIDDEN;
1009    }
1010
1011    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509) {
1012        gnutls_x509_crt_init(&cert.x509);
1013        rv = gnutls_x509_crt_import(cert.x509, &cert_list[0], GNUTLS_X509_FMT_DER);
1014    } else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP) {
1015        gnutls_openpgp_crt_init(&cert.pgp);
1016        rv = gnutls_openpgp_crt_import(cert.pgp, &cert_list[0], GNUTLS_OPENPGP_FMT_RAW);
1017    } else return HTTP_FORBIDDEN;
1018 
1019    if (rv < 0) {
1020       ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1021                      "GnuTLS: Failed to Verify Peer: "
1022                      "Failed to import peer certificates.");
1023       ret = HTTP_FORBIDDEN;
1024       goto exit;
1025    }
1026
1027    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509) {
1028        apr_time_ansi_put(&expiration_time,
1029                      gnutls_x509_crt_get_expiration_time(cert.x509));
1030        apr_time_ansi_put(&activation_time,
1031                      gnutls_x509_crt_get_activation_time(cert.x509));
1032
1033        rv = gnutls_x509_crt_verify(cert.x509, ctxt->sc->ca_list,
1034                                ctxt->sc->ca_list_size, 0, &status);
1035    } else {
1036        apr_time_ansi_put(&expiration_time,
1037                      gnutls_openpgp_crt_get_expiration_time(cert.pgp));
1038        apr_time_ansi_put(&activation_time,
1039                      gnutls_openpgp_crt_get_creation_time(cert.pgp));
1040
1041        rv = gnutls_openpgp_crt_verify_ring(cert.pgp, ctxt->sc->pgp_list,
1042                      0, &status);
1043    }
1044
1045
1046    if (rv < 0) {
1047        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1048                      "GnuTLS: Failed to Verify Peer certificate: (%d) %s",
1049                      rv, gnutls_strerror(rv));
1050        ret = HTTP_FORBIDDEN;
1051        goto exit;
1052    }
1053
1054    expired = 0;
1055    cur_time = apr_time_now();
1056    if (activation_time > cur_time) {
1057        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1058                      "GnuTLS: Failed to Verify Peer: "
1059                      "Peer Certificate is not yet activated.");
1060        expired = 1;
1061    }
1062
1063    if (expiration_time < cur_time) {
1064        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1065                      "GnuTLS: Failed to Verify Peer: "
1066                      "Peer Certificate is expired.");
1067        expired = 1;
1068    }
1069
1070    if (status & GNUTLS_CERT_SIGNER_NOT_FOUND) {
1071        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1072                      "GnuTLS: Could not find Signer for Peer Certificate");
1073    }
1074
1075    if (status & GNUTLS_CERT_SIGNER_NOT_CA) {
1076        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1077                      "GnuTLS: Peer's Certificate signer is not a CA");
1078    }
1079
1080    if (status & GNUTLS_CERT_INVALID) {
1081        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1082                      "GnuTLS: Peer Certificate is invalid.");
1083    } else if (status & GNUTLS_CERT_REVOKED) {
1084        ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1085                      "GnuTLS: Peer Certificate is revoked.");
1086    }
1087
1088    /* TODO: Further Verification. */
1089    /* Revocation is X.509 non workable paradigm, I really doubt implementation
1090     * is worth doing --nmav
1091     */
1092/// ret = gnutls_x509_crt_check_revocation(crt, crl_list, crl_list_size);
1093
1094//    mgs_hook_fixups(r);
1095//    rv = mgs_authz_lua(r);
1096
1097    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
1098        mgs_add_common_cert_vars(r, cert.x509, 1,
1099                             ctxt->sc->export_certificates_enabled);
1100    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
1101        mgs_add_common_pgpcert_vars(r, cert.pgp, 1,
1102                             ctxt->sc->export_certificates_enabled);
1103
1104    {
1105        /* days remaining */
1106        unsigned long remain =
1107            (apr_time_sec(expiration_time) -
1108             apr_time_sec(cur_time)) / 86400;
1109        apr_table_setn(r->subprocess_env, "SSL_CLIENT_V_REMAIN",
1110                       apr_psprintf(r->pool, "%lu", remain));
1111    }
1112
1113    if (status == 0 && expired == 0) {
1114        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "SUCCESS");
1115        ret = OK;
1116    } else {
1117        apr_table_setn(r->subprocess_env, "SSL_CLIENT_VERIFY", "FAILED");
1118        if (ctxt->sc->client_verify_mode == GNUTLS_CERT_REQUEST)
1119            ret = OK;
1120        else
1121            ret = HTTP_FORBIDDEN;
1122    }
1123
1124  exit:
1125    if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_X509)
1126        gnutls_x509_crt_deinit(cert.x509);
1127    else if (gnutls_certificate_type_get( ctxt->session) == GNUTLS_CRT_OPENPGP)
1128        gnutls_openpgp_crt_deinit(cert.pgp);
1129    return ret;
1130
1131
1132}
Note: See TracBrowser for help on using the repository browser.