bozohttpd.h revision 1.59
1 /* $NetBSD: bozohttpd.h,v 1.59 2019/02/28 08:28:21 mrg Exp $ */ 2 3 /* $eterna: bozohttpd.h,v 1.39 2011/11/18 09:21:15 mrg Exp $ */ 4 5 /* 6 * Copyright (c) 1997-2019 Matthew R. Green 7 * All rights reserved. 8 * 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. 18 * 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. 30 * 31 */ 32 #ifndef BOZOHTTOPD_H_ 33 #define BOZOHTTOPD_H_ 1 34 35 #include "netbsd_queue.h" 36 37 #include <stdbool.h> 38 #include <signal.h> 39 40 #include <sys/stat.h> 41 42 #ifndef NO_LUA_SUPPORT 43 #include <lua.h> 44 #endif 45 #include <stdio.h> 46 47 /* QNX provides a lot of NetBSD things in nbutil.h */ 48 #ifdef HAVE_NBUTIL_H 49 #include <nbutil.h> 50 #endif 51 52 /* lots of "const" but gets free()'ed etc at times, sigh */ 53 54 /* headers */ 55 typedef struct bozoheaders { 56 /*const*/ char *h_header; 57 /*const*/ char *h_value; /* this gets free()'ed etc at times */ 58 SIMPLEQ_ENTRY(bozoheaders) h_next; 59 } bozoheaders_t; 60 SIMPLEQ_HEAD(qheaders, bozoheaders); 61 62 #ifndef NO_LUA_SUPPORT 63 typedef struct lua_handler { 64 const char *name; 65 int ref; 66 SIMPLEQ_ENTRY(lua_handler) h_next; 67 } lua_handler_t; 68 69 typedef struct lua_state_map { 70 const char *script; 71 const char *prefix; 72 lua_State *L; 73 SIMPLEQ_HEAD(, lua_handler) handlers; 74 SIMPLEQ_ENTRY(lua_state_map) s_next; 75 } lua_state_map_t; 76 #endif 77 78 typedef struct bozo_content_map_t { 79 const char *name; /* postfix of file */ 80 const char *type; /* matching content-type */ 81 const char *encoding; /* matching content-encoding */ 82 const char *encoding11; /* matching content-encoding (HTTP/1.1) */ 83 const char *cgihandler; /* optional CGI handler */ 84 } bozo_content_map_t; 85 86 /* this struct holds the bozo constants */ 87 typedef struct bozo_consts_t { 88 const char *http_09; /* "HTTP/0.9" */ 89 const char *http_10; /* "HTTP/1.0" */ 90 const char *http_11; /* "HTTP/1.1" */ 91 const char *text_plain; /* "text/plain" */ 92 } bozo_consts_t; 93 94 /* this structure encapsulates all the bozo flags and control vars */ 95 typedef struct bozohttpd_t { 96 char *rootdir; /* root directory */ 97 int numeric; /* avoid gethostby*() */ 98 char *virtbase; /* virtual directory base */ 99 int unknown_slash; /* unknown vhosts go to normal slashdir */ 100 int logstderr; /* log to stderr (even if not tty) */ 101 int background; /* drop into daemon mode */ 102 int foreground; /* keep daemon mode in foreground */ 103 char *pidfile; /* path to the pid file, if any */ 104 size_t page_size; /* page size */ 105 char *slashdir; /* www slash directory */ 106 char *bindport; /* bind port; default "http" */ 107 char *bindaddress; /* address for binding - INADDR_ANY */ 108 int debug; /* debugging level */ 109 char *virthostname; /* my name */ 110 const char *server_software;/* our brand :-) */ 111 const char *index_html; /* our home page */ 112 const char *public_html; /* ~user/public_html page */ 113 int enable_users; /* enable public_html */ 114 int enable_cgi_users; /* use the cgi handler */ 115 int *sock; /* bound sockets */ 116 int nsock; /* number of above */ 117 struct pollfd *fds; /* current poll fd set */ 118 int request_times; /* # times a request was processed */ 119 int dir_indexing; /* handle directories */ 120 int hide_dots; /* hide .* */ 121 int process_cgi; /* use the cgi handler */ 122 char *cgibin; /* cgi-bin directory */ 123 unsigned ssl_timeout; /* ssl timeout */ 124 unsigned initial_timeout;/* first line timeout */ 125 unsigned header_timeout; /* header lines timeout */ 126 unsigned request_timeout;/* total session timeout */ 127 #ifndef NO_LUA_SUPPORT 128 int process_lua; /* use the Lua handler */ 129 SIMPLEQ_HEAD(, lua_state_map) lua_states; 130 #endif 131 void *sslinfo; /* pointer to ssl struct */ 132 int dynamic_content_map_size;/* size of dyn cont map */ 133 bozo_content_map_t *dynamic_content_map;/* dynamic content map */ 134 size_t mmapsz; /* size of region to mmap */ 135 char *getln_buffer; /* space for getln buffer */ 136 ssize_t getln_buflen; /* length of allocated space */ 137 char *errorbuf; /* no dynamic allocation allowed */ 138 bozo_consts_t consts; /* various constants */ 139 } bozohttpd_t; 140 141 /* bozo_httpreq_t */ 142 typedef struct bozo_httpreq_t { 143 bozohttpd_t *hr_httpd; 144 int hr_method; 145 #define HTTP_GET 0x01 146 #define HTTP_POST 0x02 147 #define HTTP_HEAD 0x03 148 #define HTTP_OPTIONS 0x04 /* not supported */ 149 #define HTTP_PUT 0x05 /* not supported */ 150 #define HTTP_DELETE 0x06 /* not supported */ 151 #define HTTP_TRACE 0x07 /* not supported */ 152 #define HTTP_CONNECT 0x08 /* not supported */ 153 const char *hr_methodstr; 154 char *hr_virthostname; /* server name (if not identical 155 to hr_httpd->virthostname) */ 156 char *hr_file; 157 char *hr_oldfile; /* if we added an index_html */ 158 char *hr_query; 159 char *hr_host; /* HTTP/1.1 Host: or virtual hostname, 160 possibly including a port number */ 161 #ifndef NO_USER_SUPPORT 162 char *hr_user; /* username if we hit userdir request */ 163 #endif /* !NO_USER_SUPPORT */ 164 const char *hr_proto; 165 const char *hr_content_type; 166 const char *hr_content_length; 167 const char *hr_allow; 168 const char *hr_referrer; 169 const char *hr_range; 170 const char *hr_if_modified_since; 171 const char *hr_accept_encoding; 172 int hr_have_range; 173 off_t hr_first_byte_pos; 174 off_t hr_last_byte_pos; 175 /*const*/ char *hr_remotehost; 176 /*const*/ char *hr_remoteaddr; 177 /*const*/ char *hr_serverport; 178 #ifdef DO_HTPASSWD 179 /*const*/ char *hr_authrealm; 180 /*const*/ char *hr_authuser; 181 /*const*/ char *hr_authpass; 182 #endif 183 struct qheaders hr_headers; 184 struct qheaders hr_replheaders; 185 unsigned hr_nheaders; 186 size_t hr_header_bytes; 187 } bozo_httpreq_t; 188 189 /* helper to access the "active" host name from a httpd/request pair */ 190 #define BOZOHOST(HTTPD,REQUEST) ((REQUEST)->hr_virthostname ? \ 191 (REQUEST)->hr_virthostname : \ 192 (HTTPD)->virthostname) 193 194 /* structure to hold string based (name, value) pairs with preferences */ 195 typedef struct bozoprefs_t { 196 size_t size; /* size of the two arrays */ 197 size_t count; /* # of entries in arrays */ 198 char **name; /* names of each entry */ 199 char **value; /* values for the name entries */ 200 } bozoprefs_t; 201 202 /* by default write in upto 64KiB chunks, and mmap in upto 64MiB chunks */ 203 #ifndef BOZO_WRSZ 204 #define BOZO_WRSZ (64 * 1024) 205 #endif 206 #ifndef BOZO_MMAPSZ 207 #define BOZO_MMAPSZ (BOZO_WRSZ * 1024) 208 #endif 209 210 /* only allow this many total headers bytes */ 211 #define BOZO_HEADERS_MAX_SIZE (16 * 1024) 212 213 /* debug flags */ 214 #define DEBUG_NORMAL 1 215 #define DEBUG_FAT 2 216 #define DEBUG_OBESE 3 217 #define DEBUG_EXPLODING 4 218 219 #define strornull(x) ((x) ? (x) : "<null>") 220 221 #if (defined(__GNUC__) && __GNUC__ >= 3) || defined(__lint__) 222 #define BOZO_PRINTFLIKE(x,y) __attribute__((__format__(__printf__, x,y))) 223 #define BOZO_DEAD __attribute__((__noreturn__)) 224 #define BOZO_CHECKRET __attribute__((__warn_unused_result__)) 225 #else 226 #define BOZO_PRINTFLIKE(x,y) 227 #define BOZO_DEAD 228 #define BOZO_CHECKRET 229 #endif 230 231 #ifdef NO_DEBUG 232 #define debug(x) 233 #define have_debug (0) 234 #else 235 void debug__(bozohttpd_t *, int, const char *, ...) BOZO_PRINTFLIKE(3, 4); 236 #define debug(x) debug__ x 237 #define have_debug (1) 238 #endif /* NO_DEBUG */ 239 240 /* 241 * bozohttpd special files. avoid serving these out. 242 * 243 * When you add some .bz* file, make sure to also check it in 244 * bozo_check_special_files() 245 */ 246 247 #ifndef DIRECT_ACCESS_FILE 248 #define DIRECT_ACCESS_FILE ".bzdirect" 249 #endif 250 #ifndef REDIRECT_FILE 251 #define REDIRECT_FILE ".bzredirect" 252 #endif 253 #ifndef ABSREDIRECT_FILE 254 #define ABSREDIRECT_FILE ".bzabsredirect" 255 #endif 256 #ifndef REMAP_FILE 257 #define REMAP_FILE ".bzremap" 258 #endif 259 #ifndef AUTH_FILE 260 #define AUTH_FILE ".htpasswd" 261 #endif 262 263 /* be sure to always return this error up */ 264 int bozo_http_error(bozohttpd_t *, int, bozo_httpreq_t *, const char *); 265 266 int bozo_check_special_files(bozo_httpreq_t *, const char *, bool) BOZO_CHECKRET; 267 char *bozo_http_date(char *, size_t); 268 void bozo_print_header(bozo_httpreq_t *, struct stat *, const char *, 269 const char *); 270 char *bozo_escape_rfc3986(bozohttpd_t *httpd, const char *url, int absolute); 271 char *bozo_escape_html(bozohttpd_t *httpd, const char *url); 272 int bozo_decode_url_percent(bozo_httpreq_t *, char *); 273 274 /* these are similar to libc functions, no underscore here */ 275 void bozowarn(bozohttpd_t *, const char *, ...) 276 BOZO_PRINTFLIKE(2, 3); 277 void bozoerr(bozohttpd_t *, int, const char *, ...) 278 BOZO_PRINTFLIKE(3, 4) 279 BOZO_DEAD; 280 void bozoasprintf(bozohttpd_t *, char **, const char *, ...) 281 BOZO_PRINTFLIKE(3, 4); 282 char *bozodgetln(bozohttpd_t *, int, ssize_t *, ssize_t (*)(bozohttpd_t *, 283 int, void *, size_t)); 284 char *bozostrnsep(char **, const char *, ssize_t *); 285 void *bozomalloc(bozohttpd_t *, size_t); 286 void *bozorealloc(bozohttpd_t *, void *, size_t); 287 char *bozostrdup(bozohttpd_t *, bozo_httpreq_t *, const char *); 288 289 #define bozo_noop do { /* nothing */ } while (/*CONSTCOND*/0) 290 291 #define have_all (1) 292 293 /* ssl-bozo.c */ 294 #ifdef NO_SSL_SUPPORT 295 #define bozo_ssl_set_opts(w, x, y) bozo_noop 296 #define bozo_ssl_set_ciphers(w, x) bozo_noop 297 #define bozo_ssl_init(x) bozo_noop 298 #define bozo_ssl_accept(x) (0) 299 #define bozo_ssl_destroy(x) bozo_noop 300 #define have_ssl (0) 301 #else 302 void bozo_ssl_set_opts(bozohttpd_t *, const char *, const char *); 303 void bozo_ssl_set_ciphers(bozohttpd_t *, const char *); 304 void bozo_ssl_init(bozohttpd_t *); 305 int bozo_ssl_accept(bozohttpd_t *); 306 void bozo_ssl_destroy(bozohttpd_t *); 307 #define have_ssl (1) 308 #endif 309 310 311 /* auth-bozo.c */ 312 #ifdef DO_HTPASSWD 313 void bozo_auth_init(bozo_httpreq_t *); 314 int bozo_auth_check(bozo_httpreq_t *, const char *); 315 void bozo_auth_cleanup(bozo_httpreq_t *); 316 int bozo_auth_check_headers(bozo_httpreq_t *, char *, char *, ssize_t); 317 void bozo_auth_check_401(bozo_httpreq_t *, int); 318 void bozo_auth_cgi_setenv(bozo_httpreq_t *, char ***); 319 int bozo_auth_cgi_count(bozo_httpreq_t *); 320 #else 321 #define bozo_auth_init(x) bozo_noop 322 #define bozo_auth_check(x, y) (0) 323 #define bozo_auth_cleanup(x) bozo_noop 324 #define bozo_auth_check_headers(y, z, a, b) (0) 325 #define bozo_auth_check_401(x, y) bozo_noop 326 #define bozo_auth_cgi_setenv(x, y) bozo_noop 327 #define bozo_auth_cgi_count(x) (0) 328 #endif /* DO_HTPASSWD */ 329 330 331 /* cgi-bozo.c */ 332 #ifdef NO_CGIBIN_SUPPORT 333 #define bozo_cgi_setbin(h,s) bozo_noop 334 #define bozo_process_cgi(h) (0) 335 #define have_cgibin (0) 336 #else 337 void bozo_cgi_setbin(bozohttpd_t *, const char *); 338 void bozo_setenv(bozohttpd_t *, const char *, const char *, char **); 339 int bozo_process_cgi(bozo_httpreq_t *); 340 #define have_cgibin (1) 341 #endif /* NO_CGIBIN_SUPPORT */ 342 343 344 /* lua-bozo.c */ 345 #ifdef NO_LUA_SUPPORT 346 #define bozo_process_lua(h) (0) 347 #define bozo_add_lua_map(h,s,t) bozo_noop 348 #define have_lua (0) 349 #else 350 void bozo_add_lua_map(bozohttpd_t *, const char *, const char *); 351 int bozo_process_lua(bozo_httpreq_t *); 352 #define have_lua (1) 353 #endif /* NO_LUA_SUPPORT */ 354 355 356 /* daemon-bozo.c */ 357 #ifdef NO_DAEMON_MODE 358 #define bozo_daemon_init(x) bozo_noop 359 #define bozo_daemon_fork(x) (0) 360 #define bozo_daemon_closefds(x) bozo_noop 361 #define have_daemon_mode (0) 362 #else 363 void bozo_daemon_init(bozohttpd_t *); 364 int bozo_daemon_fork(bozohttpd_t *); 365 void bozo_daemon_closefds(bozohttpd_t *); 366 #define have_daemon_mode (1) 367 #endif /* NO_DAEMON_MODE */ 368 369 370 /* tilde-luzah-bozo.c */ 371 #ifdef NO_USER_SUPPORT 372 #define bozo_user_transform(x) (0) 373 #define bozo_user_free(x) /* nothing */ 374 #define have_user (0) 375 #else 376 int bozo_user_transform(bozo_httpreq_t *); 377 #define bozo_user_free(x) free(x) 378 #define have_user (1) 379 #endif /* NO_USER_SUPPORT */ 380 381 382 /* dir-index-bozo.c */ 383 #ifdef NO_DIRINDEX_SUPPORT 384 #define bozo_dir_index(a, b, c) (0) 385 #define have_dirindex (0) 386 #else 387 int bozo_dir_index(bozo_httpreq_t *, const char *, int); 388 #define have_dirindex (1) 389 #endif /* NO_DIRINDEX_SUPPORT */ 390 391 392 /* content-bozo.c */ 393 const char *bozo_content_type(bozo_httpreq_t *, const char *); 394 const char *bozo_content_encoding(bozo_httpreq_t *, const char *); 395 bozo_content_map_t *bozo_match_content_map(bozohttpd_t *, const char *, int); 396 bozo_content_map_t *bozo_get_content_map(bozohttpd_t *, const char *); 397 #ifdef NO_DYNAMIC_CONTENT 398 #define bozo_add_content_map_mime(h,s,t,u,v) bozo_noop 399 #define have_dynamic_content (0) 400 #else 401 void bozo_add_content_map_mime(bozohttpd_t *, const char *, const char *, 402 const char *, const char *); 403 #define have_dynamic_content (1) 404 #endif 405 406 /* additional cgi-bozo.c */ 407 #if have_cgibin && have_dynamic_content 408 void bozo_add_content_map_cgi(bozohttpd_t *, const char *, const char *); 409 #else 410 #define bozo_add_content_map_cgi(h,s,t) 411 #endif 412 413 /* I/O */ 414 int bozo_printf(bozohttpd_t *, const char *, ...) BOZO_PRINTFLIKE(2, 3); 415 ssize_t bozo_read(bozohttpd_t *, int, void *, size_t); 416 ssize_t bozo_write(bozohttpd_t *, int, const void *, size_t); 417 int bozo_flush(bozohttpd_t *, FILE *); 418 419 /* misc */ 420 int bozo_init_httpd(bozohttpd_t *); 421 int bozo_init_prefs(bozohttpd_t *, bozoprefs_t *); 422 int bozo_set_defaults(bozohttpd_t *, bozoprefs_t *); 423 int bozo_setup(bozohttpd_t *, bozoprefs_t *, const char *, const char *); 424 bozo_httpreq_t *bozo_read_request(bozohttpd_t *); 425 void bozo_process_request(bozo_httpreq_t *); 426 void bozo_clean_request(bozo_httpreq_t *); 427 int bozo_set_timeout(bozohttpd_t *, bozoprefs_t *, const char *, const char *); 428 bozoheaders_t *addmerge_reqheader(bozo_httpreq_t *, const char *, 429 const char *, ssize_t); 430 bozoheaders_t *addmerge_replheader(bozo_httpreq_t *, const char *, 431 const char *, ssize_t); 432 433 /* variables */ 434 int bozo_set_pref(bozohttpd_t *, bozoprefs_t *, const char *, const char *); 435 char *bozo_get_pref(bozoprefs_t *, const char *); 436 437 int bozo_get_version(char */*buf*/, size_t /*size*/); 438 439 extern volatile sig_atomic_t bozo_timeout_hit; 440 441 #endif /* BOZOHTTOPD_H_ */ 442
Indexes created Wed Oct 01 07:09:59 GMT 2025