source: mod_gnutls/include/mod_gnutls.h.in @ a3c97d1

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

better handling of RSAFile and DHFile

  • Property mode set to 100644
File size: 8.9 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#include "httpd.h"
19#include "http_config.h"
20#include "http_protocol.h"
21#include "http_connection.h"
22#include "http_request.h"
23#include "http_core.h"
24#include "http_log.h"
25#include "apr_buckets.h"
26#include "apr_strings.h"
27#include "apr_tables.h"
28#include "ap_release.h"
29
30#include <gcrypt.h>
31#include <gnutls/gnutls.h>
32#include <gnutls/x509.h>
33
34#ifndef __mod_gnutls_h_inc
35#define __mod_gnutls_h_inc
36
37#define HAVE_APR_MEMCACHE    @have_apr_memcache@
38
39module AP_MODULE_DECLARE_DATA gnutls_module;
40
41#define GNUTLS_OUTPUT_FILTER_NAME "gnutls_output_filter"
42#define GNUTLS_INPUT_FILTER_NAME "gnutls_input_filter"
43
44#define GNUTLS_ENABLED_FALSE 0
45#define GNUTLS_ENABLED_TRUE  1
46
47#define MOD_GNUTLS_VERSION "@MOD_GNUTLS_VERSION@"
48
49#define MOD_GNUTLS_DEBUG @OOO_MAINTAIN@
50
51/* Recent Versions of 2.1 renamed several hooks. This allows us to
52   compile on 2.0.xx  */
53#if AP_SERVER_MINORVERSION_NUMBER >= 1
54#if AP_SERVER_PATCHLEVEL_NUMBER >= 3
55#define USING_2_1_RECENT 1
56#endif
57#endif
58
59#ifndef USING_2_1_RECENT
60#define USING_2_1_RECENT 0
61#endif
62
63typedef enum
64{
65    mgs_cache_none,
66    mgs_cache_dbm,
67#if HAVE_APR_MEMCACHE
68    mgs_cache_memcache
69#endif
70} mgs_cache_e;
71
72typedef struct
73{
74    int client_verify_mode;
75    const char* lua_bytecode;
76    apr_size_t lua_bytecode_len;
77} mgs_dirconf_rec;
78
79
80/* The maximum number of client CA certificates allowed.
81 */
82#define MAX_CA_CRTS 128
83#define MAX_CIPHERS 16
84
85typedef struct
86{
87    gnutls_certificate_credentials_t certs;
88    gnutls_srp_server_credentials_t srp_creds;
89    gnutls_anon_server_credentials_t anon_creds;
90    char* cert_cn;
91    gnutls_x509_crt_t cert_x509;
92    gnutls_x509_privkey_t privkey_x509;
93    int enabled;
94    /* whether to send the PEM encoded certificates
95     * to CGIs
96     */
97    int export_certificates_enabled;
98    gnutls_priority_t priorities;
99    gnutls_rsa_params_t rsa_params;
100    gnutls_dh_params_t dh_params;
101    int cache_timeout;
102    mgs_cache_e cache_type;
103    const char* cache_config;
104    const char* srp_tpasswd_file;
105    const char* srp_tpasswd_conf_file;
106    gnutls_x509_crt_t ca_list[MAX_CA_CRTS];
107    unsigned int ca_list_size;
108    int client_verify_mode;
109} mgs_srvconf_rec;
110
111typedef struct {
112    int length;
113    char *value;
114} mgs_char_buffer_t;
115
116typedef struct
117{
118    mgs_srvconf_rec *sc;
119    conn_rec* c;
120    gnutls_session_t session;
121
122    apr_status_t input_rc;
123    ap_filter_t *input_filter;
124    apr_bucket_brigade *input_bb;
125    apr_read_type_e input_block;
126    ap_input_mode_t input_mode;
127    mgs_char_buffer_t input_cbuf;
128    char input_buffer[AP_IOBUFSIZE];
129
130    apr_status_t output_rc;
131    ap_filter_t *output_filter;
132    apr_bucket_brigade *output_bb;
133    char output_buffer[AP_IOBUFSIZE];
134    apr_size_t output_blen;
135    apr_size_t output_length;
136
137    int status;
138    int non_https;
139} mgs_handle_t;
140
141/** Functions in gnutls_io.c **/
142
143/**
144 * mgs_filter_input will filter the input data
145 * by decrypting it using GnuTLS and passes it cleartext.
146 *
147 * @param f     the filter info record
148 * @param bb    the bucket brigade, where to store the result to
149 * @param mode  what shall we read?
150 * @param block a block index we shall read from?
151 * @return result status
152 */
153apr_status_t mgs_filter_input(ap_filter_t * f,
154                                     apr_bucket_brigade * bb,
155                                     ap_input_mode_t mode,
156                                     apr_read_type_e block,
157                                     apr_off_t readbytes);
158
159/**
160 * mgs_filter_output will filter the encrypt
161 * the incoming bucket using GnuTLS and passes it onto the next filter.
162 *
163 * @param f     the filter info record
164 * @param bb    the bucket brigade, where to store the result to
165 * @return result status
166 */
167apr_status_t mgs_filter_output(ap_filter_t * f,
168                                      apr_bucket_brigade * bb);
169
170
171/**
172 * mgs_transport_read is called from GnuTLS to provide encrypted
173 * data from the client.
174 *
175 * @param ptr     pointer to the filter context
176 * @param buffer  place to put data
177 * @param len     maximum size
178 * @return size   length of the data stored in buffer
179 */
180ssize_t mgs_transport_read(gnutls_transport_ptr_t ptr,
181                                  void *buffer, size_t len);
182
183/**
184 * mgs_transport_write is called from GnuTLS to
185 * write data to the client.
186 *
187 * @param ptr     pointer to the filter context
188 * @param buffer  buffer to write to the client
189 * @param len     size of the buffer
190 * @return size   length of the data written
191 */
192ssize_t mgs_transport_write(gnutls_transport_ptr_t ptr,
193                                   const void *buffer, size_t len);
194
195
196int mgs_rehandshake(mgs_handle_t * ctxt);
197
198
199
200/**
201 * Init the Cache after Configuration is done
202 */
203int mgs_cache_post_config(apr_pool_t *p, server_rec *s,
204                                 mgs_srvconf_rec *sc);
205/**
206 * Init the Cache inside each Process
207 */
208int mgs_cache_child_init(apr_pool_t *p, server_rec *s,
209                                mgs_srvconf_rec *sc);
210/**
211 * Setup the Session Caching
212 */
213int mgs_cache_session_init(mgs_handle_t *ctxt);
214
215#define GNUTLS_SESSION_ID_STRING_LEN \
216    ((GNUTLS_MAX_SESSION_ID + 1) * 2)
217   
218/**
219 * Convert a SSL Session ID into a Null Terminated Hex Encoded String
220 * @param id raw SSL Session ID
221 * @param idlen Length of the raw Session ID
222 * @param str Location to store the Hex Encoded String
223 * @param strsize The Maximum Length that can be stored in str
224 */
225char *mgs_session_id2sz(unsigned char *id, int idlen,
226                                char *str, int strsize);
227
228/**
229 * Convert a time_t into a Null Terminated String
230 * @param t time_t time
231 * @param str Location to store the Hex Encoded String
232 * @param strsize The Maximum Length that can be stored in str
233 */
234char *mgs_time2sz(time_t t, char *str, int strsize);
235
236
237/* Configuration Functions */
238
239const char *mgs_set_srp_tpasswd_conf_file(cmd_parms * parms, void *dummy,
240                                        const char *arg);
241const char *mgs_set_srp_tpasswd_file(cmd_parms * parms, void *dummy,
242                                        const char *arg);
243const char *mgs_set_dh_file(cmd_parms * parms, void *dummy,
244                                        const char *arg);
245const char *mgs_set_rsa_export_file(cmd_parms * parms, void *dummy,
246                                        const char *arg);
247const char *mgs_set_cert_file(cmd_parms * parms, void *dummy,
248                                        const char *arg);
249
250const char *mgs_set_key_file(cmd_parms * parms, void *dummy,
251                             const char *arg);
252
253const char *mgs_set_cache(cmd_parms * parms, void *dummy,
254                          const char *type, const char* arg);
255
256const char *mgs_set_cache_timeout(cmd_parms * parms, void *dummy,
257                                  const char *arg);
258
259const char *mgs_set_client_verify(cmd_parms * parms, void *dummy,
260                                  const char *arg);
261
262const char *mgs_set_client_ca_file(cmd_parms * parms, void *dummy,
263                                   const char *arg);
264
265const char *mgs_set_enabled(cmd_parms * parms, void *dummy,
266                            const char *arg);
267const char *mgs_set_export_certificates_enabled(cmd_parms * parms, void *dummy,
268                            const char *arg);
269const char *mgs_set_priorities(cmd_parms * parms, void *dummy,
270                            const char *arg);
271                           
272const char *mgs_set_require_section(cmd_parms *cmd,
273                                    void *mconfig, const char *arg);
274void *mgs_config_server_create(apr_pool_t * p, server_rec * s);
275
276void *mgs_config_dir_merge(apr_pool_t *p, void *basev, void *addv);
277
278void *mgs_config_dir_create(apr_pool_t *p, char *dir);
279
280const char *mgs_set_require_bytecode(cmd_parms *cmd,
281                                    void *mconfig, const char *arg);
282
283mgs_srvconf_rec* mgs_find_sni_server(gnutls_session_t session);
284
285/* mod_gnutls Hooks. */
286
287int mgs_hook_pre_config(apr_pool_t * pconf,
288                        apr_pool_t * plog, apr_pool_t * ptemp);
289
290int mgs_hook_post_config(apr_pool_t * p, apr_pool_t * plog,
291                         apr_pool_t * ptemp,
292                         server_rec * base_server);
293
294void mgs_hook_child_init(apr_pool_t *p, server_rec *s);
295
296const char *mgs_hook_http_scheme(const request_rec * r);
297
298apr_port_t mgs_hook_default_port(const request_rec * r);
299
300int mgs_hook_pre_connection(conn_rec * c, void *csd);
301
302int mgs_hook_fixups(request_rec *r);
303
304int mgs_hook_authz(request_rec *r);
305
306int mgs_authz_lua(request_rec* r);
307
308#endif /*  __mod_gnutls_h_inc */
Note: See TracBrowser for help on using the repository browser.