Remove building with NOCRYPTO option
[minix.git] / libexec / httpd / bozohttpd.h
blob861f88e6ccd0941b9038d58cade3aaa76a559523
1 /* $NetBSD: bozohttpd.h,v 1.36 2015/08/05 06:50:44 mrg Exp $ */
3 /* $eterna: bozohttpd.h,v 1.39 2011/11/18 09:21:15 mrg Exp $ */
5 /*
6 * Copyright (c) 1997-2015 Matthew R. Green
7 * All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer and
16 * dedication in the documentation and/or other materials provided
17 * with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
32 #ifndef BOZOHTTOPD_H_
33 #define BOZOHTTOPD_H_ 1
35 #include "netbsd_queue.h"
37 #include <sys/stat.h>
39 #ifndef NO_LUA_SUPPORT
40 #include <lua.h>
41 #endif
42 #include <stdio.h>
44 /* QNX provides a lot of NetBSD things in nbutil.h */
45 #ifdef USE_NBUTIL
46 #include <nbutil.h>
47 #endif
49 /* lots of "const" but gets free()'ed etc at times, sigh */
51 /* headers */
52 typedef struct bozoheaders {
53 /*const*/ char *h_header;
54 /*const*/ char *h_value; /* this gets free()'ed etc at times */
55 SIMPLEQ_ENTRY(bozoheaders) h_next;
56 } bozoheaders_t;
58 #ifndef NO_LUA_SUPPORT
59 typedef struct lua_handler {
60 const char *name;
61 int ref;
62 SIMPLEQ_ENTRY(lua_handler) h_next;
63 } lua_handler_t;
65 typedef struct lua_state_map {
66 const char *script;
67 const char *prefix;
68 lua_State *L;
69 SIMPLEQ_HEAD(, lua_handler) handlers;
70 SIMPLEQ_ENTRY(lua_state_map) s_next;
71 } lua_state_map_t;
72 #endif
74 typedef struct bozo_content_map_t {
75 const char *name; /* postfix of file */
76 const char *type; /* matching content-type */
77 const char *encoding; /* matching content-encoding */
78 const char *encoding11; /* matching content-encoding (HTTP/1.1) */
79 const char *cgihandler; /* optional CGI handler */
80 } bozo_content_map_t;
82 /* this struct holds the bozo constants */
83 typedef struct bozo_consts_t {
84 const char *http_09; /* "HTTP/0.9" */
85 const char *http_10; /* "HTTP/1.0" */
86 const char *http_11; /* "HTTP/1.1" */
87 const char *text_plain; /* "text/plain" */
88 } bozo_consts_t;
90 /* this structure encapsulates all the bozo flags and control vars */
91 typedef struct bozohttpd_t {
92 char *rootdir; /* root directory */
93 char *username; /* username to switch to */
94 int numeric; /* avoid gethostby*() */
95 char *virtbase; /* virtual directory base */
96 int unknown_slash; /* unknown vhosts go to normal slashdir */
97 int untrustedref; /* make sure referrer = me unless url = / */
98 int logstderr; /* log to stderr (even if not tty) */
99 int background; /* drop into daemon mode */
100 int foreground; /* keep daemon mode in foreground */
101 char *pidfile; /* path to the pid file, if any */
102 size_t page_size; /* page size */
103 char *slashdir; /* www slash directory */
104 char *bindport; /* bind port; default "http" */
105 char *bindaddress; /* address for binding - INADDR_ANY */
106 int debug; /* debugging level */
107 char *virthostname; /* my name */
108 const char *server_software;/* our brand :-) */
109 const char *index_html; /* our home page */
110 const char *public_html; /* ~user/public_html page */
111 int enable_users; /* enable public_html */
112 int *sock; /* bound sockets */
113 int nsock; /* number of above */
114 struct pollfd *fds; /* current poll fd set */
115 int request_times; /* # times a request was processed */
116 int dir_indexing; /* handle directories */
117 int hide_dots; /* hide .* */
118 int process_cgi; /* use the cgi handler */
119 char *cgibin; /* cgi-bin directory */
120 #ifndef NO_LUA_SUPPORT
121 int process_lua; /* use the Lua handler */
122 SIMPLEQ_HEAD(, lua_state_map) lua_states;
123 #endif
124 void *sslinfo; /* pointer to ssl struct */
125 int dynamic_content_map_size;/* size of dyn cont map */
126 bozo_content_map_t *dynamic_content_map;/* dynamic content map */
127 size_t mmapsz; /* size of region to mmap */
128 char *getln_buffer; /* space for getln buffer */
129 ssize_t getln_buflen; /* length of allocated space */
130 char *errorbuf; /* no dynamic allocation allowed */
131 bozo_consts_t consts; /* various constants */
132 } bozohttpd_t;
134 /* bozo_httpreq_t */
135 typedef struct bozo_httpreq_t {
136 bozohttpd_t *hr_httpd;
137 int hr_method;
138 #define HTTP_GET 0x01
139 #define HTTP_POST 0x02
140 #define HTTP_HEAD 0x03
141 #define HTTP_OPTIONS 0x04 /* not supported */
142 #define HTTP_PUT 0x05 /* not supported */
143 #define HTTP_DELETE 0x06 /* not supported */
144 #define HTTP_TRACE 0x07 /* not supported */
145 #define HTTP_CONNECT 0x08 /* not supported */
146 const char *hr_methodstr;
147 char *hr_virthostname; /* server name (if not identical
148 to hr_httpd->virthostname) */
149 char *hr_file;
150 char *hr_oldfile; /* if we added an index_html */
151 char *hr_query;
152 char *hr_host; /* HTTP/1.1 Host: or virtual hostname,
153 possibly including a port number */
154 const char *hr_proto;
155 const char *hr_content_type;
156 const char *hr_content_length;
157 const char *hr_allow;
158 const char *hr_referrer;
159 const char *hr_range;
160 const char *hr_if_modified_since;
161 const char *hr_accept_encoding;
162 int hr_have_range;
163 off_t hr_first_byte_pos;
164 off_t hr_last_byte_pos;
165 /*const*/ char *hr_remotehost;
166 /*const*/ char *hr_remoteaddr;
167 /*const*/ char *hr_serverport;
168 #ifdef DO_HTPASSWD
169 /*const*/ char *hr_authrealm;
170 /*const*/ char *hr_authuser;
171 /*const*/ char *hr_authpass;
172 #endif
173 SIMPLEQ_HEAD(, bozoheaders) hr_headers;
174 int hr_nheaders;
175 } bozo_httpreq_t;
177 /* helper to access the "active" host name from a httpd/request pair */
178 #define BOZOHOST(HTTPD,REQUEST) ((REQUEST)->hr_virthostname ? \
179 (REQUEST)->hr_virthostname : \
180 (HTTPD)->virthostname)
182 /* structure to hold string based (name, value) pairs with preferences */
183 typedef struct bozoprefs_t {
184 unsigned size; /* size of the two arrays */
185 unsigned c; /* # of entries in arrays */
186 char **name; /* names of each entry */
187 char **value; /* values for the name entries */
188 } bozoprefs_t;
190 /* by default write in upto 64KiB chunks, and mmap in upto 64MiB chunks */
191 #ifndef BOZO_WRSZ
192 #define BOZO_WRSZ (64 * 1024)
193 #endif
194 #ifndef BOZO_MMAPSZ
195 #define BOZO_MMAPSZ (BOZO_WRSZ * 1024)
196 #endif
198 /* debug flags */
199 #define DEBUG_NORMAL 1
200 #define DEBUG_FAT 2
201 #define DEBUG_OBESE 3
202 #define DEBUG_EXPLODING 4
204 #define strornull(x) ((x) ? (x) : "<null>")
206 #if defined(__GNUC__) && __GNUC__ >= 3
207 #define BOZO_PRINTFLIKE(x,y) __attribute__((__format__(__printf__, x,y)))
208 #define BOZO_DEAD __attribute__((__noreturn__))
209 #endif
211 #ifndef NO_DEBUG
212 void debug__(bozohttpd_t *, int, const char *, ...) BOZO_PRINTFLIKE(3, 4);
213 #define debug(x) debug__ x
214 #else
215 #define debug(x)
216 #endif /* NO_DEBUG */
218 void bozo_warn(bozohttpd_t *, const char *, ...)
219 BOZO_PRINTFLIKE(2, 3);
220 void bozo_err(bozohttpd_t *, int, const char *, ...)
221 BOZO_PRINTFLIKE(3, 4)
222 BOZO_DEAD;
223 int bozo_http_error(bozohttpd_t *, int, bozo_httpreq_t *, const char *);
225 int bozo_check_special_files(bozo_httpreq_t *, const char *);
226 char *bozo_http_date(char *, size_t);
227 void bozo_print_header(bozo_httpreq_t *, struct stat *, const char *, const char *);
228 char *bozo_escape_rfc3986(bozohttpd_t *httpd, const char *url);
229 char *bozo_escape_html(bozohttpd_t *httpd, const char *url);
231 char *bozodgetln(bozohttpd_t *, int, ssize_t *, ssize_t (*)(bozohttpd_t *, int, void *, size_t));
232 char *bozostrnsep(char **, const char *, ssize_t *);
234 void *bozomalloc(bozohttpd_t *, size_t);
235 void *bozorealloc(bozohttpd_t *, void *, size_t);
236 char *bozostrdup(bozohttpd_t *, const char *);
238 /* ssl-bozo.c */
239 #ifdef NO_SSL_SUPPORT
240 #define bozo_ssl_set_opts(w, x, y) do { /* nothing */ } while (0)
241 #define bozo_ssl_init(x) do { /* nothing */ } while (0)
242 #define bozo_ssl_accept(x) (0)
243 #define bozo_ssl_destroy(x) do { /* nothing */ } while (0)
244 #else
245 void bozo_ssl_set_opts(bozohttpd_t *, const char *, const char *);
246 void bozo_ssl_init(bozohttpd_t *);
247 int bozo_ssl_accept(bozohttpd_t *);
248 void bozo_ssl_destroy(bozohttpd_t *);
249 #endif
252 /* auth-bozo.c */
253 #ifdef DO_HTPASSWD
254 void bozo_auth_init(bozo_httpreq_t *);
255 int bozo_auth_check(bozo_httpreq_t *, const char *);
256 void bozo_auth_cleanup(bozo_httpreq_t *);
257 int bozo_auth_check_headers(bozo_httpreq_t *, char *, char *, ssize_t);
258 int bozo_auth_check_special_files(bozo_httpreq_t *, const char *);
259 void bozo_auth_check_401(bozo_httpreq_t *, int);
260 void bozo_auth_cgi_setenv(bozo_httpreq_t *, char ***);
261 int bozo_auth_cgi_count(bozo_httpreq_t *);
262 #else
263 #define bozo_auth_init(x) do { /* nothing */ } while (0)
264 #define bozo_auth_check(x, y) 0
265 #define bozo_auth_cleanup(x) do { /* nothing */ } while (0)
266 #define bozo_auth_check_headers(y, z, a, b) 0
267 #define bozo_auth_check_special_files(x, y) 0
268 #define bozo_auth_check_401(x, y) do { /* nothing */ } while (0)
269 #define bozo_auth_cgi_setenv(x, y) do { /* nothing */ } while (0)
270 #define bozo_auth_cgi_count(x) 0
271 #endif /* DO_HTPASSWD */
274 /* cgi-bozo.c */
275 #ifdef NO_CGIBIN_SUPPORT
276 #define bozo_process_cgi(h) 0
277 #else
278 void bozo_cgi_setbin(bozohttpd_t *, const char *);
279 void bozo_setenv(bozohttpd_t *, const char *, const char *, char **);
280 int bozo_process_cgi(bozo_httpreq_t *);
281 void bozo_add_content_map_cgi(bozohttpd_t *, const char *, const char *);
282 #endif /* NO_CGIBIN_SUPPORT */
285 /* lua-bozo.c */
286 #ifdef NO_LUA_SUPPORT
287 #define bozo_process_lua(h) 0
288 #else
289 void bozo_add_lua_map(bozohttpd_t *, const char *, const char *);
290 int bozo_process_lua(bozo_httpreq_t *);
291 #endif /* NO_LUA_SUPPORT */
294 /* daemon-bozo.c */
295 #ifdef NO_DAEMON_MODE
296 #define bozo_daemon_init(x) do { /* nothing */ } while (0)
297 #define bozo_daemon_fork(x) 0
298 #define bozo_daemon_closefds(x) do { /* nothing */ } while (0)
299 #else
300 void bozo_daemon_init(bozohttpd_t *);
301 int bozo_daemon_fork(bozohttpd_t *);
302 void bozo_daemon_closefds(bozohttpd_t *);
303 #endif /* NO_DAEMON_MODE */
306 /* tilde-luzah-bozo.c */
307 #ifdef NO_USER_SUPPORT
308 #define bozo_user_transform(a, c) 0
309 #else
310 int bozo_user_transform(bozo_httpreq_t *, int *);
311 #endif /* NO_USER_SUPPORT */
314 /* dir-index-bozo.c */
315 #ifdef NO_DIRINDEX_SUPPORT
316 #define bozo_dir_index(a, b, c) 0
317 #else
318 int bozo_dir_index(bozo_httpreq_t *, const char *, int);
319 #endif /* NO_DIRINDEX_SUPPORT */
322 /* content-bozo.c */
323 const char *bozo_content_type(bozo_httpreq_t *, const char *);
324 const char *bozo_content_encoding(bozo_httpreq_t *, const char *);
325 bozo_content_map_t *bozo_match_content_map(bozohttpd_t *, const char *, int);
326 bozo_content_map_t *bozo_get_content_map(bozohttpd_t *, const char *);
327 #ifndef NO_DYNAMIC_CONTENT
328 void bozo_add_content_map_mime(bozohttpd_t *, const char *, const char *, const char *, const char *);
329 #endif
331 /* I/O */
332 int bozo_printf(bozohttpd_t *, const char *, ...) BOZO_PRINTFLIKE(2, 3);;
333 ssize_t bozo_read(bozohttpd_t *, int, void *, size_t);
334 ssize_t bozo_write(bozohttpd_t *, int, const void *, size_t);
335 int bozo_flush(bozohttpd_t *, FILE *);
337 /* misc */
338 int bozo_init_httpd(bozohttpd_t *);
339 int bozo_init_prefs(bozoprefs_t *);
340 int bozo_set_defaults(bozohttpd_t *, bozoprefs_t *);
341 int bozo_setup(bozohttpd_t *, bozoprefs_t *, const char *, const char *);
342 bozo_httpreq_t *bozo_read_request(bozohttpd_t *);
343 void bozo_process_request(bozo_httpreq_t *);
344 void bozo_clean_request(bozo_httpreq_t *);
346 /* variables */
347 int bozo_set_pref(bozoprefs_t *, const char *, const char *);
348 char *bozo_get_pref(bozoprefs_t *, const char *);
350 #endif /* BOZOHTTOPD_H_ */