-#ifndef _PROJECT_H
-#define _PROJECT_H
-#define PROJECT_H_VERSION "$Id: project.h,v 1.23 2001/07/18 12:32:23 oes Exp $"
+#ifndef PROJECT_H_INCLUDED
+#define PROJECT_H_INCLUDED
+#define PROJECT_H_VERSION "$Id: project.h,v 1.34 2001/10/07 15:45:25 oes Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.34 2001/10/07 15:45:25 oes
+ * Added url member to struct http_request and commented all
+ * members
+ *
+ * Added CT_TABOO
+ *
+ * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
+ *
+ * Replaced struct client_state members rejected,
+ * force, active and toggled_on with "flags" bitmap.
+ *
+ * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
+ *
+ * Added buffer_limit to struct configuration_spec
+ *
+ * Revision 1.33 2001/09/20 13:30:08 steudten
+ *
+ * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
+ * Last case will set z to NULL in free(z) and thats bad..
+ *
+ * Revision 1.32 2001/09/16 23:02:51 jongfoster
+ * Fixing warning
+ *
+ * Revision 1.31 2001/09/16 13:20:29 jongfoster
+ * Rewrite of list library. Now has seperate header and list_entry
+ * structures. Also added a large sprinking of assert()s to the list
+ * code.
+ *
+ * Revision 1.30 2001/09/13 23:52:00 jongfoster
+ * Support for both static and dynamically generated CGI pages
+ *
+ * Revision 1.29 2001/09/13 23:29:43 jongfoster
+ * Defining FORWARD_SPEC_INITIALIZER
+ *
+ * Revision 1.28 2001/09/13 23:05:50 jongfoster
+ * Changing the string paramater to the header parsers a "const".
+ *
+ * Revision 1.27 2001/08/05 16:06:20 jongfoster
+ * Modifiying "struct map" so that there are now separate header and
+ * "map_entry" structures. This means that functions which modify a
+ * map no longer need to return a pointer to the modified map.
+ * Also, it no longer reverses the order of the entries (which may be
+ * important with some advanced template substitutions).
+ *
+ * Revision 1.26 2001/07/30 22:08:36 jongfoster
+ * Tidying up #defines:
+ * - All feature #defines are now of the form FEATURE_xxx
+ * - Permanently turned off WIN_GUI_EDIT
+ * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
+ *
+ * Revision 1.25 2001/07/29 18:43:08 jongfoster
+ * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
+ * ANSI C rules.
+ *
+ * Revision 1.24 2001/07/25 17:20:27 oes
+ * Introduced http->user_agent
+ *
* Revision 1.23 2001/07/18 12:32:23 oes
* - Added ACTION_STRING_DEANIMATE
* - moved #define freez from jcc.h to project.h
extern "C" {
#endif
-#define freez(X) if(X) free(X); X = NULL
+#define freez(X) { if(X) { free(X); X = NULL ; } }
#define BUFFER_SIZE 5000
#define HADDR_PORT 8000
+/* Forward defs for various structures */
+
/* Need this for struct client_state */
struct configuration_spec;
+
/* Generic linked list of strings */
-struct list /* FIXME: Why not separate entries and header? */
+
+struct list_entry
+{
+ const char *str;
+ struct list_entry *next;
+};
+
+struct list
+{
+ struct list_entry *first;
+ struct list_entry *last;
+};
+
+
+/* A map from a string to another string */
+
+struct map_entry
{
- char * str; /* valid in an entry */
- struct list *last; /* valid in header */
- struct list *next;
+ const char *name;
+ const char *value;
+ struct map_entry *next;
};
struct map
{
- char *name;
- char *value;
- struct map *next;
+ struct map_entry *first;
+ struct map_entry *last;
};
+
struct http_request
{
- char *cmd;
- char *gpc;
- char *host;
- char *host_ip_addr_str; /* NULL before connect_to() */
- int port;
- char *path;
- char *ver;
- char *hostport; /* "host[:port]" */
- int ssl;
- char *user_agent; /* Client's User-Agent: header value */
+ char *cmd; /* Whole command line: method, URL, Version */
+ char *gpc; /* HTTP method: GET, POST, .. */
+ char *url; /* The URL */
+ char *ver; /* Protocol version */
+ int status; /* HTTP Status */
+
+ char *host; /* Host part of URL */
+ int port; /* Port of URL or 80 (default) */
+ char *path; /* Path of URL */
+ char *hostport; /* host[:port] */
+ int ssl; /* Flag if protocol is https */
+
+ 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 */
char *head; /* Formatted http response head */
int head_length; /* Length of http response head */
char *body; /* HTTP document body */
- int content_length; /* Length of body, REQUIRED if binary body*/
+ int content_length; /* Length of body, REQUIRED if binary body */
+ int is_static; /* Nonzero if the content will never change and
+ * should be cached by the broser (e.g. images) */
};
/* A URL pattern */
regex_t *preg; /* Regex for matching path part */
#endif
};
+#ifdef REGEX
+#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
+#else /* ifndef REGEX */
+#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
+#endif /* ndef REGEX */
/* Constants for host part matching in URLs */
#define ANCHOR_LEFT 1
#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
/* Keys for csp->content_type */
-#define CT_TEXT 0x01U
-#define CT_GIF 0x02U
+#define CT_TEXT 1 /* Suitable for pcrs filtering */
+#define CT_GIF 2 /* Suitable for GIF filtering */
+#define CT_TABOO 3 /* DONT filter */
#define ACTION_MASK_ALL (~0U)
#define ACTION_MOST_COMPATIBLE 0x0000U
#define ACTION_BLOCK 0x0001U
-#define ACTION_DEANIMATE 0x2000U
-#define ACTION_FAST_REDIRECTS 0x0002U
-#define ACTION_FILTER 0x0004U
-#define ACTION_HIDE_FORWARDED 0x0008U
-#define ACTION_HIDE_FROM 0x0010U
-#define ACTION_HIDE_REFERER 0x0020U /* sic - follow HTTP, not English */
-#define ACTION_HIDE_USER_AGENT 0x0040U
-#define ACTION_IMAGE 0x0080U
-#define ACTION_IMAGE_BLOCKER 0x0100U
-#define ACTION_NO_COOKIE_READ 0x0200U
-#define ACTION_NO_COOKIE_SET 0x0400U
-#define ACTION_NO_POPUPS 0x0800U
-#define ACTION_VANILLA_WAFER 0x1000U
+#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_STRING_DEANIMATE 0
#define ACTION_STRING_FROM 1
/* Constants defining bitmask for csp->accept_types */
-#ifdef DETECT_MSIE_IMAGES
+#ifdef FEATURE_IMAGE_DETECT_MSIE
/* MSIE detected by user-agent string */
#define ACCEPT_TYPE_IS_MSIE 0x0001
*/
#define ACCEPT_TYPE_MSIE_HTML 0x0004
-#endif /* def DETECT_MSIE_IMAGES */
+#endif /* def FEATURE_IMAGE_DETECT_MSIE */
+/*
+ * Flags for use in csp->flags
+ */
+#define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
+ * Cleared when the thread associated with
+ * this structure dies. */
+#define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
+ * transfer encoding */
+#define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
+ * it would normally have been blocked. */
+#define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
+#define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
+#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
struct client_state
{
/* socket to talk to server (web server or proxy) */
int sfd;
-
-#ifdef STATISTICS
- /* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to
- * occur in main thread only for thread-safety.
- */
- int rejected;
-#endif /* def STATISTICS */
-
-#ifdef FORCE_LOAD
- int force;
-#endif /* def FORCE_LOAD */
-
-#ifdef TOGGLE
- int toggled_on;
-#endif /* def TOGGLE */
+ /* Multi-purpose flag container, see CSP_FLAG_* above */
+ unsigned short int flags;
/*
* Client PC's IP address, as reported by the accept()_ function.
char *my_ip_addr_str;
char *my_hostname;
-#ifdef TRUST_FILES
+#ifdef FEATURE_TRUST
/* The referer in this request, if one was specified. */
char *referrer;
-#endif /* def TRUST_FILES */
+#endif /* def FEATURE_TRUST */
-#if defined(DETECT_MSIE_IMAGES)
+#if defined(FEATURE_IMAGE_DETECT_MSIE)
/* Types the client will accept.
* Bitmask - see ACCEPT_TYPE_XXX constants.
*/
int accept_types;
-#endif /* defined(DETECT_MSIE_IMAGES) */
+#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */
/* The URL that was requested */
struct http_request http[1];
/* List of all cookies for this request */
struct list cookie_list[1];
- /* MIME-Type bitmap, see CT_* above */
- unsigned char content_type;
+ /* MIME-Type key, see CT_* above */
+ unsigned short int content_type;
/* The "X-Forwarded-For:" header sent by the client */
char *x_forwarded;
- /*
- * Nonzero if this client is processing data.
- * Set to zero when the thread associated with this structure dies.
- */
- int active;
-
/* files associated with this client */
struct file_list *actions_list;
struct file_list *rlist; /* pcrs job file */
size_t content_length; /* Length after content modification */
-#ifdef TRUST_FILES
+#ifdef FEATURE_TRUST
struct file_list *tlist; /* trustfile */
-#endif /* def TRUST_FILES */
+#endif /* def FEATURE_TRUST */
struct client_state *next;
};
{
char *str;
char len;
- char *(*parser)(const struct parsers *, char *, struct client_state *);
+ char *(*parser)(const struct parsers *, const char *, struct client_state *);
};
struct cgi_dispatcher
/* Used internally by sweep(). Do not access from elsewhere. */
int active;
-#ifndef SPLIT_PROXY_ARGS
- /* String to be displayed as part of show-proxy-args display.
- * Read-only once the structure has been created.
- */
- char *proxy_args;
-#endif /* ndef SPLIT_PROXY_ARGS */
-
/* Following variables allow us to check if file has been changed.
* Read-only once the structure has been created.
*/
};
-#ifdef TRUST_FILES
+#ifdef FEATURE_TRUST
struct block_spec
{
struct url_spec url[1];
int reject;
struct block_spec *next;
};
-#endif /* def TRUST_FILES */
+#endif /* def FEATURE_TRUST */
#define SOCKS_NONE 0 /* Don't use a SOCKS server */
/* For the linked list */
struct forward_spec *next;
};
+#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
+
struct re_filterfile_spec
{
pcrs_job *joblist;
};
-#ifdef ACL_FILES
+#ifdef FEATURE_ACL
#define ACL_PERMIT 1 /* accept connection request */
#define ACL_DENY 2 /* reject connection request */
short action;
struct access_control_list *next;
};
-#endif /* def ACL_FILES */
+#endif /* def FEATURE_ACL */
/* Maximum number of loaders (actions, re_filter, ...) */
const char *re_filterfile;
-#ifdef JAR_FILES
+#ifdef FEATURE_COOKIE_JAR
const char * jarfile;
FILE * jar;
-#endif /* def JAR_FILES */
+#endif /* def FEATURE_COOKIE_JAR */
/*
* Port and IP to bind to.
const char *haddr;
int hport;
-#ifndef SPLIT_PROXY_ARGS
- const char *suppress_message;
-#endif /* ndef SPLIT_PROXY_ARGS */
-
-#ifndef SPLIT_PROXY_ARGS
- /* suppress listing config files */
- int suppress_blocklists;
-#endif /* ndef SPLIT_PROXY_ARGS */
+ /* Size limit for IOB */
+ size_t buffer_limit;
-#ifdef TRUST_FILES
+#ifdef FEATURE_TRUST
const char * trustfile;
struct list trust_info[1];
struct url_spec *trust_list[64];
-#endif /* def TRUST_FILES */
+#endif /* def FEATURE_TRUST */
-#ifdef ACL_FILES
+#ifdef FEATURE_ACL
struct access_control_list *acl;
-#endif /* def ACL_FILES */
+#endif /* def FEATURE_ACL */
struct forward_spec *forward;
#define SZ(X) (sizeof(X) / sizeof(*X))
-#ifdef FORCE_LOAD
+#ifdef FEATURE_FORCE_LOAD
#define FORCE_PREFIX "/IJB-FORCE-LOAD"
-#endif /* def FORCE_LOAD */
+#endif /* def FEATURE_FORCE_LOAD */
/* Hardwired URLs */
#define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
} /* extern "C" */
#endif
-#endif /* ndef _PROJECT_H */
+#endif /* ndef PROJECT_H_INCLUDED */
/*
Local Variables: