1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.56 2002/03/13 20:27:30 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.56 2002/03/13 20:27:30 oes
40 * Fixing bug with CT_TABOO
42 * Revision 1.55 2002/03/12 01:42:50 oes
43 * Introduced modular filters
45 * Revision 1.54 2002/03/09 20:03:52 jongfoster
46 * - Making various functions return int rather than size_t.
47 * (Undoing a recent change). Since size_t is unsigned on
48 * Windows, functions like read_socket that return -1 on
49 * error cannot return a size_t.
51 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
52 * crashes, and also frequently caused JB to jump to 100%
53 * CPU and stay there. (Because it thought it had just
54 * read ((unsigned)-1) == 4Gb of data...)
56 * - The signature of write_socket has changed, it now simply
57 * returns success=0/failure=nonzero.
59 * - Trying to get rid of a few warnings --with-debug on
60 * Windows, I've introduced a new type "jb_socket". This is
61 * used for the socket file descriptors. On Windows, this
62 * is SOCKET (a typedef for unsigned). Everywhere else, it's
63 * an int. The error value can't be -1 any more, so it's
64 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
65 * Windows it maps to the #define INVALID_SOCKET.)
67 * - The signature of bind_port has changed.
69 * Revision 1.53 2002/03/08 16:48:55 oes
70 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
72 * Revision 1.52 2002/03/07 03:46:17 oes
73 * Fixed compiler warnings
75 * Revision 1.51 2002/03/05 04:52:42 oes
76 * Deleted non-errlog debugging code
78 * Revision 1.50 2002/03/04 19:32:07 oes
79 * Changed default port to 8118
81 * Revision 1.49 2002/03/04 18:28:55 oes
82 * Deleted PID_FILE_NAME
84 * Revision 1.48 2002/03/03 14:50:40 oes
85 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
87 * Revision 1.47 2002/02/20 23:15:13 jongfoster
88 * Parsing functions now handle out-of-memory gracefully by returning
91 * Revision 1.46 2002/01/17 21:06:09 jongfoster
92 * Now #defining the URLs of the config interface
94 * Minor changes to struct http_request and struct url_spec due to
95 * standardizing that struct http_request is used to represent a URL, and
96 * struct url_spec is used to represent a URL pattern. (Before, URLs were
97 * represented as seperate variables and a partially-filled-in url_spec).
99 * Revision 1.45 2002/01/09 14:33:27 oes
100 * Added HOSTENT_BUFFER_SIZE
102 * Revision 1.44 2001/12/30 14:07:32 steudten
103 * - Add signal handling (unix)
104 * - Add SIGHUP handler (unix)
105 * - Add creation of pidfile (unix)
106 * - Add action 'top' in rc file (RH)
107 * - Add entry 'SIGNALS' to manpage
108 * - Add exit message to logfile (unix)
110 * Revision 1.43 2001/11/22 21:57:51 jongfoster
111 * Making action_spec->flags into an unsigned long rather than just an
113 * Adding ACTION_NO_COOKIE_KEEP
115 * Revision 1.42 2001/11/05 21:42:41 steudten
116 * Include DBG() macro.
118 * Revision 1.41 2001/10/28 19:12:06 jongfoster
119 * Adding ijb_toupper()
121 * Revision 1.40 2001/10/26 17:40:47 oes
122 * Moved ijb_isspace and ijb_tolower to project.h
123 * Removed http->user_agent, csp->referrer and csp->accept_types
125 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
126 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
127 * macro when called with a cast; so moving the cast to the macro def'n
128 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
129 * doesn't make macro expansion complain. Hope this works for everyone else
132 * Revision 1.38 2001/10/23 21:19:04 jongfoster
133 * New error-handling support: jb_err type and JB_ERR_xxx constants
134 * CGI functions now return a jb_err, and their parameters map is const.
135 * Support for RUNTIME_FEATUREs to enable/disable config editor
136 * Adding a few comments
138 * Revision 1.37 2001/10/14 22:14:01 jongfoster
139 * Removing name_length field from struct cgi_dispatcher, as this is
140 * now calculated at runtime from the "name" field.
142 * Revision 1.36 2001/10/10 16:45:15 oes
143 * Added LIMIT_CONNECT action and string
144 * Fixed HTTP message line termination
145 * Added CFORBIDDEN HTTP message
147 * Revision 1.35 2001/10/07 18:06:43 oes
148 * Added status member to struct http_request
150 * Revision 1.34 2001/10/07 15:45:25 oes
151 * Added url member to struct http_request and commented all
156 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
158 * Replaced struct client_state members rejected,
159 * force, active and toggled_on with "flags" bitmap.
161 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
163 * Added buffer_limit to struct configuration_spec
165 * Revision 1.33 2001/09/20 13:30:08 steudten
167 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
168 * Last case will set z to NULL in free(z) and thats bad..
170 * Revision 1.32 2001/09/16 23:02:51 jongfoster
173 * Revision 1.31 2001/09/16 13:20:29 jongfoster
174 * Rewrite of list library. Now has seperate header and list_entry
175 * structures. Also added a large sprinking of assert()s to the list
178 * Revision 1.30 2001/09/13 23:52:00 jongfoster
179 * Support for both static and dynamically generated CGI pages
181 * Revision 1.29 2001/09/13 23:29:43 jongfoster
182 * Defining FORWARD_SPEC_INITIALIZER
184 * Revision 1.28 2001/09/13 23:05:50 jongfoster
185 * Changing the string paramater to the header parsers a "const".
187 * Revision 1.27 2001/08/05 16:06:20 jongfoster
188 * Modifiying "struct map" so that there are now separate header and
189 * "map_entry" structures. This means that functions which modify a
190 * map no longer need to return a pointer to the modified map.
191 * Also, it no longer reverses the order of the entries (which may be
192 * important with some advanced template substitutions).
194 * Revision 1.26 2001/07/30 22:08:36 jongfoster
195 * Tidying up #defines:
196 * - All feature #defines are now of the form FEATURE_xxx
197 * - Permanently turned off WIN_GUI_EDIT
198 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
200 * Revision 1.25 2001/07/29 18:43:08 jongfoster
201 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
204 * Revision 1.24 2001/07/25 17:20:27 oes
205 * Introduced http->user_agent
207 * Revision 1.23 2001/07/18 12:32:23 oes
208 * - Added ACTION_STRING_DEANIMATE
209 * - moved #define freez from jcc.h to project.h
211 * Revision 1.22 2001/07/15 17:51:41 jongfoster
212 * Renaming #define STATIC to STATIC_PCRE
214 * Revision 1.21 2001/07/13 14:03:19 oes
215 * - Reorganized regex header inclusion and #defines to
216 * comply to the scheme in configure.in
217 * - Added csp->content_type and its CT_* keys
218 * - Added ACTION_DEANIMATE
219 * - Removed all #ifdef PCRS
221 * Revision 1.20 2001/06/29 21:45:41 oes
222 * Indentation, CRLF->LF, Tab-> Space
224 * Revision 1.19 2001/06/29 13:33:36 oes
225 * - Improved comments
226 * - Introduced http_request.host_ip_addr_str
227 * - Introduced http_response.head_length
228 * - Introduced config.my_ip_addr_str, config.my_hostname,
229 * config.admin_address and config.proxy_info_url
230 * - Removed config.proxy_args_header and config.proxy_args_trailer,
231 * renamed config.proxy_args_invocation to config.proxy_args
232 * - Removed HTML snipplets and GIFs
233 * - Removed logentry from cancelled commit
235 * Revision 1.18 2001/06/09 10:57:39 jongfoster
236 * Adding definition of BUFFER_SIZE.
237 * Changing struct cgi_dispatcher to use "const" strings.
239 * Revision 1.17 2001/06/07 23:15:09 jongfoster
240 * Merging ACL and forward files into config file.
241 * Moving struct gateway members into struct forward_spec
242 * Removing config->proxy_args_gateways
243 * Cosmetic: Adding a few comments
245 * Revision 1.16 2001/06/04 18:31:58 swa
246 * files are now prefixed with either `confdir' or `logdir'.
247 * `make redhat-dist' replaces both entries confdir and logdir
250 * Revision 1.15 2001/06/04 11:28:53 swa
251 * redirect did not work due to missing /
253 * Revision 1.14 2001/06/03 11:03:48 oes
255 * added struct http_response,
256 * changed struct interceptors to struct cgi_dispatcher,
257 * moved HTML stuff to cgi.h
259 * Revision 1.13 2001/06/01 20:05:36 jongfoster
260 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
261 * constant, and removed csp->tinygif.
263 * Revision 1.12 2001/06/01 18:49:17 jongfoster
264 * Replaced "list_share" with "list" - the tiny memory gain was not
265 * worth the extra complexity.
267 * Revision 1.11 2001/06/01 10:32:47 oes
268 * Added constants for anchoring selection bitmap
270 * Revision 1.10 2001/05/31 21:33:53 jongfoster
271 * Changes for new actions file, replacing permissionsfile
272 * and parts of the config file. Also added support for
275 * Revision 1.9 2001/05/31 17:32:31 oes
277 * - Enhanced domain part globbing with infix and prefix asterisk
278 * matching and optional unanchored operation
280 * Revision 1.8 2001/05/29 20:09:15 joergs
281 * HTTP_REDIRECT_TEMPLATE fixed.
283 * Revision 1.7 2001/05/29 09:50:24 jongfoster
284 * Unified blocklist/imagelist/actionslist.
285 * File format is still under discussion, but the internal changes
288 * Also modified interceptor behaviour:
289 * - We now intercept all URLs beginning with one of the following
290 * prefixes (and *only* these prefixes):
292 * * http://ijbswa.sf.net/config/
293 * * http://ijbswa.sourceforge.net/config/
294 * - New interceptors "home page" - go to http://i.j.b/ to see it.
295 * - Internal changes so that intercepted and fast redirect pages
296 * are not replaced with an image.
297 * - Interceptors now have the option to send a binary page direct
298 * to the client. (i.e. ijb-send-banner uses this)
299 * - Implemented show-url-info interceptor. (Which is why I needed
300 * the above interceptors changes - a typical URL is
301 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
302 * The previous mechanism would not have intercepted that, and
303 * if it had been intercepted then it then it would have replaced
306 * Revision 1.6 2001/05/27 22:17:04 oes
308 * - re_process_buffer no longer writes the modified buffer
309 * to the client, which was very ugly. It now returns the
310 * buffer, which it is then written by chat.
312 * - content_length now adjusts the Content-Length: header
313 * for modified documents rather than crunch()ing it.
314 * (Length info in csp->content_length, which is 0 for
315 * unmodified documents)
317 * - For this to work, sed() is called twice when filtering.
319 * Revision 1.5 2001/05/26 00:28:36 jongfoster
320 * Automatic reloading of config file.
321 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
322 * Most of the global variables have been moved to a new
323 * struct configuration_spec, accessed through csp->config->globalname
324 * Most of the globals remaining are used by the Win32 GUI.
326 * Revision 1.4 2001/05/22 18:46:04 oes
328 * - Enabled filtering banners by size rather than URL
329 * by adding patterns that replace all standard banner
330 * sizes with the "Junkbuster" gif to the re_filterfile
332 * - Enabled filtering WebBugs by providing a pattern
333 * which kills all 1x1 images
335 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
336 * which is selected by the (nonstandard and therefore
337 * capital) letter 'U' in the option string.
338 * It causes the quantifiers to be ungreedy by default.
339 * Appending a ? turns back to greedy (!).
341 * - Added a new interceptor ijb-send-banner, which
342 * sends back the "Junkbuster" gif. Without imagelist or
343 * MSIE detection support, or if tinygif = 1, or the
344 * URL isn't recognized as an imageurl, a lame HTML
345 * explanation is sent instead.
347 * - Added new feature, which permits blocking remote
348 * script redirects and firing back a local redirect
350 * The feature is conditionally compiled, i.e. it
351 * can be disabled with --disable-fast-redirects,
352 * plus it must be activated by a "fast-redirects"
353 * line in the config file, has its own log level
354 * and of course wants to be displayed by show-proxy-args
355 * Note: Boy, all the #ifdefs in 1001 locations and
356 * all the fumbling with configure.in and acconfig.h
357 * were *way* more work than the feature itself :-(
359 * - Because a generic redirect template was needed for
360 * this, tinygif = 3 now uses the same.
362 * - Moved GIFs, and other static HTTP response templates
367 * - Removed some >400 CRs again (Jon, you really worked
370 * Revision 1.3 2001/05/20 01:21:20 jongfoster
371 * Version 2.9.4 checkin.
372 * - Merged popupfile and cookiefile, and added control over PCRS
373 * filtering, in new "actionsfile".
374 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
375 * file error you now get a message box (in the Win32 GUI) rather
376 * than the program exiting with no explanation.
377 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
379 * - Removed tabs from "config"
380 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
381 * - Bumped up version number.
383 * Revision 1.2 2001/05/17 23:01:01 oes
384 * - Cleaned CRLF's from the sources and related files
386 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
387 * Initial import of version 2.9.3 source tree
390 *********************************************************************/
393 /* Declare struct FILE for vars and funcs. */
396 /* Need time_t for file_list */
400 * Include appropriate regular expression libraries.
401 * Note that pcrs and pcre (native) are needed for cgi
402 * and are included anyway.
405 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
407 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
421 #if defined(REGEX_PCRE)
423 # include "pcreposix.h"
425 # include <pcreposix.h>
427 #endif /* defined(REGEX_PCRE) */
429 #if defined(REGEX_GNU)
430 # include "gnu_regex.h"
435 #endif /* def AMIGA */
439 * I don't want to have to #include all this just for the declaration
440 * of SOCKET. However, it looks like we have to...
451 * The type used by sockets. On UNIX it's an int. Microsoft decided to
452 * make it an unsigned.
455 typedef SOCKET jb_socket;
456 #define JB_INVALID_SOCKET INVALID_SOCKET
457 #else /* ndef _WIN32 */
458 typedef int jb_socket;
459 #define JB_INVALID_SOCKET (-1)
460 #endif /* ndef _WIN32 */
464 * Error codes. Functions returning these should return a jb_err
466 #define JB_ERR_OK 0 /* Success, no error */
467 #define JB_ERR_MEMORY 1 /* Out of memory */
468 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
469 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
470 #define JB_ERR_PARSE 4 /* Error parsing file */
471 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
472 /* CGI actions editor. */
477 * This macro is used to free a pointer that may be NULL
479 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
482 /* Fix a problem with Solaris. There should be no effect on other
484 * Solaris's isspace() is a macro which uses it's argument directly
485 * as an array index. Therefore we need to make sure that high-bit
486 * characters generate +ve values, and ideally we also want to make
487 * the argument match the declared parameter type of "int".
489 * Note: Remember to #include <ctype.h> if you use these macros.
491 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
492 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
493 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
496 * Use for statically allocated buffers if you have no other choice.
497 * Remember to check the length of what you write into the buffer
498 * - we don't want any buffer overflows!
500 #define BUFFER_SIZE 5000
503 * Buffer size for capturing struct hostent data in the
504 * gethostby(name|addr)_r library calls. Since we don't
505 * loop over gethostbyname_r, the buffer must be sufficient
506 * to accomodate multiple IN A RRs, as used in DNS round robin
507 * load balancing. W3C's wwwlib uses 1K, so that should be
508 * good enough for us, too.
510 #define HOSTENT_BUFFER_SIZE 1024
513 * So you can say "while (FOREVER) { ...do something... }"
517 /* Default IP and port to listen on */
518 #define HADDR_DEFAULT "127.0.0.1"
519 #define HADDR_PORT 8118
521 /* Forward defs for various structures */
523 /* Need this for struct client_state */
524 struct configuration_spec;
527 /* Generic linked list of strings */
532 struct list_entry *next;
537 struct list_entry *first;
538 struct list_entry *last;
542 /* A map from a string to another string */
548 struct map_entry *next;
553 struct map_entry *first;
554 struct map_entry *last;
560 char *cmd; /* Whole command line: method, URL, Version */
561 char *ocmd; /* Backup of original cmd for CLF logging */
562 char *gpc; /* HTTP method: GET, POST, .. */
563 char *url; /* The URL */
564 char *ver; /* Protocol version */
565 int status; /* HTTP Status */
567 char *host; /* Host part of URL */
568 int port; /* Port of URL or 80 (default) */
569 char *path; /* Path of URL */
570 char *hostport; /* host[:port] */
571 int ssl; /* Flag if protocol is https */
573 char *host_ip_addr_str; /* String with dotted decimal representation
574 * of host's IP. NULL before connect_to() */
576 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
577 char **dvec; /* List of pointers to the strings in dbuffer. */
578 int dcount; /* How many parts to this domain? (length of dvec) */
582 * Response generated by CGI, blocker, or error handler
586 char *status; /* HTTP status (string) */
587 struct list headers[1]; /* List of header lines */
588 char *head; /* Formatted http response head */
589 size_t head_length; /* Length of http response head */
590 char *body; /* HTTP document body */
591 size_t content_length; /* Length of body, REQUIRED if binary body */
592 int is_static; /* Nonzero if the content will never change and
593 * should be cached by the brwoser (e.g. images) */
599 char *spec; /* The string which was parsed to produce this */
600 /* url_spec. Used for debugging or display only. */
602 /* Hostname matching, or dbuffer == NULL to match all hosts */
603 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
604 char **dvec; /* List of pointers to the strings in dbuffer. */
605 int dcount; /* How many parts to this domain? (length of dvec) */
606 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
609 int port; /* The port number, or 0 to match all ports. */
612 char *path; /* The path prefix (if not using regex), or source */
614 int pathlen; /* ==strlen(path). Needed for prefix matching. */
616 regex_t *preg; /* Regex for matching path part */
620 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
621 #else /* ifndef REGEX */
622 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
623 #endif /* ndef REGEX */
625 /* Constants for host part matching in URLs */
626 #define ANCHOR_LEFT 1
627 #define ANCHOR_RIGHT 2
639 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
640 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
642 /* Bits for csp->content_type */
643 #define CT_TEXT 1 /* Suitable for pcrs filtering */
644 #define CT_GIF 2 /* Suitable for GIF filtering */
645 #define CT_TABOO 4 /* DONT filter */
647 #define ACTION_MASK_ALL (~0U)
649 #define ACTION_MOST_COMPATIBLE 0x00000000UL
651 #define ACTION_BLOCK 0x00000001UL
652 #define ACTION_DEANIMATE 0x00000002UL
653 #define ACTION_DOWNGRADE 0x00000004UL
654 #define ACTION_FAST_REDIRECTS 0x00000008UL
655 #define ACTION_HIDE_FORWARDED 0x00000010UL
656 #define ACTION_HIDE_FROM 0x00000020UL
657 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
658 #define ACTION_HIDE_USER_AGENT 0x00000080UL
659 #define ACTION_IMAGE 0x00000100UL
660 #define ACTION_IMAGE_BLOCKER 0x00000200UL
661 #define ACTION_NO_COMPRESSION 0x00000400UL
662 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
663 #define ACTION_NO_COOKIE_READ 0x00001000UL
664 #define ACTION_NO_COOKIE_SET 0x00002000UL
665 #define ACTION_NO_POPUPS 0x00004000UL
666 #define ACTION_VANILLA_WAFER 0x00008000UL
667 #define ACTION_LIMIT_CONNECT 0x00010000UL
669 #define ACTION_STRING_DEANIMATE 0
670 #define ACTION_STRING_FROM 1
671 #define ACTION_STRING_IMAGE_BLOCKER 2
672 #define ACTION_STRING_REFERER 3
673 #define ACTION_STRING_USER_AGENT 4
674 #define ACTION_STRING_LIMIT_CONNECT 5
675 #define ACTION_STRING_COUNT 6
677 #define ACTION_MULTI_ADD_HEADER 0
678 #define ACTION_MULTI_WAFER 1
679 #define ACTION_MULTI_FILTER 2
680 #define ACTION_MULTI_COUNT 3
684 * This structure contains a list of actions to apply to a URL.
685 * It only contains positive instructions - no "-" options.
686 * It is not used to store the actions list itself, only for
687 * url_actions() to return the current values.
689 struct current_action_spec
691 unsigned long flags; /* a bit set to "1" = add action */
693 /* For those actions that require parameters: */
695 /* each entry is valid if & only if corresponding entry in "add" set. */
696 char * string[ACTION_STRING_COUNT];
699 struct list multi[ACTION_MULTI_COUNT][1];
704 * This structure contains a set of changes to actions.
705 * It can contain both positive and negative instructions.
706 * It is used to store an entry in the actions list.
710 unsigned long mask; /* a bit set to "0" = remove action */
711 unsigned long add; /* a bit set to "1" = add action */
713 /* For those actions that require parameters: */
715 /* each entry is valid if & only if corresponding entry in "add" set. */
716 char * string[ACTION_STRING_COUNT];
718 /* Strings to remove. */
719 struct list multi_remove[ACTION_MULTI_COUNT][1];
721 /* If nonzero, remove *all* strings. */
722 int multi_remove_all[ACTION_MULTI_COUNT];
725 struct list multi_add[ACTION_MULTI_COUNT][1];
729 * This structure is used to store the actions list.
731 * It contains a URL pattern, and the chages to the actions.
732 * It is a linked list.
736 struct url_spec url[1];
738 struct action_spec action[1];
740 struct url_actions * next;
745 * Flags for use in csp->flags
747 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
748 * Cleared when the thread associated with
749 * this structure dies. */
750 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
751 * transfer encoding */
752 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
753 * it would normally have been blocked. */
754 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
755 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
756 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
759 * The state of a JunkBuster processing thread.
763 /* The proxy's configuration */
764 struct configuration_spec * config;
766 /* The actions to perform on the current request */
767 struct current_action_spec action[1];
769 /* socket to talk to client (web browser) */
772 /* socket to talk to server (web server or proxy) */
775 /* Multi-purpose flag container, see CSP_FLAG_* above */
776 unsigned short int flags;
779 * Client PC's IP address, as reported by the accept()_ function.
780 * Both as string and number
786 /* Our IP address and hostname, i.e. the IP address that
787 the client used to reach us, and the associated hostname,
790 char *my_ip_addr_str;
793 /* The URL that was requested */
794 struct http_request http[1];
796 /* An I/O buffer used for buffering data read from the client */
799 /* List of all headers for this request */
800 struct list headers[1];
802 /* List of all cookies for this request */
803 struct list cookie_list[1];
805 /* MIME-Type key, see CT_* above */
806 unsigned short int content_type;
808 /* The "X-Forwarded-For:" header sent by the client */
811 /* files associated with this client */
812 struct file_list *actions_list;
814 struct file_list *rlist; /* pcrs job file */
815 size_t content_length; /* Length after content modification */
818 struct file_list *tlist; /* trustfile */
819 #endif /* def FEATURE_TRUST */
821 struct client_state *next;
826 * A function to add a header
828 typedef jb_err (*add_header_func_ptr)(struct client_state *);
831 * A function to process a header
833 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
836 * List of functions to run on a list of headers
842 parser_func_ptr parser;
847 * List of available CGI functions.
849 struct cgi_dispatcher
851 const char * const name;
852 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
853 const char * const description;
858 * A data file used by JunkBuster. Kept in a linked list.
863 * this is a pointer to the data structures associated with the file.
864 * Read-only once the structure has been created.
868 /* Normally NULL. When we are finished with file (i.e. when we have
869 * loaded a new one), set to a pointer to an unloader function.
870 * Unloader will be called by sweep() (called from main loop) when
871 * all clients using this file are done. This prevents threading
874 void (*unloader)(void *);
876 /* Used internally by sweep(). Do not access from elsewhere. */
879 /* Following variables allow us to check if file has been changed.
880 * Read-only once the structure has been created.
885 /* Pointer to next entry in the linked list of all "file_list"s.
886 * This linked list is so that sweep() can navigate it.
887 * Since sweep() can remove items from the list, we must be careful
888 * to only access this value from main thread (when we know sweep
891 struct file_list *next;
898 struct url_spec url[1];
900 struct block_spec *next;
902 #endif /* def FEATURE_TRUST */
905 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
906 #define SOCKS_4 40 /* original SOCKS 4 protocol */
907 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
911 struct url_spec url[1];
913 /* Connection type - must be a SOCKS_xxx constant */
920 /* Parent HTTP proxy */
924 /* For the linked list */
925 struct forward_spec *next;
927 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
931 * This struct represents one filter (one block) from
932 * the re_filterfile. If there is more than one filter
933 * in the file, the file will be represented by a
934 * chained list of re_filterfile specs.
936 struct re_filterfile_spec
938 char *name; /* Name from FILTER: statement in re_filterfile */
939 char *description; /* Description from FILTER: statement in re_filterfile */
940 struct list patterns[1]; /* The patterns from the re_filterfile */
941 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
942 struct re_filterfile_spec *next; /* The pointer for chaining */
946 #define ACL_PERMIT 1 /* accept connection request */
947 #define ACL_DENY 2 /* reject connection request */
949 struct access_control_addr
956 struct access_control_list
958 struct access_control_addr src[1];
959 struct access_control_addr dst[1];
962 struct access_control_list *next;
964 #endif /* def FEATURE_ACL */
967 /* Maximum number of loaders (actions, re_filter, ...) */
971 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
972 #define RUNTIME_FEATURE_CGI_TOGGLE 2
976 * Data loaded from the configuration file.
978 * (Anomaly: toggle is still handled through a global, not this structure)
980 struct configuration_spec
985 /* Features that can be enabled/disabled throuigh the config file */
986 unsigned feature_flags;
992 const char *actions_file;
994 /* The administrator's email address */
997 /* A URL with info on this proxy */
998 char *proxy_info_url;
1000 const char *re_filterfile;
1002 #ifdef FEATURE_COOKIE_JAR
1003 const char * jarfile;
1005 #endif /* def FEATURE_COOKIE_JAR */
1008 * Port and IP to bind to.
1009 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1014 /* Size limit for IOB */
1015 size_t buffer_limit;
1017 #ifdef FEATURE_TRUST
1018 const char * trustfile;
1020 struct list trust_info[1];
1021 struct url_spec *trust_list[64];
1022 #endif /* def FEATURE_TRUST */
1025 struct access_control_list *acl;
1026 #endif /* def FEATURE_ACL */
1028 struct forward_spec *forward;
1030 /* All options from the config file, HTML-formatted */
1033 /* the configuration file object. */
1034 struct file_list *config_file_list;
1036 /* List of loaders */
1037 int (*loaders[NLOADERS])(struct client_state *);
1039 /* bool, nonzero if we need to bind() to the new port */
1044 #define SZ(X) (sizeof(X) / sizeof(*X))
1046 #ifdef FEATURE_FORCE_LOAD
1047 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
1048 #endif /* def FEATURE_FORCE_LOAD */
1050 #ifdef FEATURE_NO_GIFS
1051 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1053 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1054 #endif /* def FEATURE_NO_GIFS */
1057 /* Hardwired URLs */
1058 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
1059 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1062 * The "hosts" to intercept and display CGI pages.
1063 * First one is a hostname only, second one can specify host and path.
1066 * 1) Do not specify the http: prefix
1067 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1068 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1070 #define CGI_SITE_1_HOST "i.j.b"
1071 #define CGI_SITE_2_HOST "ijbswa.sourceforge.net"
1072 #define CGI_SITE_2_PATH "/config"
1075 * The prefix for CGI pages. Written out in generated HTML.
1076 * INCLUDES the trailing slash.
1078 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1081 /* HTTP snipplets */
1082 static const char CSUCCEED[] =
1083 "HTTP/1.0 200 Connection established\n"
1084 "Proxy-Agent: IJ/" VERSION "\r\n\r\n";
1086 static const char CHEADER[] =
1087 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1089 static const char CFORBIDDEN[] =
1090 "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";
1096 #endif /* ndef PROJECT_H_INCLUDED */