source: mod_gnutls/include/mod_gnutls.h.in @ 25e6b32

debian/masterdebian/stretch-backportsjessie-backportsmsvaupstream
Last change on this file since 25e6b32 was 25e6b32, checked in by Daniel Kahn Gillmor <dkg@…>, 7 years ago

remove obsolete mgs_handle_t.rsa_params -- RSA-EXPORT is not supported

This change breaks backward compatibility if anyone is trying to link
some other code to mod_gnutls. I don't think that's happening right
now, so I am willing to break backward compatibility to have a cleaner
codebase going forward.

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