X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=pcrs.h;h=a3bfede6414c568b65a4be1811ea010f6abe8088;hp=9c29ca73215c1f024a8bdc1ac1eeea1e43c4e147;hb=828afb5284f082722460ac443a958016b0f77a6f;hpb=b655349f3a38329dd7042a3315e8c9e0fef9e51c diff --git a/pcrs.h b/pcrs.h index 9c29ca73..a3bfede6 100644 --- a/pcrs.h +++ b/pcrs.h @@ -11,6 +11,37 @@ * * Revisions : * $Log: pcrs.h,v $ + * Revision 1.15 2007/01/05 15:46:12 fabiankeil + * Don't use strlen() to calculate the length of + * the pcrs substitutes. They don't have to be valid C + * strings and getting their length wrong can result in + * user-controlled memory corruption. + * + * Thanks to Felix Gröbert for reporting the problem + * and providing the fix [#1627140]. + * + * Revision 1.14 2006/12/24 17:27:37 fabiankeil + * Increase pcrs error code offset to prevent overlaps + * with pcre versions newer than our own. + * + * Revision 1.13 2006/07/18 14:48:47 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.11 2002/03/08 14:18:23 oes + * Fixing -Wconversion warnings + * + * Revision 1.10 2002/03/08 13:44:48 oes + * Hiding internal functions, preventing double inclusion of pcre.h + * + * Revision 1.9 2001/08/18 11:35:29 oes + * - Introduced pcrs_strerror() + * - added pcrs_execute_list() + * + * Revision 1.8 2001/08/15 15:32:50 oes + * Replaced the hard limit for the maximum number of matches + * by dynamic reallocation + * * Revision 1.7 2001/08/05 13:13:11 jongfoster * Making parameters "const" where possible. * @@ -48,10 +79,12 @@ * *********************************************************************/ -#define PCRS_H_VERSION "$Id: pcrs.h,v 1.8 2001/08/15 15:26:58 oes Exp $" +#define PCRS_H_VERSION "$Id: pcrs.h,v 1.15 2007/01/05 15:46:12 fabiankeil Exp $" +#ifndef _PCRE_H #include +#endif #ifdef __cplusplus extern "C" { @@ -65,15 +98,26 @@ extern "C" { #define TRUE 1 /* Capacity */ -#define PCRS_MAX_SUBMATCHES 33 /* Maximum number of capturing subpatterns allowed. FIXME: Should be dynamic */ +#define PCRS_MAX_SUBMATCHES 33 /* Maximum number of capturing subpatterns allowed. MUST be <= 99! FIXME: Should be dynamic */ #define PCRS_MAX_MATCH_INIT 40 /* Initial amount of matches that can be stored in global searches */ -#define PCRS_MAX_MATCH_GROW 1.5 /* Factor by which storage for matches is extended if exhausted */ +#define PCRS_MAX_MATCH_GROW 1.6 /* Factor by which storage for matches is extended if exhausted */ -/* Error codes */ -#define PCRS_ERR_NOMEM -10 /* Failed to acquire memory. */ -#define PCRS_ERR_CMDSYNTAX -11 /* Syntax of s///-command */ -#define PCRS_ERR_STUDY -12 /* pcre error while studying the pattern */ -#define PCRS_ERR_BADJOB -13 /* NULL job pointer, pattern or substitute */ +/* + * PCRS error codes + * + * They are supposed to be handled together with PCRE error + * codes and have to start with an offset to prevent overlaps. + * + * PCRE 6.7 uses error codes from -1 to -21, PCRS error codes + * below -100 should be safe for a while. + */ +#define PCRS_ERR_NOMEM -100 /* Failed to acquire memory. */ +#define PCRS_ERR_CMDSYNTAX -101 /* Syntax of s///-command */ +#define PCRS_ERR_STUDY -102 /* pcre error while studying the pattern */ +#define PCRS_ERR_BADJOB -103 /* NULL job pointer, pattern or substitute */ +#define PCRS_WARN_BADREF -104 /* Backreference out of range */ +#define PCRS_WARN_TRUNCATION -105 /* At least one pcrs variable was too big, + * only the first part was used. */ /* Flags */ #define PCRS_GLOBAL 1 /* Job should be applied globally, as with perl's g option */ @@ -87,29 +131,32 @@ extern "C" { /* A compiled substitute */ -typedef struct PCRS_SUBSTITUTE { - char *text; /* The plaintext part of the substitute, with all backreferences stripped */ - int backrefs; /* The number of backreferences */ - int block_offset[PCRS_MAX_SUBMATCHES]; /* Array with the offsets of all plaintext blocks in text */ - int block_length[PCRS_MAX_SUBMATCHES]; /* Array with the lengths of all plaintext blocks in text */ - int backref[PCRS_MAX_SUBMATCHES]; /* Array with the backref number for all plaintext block borders */ - int backref_count[PCRS_MAX_SUBMATCHES]; /* Array with the number of reference to each backref index */ +typedef struct { + char *text; /* The plaintext part of the substitute, with all backreferences stripped */ + size_t length; /* The substitute may not be a valid C string so we can't rely on strlen(). */ + int backrefs; /* The number of backreferences */ + int block_offset[PCRS_MAX_SUBMATCHES]; /* Array with the offsets of all plaintext blocks in text */ + size_t block_length[PCRS_MAX_SUBMATCHES]; /* Array with the lengths of all plaintext blocks in text */ + int backref[PCRS_MAX_SUBMATCHES]; /* Array with the backref number for all plaintext block borders */ + int backref_count[PCRS_MAX_SUBMATCHES + 2]; /* Array with the number of references to each backref index */ } pcrs_substitute; + /* * A match, including all captured subpatterns (submatches) - * Note: The zeroth is the whole match, the PCRS_MAX_SUBMATCHES + 1st - * is the range before the match, the PCRS_MAX_SUBMATCHES + 2nd is the + * Note: The zeroth is the whole match, the PCRS_MAX_SUBMATCHES + 0th + * is the range before the match, the PCRS_MAX_SUBMATCHES + 1th is the * range after the match. */ -typedef struct PCRS_MATCH { - int submatches; /* Number of submatches */ - int submatch_offset[PCRS_MAX_SUBMATCHES + 2]; /* Offset for each submatch in the subject */ - int submatch_length[PCRS_MAX_SUBMATCHES + 2]; /* Length of each submatch in the subject */ +typedef struct { + int submatches; /* Number of captured subpatterns */ + int submatch_offset[PCRS_MAX_SUBMATCHES + 2]; /* Offset for each submatch in the subject */ + size_t submatch_length[PCRS_MAX_SUBMATCHES + 2]; /* Length of each submatch in the subject */ } pcrs_match; -/* A pcrs job */ + +/* A PCRS job */ typedef struct PCRS_JOB { pcre *pattern; /* The compiled pcre pattern */ @@ -120,6 +167,7 @@ typedef struct PCRS_JOB { struct PCRS_JOB *next; /* Pointer for chaining jobs to joblists */ } pcrs_job; + /* * Prototypes: */ @@ -127,15 +175,35 @@ typedef struct PCRS_JOB { /* Main usage */ extern pcrs_job *pcrs_compile_command(const char *command, int *errptr); extern pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr); -extern int pcrs_execute(pcrs_job *job, char *subject, int subject_length, char **result, int *result_length); +extern int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length); +extern int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length); /* Freeing jobs */ extern pcrs_job *pcrs_free_job(pcrs_job *job); extern void pcrs_free_joblist(pcrs_job *joblist); -/* Expert usage */ -extern int pcrs_parse_perl_options(const char *optstring, int *flags); -extern pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int capturecount, int *errptr); +/* Info on errors: */ +extern const char *pcrs_strerror(const int error); + +extern int pcrs_job_is_dynamic(char *job); +extern char pcrs_get_delimiter(const char *string); +extern char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits); +/* + * Variable/value pair for dynamic pcrs commands. + */ +struct pcrs_variable +{ + const char *name; + char *value; + int static_value; +}; + +extern pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error); + +/* Only relevant for maximum pcrs variable size */ +#ifndef PCRS_BUFFER_SIZE +#define PCRS_BUFFER_SIZE 4000 +#endif /* ndef PCRS_BUFFER_SIZE */ #ifdef __cplusplus } /* extern "C" */