X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=project.h;h=472222d43a556ecaad4c98b7ca9a98406a9b6413;hb=07ce1074db2cafac47f64c5933bcb5f7521023c6;hp=e0f526e17a0dd926f08a696c7d212625040f0ed8;hpb=ae6704a51522180202416c36a30a4d6d2914a0f5;p=privoxy.git diff --git a/project.h b/project.h index e0f526e1..472222d4 100644 --- a/project.h +++ b/project.h @@ -1,6 +1,6 @@ #ifndef PROJECT_H_INCLUDED #define PROJECT_H_INCLUDED -#define PROJECT_H_VERSION "$Id: project.h,v 1.27 2001/08/05 16:06:20 jongfoster Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.38 2001/10/23 21:19:04 jongfoster Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -13,10 +13,10 @@ * 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 @@ -36,6 +36,61 @@ * * Revisions : * $Log: project.h,v $ + * 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 + * + * 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 @@ -265,9 +320,9 @@ #endif #ifdef STATIC_PCRS -# include "pcrs.h" +# include "pcrs.h" #else -# include +# include #endif #if defined(REGEX_PCRE) @@ -282,18 +337,43 @@ # 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 +/* + * 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 ; } } + +/* + * 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 +/* + * So you can say "while (FOREVER) { ...do something... }" + */ #define FOREVER 1 /* Default IP and port to listen on */ @@ -301,17 +381,29 @@ extern "C" { #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 { - char * str; /* valid in an entry */ - struct list *last; /* valid in header */ - struct list *next; + 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 { const char *name; @@ -325,18 +417,24 @@ struct map 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 */ @@ -347,7 +445,9 @@ struct http_response 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 */ @@ -375,6 +475,11 @@ struct url_spec 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 @@ -394,35 +499,39 @@ struct iob #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_LIMIT_CONNECT 0x010000U #define ACTION_STRING_DEANIMATE 0 #define ACTION_STRING_FROM 1 #define ACTION_STRING_IMAGE_BLOCKER 2 #define ACTION_STRING_REFERER 3 #define ACTION_STRING_USER_AGENT 4 -#define ACTION_STRING_COUNT 5 - +#define ACTION_STRING_LIMIT_CONNECT 5 +#define ACTION_STRING_COUNT 6 #define ACTION_MULTI_ADD_HEADER 0 #define ACTION_MULTI_WAFER 1 @@ -499,7 +608,7 @@ struct url_actions /* * *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 + * Only meaningful if ACCEPT_TYPE_IS_MSIE set */ #define ACCEPT_TYPE_MSIE_IMAGE 0x0002 @@ -511,7 +620,23 @@ struct url_actions #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) */ +/* + * The state of a JunkBuster processing thread. + */ struct client_state { /* The proxy's configuration */ @@ -526,21 +651,8 @@ struct client_state /* socket to talk to server (web server or proxy) */ int sfd; - -#ifdef FEATURE_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 FEATURE_STATISTICS */ - -#ifdef FEATURE_FORCE_LOAD - int force; -#endif /* def FEATURE_FORCE_LOAD */ - -#ifdef FEATURE_TOGGLE - int toggled_on; -#endif /* def FEATURE_TOGGLE */ + /* Multi-purpose flag container, see CSP_FLAG_* above */ + unsigned short int flags; /* * Client PC's IP address, as reported by the accept()_ function. @@ -581,23 +693,17 @@ struct client_state /* 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 */ + size_t content_length; /* Length after content modification */ #ifdef FEATURE_TRUST struct file_list *tlist; /* trustfile */ @@ -607,6 +713,9 @@ struct client_state }; +/* + * List of functions to run on a list of headers + */ struct parsers { char *str; @@ -614,14 +723,21 @@ struct parsers 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 { /* @@ -629,11 +745,11 @@ 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 *); @@ -689,6 +805,8 @@ struct forward_spec /* 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 { @@ -723,6 +841,11 @@ struct access_control_list /* 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. * @@ -733,6 +856,9 @@ struct configuration_spec int debug; int multi_threaded; + /* Features that can be enabled/disabled throuigh the config file */ + unsigned feature_flags; + const char *logfile; const char *confdir; @@ -759,6 +885,9 @@ struct configuration_spec const char *haddr; int hport; + /* Size limit for IOB */ + size_t buffer_limit; + #ifdef FEATURE_TRUST const char * trustfile; @@ -800,10 +929,13 @@ struct configuration_spec /* HTTP snipplets */ static const char CSUCCEED[] = "HTTP/1.0 200 Connection established\n" - "Proxy-Agent: IJ/" VERSION "\n\n"; + "Proxy-Agent: IJ/" VERSION "\r\n\r\n"; static const char CHEADER[] = - "HTTP/1.0 400 Invalid header received from browser\n\n"; + "HTTP/1.0 400 Invalid header received from browser\r\n\r\n"; + +static const char CFORBIDDEN[] = + "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"; #ifdef __cplusplus } /* extern "C" */