1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.50 2002/03/04 19:32:07 oes Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
8 * Purpose : Defines data structures which are widely used in the
9 * project. Does not define any variables or functions
10 * (though it does declare some macros).
12 * Copyright : Written by and Copyright (C) 2001 the SourceForge
13 * IJBSWA team. http://ijbswa.sourceforge.net
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
19 * This program is free software; you can redistribute it
20 * and/or modify it under the terms of the GNU General
21 * Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at
23 * your option) any later version.
25 * This program is distributed in the hope that it will
26 * be useful, but WITHOUT ANY WARRANTY; without even the
27 * implied warranty of MERCHANTABILITY or FITNESS FOR A
28 * PARTICULAR PURPOSE. See the GNU General Public
29 * License for more details.
31 * The GNU General Public License should be included with
32 * this file. If not, you can view it at
33 * http://www.gnu.org/copyleft/gpl.html
34 * or write to the Free Software Foundation, Inc., 59
35 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
39 * Revision 1.50 2002/03/04 19:32:07 oes
40 * Changed default port to 8118
42 * Revision 1.49 2002/03/04 18:28:55 oes
43 * Deleted PID_FILE_NAME
45 * Revision 1.48 2002/03/03 14:50:40 oes
46 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
48 * Revision 1.47 2002/02/20 23:15:13 jongfoster
49 * Parsing functions now handle out-of-memory gracefully by returning
52 * Revision 1.46 2002/01/17 21:06:09 jongfoster
53 * Now #defining the URLs of the config interface
55 * Minor changes to struct http_request and struct url_spec due to
56 * standardizing that struct http_request is used to represent a URL, and
57 * struct url_spec is used to represent a URL pattern. (Before, URLs were
58 * represented as seperate variables and a partially-filled-in url_spec).
60 * Revision 1.45 2002/01/09 14:33:27 oes
61 * Added HOSTENT_BUFFER_SIZE
63 * Revision 1.44 2001/12/30 14:07:32 steudten
64 * - Add signal handling (unix)
65 * - Add SIGHUP handler (unix)
66 * - Add creation of pidfile (unix)
67 * - Add action 'top' in rc file (RH)
68 * - Add entry 'SIGNALS' to manpage
69 * - Add exit message to logfile (unix)
71 * Revision 1.43 2001/11/22 21:57:51 jongfoster
72 * Making action_spec->flags into an unsigned long rather than just an
74 * Adding ACTION_NO_COOKIE_KEEP
76 * Revision 1.42 2001/11/05 21:42:41 steudten
77 * Include DBG() macro.
79 * Revision 1.41 2001/10/28 19:12:06 jongfoster
80 * Adding ijb_toupper()
82 * Revision 1.40 2001/10/26 17:40:47 oes
83 * Moved ijb_isspace and ijb_tolower to project.h
84 * Removed http->user_agent, csp->referrer and csp->accept_types
86 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
87 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
88 * macro when called with a cast; so moving the cast to the macro def'n
89 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
90 * doesn't make macro expansion complain. Hope this works for everyone else
93 * Revision 1.38 2001/10/23 21:19:04 jongfoster
94 * New error-handling support: jb_err type and JB_ERR_xxx constants
95 * CGI functions now return a jb_err, and their parameters map is const.
96 * Support for RUNTIME_FEATUREs to enable/disable config editor
97 * Adding a few comments
99 * Revision 1.37 2001/10/14 22:14:01 jongfoster
100 * Removing name_length field from struct cgi_dispatcher, as this is
101 * now calculated at runtime from the "name" field.
103 * Revision 1.36 2001/10/10 16:45:15 oes
104 * Added LIMIT_CONNECT action and string
105 * Fixed HTTP message line termination
106 * Added CFORBIDDEN HTTP message
108 * Revision 1.35 2001/10/07 18:06:43 oes
109 * Added status member to struct http_request
111 * Revision 1.34 2001/10/07 15:45:25 oes
112 * Added url member to struct http_request and commented all
117 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
119 * Replaced struct client_state members rejected,
120 * force, active and toggled_on with "flags" bitmap.
122 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
124 * Added buffer_limit to struct configuration_spec
126 * Revision 1.33 2001/09/20 13:30:08 steudten
128 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
129 * Last case will set z to NULL in free(z) and thats bad..
131 * Revision 1.32 2001/09/16 23:02:51 jongfoster
134 * Revision 1.31 2001/09/16 13:20:29 jongfoster
135 * Rewrite of list library. Now has seperate header and list_entry
136 * structures. Also added a large sprinking of assert()s to the list
139 * Revision 1.30 2001/09/13 23:52:00 jongfoster
140 * Support for both static and dynamically generated CGI pages
142 * Revision 1.29 2001/09/13 23:29:43 jongfoster
143 * Defining FORWARD_SPEC_INITIALIZER
145 * Revision 1.28 2001/09/13 23:05:50 jongfoster
146 * Changing the string paramater to the header parsers a "const".
148 * Revision 1.27 2001/08/05 16:06:20 jongfoster
149 * Modifiying "struct map" so that there are now separate header and
150 * "map_entry" structures. This means that functions which modify a
151 * map no longer need to return a pointer to the modified map.
152 * Also, it no longer reverses the order of the entries (which may be
153 * important with some advanced template substitutions).
155 * Revision 1.26 2001/07/30 22:08:36 jongfoster
156 * Tidying up #defines:
157 * - All feature #defines are now of the form FEATURE_xxx
158 * - Permanently turned off WIN_GUI_EDIT
159 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
161 * Revision 1.25 2001/07/29 18:43:08 jongfoster
162 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
165 * Revision 1.24 2001/07/25 17:20:27 oes
166 * Introduced http->user_agent
168 * Revision 1.23 2001/07/18 12:32:23 oes
169 * - Added ACTION_STRING_DEANIMATE
170 * - moved #define freez from jcc.h to project.h
172 * Revision 1.22 2001/07/15 17:51:41 jongfoster
173 * Renaming #define STATIC to STATIC_PCRE
175 * Revision 1.21 2001/07/13 14:03:19 oes
176 * - Reorganized regex header inclusion and #defines to
177 * comply to the scheme in configure.in
178 * - Added csp->content_type and its CT_* keys
179 * - Added ACTION_DEANIMATE
180 * - Removed all #ifdef PCRS
182 * Revision 1.20 2001/06/29 21:45:41 oes
183 * Indentation, CRLF->LF, Tab-> Space
185 * Revision 1.19 2001/06/29 13:33:36 oes
186 * - Improved comments
187 * - Introduced http_request.host_ip_addr_str
188 * - Introduced http_response.head_length
189 * - Introduced config.my_ip_addr_str, config.my_hostname,
190 * config.admin_address and config.proxy_info_url
191 * - Removed config.proxy_args_header and config.proxy_args_trailer,
192 * renamed config.proxy_args_invocation to config.proxy_args
193 * - Removed HTML snipplets and GIFs
194 * - Removed logentry from cancelled commit
196 * Revision 1.18 2001/06/09 10:57:39 jongfoster
197 * Adding definition of BUFFER_SIZE.
198 * Changing struct cgi_dispatcher to use "const" strings.
200 * Revision 1.17 2001/06/07 23:15:09 jongfoster
201 * Merging ACL and forward files into config file.
202 * Moving struct gateway members into struct forward_spec
203 * Removing config->proxy_args_gateways
204 * Cosmetic: Adding a few comments
206 * Revision 1.16 2001/06/04 18:31:58 swa
207 * files are now prefixed with either `confdir' or `logdir'.
208 * `make redhat-dist' replaces both entries confdir and logdir
211 * Revision 1.15 2001/06/04 11:28:53 swa
212 * redirect did not work due to missing /
214 * Revision 1.14 2001/06/03 11:03:48 oes
216 * added struct http_response,
217 * changed struct interceptors to struct cgi_dispatcher,
218 * moved HTML stuff to cgi.h
220 * Revision 1.13 2001/06/01 20:05:36 jongfoster
221 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
222 * constant, and removed csp->tinygif.
224 * Revision 1.12 2001/06/01 18:49:17 jongfoster
225 * Replaced "list_share" with "list" - the tiny memory gain was not
226 * worth the extra complexity.
228 * Revision 1.11 2001/06/01 10:32:47 oes
229 * Added constants for anchoring selection bitmap
231 * Revision 1.10 2001/05/31 21:33:53 jongfoster
232 * Changes for new actions file, replacing permissionsfile
233 * and parts of the config file. Also added support for
236 * Revision 1.9 2001/05/31 17:32:31 oes
238 * - Enhanced domain part globbing with infix and prefix asterisk
239 * matching and optional unanchored operation
241 * Revision 1.8 2001/05/29 20:09:15 joergs
242 * HTTP_REDIRECT_TEMPLATE fixed.
244 * Revision 1.7 2001/05/29 09:50:24 jongfoster
245 * Unified blocklist/imagelist/actionslist.
246 * File format is still under discussion, but the internal changes
249 * Also modified interceptor behaviour:
250 * - We now intercept all URLs beginning with one of the following
251 * prefixes (and *only* these prefixes):
253 * * http://ijbswa.sf.net/config/
254 * * http://ijbswa.sourceforge.net/config/
255 * - New interceptors "home page" - go to http://i.j.b/ to see it.
256 * - Internal changes so that intercepted and fast redirect pages
257 * are not replaced with an image.
258 * - Interceptors now have the option to send a binary page direct
259 * to the client. (i.e. ijb-send-banner uses this)
260 * - Implemented show-url-info interceptor. (Which is why I needed
261 * the above interceptors changes - a typical URL is
262 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
263 * The previous mechanism would not have intercepted that, and
264 * if it had been intercepted then it then it would have replaced
267 * Revision 1.6 2001/05/27 22:17:04 oes
269 * - re_process_buffer no longer writes the modified buffer
270 * to the client, which was very ugly. It now returns the
271 * buffer, which it is then written by chat.
273 * - content_length now adjusts the Content-Length: header
274 * for modified documents rather than crunch()ing it.
275 * (Length info in csp->content_length, which is 0 for
276 * unmodified documents)
278 * - For this to work, sed() is called twice when filtering.
280 * Revision 1.5 2001/05/26 00:28:36 jongfoster
281 * Automatic reloading of config file.
282 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
283 * Most of the global variables have been moved to a new
284 * struct configuration_spec, accessed through csp->config->globalname
285 * Most of the globals remaining are used by the Win32 GUI.
287 * Revision 1.4 2001/05/22 18:46:04 oes
289 * - Enabled filtering banners by size rather than URL
290 * by adding patterns that replace all standard banner
291 * sizes with the "Junkbuster" gif to the re_filterfile
293 * - Enabled filtering WebBugs by providing a pattern
294 * which kills all 1x1 images
296 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
297 * which is selected by the (nonstandard and therefore
298 * capital) letter 'U' in the option string.
299 * It causes the quantifiers to be ungreedy by default.
300 * Appending a ? turns back to greedy (!).
302 * - Added a new interceptor ijb-send-banner, which
303 * sends back the "Junkbuster" gif. Without imagelist or
304 * MSIE detection support, or if tinygif = 1, or the
305 * URL isn't recognized as an imageurl, a lame HTML
306 * explanation is sent instead.
308 * - Added new feature, which permits blocking remote
309 * script redirects and firing back a local redirect
311 * The feature is conditionally compiled, i.e. it
312 * can be disabled with --disable-fast-redirects,
313 * plus it must be activated by a "fast-redirects"
314 * line in the config file, has its own log level
315 * and of course wants to be displayed by show-proxy-args
316 * Note: Boy, all the #ifdefs in 1001 locations and
317 * all the fumbling with configure.in and acconfig.h
318 * were *way* more work than the feature itself :-(
320 * - Because a generic redirect template was needed for
321 * this, tinygif = 3 now uses the same.
323 * - Moved GIFs, and other static HTTP response templates
328 * - Removed some >400 CRs again (Jon, you really worked
331 * Revision 1.3 2001/05/20 01:21:20 jongfoster
332 * Version 2.9.4 checkin.
333 * - Merged popupfile and cookiefile, and added control over PCRS
334 * filtering, in new "actionsfile".
335 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
336 * file error you now get a message box (in the Win32 GUI) rather
337 * than the program exiting with no explanation.
338 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
340 * - Removed tabs from "config"
341 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
342 * - Bumped up version number.
344 * Revision 1.2 2001/05/17 23:01:01 oes
345 * - Cleaned CRLF's from the sources and related files
347 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
348 * Initial import of version 2.9.3 source tree
351 *********************************************************************/
354 /* Declare struct FILE for vars and funcs. */
357 /* Need time_t for file_list */
361 * Include appropriate regular expression libraries.
362 * Note that pcrs and pcre (native) are needed for cgi
363 * and are included anyway.
366 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
368 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
382 #if defined(REGEX_PCRE)
384 # include "pcreposix.h"
386 # include <pcreposix.h>
388 #endif /* defined(REGEX_PCRE) */
390 #if defined(REGEX_GNU)
391 # include "gnu_regex.h"
396 #endif /* def AMIGA */
404 * Error codes. Functions returning these should return a jb_err
406 #define JB_ERR_OK 0 /* Success, no error */
407 #define JB_ERR_MEMORY 1 /* Out of memory */
408 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
409 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
410 #define JB_ERR_PARSE 4 /* Error parsing file */
411 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
412 /* CGI actions editor. */
417 * This macro is used to free a pointer that may be NULL
419 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
422 /* Fix a problem with Solaris. There should be no effect on other
424 * Solaris's isspace() is a macro which uses it's argument directly
425 * as an array index. Therefore we need to make sure that high-bit
426 * characters generate +ve values, and ideally we also want to make
427 * the argument match the declared parameter type of "int".
429 * Note: Remember to #include <ctype.h> if you use these macros.
431 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
432 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
433 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
436 * Use for statically allocated buffers if you have no other choice.
437 * Remember to check the length of what you write into the buffer
438 * - we don't want any buffer overflows!
440 #define BUFFER_SIZE 5000
443 * Buffer size for capturing struct hostent data in the
444 * gethostby(name|addr)_r library calls. Since we don't
445 * loop over gethostbyname_r, the buffer must be sufficient
446 * to accomodate multiple IN A RRs, as used in DNS round robin
447 * load balancing. W3C's wwwlib uses 1K, so that should be
448 * good enough for us, too.
450 #define HOSTENT_BUFFER_SIZE 1024
453 * So you can say "while (FOREVER) { ...do something... }"
457 /* Default IP and port to listen on */
458 #define HADDR_DEFAULT "127.0.0.1"
459 #define HADDR_PORT 8118
461 /* Forward defs for various structures */
463 /* Need this for struct client_state */
464 struct configuration_spec;
467 /* Generic linked list of strings */
472 struct list_entry *next;
477 struct list_entry *first;
478 struct list_entry *last;
482 /* A map from a string to another string */
488 struct map_entry *next;
493 struct map_entry *first;
494 struct map_entry *last;
500 char *cmd; /* Whole command line: method, URL, Version */
501 char *ocmd; /* Backup of original cmd for CLF logging */
502 char *gpc; /* HTTP method: GET, POST, .. */
503 char *url; /* The URL */
504 char *ver; /* Protocol version */
505 int status; /* HTTP Status */
507 char *host; /* Host part of URL */
508 int port; /* Port of URL or 80 (default) */
509 char *path; /* Path of URL */
510 char *hostport; /* host[:port] */
511 int ssl; /* Flag if protocol is https */
513 char *host_ip_addr_str; /* String with dotted decimal representation
514 * of host's IP. NULL before connect_to() */
516 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
517 char **dvec; /* List of pointers to the strings in dbuffer. */
518 int dcount; /* How many parts to this domain? (length of dvec) */
521 /* Response generated by CGI, blocker, or error handler */
524 char *status; /* HTTP status (string)*/
525 struct list headers[1]; /* List of header lines */
526 char *head; /* Formatted http response head */
527 int head_length; /* Length of http response head */
528 char *body; /* HTTP document body */
529 int content_length; /* Length of body, REQUIRED if binary body */
530 int is_static; /* Nonzero if the content will never change and
531 * should be cached by the broser (e.g. images) */
537 char *spec; /* The string which was parsed to produce this */
538 /* url_spec. Used for debugging or display only. */
540 /* Hostname matching, or dbuffer == NULL to match all hosts */
541 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
542 char **dvec; /* List of pointers to the strings in dbuffer. */
543 int dcount; /* How many parts to this domain? (length of dvec) */
544 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
547 int port; /* The port number, or 0 to match all ports. */
550 char *path; /* The path prefix (if not using regex), or source */
552 int pathlen; /* ==strlen(path). Needed for prefix matching. */
554 regex_t *preg; /* Regex for matching path part */
558 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
559 #else /* ifndef REGEX */
560 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
561 #endif /* ndef REGEX */
563 /* Constants for host part matching in URLs */
564 #define ANCHOR_LEFT 1
565 #define ANCHOR_RIGHT 2
577 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
578 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
580 /* Keys for csp->content_type */
581 #define CT_TEXT 1 /* Suitable for pcrs filtering */
582 #define CT_GIF 2 /* Suitable for GIF filtering */
583 #define CT_TABOO 3 /* DONT filter */
585 #define ACTION_MASK_ALL (~0U)
587 #define ACTION_MOST_COMPATIBLE 0x00000000UL
589 #define ACTION_BLOCK 0x00000001UL
590 #define ACTION_DEANIMATE 0x00000002UL
591 #define ACTION_DOWNGRADE 0x00000004UL
592 #define ACTION_FAST_REDIRECTS 0x00000008UL
593 #define ACTION_FILTER 0x00000010UL
594 #define ACTION_HIDE_FORWARDED 0x00000020UL
595 #define ACTION_HIDE_FROM 0x00000040UL
596 #define ACTION_HIDE_REFERER 0x00000080UL /* sic - follow HTTP, not English */
597 #define ACTION_HIDE_USER_AGENT 0x00000100UL
598 #define ACTION_IMAGE 0x00000200UL
599 #define ACTION_IMAGE_BLOCKER 0x00000400UL
600 #define ACTION_NO_COMPRESSION 0x00000800UL
601 #define ACTION_NO_COOKIE_KEEP 0x00001000UL
602 #define ACTION_NO_COOKIE_READ 0x00002000UL
603 #define ACTION_NO_COOKIE_SET 0x00004000UL
604 #define ACTION_NO_POPUPS 0x00008000UL
605 #define ACTION_VANILLA_WAFER 0x00010000UL
606 #define ACTION_LIMIT_CONNECT 0x00020000UL
608 #define ACTION_STRING_DEANIMATE 0
609 #define ACTION_STRING_FROM 1
610 #define ACTION_STRING_IMAGE_BLOCKER 2
611 #define ACTION_STRING_REFERER 3
612 #define ACTION_STRING_USER_AGENT 4
613 #define ACTION_STRING_LIMIT_CONNECT 5
614 #define ACTION_STRING_COUNT 6
616 #define ACTION_MULTI_ADD_HEADER 0
617 #define ACTION_MULTI_WAFER 1
618 #define ACTION_MULTI_COUNT 2
621 * This structure contains a list of actions to apply to a URL.
622 * It only contains positive instructions - no "-" options.
623 * It is not used to store the actions list itself, only for
624 * url_actions() to return the current values.
626 struct current_action_spec
628 unsigned long flags; /* a bit set to "1" = add action */
630 /* For those actions that require parameters: */
632 /* each entry is valid if & only if corresponding entry in "add" set. */
633 char * string[ACTION_STRING_COUNT];
636 struct list multi[ACTION_MULTI_COUNT][1];
641 * This structure contains a set of changes to actions.
642 * It can contain both positive and negative instructions.
643 * It is used to store an entry in the actions list.
647 unsigned long mask; /* a bit set to "0" = remove action */
648 unsigned long add; /* a bit set to "1" = add action */
650 /* For those actions that require parameters: */
652 /* each entry is valid if & only if corresponding entry in "add" set. */
653 char * string[ACTION_STRING_COUNT];
655 /* Strings to remove. */
656 struct list multi_remove[ACTION_MULTI_COUNT][1];
658 /* If nonzero, remove *all* strings. */
659 int multi_remove_all[ACTION_MULTI_COUNT];
662 struct list multi_add[ACTION_MULTI_COUNT][1];
666 * This structure is used to store the actions list.
668 * It contains a URL pattern, and the chages to the actions.
669 * It is a linked list.
673 struct url_spec url[1];
675 struct action_spec action[1];
677 struct url_actions * next;
682 * Flags for use in csp->flags
684 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
685 * Cleared when the thread associated with
686 * this structure dies. */
687 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
688 * transfer encoding */
689 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
690 * it would normally have been blocked. */
691 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
692 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
693 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
696 * The state of a JunkBuster processing thread.
700 /* The proxy's configuration */
701 struct configuration_spec * config;
703 /* The actions to perform on the current request */
704 struct current_action_spec action[1];
706 /* socket to talk to client (web browser) */
709 /* socket to talk to server (web server or proxy) */
712 /* Multi-purpose flag container, see CSP_FLAG_* above */
713 unsigned short int flags;
716 * Client PC's IP address, as reported by the accept()_ function.
717 * Both as string and number
723 /* Our IP address and hostname, i.e. the IP address that
724 the client used to reach us, and the associated hostname,
727 char *my_ip_addr_str;
730 /* The URL that was requested */
731 struct http_request http[1];
733 /* An I/O buffer used for buffering data read from the client */
736 /* List of all headers for this request */
737 struct list headers[1];
739 /* List of all cookies for this request */
740 struct list cookie_list[1];
742 /* MIME-Type key, see CT_* above */
743 unsigned short int content_type;
745 /* The "X-Forwarded-For:" header sent by the client */
748 /* files associated with this client */
749 struct file_list *actions_list;
751 struct file_list *rlist; /* pcrs job file */
752 size_t content_length; /* Length after content modification */
755 struct file_list *tlist; /* trustfile */
756 #endif /* def FEATURE_TRUST */
758 struct client_state *next;
763 * A function to add a header
765 typedef jb_err (*add_header_func_ptr)(struct client_state *);
768 * A function to process a header
770 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
773 * List of functions to run on a list of headers
779 parser_func_ptr parser;
784 * List of available CGI functions.
786 struct cgi_dispatcher
788 const char * const name;
789 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
790 const char * const description;
795 * A data file used by JunkBuster. Kept in a linked list.
800 * this is a pointer to the data structures associated with the file.
801 * Read-only once the structure has been created.
805 /* Normally NULL. When we are finished with file (i.e. when we have
806 * loaded a new one), set to a pointer to an unloader function.
807 * Unloader will be called by sweep() (called from main loop) when
808 * all clients using this file are done. This prevents threading
811 void (*unloader)(void *);
813 /* Used internally by sweep(). Do not access from elsewhere. */
816 /* Following variables allow us to check if file has been changed.
817 * Read-only once the structure has been created.
822 /* Pointer to next entry in the linked list of all "file_list"s.
823 * This linked list is so that sweep() can navigate it.
824 * Since sweep() can remove items from the list, we must be careful
825 * to only access this value from main thread (when we know sweep
828 struct file_list *next;
835 struct url_spec url[1];
837 struct block_spec *next;
839 #endif /* def FEATURE_TRUST */
842 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
843 #define SOCKS_4 40 /* original SOCKS 4 protocol */
844 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
848 struct url_spec url[1];
850 /* Connection type - must be a SOCKS_xxx constant */
857 /* Parent HTTP proxy */
861 /* For the linked list */
862 struct forward_spec *next;
864 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
867 struct re_filterfile_spec
871 struct list patterns[1];
876 #define ACL_PERMIT 1 /* accept connection request */
877 #define ACL_DENY 2 /* reject connection request */
879 struct access_control_addr
886 struct access_control_list
888 struct access_control_addr src[1];
889 struct access_control_addr dst[1];
892 struct access_control_list *next;
894 #endif /* def FEATURE_ACL */
897 /* Maximum number of loaders (actions, re_filter, ...) */
901 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
902 #define RUNTIME_FEATURE_CGI_TOGGLE 2
906 * Data loaded from the configuration file.
908 * (Anomaly: toggle is still handled through a global, not this structure)
910 struct configuration_spec
915 /* Features that can be enabled/disabled throuigh the config file */
916 unsigned feature_flags;
922 const char *actions_file;
924 /* The administrator's email address */
927 /* A URL with info on this proxy */
928 char *proxy_info_url;
930 const char *re_filterfile;
932 #ifdef FEATURE_COOKIE_JAR
933 const char * jarfile;
935 #endif /* def FEATURE_COOKIE_JAR */
938 * Port and IP to bind to.
939 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
944 /* Size limit for IOB */
948 const char * trustfile;
950 struct list trust_info[1];
951 struct url_spec *trust_list[64];
952 #endif /* def FEATURE_TRUST */
955 struct access_control_list *acl;
956 #endif /* def FEATURE_ACL */
958 struct forward_spec *forward;
960 /* All options from the config file, HTML-formatted */
963 /* the configuration file object. */
964 struct file_list *config_file_list;
966 /* List of loaders */
967 int (*loaders[NLOADERS])(struct client_state *);
969 /* bool, nonzero if we need to bind() to the new port */
974 #define SZ(X) (sizeof(X) / sizeof(*X))
976 #ifdef FEATURE_FORCE_LOAD
977 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
978 #endif /* def FEATURE_FORCE_LOAD */
981 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
982 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
985 * The "hosts" to intercept and display CGI pages.
986 * First one is a hostname only, second one can specify host and path.
989 * 1) Do not specify the http: prefix
990 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
991 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
993 #define CGI_SITE_1_HOST "i.j.b"
994 #define CGI_SITE_2_HOST "ijbswa.sourceforge.net"
995 #define CGI_SITE_2_PATH "/config"
998 * The prefix for CGI pages. Written out in generated HTML.
999 * INCLUDES the trailing slash.
1001 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1004 /* HTTP snipplets */
1005 static const char CSUCCEED[] =
1006 "HTTP/1.0 200 Connection established\n"
1007 "Proxy-Agent: IJ/" VERSION "\r\n\r\n";
1009 static const char CHEADER[] =
1010 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1012 static const char CFORBIDDEN[] =
1013 "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n";
1019 #endif /* ndef PROJECT_H_INCLUDED */