source: mod_gnutls/include/mod_gnutls.h.in @ 3e800f9

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

restore GnuTLSExportCertificate directive

It looks to me like this option was mistakenly removed when the the
RSA-EXPORT configuration parameters were ripped out, possibly due to
confusion over the term Export.

GnuTLSExportCertificate is a useful configuration directive, and some
users might be relying on it.

  • Property mode set to 100644
File size: 12.1 KB
RevLine 
[fcb122d]1/**
2 *  Copyright 2004-2005 Paul Querna
[7e2b223]3 *
4 *  Licensed under the Apache License, Version 2.0 (the "License");
5 *  you may not use this file except in compliance with the License.
6 *  You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 *  Unless required by applicable law or agreed to in writing, software
11 *  distributed under the License is distributed on an "AS IS" BASIS,
12 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 *  See the License for the specific language governing permissions and
14 *  limitations under the License.
15 *
16 */
17
[3b4c0d0]18/* Apache Runtime Headers */
[7e2b223]19#include "httpd.h"
20#include "http_config.h"
21#include "http_protocol.h"
22#include "http_connection.h"
[76bd3bf]23#include "http_request.h"
[7e2b223]24#include "http_core.h"
25#include "http_log.h"
26#include "apr_buckets.h"
27#include "apr_strings.h"
28#include "apr_tables.h"
[482f47f]29#include "ap_release.h"
[9ddaa29]30#include "apr_fnmatch.h"
[3b4c0d0]31/* GnuTLS Library Headers */
[31645b2]32#include <gnutls/gnutls.h>
[3596d6a]33#if GNUTLS_VERSION_MAJOR == 2
[e5bbda4]34#include <gnutls/extra.h>
[3596d6a]35#endif
[e5bbda4]36#include <gnutls/openpgp.h>
[31645b2]37#include <gnutls/x509.h>
38
[05d56ce]39#ifndef __mod_gnutls_h_inc
40#define __mod_gnutls_h_inc
41
[6e0bfd6]42#define HAVE_APR_MEMCACHE    @have_apr_memcache@
[a66e147]43
[6d4de37]44extern module AP_MODULE_DECLARE_DATA gnutls_module;
[7e2b223]45
[3b4c0d0]46/* IO Filter names */
[7e2b223]47#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
48#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
[3b4c0d0]49/* GnuTLS Constants */
[7e2b223]50#define GNUTLS_ENABLED_FALSE 0
51#define GNUTLS_ENABLED_TRUE  1
[040387c]52#define GNUTLS_ENABLED_UNSET  2
[3b4c0d0]53/* Current module version */
[032ff02]54#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
55
[3b4c0d0]56/* Module Debug Mode */
[032ff02]57#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
[3b4c0d0]58
59/*
60 * Recent Versions of 2.1 renamed several hooks.
61 * This allows us to compile on 2.0.xx 
62 */
[7e67487]63#if AP_SERVER_MINORVERSION_NUMBER >= 2 || (AP_SERVER_MINORVERSION_NUMBER == 1 && AP_SERVER_PATCHLEVEL_NUMBER >= 3)
[3b4c0d0]64        #define USING_2_1_RECENT 1
[7c05ed1]65#else
[3b4c0d0]66        #define USING_2_1_RECENT 0
[482f47f]67#endif
68
[3b4c0d0]69/* mod_gnutls Cache Types */
70typedef enum {
71        /* No Cache */
[c301152]72    mgs_cache_none,
[3b4c0d0]73        /* Use Old Berkley DB */
[c301152]74    mgs_cache_dbm,
[3b4c0d0]75        /* Use Gnu's version of Berkley DB */
[d8c7cf4]76    mgs_cache_gdbm,
[fcb122d]77#if HAVE_APR_MEMCACHE
[3b4c0d0]78        /* Use Memcache */
[040387c]79    mgs_cache_memcache,
[2e12226]80#endif
[040387c]81    mgs_cache_unset
[c301152]82} mgs_cache_e;
[2e12226]83
[3b4c0d0]84/* Directory Configuration Record */
85typedef struct {
[e924ddd]86    int client_verify_mode;
[84cb5b2]87    const char* lua_bytecode;
88    apr_size_t lua_bytecode_len;
[c301152]89} mgs_dirconf_rec;
[31645b2]90
[7bebb42]91
[3b4c0d0]92/* The maximum number of certificates to send in a chain */
[5e81262]93#define MAX_CHAIN_SIZE 8
[3b4c0d0]94/* The maximum number of SANs to read from a x509 certificate */
95#define MAX_CERT_SAN 5
[7bebb42]96
[3b4c0d0]97/* Server Configuration Record */
98typedef struct {
99        /* x509 Certificate Structure */
100    gnutls_certificate_credentials_t certs;
101        /* SRP Certificate Structure*/
[7bebb42]102    gnutls_srp_server_credentials_t srp_creds;
[3b4c0d0]103        /* Annonymous Certificate Structure */
[7bebb42]104    gnutls_anon_server_credentials_t anon_creds;
[3b4c0d0]105        /* Current x509 Certificate CN [Common Name] */
[e924ddd]106    char* cert_cn;
[3b4c0d0]107        /* Current x509 Certificate SAN [Subject Alternate Name]s*/
108        char* cert_san[MAX_CERT_SAN];
109        /* A x509 Certificate Chain */
110    gnutls_x509_crt_t *certs_x509_chain;
111        /* Current x509 Certificate Private Key */
[31645b2]112    gnutls_x509_privkey_t privkey_x509;
[3b4c0d0]113        /* OpenPGP Certificate */
114    gnutls_openpgp_crt_t cert_pgp;
115        /* OpenPGP Certificate Private Key */
[e5bbda4]116    gnutls_openpgp_privkey_t privkey_pgp;
[3b4c0d0]117        /* Number of Certificates in Chain */
118    unsigned int certs_x509_chain_num;
119        /* Is the module enabled? */
[7e2b223]120    int enabled;
[7d1ab49]121    /* Export full certificates to CGI environment: */
122    int export_certificates_enabled;
[3b4c0d0]123        /* GnuTLS Priorities */
[7bebb42]124    gnutls_priority_t priorities;
[3b4c0d0]125        /* GnuTLS DH Parameters */
[a3c97d1]126    gnutls_dh_params_t dh_params;
[3b4c0d0]127        /* Cache timeout value */
[7bebb42]128    int cache_timeout;
[3b4c0d0]129        /* Chose Cache Type */
[c301152]130    mgs_cache_e cache_type;
[a66e147]131    const char* cache_config;
[7bebb42]132    const char* srp_tpasswd_file;
133    const char* srp_tpasswd_conf_file;
[3b4c0d0]134        /* A list of CA Certificates */
[8663ace]135    gnutls_x509_crt_t *ca_list;
[3b4c0d0]136        /* OpenPGP Key Ring */
[e5bbda4]137    gnutls_openpgp_keyring_t pgp_list;
[3b4c0d0]138        /* CA Certificate list size */
[7bebb42]139    unsigned int ca_list_size;
[3b4c0d0]140        /* Client Certificate Verification Mode */
[e924ddd]141    int client_verify_mode;
[3b4c0d0]142        /* Last Cache timestamp */
[f10ab4f]143    apr_time_t last_cache_check;
[3b4c0d0]144        /* GnuTLS uses Session Tickets */
145    int tickets;
146        /* Is mod_proxy enabled? */
[33826c5]147    int proxy_enabled;
[3b4c0d0]148        /* A Plain HTTP request */
[9ee0464]149    int non_ssl_request;
[c301152]150} mgs_srvconf_rec;
[7e2b223]151
[3b4c0d0]152/* Character Buffer */
[dae0aec]153typedef struct {
154    int length;
155    char *value;
[c301152]156} mgs_char_buffer_t;
[dae0aec]157
[3b4c0d0]158/* GnuTLS Handle */
159typedef struct {
160        /* Server configuration record */
[c301152]161    mgs_srvconf_rec *sc;
[3b4c0d0]162        /* Connection record */
[dae0aec]163    conn_rec* c;
[3b4c0d0]164        /* GnuTLS Session handle */
[7e2b223]165    gnutls_session_t session;
[3b4c0d0]166        /* module input status */
[dae0aec]167    apr_status_t input_rc;
[3b4c0d0]168        /* Input filter */
[7e2b223]169    ap_filter_t *input_filter;
[3b4c0d0]170        /* Input Bucket Brigade */
[7e2b223]171    apr_bucket_brigade *input_bb;
[3b4c0d0]172        /* Input Read Type */
[7e2b223]173    apr_read_type_e input_block;
[3b4c0d0]174        /* Input Mode */
[dae0aec]175    ap_input_mode_t input_mode;
[3b4c0d0]176        /* Input Character Buffer */
[c301152]177    mgs_char_buffer_t input_cbuf;
[3b4c0d0]178        /* Input Character Array */
[dae0aec]179    char input_buffer[AP_IOBUFSIZE];
[3b4c0d0]180        /* module Output status */
[dae0aec]181    apr_status_t output_rc;
[3b4c0d0]182        /* Output filter */
[dae0aec]183    ap_filter_t *output_filter;
[3b4c0d0]184        /* Output Bucket Brigade */
[dae0aec]185    apr_bucket_brigade *output_bb;
[3b4c0d0]186        /* Output character array */
[dae0aec]187    char output_buffer[AP_IOBUFSIZE];
[3b4c0d0]188        /* Output buffer length */
[dae0aec]189    apr_size_t output_blen;
[3b4c0d0]190        /* Output length */
[dae0aec]191    apr_size_t output_length;
[3b4c0d0]192        /* General Status */
[7e2b223]193    int status;
[c301152]194} mgs_handle_t;
[7e2b223]195
[3b4c0d0]196
197
[7e2b223]198/** Functions in gnutls_io.c **/
199
[fb26be5]200/* apr_signal_block() for blocking SIGPIPE */
201apr_status_t apr_signal_block(int signum);
202
[33826c5]203 /* Proxy Support */
[37f8282]204/* An optional function which returns non-zero if the given connection
205is using SSL/TLS. */
206APR_DECLARE_OPTIONAL_FN(int, ssl_is_https, (conn_rec *));
207/* The ssl_proxy_enable() and ssl_engine_disable() optional functions
208 * are used by mod_proxy to enable use of SSL for outgoing
209 * connections. */
210APR_DECLARE_OPTIONAL_FN(int, ssl_proxy_enable, (conn_rec *));
211APR_DECLARE_OPTIONAL_FN(int, ssl_engine_disable, (conn_rec *));
212int ssl_is_https(conn_rec *c);
[33826c5]213int ssl_proxy_enable(conn_rec *c);
214int ssl_engine_disable(conn_rec *c);
[37f8282]215const char *mgs_set_proxy_engine(cmd_parms * parms, void *dummy,
216    const char *arg);
217apr_status_t mgs_cleanup_pre_config(void *data);
[33826c5]218
[7e2b223]219/**
[c301152]220 * mgs_filter_input will filter the input data
[7e2b223]221 * by decrypting it using GnuTLS and passes it cleartext.
222 *
223 * @param f     the filter info record
224 * @param bb    the bucket brigade, where to store the result to
225 * @param mode  what shall we read?
226 * @param block a block index we shall read from?
227 * @return result status
228 */
[c301152]229apr_status_t mgs_filter_input(ap_filter_t * f,
[2e12226]230                                     apr_bucket_brigade * bb,
231                                     ap_input_mode_t mode,
232                                     apr_read_type_e block,
233                                     apr_off_t readbytes);
[7e2b223]234
235/**
[c301152]236 * mgs_filter_output will filter the encrypt
[7e2b223]237 * the incoming bucket using GnuTLS and passes it onto the next filter.
238 *
239 * @param f     the filter info record
240 * @param bb    the bucket brigade, where to store the result to
241 * @return result status
242 */
[c301152]243apr_status_t mgs_filter_output(ap_filter_t * f,
[2e12226]244                                      apr_bucket_brigade * bb);
[7e2b223]245
246
247/**
[c301152]248 * mgs_transport_read is called from GnuTLS to provide encrypted
[7e2b223]249 * data from the client.
250 *
251 * @param ptr     pointer to the filter context
252 * @param buffer  place to put data
253 * @param len     maximum size
254 * @return size   length of the data stored in buffer
255 */
[c301152]256ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
[2e12226]257                                  void *buffer, size_t len);
[7e2b223]258
259/**
[c301152]260 * mgs_transport_write is called from GnuTLS to
[7e2b223]261 * write data to the client.
262 *
263 * @param ptr     pointer to the filter context
264 * @param buffer  buffer to write to the client
265 * @param len     size of the buffer
266 * @return size   length of the data written
267 */
[c301152]268ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
[2e12226]269                                   const void *buffer, size_t len);
[7e2b223]270
271
[c301152]272int mgs_rehandshake(mgs_handle_t * ctxt);
[e924ddd]273
274
275
[a66e147]276/**
[fcb122d]277 * Init the Cache after Configuration is done
278 */
[c301152]279int mgs_cache_post_config(apr_pool_t *p, server_rec *s,
280                                 mgs_srvconf_rec *sc);
[fcb122d]281/**
[a66e147]282 * Init the Cache inside each Process
283 */
[c301152]284int mgs_cache_child_init(apr_pool_t *p, server_rec *s,
285                                mgs_srvconf_rec *sc);
[a66e147]286/**
287 * Setup the Session Caching
288 */
[c301152]289int mgs_cache_session_init(mgs_handle_t *ctxt);
[05d56ce]290
[42307a9]291#define GNUTLS_SESSION_ID_STRING_LEN \
292    ((GNUTLS_MAX_SESSION_ID + 1) * 2)
293   
294/**
295 * Convert a SSL Session ID into a Null Terminated Hex Encoded String
296 * @param id raw SSL Session ID
297 * @param idlen Length of the raw Session ID
298 * @param str Location to store the Hex Encoded String
299 * @param strsize The Maximum Length that can be stored in str
300 */
[c301152]301char *mgs_session_id2sz(unsigned char *id, int idlen,
[42307a9]302                                char *str, int strsize);
303
[7bebb42]304/**
305 * Convert a time_t into a Null Terminated String
306 * @param t time_t time
307 * @param str Location to store the Hex Encoded String
308 * @param strsize The Maximum Length that can be stored in str
309 */
310char *mgs_time2sz(time_t t, char *str, int strsize);
311
[c301152]312
[46b85d8]313/* Configuration Functions */
314
[7bebb42]315const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
316                                        const char *arg);
317const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
318                                        const char *arg);
319const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
320                                        const char *arg);
[46b85d8]321const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
322                                        const char *arg);
323
324const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
325                             const char *arg);
326
[e5bbda4]327const char *mgs_set_pgpcert_file(cmd_parms * parms, void *dummy,
328                                        const char *arg);
329
330const char *mgs_set_pgpkey_file(cmd_parms * parms, void *dummy,
331                             const char *arg);
332
[46b85d8]333const char *mgs_set_cache(cmd_parms * parms, void *dummy,
334                          const char *type, const char* arg);
335
336const char *mgs_set_cache_timeout(cmd_parms * parms, void *dummy,
337                                  const char *arg);
338
339const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
340                                  const char *arg);
341
342const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
343                                   const char *arg);
344
[e5bbda4]345const char *mgs_set_keyring_file(cmd_parms * parms, void *dummy,
346                                   const char *arg);
347
[46b85d8]348const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
349                            const char *arg);
[7bebb42]350const char *mgs_set_export_certificates_enabled(cmd_parms * parms, void *dummy,
351                            const char *arg);
352const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
353                            const char *arg);
[ae233c2]354const char *mgs_set_tickets(cmd_parms * parms, void *dummy,
355                            const char *arg);
[84cb5b2]356                           
357const char *mgs_set_require_section(cmd_parms *cmd,
358                                    void *mconfig, const char *arg);
[46b85d8]359void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
[040387c]360void *mgs_config_server_merge(apr_pool_t *p, void *BASE, void *ADD);
[46b85d8]361
[84cb5b2]362void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
363
[46b85d8]364void *mgs_config_dir_create(apr_pool_t *p, char *dir);
365
[84cb5b2]366const char *mgs_set_require_bytecode(cmd_parms *cmd,
367                                    void *mconfig, const char *arg);
368
[836417f]369mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
[c301152]370
371/* mod_gnutls Hooks. */
372
373int mgs_hook_pre_config(apr_pool_t * pconf,
374                        apr_pool_t * plog, apr_pool_t * ptemp);
375
376int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
377                         apr_pool_t * ptemp,
378                         server_rec * base_server);
379
380void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
381
382const char *mgs_hook_http_scheme(const request_rec * r);
383
384apr_port_t mgs_hook_default_port(const request_rec * r);
385
386int mgs_hook_pre_connection(conn_rec * c, void *csd);
387
388int mgs_hook_fixups(request_rec *r);
389
390int mgs_hook_authz(request_rec *r);
391
[7e2b223]392#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.