1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.54 2002/03/09 20:03:52 jongfoster 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.54 2002/03/09 20:03:52 jongfoster
40 * - Making various functions return int rather than size_t.
41 * (Undoing a recent change). Since size_t is unsigned on
42 * Windows, functions like read_socket that return -1 on
43 * error cannot return a size_t.
45 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
46 * crashes, and also frequently caused JB to jump to 100%
47 * CPU and stay there. (Because it thought it had just
48 * read ((unsigned)-1) == 4Gb of data...)
50 * - The signature of write_socket has changed, it now simply
51 * returns success=0/failure=nonzero.
53 * - Trying to get rid of a few warnings --with-debug on
54 * Windows, I've introduced a new type "jb_socket". This is
55 * used for the socket file descriptors. On Windows, this
56 * is SOCKET (a typedef for unsigned). Everywhere else, it's
57 * an int. The error value can't be -1 any more, so it's
58 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
59 * Windows it maps to the #define INVALID_SOCKET.)
61 * - The signature of bind_port has changed.
63 * Revision 1.53 2002/03/08 16:48:55 oes
64 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
66 * Revision 1.52 2002/03/07 03:46:17 oes
67 * Fixed compiler warnings
69 * Revision 1.51 2002/03/05 04:52:42 oes
70 * Deleted non-errlog debugging code
72 * Revision 1.50 2002/03/04 19:32:07 oes
73 * Changed default port to 8118
75 * Revision 1.49 2002/03/04 18:28:55 oes
76 * Deleted PID_FILE_NAME
78 * Revision 1.48 2002/03/03 14:50:40 oes
79 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
81 * Revision 1.47 2002/02/20 23:15:13 jongfoster
82 * Parsing functions now handle out-of-memory gracefully by returning
85 * Revision 1.46 2002/01/17 21:06:09 jongfoster
86 * Now #defining the URLs of the config interface
88 * Minor changes to struct http_request and struct url_spec due to
89 * standardizing that struct http_request is used to represent a URL, and
90 * struct url_spec is used to represent a URL pattern. (Before, URLs were
91 * represented as seperate variables and a partially-filled-in url_spec).
93 * Revision 1.45 2002/01/09 14:33:27 oes
94 * Added HOSTENT_BUFFER_SIZE
96 * Revision 1.44 2001/12/30 14:07:32 steudten
97 * - Add signal handling (unix)
98 * - Add SIGHUP handler (unix)
99 * - Add creation of pidfile (unix)
100 * - Add action 'top' in rc file (RH)
101 * - Add entry 'SIGNALS' to manpage
102 * - Add exit message to logfile (unix)
104 * Revision 1.43 2001/11/22 21:57:51 jongfoster
105 * Making action_spec->flags into an unsigned long rather than just an
107 * Adding ACTION_NO_COOKIE_KEEP
109 * Revision 1.42 2001/11/05 21:42:41 steudten
110 * Include DBG() macro.
112 * Revision 1.41 2001/10/28 19:12:06 jongfoster
113 * Adding ijb_toupper()
115 * Revision 1.40 2001/10/26 17:40:47 oes
116 * Moved ijb_isspace and ijb_tolower to project.h
117 * Removed http->user_agent, csp->referrer and csp->accept_types
119 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
120 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
121 * macro when called with a cast; so moving the cast to the macro def'n
122 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
123 * doesn't make macro expansion complain. Hope this works for everyone else
126 * Revision 1.38 2001/10/23 21:19:04 jongfoster
127 * New error-handling support: jb_err type and JB_ERR_xxx constants
128 * CGI functions now return a jb_err, and their parameters map is const.
129 * Support for RUNTIME_FEATUREs to enable/disable config editor
130 * Adding a few comments
132 * Revision 1.37 2001/10/14 22:14:01 jongfoster
133 * Removing name_length field from struct cgi_dispatcher, as this is
134 * now calculated at runtime from the "name" field.
136 * Revision 1.36 2001/10/10 16:45:15 oes
137 * Added LIMIT_CONNECT action and string
138 * Fixed HTTP message line termination
139 * Added CFORBIDDEN HTTP message
141 * Revision 1.35 2001/10/07 18:06:43 oes
142 * Added status member to struct http_request
144 * Revision 1.34 2001/10/07 15:45:25 oes
145 * Added url member to struct http_request and commented all
150 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
152 * Replaced struct client_state members rejected,
153 * force, active and toggled_on with "flags" bitmap.
155 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
157 * Added buffer_limit to struct configuration_spec
159 * Revision 1.33 2001/09/20 13:30:08 steudten
161 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
162 * Last case will set z to NULL in free(z) and thats bad..
164 * Revision 1.32 2001/09/16 23:02:51 jongfoster
167 * Revision 1.31 2001/09/16 13:20:29 jongfoster
168 * Rewrite of list library. Now has seperate header and list_entry
169 * structures. Also added a large sprinking of assert()s to the list
172 * Revision 1.30 2001/09/13 23:52:00 jongfoster
173 * Support for both static and dynamically generated CGI pages
175 * Revision 1.29 2001/09/13 23:29:43 jongfoster
176 * Defining FORWARD_SPEC_INITIALIZER
178 * Revision 1.28 2001/09/13 23:05:50 jongfoster
179 * Changing the string paramater to the header parsers a "const".
181 * Revision 1.27 2001/08/05 16:06:20 jongfoster
182 * Modifiying "struct map" so that there are now separate header and
183 * "map_entry" structures. This means that functions which modify a
184 * map no longer need to return a pointer to the modified map.
185 * Also, it no longer reverses the order of the entries (which may be
186 * important with some advanced template substitutions).
188 * Revision 1.26 2001/07/30 22:08:36 jongfoster
189 * Tidying up #defines:
190 * - All feature #defines are now of the form FEATURE_xxx
191 * - Permanently turned off WIN_GUI_EDIT
192 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
194 * Revision 1.25 2001/07/29 18:43:08 jongfoster
195 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
198 * Revision 1.24 2001/07/25 17:20:27 oes
199 * Introduced http->user_agent
201 * Revision 1.23 2001/07/18 12:32:23 oes
202 * - Added ACTION_STRING_DEANIMATE
203 * - moved #define freez from jcc.h to project.h
205 * Revision 1.22 2001/07/15 17:51:41 jongfoster
206 * Renaming #define STATIC to STATIC_PCRE
208 * Revision 1.21 2001/07/13 14:03:19 oes
209 * - Reorganized regex header inclusion and #defines to
210 * comply to the scheme in configure.in
211 * - Added csp->content_type and its CT_* keys
212 * - Added ACTION_DEANIMATE
213 * - Removed all #ifdef PCRS
215 * Revision 1.20 2001/06/29 21:45:41 oes
216 * Indentation, CRLF->LF, Tab-> Space
218 * Revision 1.19 2001/06/29 13:33:36 oes
219 * - Improved comments
220 * - Introduced http_request.host_ip_addr_str
221 * - Introduced http_response.head_length
222 * - Introduced config.my_ip_addr_str, config.my_hostname,
223 * config.admin_address and config.proxy_info_url
224 * - Removed config.proxy_args_header and config.proxy_args_trailer,
225 * renamed config.proxy_args_invocation to config.proxy_args
226 * - Removed HTML snipplets and GIFs
227 * - Removed logentry from cancelled commit
229 * Revision 1.18 2001/06/09 10:57:39 jongfoster
230 * Adding definition of BUFFER_SIZE.
231 * Changing struct cgi_dispatcher to use "const" strings.
233 * Revision 1.17 2001/06/07 23:15:09 jongfoster
234 * Merging ACL and forward files into config file.
235 * Moving struct gateway members into struct forward_spec
236 * Removing config->proxy_args_gateways
237 * Cosmetic: Adding a few comments
239 * Revision 1.16 2001/06/04 18:31:58 swa
240 * files are now prefixed with either `confdir' or `logdir'.
241 * `make redhat-dist' replaces both entries confdir and logdir
244 * Revision 1.15 2001/06/04 11:28:53 swa
245 * redirect did not work due to missing /
247 * Revision 1.14 2001/06/03 11:03:48 oes
249 * added struct http_response,
250 * changed struct interceptors to struct cgi_dispatcher,
251 * moved HTML stuff to cgi.h
253 * Revision 1.13 2001/06/01 20:05:36 jongfoster
254 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
255 * constant, and removed csp->tinygif.
257 * Revision 1.12 2001/06/01 18:49:17 jongfoster
258 * Replaced "list_share" with "list" - the tiny memory gain was not
259 * worth the extra complexity.
261 * Revision 1.11 2001/06/01 10:32:47 oes
262 * Added constants for anchoring selection bitmap
264 * Revision 1.10 2001/05/31 21:33:53 jongfoster
265 * Changes for new actions file, replacing permissionsfile
266 * and parts of the config file. Also added support for
269 * Revision 1.9 2001/05/31 17:32:31 oes
271 * - Enhanced domain part globbing with infix and prefix asterisk
272 * matching and optional unanchored operation
274 * Revision 1.8 2001/05/29 20:09:15 joergs
275 * HTTP_REDIRECT_TEMPLATE fixed.
277 * Revision 1.7 2001/05/29 09:50:24 jongfoster
278 * Unified blocklist/imagelist/actionslist.
279 * File format is still under discussion, but the internal changes
282 * Also modified interceptor behaviour:
283 * - We now intercept all URLs beginning with one of the following
284 * prefixes (and *only* these prefixes):
286 * * http://ijbswa.sf.net/config/
287 * * http://ijbswa.sourceforge.net/config/
288 * - New interceptors "home page" - go to http://i.j.b/ to see it.
289 * - Internal changes so that intercepted and fast redirect pages
290 * are not replaced with an image.
291 * - Interceptors now have the option to send a binary page direct
292 * to the client. (i.e. ijb-send-banner uses this)
293 * - Implemented show-url-info interceptor. (Which is why I needed
294 * the above interceptors changes - a typical URL is
295 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
296 * The previous mechanism would not have intercepted that, and
297 * if it had been intercepted then it then it would have replaced
300 * Revision 1.6 2001/05/27 22:17:04 oes
302 * - re_process_buffer no longer writes the modified buffer
303 * to the client, which was very ugly. It now returns the
304 * buffer, which it is then written by chat.
306 * - content_length now adjusts the Content-Length: header
307 * for modified documents rather than crunch()ing it.
308 * (Length info in csp->content_length, which is 0 for
309 * unmodified documents)
311 * - For this to work, sed() is called twice when filtering.
313 * Revision 1.5 2001/05/26 00:28:36 jongfoster
314 * Automatic reloading of config file.
315 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
316 * Most of the global variables have been moved to a new
317 * struct configuration_spec, accessed through csp->config->globalname
318 * Most of the globals remaining are used by the Win32 GUI.
320 * Revision 1.4 2001/05/22 18:46:04 oes
322 * - Enabled filtering banners by size rather than URL
323 * by adding patterns that replace all standard banner
324 * sizes with the "Junkbuster" gif to the re_filterfile
326 * - Enabled filtering WebBugs by providing a pattern
327 * which kills all 1x1 images
329 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
330 * which is selected by the (nonstandard and therefore
331 * capital) letter 'U' in the option string.
332 * It causes the quantifiers to be ungreedy by default.
333 * Appending a ? turns back to greedy (!).
335 * - Added a new interceptor ijb-send-banner, which
336 * sends back the "Junkbuster" gif. Without imagelist or
337 * MSIE detection support, or if tinygif = 1, or the
338 * URL isn't recognized as an imageurl, a lame HTML
339 * explanation is sent instead.
341 * - Added new feature, which permits blocking remote
342 * script redirects and firing back a local redirect
344 * The feature is conditionally compiled, i.e. it
345 * can be disabled with --disable-fast-redirects,
346 * plus it must be activated by a "fast-redirects"
347 * line in the config file, has its own log level
348 * and of course wants to be displayed by show-proxy-args
349 * Note: Boy, all the #ifdefs in 1001 locations and
350 * all the fumbling with configure.in and acconfig.h
351 * were *way* more work than the feature itself :-(
353 * - Because a generic redirect template was needed for
354 * this, tinygif = 3 now uses the same.
356 * - Moved GIFs, and other static HTTP response templates
361 * - Removed some >400 CRs again (Jon, you really worked
364 * Revision 1.3 2001/05/20 01:21:20 jongfoster
365 * Version 2.9.4 checkin.
366 * - Merged popupfile and cookiefile, and added control over PCRS
367 * filtering, in new "actionsfile".
368 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
369 * file error you now get a message box (in the Win32 GUI) rather
370 * than the program exiting with no explanation.
371 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
373 * - Removed tabs from "config"
374 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
375 * - Bumped up version number.
377 * Revision 1.2 2001/05/17 23:01:01 oes
378 * - Cleaned CRLF's from the sources and related files
380 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
381 * Initial import of version 2.9.3 source tree
384 *********************************************************************/
387 /* Declare struct FILE for vars and funcs. */
390 /* Need time_t for file_list */
394 * Include appropriate regular expression libraries.
395 * Note that pcrs and pcre (native) are needed for cgi
396 * and are included anyway.
399 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
401 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
415 #if defined(REGEX_PCRE)
417 # include "pcreposix.h"
419 # include <pcreposix.h>
421 #endif /* defined(REGEX_PCRE) */
423 #if defined(REGEX_GNU)
424 # include "gnu_regex.h"
429 #endif /* def AMIGA */
433 * I don't want to have to #include all this just for the declaration
434 * of SOCKET. However, it looks like we have to...
445 * The type used by sockets. On UNIX it's an int. Microsoft decided to
446 * make it an unsigned.
449 typedef SOCKET jb_socket;
450 #define JB_INVALID_SOCKET INVALID_SOCKET
451 #else /* ndef _WIN32 */
452 typedef int jb_socket;
453 #define JB_INVALID_SOCKET (-1)
454 #endif /* ndef _WIN32 */
458 * Error codes. Functions returning these should return a jb_err
460 #define JB_ERR_OK 0 /* Success, no error */
461 #define JB_ERR_MEMORY 1 /* Out of memory */
462 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
463 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
464 #define JB_ERR_PARSE 4 /* Error parsing file */
465 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
466 /* CGI actions editor. */
471 * This macro is used to free a pointer that may be NULL
473 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
476 /* Fix a problem with Solaris. There should be no effect on other
478 * Solaris's isspace() is a macro which uses it's argument directly
479 * as an array index. Therefore we need to make sure that high-bit
480 * characters generate +ve values, and ideally we also want to make
481 * the argument match the declared parameter type of "int".
483 * Note: Remember to #include <ctype.h> if you use these macros.
485 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
486 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
487 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
490 * Use for statically allocated buffers if you have no other choice.
491 * Remember to check the length of what you write into the buffer
492 * - we don't want any buffer overflows!
494 #define BUFFER_SIZE 5000
497 * Buffer size for capturing struct hostent data in the
498 * gethostby(name|addr)_r library calls. Since we don't
499 * loop over gethostbyname_r, the buffer must be sufficient
500 * to accomodate multiple IN A RRs, as used in DNS round robin
501 * load balancing. W3C's wwwlib uses 1K, so that should be
502 * good enough for us, too.
504 #define HOSTENT_BUFFER_SIZE 1024
507 * So you can say "while (FOREVER) { ...do something... }"
511 /* Default IP and port to listen on */
512 #define HADDR_DEFAULT "127.0.0.1"
513 #define HADDR_PORT 8118
515 /* Forward defs for various structures */
517 /* Need this for struct client_state */
518 struct configuration_spec;
521 /* Generic linked list of strings */
526 struct list_entry *next;
531 struct list_entry *first;
532 struct list_entry *last;
536 /* A map from a string to another string */
542 struct map_entry *next;
547 struct map_entry *first;
548 struct map_entry *last;
554 char *cmd; /* Whole command line: method, URL, Version */
555 char *ocmd; /* Backup of original cmd for CLF logging */
556 char *gpc; /* HTTP method: GET, POST, .. */
557 char *url; /* The URL */
558 char *ver; /* Protocol version */
559 int status; /* HTTP Status */
561 char *host; /* Host part of URL */
562 int port; /* Port of URL or 80 (default) */
563 char *path; /* Path of URL */
564 char *hostport; /* host[:port] */
565 int ssl; /* Flag if protocol is https */
567 char *host_ip_addr_str; /* String with dotted decimal representation
568 * of host's IP. NULL before connect_to() */
570 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
571 char **dvec; /* List of pointers to the strings in dbuffer. */
572 int dcount; /* How many parts to this domain? (length of dvec) */
576 * Response generated by CGI, blocker, or error handler
580 char *status; /* HTTP status (string) */
581 struct list headers[1]; /* List of header lines */
582 char *head; /* Formatted http response head */
583 size_t head_length; /* Length of http response head */
584 char *body; /* HTTP document body */
585 size_t content_length; /* Length of body, REQUIRED if binary body */
586 int is_static; /* Nonzero if the content will never change and
587 * should be cached by the brwoser (e.g. images) */
593 char *spec; /* The string which was parsed to produce this */
594 /* url_spec. Used for debugging or display only. */
596 /* Hostname matching, or dbuffer == NULL to match all hosts */
597 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
598 char **dvec; /* List of pointers to the strings in dbuffer. */
599 int dcount; /* How many parts to this domain? (length of dvec) */
600 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
603 int port; /* The port number, or 0 to match all ports. */
606 char *path; /* The path prefix (if not using regex), or source */
608 int pathlen; /* ==strlen(path). Needed for prefix matching. */
610 regex_t *preg; /* Regex for matching path part */
614 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
615 #else /* ifndef REGEX */
616 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
617 #endif /* ndef REGEX */
619 /* Constants for host part matching in URLs */
620 #define ANCHOR_LEFT 1
621 #define ANCHOR_RIGHT 2
633 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
634 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
636 /* Keys for csp->content_type */
637 #define CT_TEXT 1 /* Suitable for pcrs filtering */
638 #define CT_GIF 2 /* Suitable for GIF filtering */
639 #define CT_TABOO 3 /* DONT filter */
641 #define ACTION_MASK_ALL (~0U)
643 #define ACTION_MOST_COMPATIBLE 0x00000000UL
645 #define ACTION_BLOCK 0x00000001UL
646 #define ACTION_DEANIMATE 0x00000002UL
647 #define ACTION_DOWNGRADE 0x00000004UL
648 #define ACTION_FAST_REDIRECTS 0x00000008UL
649 #define ACTION_HIDE_FORWARDED 0x00000010UL
650 #define ACTION_HIDE_FROM 0x00000020UL
651 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
652 #define ACTION_HIDE_USER_AGENT 0x00000080UL
653 #define ACTION_IMAGE 0x00000100UL
654 #define ACTION_IMAGE_BLOCKER 0x00000200UL
655 #define ACTION_NO_COMPRESSION 0x00000400UL
656 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
657 #define ACTION_NO_COOKIE_READ 0x00001000UL
658 #define ACTION_NO_COOKIE_SET 0x00002000UL
659 #define ACTION_NO_POPUPS 0x00004000UL
660 #define ACTION_VANILLA_WAFER 0x00008000UL
661 #define ACTION_LIMIT_CONNECT 0x00010000UL
663 #define ACTION_STRING_DEANIMATE 0
664 #define ACTION_STRING_FROM 1
665 #define ACTION_STRING_IMAGE_BLOCKER 2
666 #define ACTION_STRING_REFERER 3
667 #define ACTION_STRING_USER_AGENT 4
668 #define ACTION_STRING_LIMIT_CONNECT 5
669 #define ACTION_STRING_COUNT 6
671 #define ACTION_MULTI_ADD_HEADER 0
672 #define ACTION_MULTI_WAFER 1
673 #define ACTION_MULTI_FILTER 2
674 #define ACTION_MULTI_COUNT 3
678 * This structure contains a list of actions to apply to a URL.
679 * It only contains positive instructions - no "-" options.
680 * It is not used to store the actions list itself, only for
681 * url_actions() to return the current values.
683 struct current_action_spec
685 unsigned long flags; /* a bit set to "1" = add action */
687 /* For those actions that require parameters: */
689 /* each entry is valid if & only if corresponding entry in "add" set. */
690 char * string[ACTION_STRING_COUNT];
693 struct list multi[ACTION_MULTI_COUNT][1];
698 * This structure contains a set of changes to actions.
699 * It can contain both positive and negative instructions.
700 * It is used to store an entry in the actions list.
704 unsigned long mask; /* a bit set to "0" = remove action */
705 unsigned long add; /* a bit set to "1" = add action */
707 /* For those actions that require parameters: */
709 /* each entry is valid if & only if corresponding entry in "add" set. */
710 char * string[ACTION_STRING_COUNT];
712 /* Strings to remove. */
713 struct list multi_remove[ACTION_MULTI_COUNT][1];
715 /* If nonzero, remove *all* strings. */
716 int multi_remove_all[ACTION_MULTI_COUNT];
719 struct list multi_add[ACTION_MULTI_COUNT][1];
723 * This structure is used to store the actions list.
725 * It contains a URL pattern, and the chages to the actions.
726 * It is a linked list.
730 struct url_spec url[1];
732 struct action_spec action[1];
734 struct url_actions * next;
739 * Flags for use in csp->flags
741 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
742 * Cleared when the thread associated with
743 * this structure dies. */
744 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
745 * transfer encoding */
746 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
747 * it would normally have been blocked. */
748 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
749 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
750 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
753 * The state of a JunkBuster processing thread.
757 /* The proxy's configuration */
758 struct configuration_spec * config;
760 /* The actions to perform on the current request */
761 struct current_action_spec action[1];
763 /* socket to talk to client (web browser) */
766 /* socket to talk to server (web server or proxy) */
769 /* Multi-purpose flag container, see CSP_FLAG_* above */
770 unsigned short int flags;
773 * Client PC's IP address, as reported by the accept()_ function.
774 * Both as string and number
780 /* Our IP address and hostname, i.e. the IP address that
781 the client used to reach us, and the associated hostname,
784 char *my_ip_addr_str;
787 /* The URL that was requested */
788 struct http_request http[1];
790 /* An I/O buffer used for buffering data read from the client */
793 /* List of all headers for this request */
794 struct list headers[1];
796 /* List of all cookies for this request */
797 struct list cookie_list[1];
799 /* MIME-Type key, see CT_* above */
800 unsigned short int content_type;
802 /* The "X-Forwarded-For:" header sent by the client */
805 /* files associated with this client */
806 struct file_list *actions_list;
808 struct file_list *rlist; /* pcrs job file */
809 size_t content_length; /* Length after content modification */
812 struct file_list *tlist; /* trustfile */
813 #endif /* def FEATURE_TRUST */
815 struct client_state *next;
820 * A function to add a header
822 typedef jb_err (*add_header_func_ptr)(struct client_state *);
825 * A function to process a header
827 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
830 * List of functions to run on a list of headers
836 parser_func_ptr parser;
841 * List of available CGI functions.
843 struct cgi_dispatcher
845 const char * const name;
846 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
847 const char * const description;
852 * A data file used by JunkBuster. Kept in a linked list.
857 * this is a pointer to the data structures associated with the file.
858 * Read-only once the structure has been created.
862 /* Normally NULL. When we are finished with file (i.e. when we have
863 * loaded a new one), set to a pointer to an unloader function.
864 * Unloader will be called by sweep() (called from main loop) when
865 * all clients using this file are done. This prevents threading
868 void (*unloader)(void *);
870 /* Used internally by sweep(). Do not access from elsewhere. */
873 /* Following variables allow us to check if file has been changed.
874 * Read-only once the structure has been created.
879 /* Pointer to next entry in the linked list of all "file_list"s.
880 * This linked list is so that sweep() can navigate it.
881 * Since sweep() can remove items from the list, we must be careful
882 * to only access this value from main thread (when we know sweep
885 struct file_list *next;
892 struct url_spec url[1];
894 struct block_spec *next;
896 #endif /* def FEATURE_TRUST */
899 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
900 #define SOCKS_4 40 /* original SOCKS 4 protocol */
901 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
905 struct url_spec url[1];
907 /* Connection type - must be a SOCKS_xxx constant */
914 /* Parent HTTP proxy */
918 /* For the linked list */
919 struct forward_spec *next;
921 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
925 * This struct represents one filter (one block) from
926 * the re_filterfile. If there is more than one filter
927 * in the file, the file will be represented by a
928 * chained list of re_filterfile specs.
930 struct re_filterfile_spec
932 char *filtername; /* Name from FILTER: statement in re_filterfile (or "default") */
933 struct list patterns[1]; /* The patterns from the re_filterfile */
934 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
935 struct re_filterfile_spec *next; /* The pointer for chaining */
939 #define ACL_PERMIT 1 /* accept connection request */
940 #define ACL_DENY 2 /* reject connection request */
942 struct access_control_addr
949 struct access_control_list
951 struct access_control_addr src[1];
952 struct access_control_addr dst[1];
955 struct access_control_list *next;
957 #endif /* def FEATURE_ACL */
960 /* Maximum number of loaders (actions, re_filter, ...) */
964 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
965 #define RUNTIME_FEATURE_CGI_TOGGLE 2
969 * Data loaded from the configuration file.
971 * (Anomaly: toggle is still handled through a global, not this structure)
973 struct configuration_spec
978 /* Features that can be enabled/disabled throuigh the config file */
979 unsigned feature_flags;
985 const char *actions_file;
987 /* The administrator's email address */
990 /* A URL with info on this proxy */
991 char *proxy_info_url;
993 const char *re_filterfile;
995 #ifdef FEATURE_COOKIE_JAR
996 const char * jarfile;
998 #endif /* def FEATURE_COOKIE_JAR */
1001 * Port and IP to bind to.
1002 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1007 /* Size limit for IOB */
1008 size_t buffer_limit;
1010 #ifdef FEATURE_TRUST
1011 const char * trustfile;
1013 struct list trust_info[1];
1014 struct url_spec *trust_list[64];
1015 #endif /* def FEATURE_TRUST */
1018 struct access_control_list *acl;
1019 #endif /* def FEATURE_ACL */
1021 struct forward_spec *forward;
1023 /* All options from the config file, HTML-formatted */
1026 /* the configuration file object. */
1027 struct file_list *config_file_list;
1029 /* List of loaders */
1030 int (*loaders[NLOADERS])(struct client_state *);
1032 /* bool, nonzero if we need to bind() to the new port */
1037 #define SZ(X) (sizeof(X) / sizeof(*X))
1039 #ifdef FEATURE_FORCE_LOAD
1040 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
1041 #endif /* def FEATURE_FORCE_LOAD */
1043 #ifdef FEATURE_NO_GIFS
1044 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1046 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1047 #endif /* def FEATURE_NO_GIFS */
1050 /* Hardwired URLs */
1051 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
1052 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1055 * The "hosts" to intercept and display CGI pages.
1056 * First one is a hostname only, second one can specify host and path.
1059 * 1) Do not specify the http: prefix
1060 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1061 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1063 #define CGI_SITE_1_HOST "i.j.b"
1064 #define CGI_SITE_2_HOST "ijbswa.sourceforge.net"
1065 #define CGI_SITE_2_PATH "/config"
1068 * The prefix for CGI pages. Written out in generated HTML.
1069 * INCLUDES the trailing slash.
1071 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1074 /* HTTP snipplets */
1075 static const char CSUCCEED[] =
1076 "HTTP/1.0 200 Connection established\n"
1077 "Proxy-Agent: IJ/" VERSION "\r\n\r\n";
1079 static const char CHEADER[] =
1080 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1082 static const char CFORBIDDEN[] =
1083 "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";
1089 #endif /* ndef PROJECT_H_INCLUDED */