#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
-#define PROJECT_H_VERSION "$Id: project.h,v 1.35 2001/10/07 18:06:43 oes Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.44 2001/12/30 14:07:32 steudten Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
* IJBSWA team. http://ijbswa.sourceforge.net
*
* Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
+ * by and Copyright (C) 1997 Anonymous Coders and
* Junkbusters Corporation. http://www.junkbusters.com
*
- * This program is free software; you can redistribute it
+ * This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.44 2001/12/30 14:07:32 steudten
+ * - Add signal handling (unix)
+ * - Add SIGHUP handler (unix)
+ * - Add creation of pidfile (unix)
+ * - Add action 'top' in rc file (RH)
+ * - Add entry 'SIGNALS' to manpage
+ * - Add exit message to logfile (unix)
+ *
+ * Revision 1.43 2001/11/22 21:57:51 jongfoster
+ * Making action_spec->flags into an unsigned long rather than just an
+ * unsigned int.
+ * Adding ACTION_NO_COOKIE_KEEP
+ *
+ * Revision 1.42 2001/11/05 21:42:41 steudten
+ * Include DBG() macro.
+ *
+ * Revision 1.41 2001/10/28 19:12:06 jongfoster
+ * Adding ijb_toupper()
+ *
+ * Revision 1.40 2001/10/26 17:40:47 oes
+ * Moved ijb_isspace and ijb_tolower to project.h
+ * Removed http->user_agent, csp->referrer and csp->accept_types
+ *
+ * Revision 1.39 2001/10/25 03:45:02 david__schmidt
+ * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
+ * macro when called with a cast; so moving the cast to the macro def'n
+ * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
+ * doesn't make macro expansion complain. Hope this works for everyone else
+ * too...
+ *
+ * Revision 1.38 2001/10/23 21:19:04 jongfoster
+ * New error-handling support: jb_err type and JB_ERR_xxx constants
+ * CGI functions now return a jb_err, and their parameters map is const.
+ * Support for RUNTIME_FEATUREs to enable/disable config editor
+ * Adding a few comments
+ *
+ * Revision 1.37 2001/10/14 22:14:01 jongfoster
+ * Removing name_length field from struct cgi_dispatcher, as this is
+ * now calculated at runtime from the "name" field.
+ *
+ * Revision 1.36 2001/10/10 16:45:15 oes
+ * Added LIMIT_CONNECT action and string
+ * Fixed HTTP message line termination
+ * Added CFORBIDDEN HTTP message
+ *
* Revision 1.35 2001/10/07 18:06:43 oes
* Added status member to struct http_request
*
#endif
#ifdef STATIC_PCRS
-# include "pcrs.h"
+# include "pcrs.h"
#else
-# include <pcrs.h>
+# include <pcrs.h>
#endif
#if defined(REGEX_PCRE)
# include "gnu_regex.h"
#endif
-#ifdef AMIGA
-#include "amiga.h"
+#ifdef AMIGA
+#include "amiga.h"
#endif /* def AMIGA */
#ifdef __cplusplus
extern "C" {
#endif
-#define freez(X) { if(X) { free(X); X = NULL ; } }
+#ifdef _DEBUG
+extern int ldebug;
+#define DBG(a,b) { if ( ldebug >= a ) { printf b ; }}
+#else
+#define DBG(a,b)
+#endif /* _DEBUG */
+
+
+
+/*
+ * Error codes. Functions returning these should return a jb_err
+ */
+#define JB_ERR_OK 0 /* Success, no error */
+#define JB_ERR_MEMORY 1 /* Out of memory */
+#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
+#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
+#define JB_ERR_PARSE 4 /* Error parsing file */
+#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
+ /* CGI actions editor. */
+typedef int jb_err;
+
+
+/*
+ * This macro is used to free a pointer that may be NULL
+ */
+#define freez(X) { if(X) { free((void*)X); X = NULL ; } }
+
+
+/* Fix a problem with Solaris. There should be no effect on other
+ * platforms.
+ * Solaris's isspace() is a macro which uses it's argument directly
+ * as an array index. Therefore we need to make sure that high-bit
+ * characters generate +ve values, and ideally we also want to make
+ * the argument match the declared parameter type of "int".
+ *
+ * Note: Remember to #include <ctype.h> if you use these macros.
+ */
+#define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
+#define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
+#define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
+/*
+ * Use for statically allocated buffers if you have no other choice.
+ * Remember to check the length of what you write into the buffer
+ * - we don't want any buffer overflows!
+ */
#define BUFFER_SIZE 5000
+/*
+ * Buffer size for capturing struct hostent data in the
+ * gethostby(name|addr)_r library calls. Since we don't
+ * loop over gethostbyname_r, the buffer must be sufficient
+ * to accomodate multiple IN A RRs, as used in DNS round robin
+ * load balancing. W3C's wwwlib uses 1K, so that should be
+ * good enough for us, too.
+ */
+#define HOSTENT_BUFFER_SIZE 1024
+
+/*
+ * So you can say "while (FOREVER) { ...do something... }"
+ */
#define FOREVER 1
/* Default IP and port to listen on */
#define HADDR_DEFAULT "127.0.0.1"
#define HADDR_PORT 8000
+/*
+ * pid file name
+ */
+#define PID_FILE_NAME "junkbuster.pid"
/* Forward defs for various structures */
char *host_ip_addr_str; /* String with dotted decimal representation
* of host's IP. NULL before connect_to() */
- char *user_agent; /* Client's User-Agent: header value */
};
/* Response generated by CGI, blocker, or error handler */
#define ACTION_MASK_ALL (~0U)
-#define ACTION_MOST_COMPATIBLE 0x0000U
-
-#define ACTION_BLOCK 0x0001U
-#define ACTION_DEANIMATE 0x0002U
-#define ACTION_DOWNGRADE 0x0004U
-#define ACTION_FAST_REDIRECTS 0x0008U
-#define ACTION_FILTER 0x0010U
-#define ACTION_HIDE_FORWARDED 0x0020U
-#define ACTION_HIDE_FROM 0x0040U
-#define ACTION_HIDE_REFERER 0x0080U /* sic - follow HTTP, not English */
-#define ACTION_HIDE_USER_AGENT 0x0100U
-#define ACTION_IMAGE 0x0200U
-#define ACTION_IMAGE_BLOCKER 0x0400U
-#define ACTION_NO_COMPRESSION 0x0800U
-#define ACTION_NO_COOKIE_READ 0x1000U
-#define ACTION_NO_COOKIE_SET 0x2000U
-#define ACTION_NO_POPUPS 0x4000U
-#define ACTION_VANILLA_WAFER 0x8000U
-#define ACTION_LIMIT_CONNECT 0x010000U
+#define ACTION_MOST_COMPATIBLE 0x00000000UL
+
+#define ACTION_BLOCK 0x00000001UL
+#define ACTION_DEANIMATE 0x00000002UL
+#define ACTION_DOWNGRADE 0x00000004UL
+#define ACTION_FAST_REDIRECTS 0x00000008UL
+#define ACTION_FILTER 0x00000010UL
+#define ACTION_HIDE_FORWARDED 0x00000020UL
+#define ACTION_HIDE_FROM 0x00000040UL
+#define ACTION_HIDE_REFERER 0x00000080UL /* sic - follow HTTP, not English */
+#define ACTION_HIDE_USER_AGENT 0x00000100UL
+#define ACTION_IMAGE 0x00000200UL
+#define ACTION_IMAGE_BLOCKER 0x00000400UL
+#define ACTION_NO_COMPRESSION 0x00000800UL
+#define ACTION_NO_COOKIE_KEEP 0x00001000UL
+#define ACTION_NO_COOKIE_READ 0x00002000UL
+#define ACTION_NO_COOKIE_SET 0x00004000UL
+#define ACTION_NO_POPUPS 0x00008000UL
+#define ACTION_VANILLA_WAFER 0x00010000UL
+#define ACTION_LIMIT_CONNECT 0x00020000UL
#define ACTION_STRING_DEANIMATE 0
#define ACTION_STRING_FROM 1
*/
struct current_action_spec
{
- unsigned flags; /* a bit set to "1" = add action */
+ unsigned long flags; /* a bit set to "1" = add action */
/* For those actions that require parameters: */
*/
struct action_spec
{
- unsigned mask; /* a bit set to "0" = remove action */
- unsigned add; /* a bit set to "1" = add action */
+ unsigned long mask; /* a bit set to "0" = remove action */
+ unsigned long add; /* a bit set to "1" = add action */
/* For those actions that require parameters: */
};
-/* Constants defining bitmask for csp->accept_types */
-
-#ifdef FEATURE_IMAGE_DETECT_MSIE
-
-/* MSIE detected by user-agent string */
-#define ACCEPT_TYPE_IS_MSIE 0x0001
-
-/*
- * *If* this is MSIE, it wants an image. (Or this is a shift-reload, or
- * it's got an image from this URL before... yuck!)
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set
- */
-#define ACCEPT_TYPE_MSIE_IMAGE 0x0002
-
-/*
- * *If* this is MSIE, it wants a HTML document.
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set
- */
-#define ACCEPT_TYPE_MSIE_HTML 0x0004
-
-#endif /* def FEATURE_IMAGE_DETECT_MSIE */
-
/*
* Flags for use in csp->flags
*/
#define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
+/*
+ * The state of a JunkBuster processing thread.
+ */
struct client_state
{
/* The proxy's configuration */
char *my_ip_addr_str;
char *my_hostname;
-#ifdef FEATURE_TRUST
- /* The referer in this request, if one was specified. */
- char *referrer;
-#endif /* def FEATURE_TRUST */
-
-#if defined(FEATURE_IMAGE_DETECT_MSIE)
- /* Types the client will accept.
- * Bitmask - see ACCEPT_TYPE_XXX constants.
- */
- int accept_types;
-#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */
-
/* The URL that was requested */
struct http_request http[1];
struct file_list *actions_list;
struct file_list *rlist; /* pcrs job file */
- size_t content_length; /* Length after content modification */
+ size_t content_length; /* Length after content modification */
#ifdef FEATURE_TRUST
struct file_list *tlist; /* trustfile */
};
+/*
+ * List of functions to run on a list of headers
+ */
struct parsers
{
char *str;
char *(*parser)(const struct parsers *, const char *, struct client_state *);
};
+
+/*
+ * List of available CGI functions.
+ */
struct cgi_dispatcher
{
- const char *name;
- int name_length;
- int (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters);
- const char *description;
+ const char * const name;
+ jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
+ const char * const description;
};
+
+/*
+ * A data file used by JunkBuster. Kept in a linked list.
+ */
struct file_list
{
/*
* Read-only once the structure has been created.
*/
void *f;
-
+
/* Normally NULL. When we are finished with file (i.e. when we have
* loaded a new one), set to a pointer to an unloader function.
* Unloader will be called by sweep() (called from main loop) when
- * all clients using this file are done. This prevents threading
+ * all clients using this file are done. This prevents threading
* problems.
*/
void (*unloader)(void *);
/* Maximum number of loaders (actions, re_filter, ...) */
#define NLOADERS 8
+
+#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
+#define RUNTIME_FEATURE_CGI_TOGGLE 2
+
+
/*
* Data loaded from the configuration file.
*
int debug;
int multi_threaded;
+ /* Features that can be enabled/disabled throuigh the config file */
+ unsigned feature_flags;
+
const char *logfile;
const char *confdir;