Annotation of parser3/src/main/untaint.C, revision 1.141
1.7 paf 1: /** @file
1.8 paf 2: Parser: String class part: untaint mechanizm.
3:
1.135 paf 4: Copyright(c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com)
1.89 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.103 paf 6: */
1.8 paf 7:
1.141 ! misha 8: static const char * const IDENT_UNTAINT_C="$Date: 2008-07-15 12:55:43 $";
1.117 paf 9:
1.1 paf 10:
11: #include "pa_string.h"
12: #include "pa_hash.h"
13: #include "pa_exception.h"
1.13 paf 14: #include "pa_table.h"
1.32 paf 15: #include "pa_globals.h"
1.58 parser 16: #include "pa_dictionary.h"
1.66 parser 17: #include "pa_common.h"
1.85 paf 18: #include "pa_charset.h"
1.117 paf 19: #include "pa_request_charsets.h"
20: #include "pa_sapi.h"
1.1 paf 21:
1.117 paf 22: extern "C" { // author forgot to do that
23: #include "ec.h"
24: }
1.91 paf 25:
1.117 paf 26: #include "pa_sql_connection.h"
1.91 paf 27:
1.117 paf 28: // defines
29:
30: #undef CORD_ec_append
31: // redefining to intercept flushes and implement whitespace optimization
32: // of all consequent white space chars leaving only first one
33: #define CORD_ec_append(x, c) \
34: { \
35: bool skip=false; \
36: if(optimize) switch(c) { \
1.131 paf 37: case ' ': case '\n': case '\t': \
1.117 paf 38: if(whitespace) \
39: skip=true; /*skipping subsequent*/ \
40: else \
41: whitespace=true; \
42: break; \
43: default: \
44: whitespace=false; \
45: break; \
46: } \
47: if(!skip) { \
48: if ((x)[0].ec_bufptr == (x)[0].ec_buf + CORD_BUFSZ) { \
49: CORD_ec_flush_buf(x); \
50: } \
51: *((x)[0].ec_bufptr)++ = (c); \
52: } \
53: }
54:
55:
1.140 misha 56: #define escape_fragment(action) \
1.119 paf 57: for(; fragment_length--; CORD_next(info->pos)) { \
58: char c=CORD_pos_fetch(info->pos); \
1.117 paf 59: action \
1.1 paf 60: }
1.133 paf 61: #define _default CORD_ec_append(info->result, c)
1.117 paf 62: #define encode(need_encode_func, prefix, otherwise) \
63: if(need_encode_func(c)) { \
64: static const char* hex="0123456789ABCDEF"; \
1.119 paf 65: CORD_ec_append(info->result, prefix); \
66: CORD_ec_append(info->result, hex[((unsigned char)c)/0x10]); \
67: CORD_ec_append(info->result, hex[((unsigned char)c)%0x10]); \
1.117 paf 68: } else \
1.119 paf 69: CORD_ec_append(info->result, otherwise);
1.126 paf 70: #define to_char(c) { CORD_ec_append(info->result, c); whitespace=false; }
71: #define to_string(s) { CORD_ec_append_cord(info->result, s); whitespace=false; }
1.4 paf 72:
1.9 paf 73: inline bool need_file_encode(unsigned char c){
1.108 paf 74: // russian letters and space ENABLED
75: // encoding only these...
76: return strchr(
77: "*?'\"<>|"
78: #ifndef WIN32
1.116 paf 79: ":\\"
1.31 paf 80: #endif
1.108 paf 81: , c)!=0;
1.9 paf 82: }
1.5 paf 83: inline bool need_uri_encode(unsigned char c){
1.13 paf 84: if((c>='0') &&(c<='9') ||(c>='A') &&(c<='Z') ||(c>='a') &&(c<='z'))
1.4 paf 85: return false;
86:
1.5 paf 87: return !strchr("_-./", c);
88: }
1.36 paf 89: inline bool need_http_header_encode(unsigned char c){
1.18 paf 90: if(strchr(" , :", c))
1.5 paf 91: return false;
92:
93: return need_uri_encode(c);
1.4 paf 94: }
1.136 paf 95: inline bool need_regex_escape(unsigned char c){
96: return strchr("\\^$.[]|()?*+{}", c)!=0;
97: }
1.1 paf 98:
99: // String
100:
1.41 paf 101: /*
102: HTTP-header = field-name ":" [ field-value ] CRLF
103:
104: field-name = token
105: field-value = *( field-content | LWS )
106:
107: field-content = <the OCTETs making up the field-value
108: and consisting of either *TEXT or combinations
109: of token, tspecials, and quoted-string>
110:
111:
112:
113: word = token | quoted-string
114:
115: token = 1*<any CHAR except CTLs or tspecials>
116:
117:
118:
119: tspecials = "(" | ")" | "<" | ">" | "@"
120: | "," | ";" | ":" | "\" | <">
121: | "/" | "[" | "]" | "?" | "="
122: | "{" | "}" | SP | HT
123:
124: SP = <US-ASCII SP, space (32)>
125: HT = <US-ASCII HT, horizontal-tab (9)>
126:
127: LWS = [CRLF] 1*( SP | HT )
128: TEXT = <any OCTET except CTLs,
129: but including LWS>
130:
131: quoted-pair = "\" CHAR
132:
133: if(strchr("()<>@,;:\\\"/[]?={} \t", *ptr))
134: */
1.117 paf 135: inline bool need_quote_http_header(const char* ptr, size_t size) {
1.41 paf 136: for(; size--; ptr++)
1.42 paf 137: if(strchr(";\\\"= \t" /* excluded ()<>@, :/ ? []{} */, *ptr))
1.41 paf 138: return true;
139: return false;
140: }
141:
1.119 paf 142: #ifndef DOXYGEN
143: struct Append_fragment_info {
144: String::Language lang;
145: String::Languages* dest_languages;
146: size_t dest_body_plan_length;
147: };
148: #endif
149: int append_fragment_optimizing(char alang, size_t asize, Append_fragment_info* info) {
150: const String::Language lang=(String::Language)(unsigned char)alang;
151: // main idea here:
152: // tainted piece would get OPTIMIZED bit from 'lang'
153: // clean piece would be marked OPTIMIZED manually
154: // pieces with determined languages [not tainted|clean] would retain theirs langs
155: info->dest_languages->append(info->dest_body_plan_length,
1.120 paf 156: lang==String::L_TAINTED?
1.119 paf 157: info->lang
1.120 paf 158: :lang==String::L_CLEAN?
159: (String::Language)(String::L_CLEAN|String::L_OPTIMIZE_BIT) // ORing with OPTIMIZED flag
1.119 paf 160: :lang,
161: asize);
162: info->dest_body_plan_length+=asize;
163:
164: return 0; // 0=continue
165: }
166: int append_fragment_nonoptimizing(char alang, size_t asize, Append_fragment_info* info) {
167: const String::Language lang=(String::Language)(unsigned char)alang;
168: // The core idea: tainted pieces got marked with context's lang
169: info->dest_languages->append(info->dest_body_plan_length,
1.120 paf 170: lang==String::L_TAINTED?
1.119 paf 171: info->lang
172: :lang,
173: asize);
174: info->dest_body_plan_length+=asize;
175:
176: return 0; // 0=continue
177: }
1.117 paf 178:
1.91 paf 179: /**
1.117 paf 180: appends to other String,
1.91 paf 181: marking all tainted pieces of it with @a lang.
1.92 paf 182: or marking ALL pieces of it with a @a lang when @a forced to,
183: and propagating OPTIMIZE language bit.
1.117 paf 184: */
185: String& String::append_to(String& dest, Language lang, bool forced) const {
186: if(is_empty())
187: return dest;
1.91 paf 188:
1.119 paf 189: // first: fragment infos
1.117 paf 190:
191: if(lang==L_PASS_APPENDED) // without language-change?
1.119 paf 192: dest.langs.append(dest.body, body.length(), langs);
1.117 paf 193: else if(forced) //forcing passed lang?
1.119 paf 194: dest.langs.append(dest.body, lang, length());
195: else {
1.122 paf 196: Append_fragment_info info={lang, &dest.langs, dest.body.length()};
1.119 paf 197: langs.for_each(body, lang&L_OPTIMIZE_BIT?
198: append_fragment_optimizing
199: :append_fragment_nonoptimizing, &info);
1.91 paf 200: }
201:
1.119 paf 202: // next: letters
203: dest.body<<body;
204:
1.117 paf 205: ASSERT_STRING_INVARIANT(dest);
1.75 paf 206: return dest;
1.51 parser 207: }
208:
1.109 paf 209: /** http://www.ietf.org/rfc/rfc2047.txt
210: RFC
211: (3) As a replacement for a 'word' entity within a 'phrase', for example,
212: one that precedes an address in a From, To, or Cc header. The ABNF
213: definition for 'phrase' from RFC 822 thus becomes:
214:
215: phrase = 1*( encoded-word / word )
216:
217: In this case the set of characters that may be used in a "Q"-encoded
218: 'encoded-word' is restricted to: <upper and lower case ASCII
219: letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
220: (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
221: 'phrase' MUST be separated from any adjacent 'word', 'text' or
222: 'special' by 'linear-white-space'.
223: ...
224: (2) The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE) may be
225: represented as "_" (underscore, ASCII 95.). (This character may
226: not pass through some internetwork mail gateways, but its use
227: will greatly enhance readability of "Q" encoded data with mail
228: readers that do not support this encoding.) Note that the "_"
229: always represents hexadecimal 20, even if the SPACE character
230: occupies a different code position in the character set in use.
231:
232: paf: obviously,
233: without "=", or one could not differ "=E0" and "russian letter a"
234: and without "_", or in would mean 0x20
235: */
1.117 paf 236: inline bool mail_header_char_valid_within_Qencoded(char c) {
1.109 paf 237: return c>='A' && c<='Z'
238: || c>='a' && c<='Z'
239: || c>='0' && c<='9'
240: || strchr("!*+-/", c);
241: }
1.118 paf 242: inline bool addr_spec_soon(const char *src) {
1.124 paf 243: for(char c; (c=*src); src++)
1.118 paf 244: if(c=='<')
245: return true;
246: else if(!(c==' ' || c=='\t'))
247: return false;
248: return false;
249: }
1.117 paf 250: /**
251: RFC
252: Upper case should be used for hexadecimal digits "A" through "F"
253: The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE)
254: may be represented as "_"
255: */
256: inline bool mail_header_nonspace_char(char c) {
257: return c != 0x20;
258: }
1.125 paf 259:
1.117 paf 260: inline void ec_append(CORD_ec& result, bool& optimize, bool& whitespace, CORD_pos pos, size_t size) {
261: while(size--) {
262: CORD_ec_append(result, CORD_pos_fetch(pos));
263: CORD_next(pos);
264: }
265: }
266: inline void pa_CORD_pos_advance(CORD_pos pos, size_t n) {
267: while(true) {
1.125 paf 268: long avail=CORD_pos_chars_left(pos);
269: if(avail<=0) {
1.117 paf 270: CORD_next(pos);
271: if(!--n)
272: break;
1.125 paf 273: } else if((size_t)avail<n) {
1.117 paf 274: CORD_pos_advance(pos, avail);
275: n-=avail;
276: } else { // avail>=n
277: CORD_pos_advance(pos, n);
278: break;
279: }
280: }
281: }
282:
1.119 paf 283: #ifndef DOXYGEN
284: struct Cstr_to_string_body_block_info {
285: // input
286: String::Language lang;
287: SQL_Connection* connection;
288: const Request_charsets* charsets;
289: const String::Body* body;
290:
291: // output
292: CORD_ec result;
293:
294: // private
295: CORD_pos pos;
296: size_t fragment_begin;
297: bool whitespace;
1.138 misha 298: const char* exception;
1.119 paf 299: };
300: #endif
301: int cstr_to_string_body_block(char alang, size_t fragment_length, Cstr_to_string_body_block_info* info) {
302: const String::Language fragment_lang=(String::Language)(unsigned char)alang;
303: bool& whitespace=info->whitespace;
304: size_t fragment_end=info->fragment_begin+fragment_length;
1.138 misha 305: //fprintf(stderr, "%d, %d =%s=\n", fragment_lang, fragment_length, info->body->cstr());
1.119 paf 306:
1.120 paf 307: String::Language to_lang=info->lang==String::L_UNSPECIFIED?fragment_lang:info->lang;
308: bool optimize=(to_lang & String::L_OPTIMIZE_BIT)!=0;
1.119 paf 309: if(!optimize)
310: whitespace=false;
311:
1.120 paf 312: switch(to_lang & ~String::L_OPTIMIZE_BIT) {
313: case String::L_CLEAN:
314: case String::L_TAINTED:
315: case String::L_AS_IS:
1.119 paf 316: // clean piece
317:
318: // tainted piece, but undefined untaint language
319: // for VString.as_double of tainted values
320: // for ^process{body} evaluation
321:
322: // tainted, untaint language: as-is
323: ec_append(info->result, optimize, whitespace, info->pos, fragment_length);
324: break;
1.120 paf 325: case String::L_FILE_SPEC:
1.119 paf 326: // tainted, untaint language: file [name]
1.140 misha 327: {
328: bool is1251=(info->charsets && info->charsets->source().NAME()=="WINDOWS-1251");
329: escape_fragment(
330: // Macintosh has problems with small Russian letter 'r'
331: if( is1251 && c=='\xF0' ) {
332: // fixing that letter for most common charset
333: to_char('p');
334: } else // fallback to default
335: encode(need_file_encode, '_', c);
336: );
337: }
1.119 paf 338: break;
1.120 paf 339: case String::L_URI:
1.119 paf 340: // tainted, untaint language: uri
341: {
342: const char *fragment_str=info->body->mid(info->fragment_begin, fragment_length).cstr();
343: // skip source [we use recoded version]
344: pa_CORD_pos_advance(info->pos, fragment_length);
345: String::C output(fragment_str, fragment_length);
346: if(info->charsets)
347: output=Charset::transcode(output,
348: info->charsets->source(),
349: info->charsets->client());
1.77 paf 350:
1.119 paf 351: char c;
1.124 paf 352: for(const char* src=output.str; (c=*src++); )
1.117 paf 353: encode(need_uri_encode, '%', c);
1.119 paf 354: }
355: break;
1.120 paf 356: case String::L_HTTP_HEADER:
1.119 paf 357: // tainted, untaint language: http-field-content-text
1.139 misha 358: // the same as L_URI BUT not transcoded into $response:charset before encoding
1.140 misha 359: escape_fragment(
1.119 paf 360: encode(need_uri_encode, '%', c);
361: );
362: break;
1.120 paf 363: case String::L_MAIL_HEADER:
1.119 paf 364: // tainted, untaint language: mail-header
365: // http://www.ietf.org/rfc/rfc2047.txt
366: if(info->charsets) {
367: size_t mail_size;
368: const char *mail_ptr=
369: info->body->mid(info->fragment_begin, mail_size=fragment_length).cstr();
370: // skip source [we use recoded version]
371: pa_CORD_pos_advance(info->pos, mail_size);
372:
373: const char* charset_name=info->charsets->mail().NAME().cstr();
374:
375: // Subject: Re: parser3: =?koi8-r?Q?=D3=C5=CD=C9=CE=C1=D2?=
376: bool to_quoted_printable=false;
377:
378: bool email=false;
379: uchar c;
1.124 paf 380: for(const char* src=mail_ptr; (c=(uchar)*src++); ) {
1.137 paf 381: if(c=='\r' || c=='\n')
382: c=' ';
1.130 paf 383: if(to_quoted_printable && (c==',' || c == '"' || addr_spec_soon(src-1/*position to 'c'*/))) {
1.119 paf 384: email=c=='<';
385: to_string("?=");
386: to_quoted_printable=false;
387: }
1.130 paf 388: //RFC + An 'encoded-word' MUST NOT appear in any portion of an 'addr-spec'.
1.119 paf 389: if(!email && (
390: !to_quoted_printable && (c & 0x80) // starting quote-printable-encoding on first 8bit char
391: || to_quoted_printable && !mail_header_char_valid_within_Qencoded(c)
392: )) {
393: if(!to_quoted_printable) {
394: to_string("=?");
395: to_string(charset_name);
396: to_string("?Q?");
397: to_quoted_printable=true;
1.105 paf 398: }
1.119 paf 399: encode(mail_header_nonspace_char, '=', '_');
400: } else
401: to_char(c);
402: if(c=='>')
403: email=false;
404: }
405: if(to_quoted_printable) // close
406: to_string("?=");
407:
408: } else
409: ec_append(info->result, optimize, whitespace, info->pos, fragment_length);
410: break;
1.120 paf 411: case String::L_SQL:
1.119 paf 412: // tainted, untaint language: sql
413: if(info->connection) {
414: const char *fragment_str=info->body->mid(info->fragment_begin, fragment_length).cstr();
415: // skip source [we use recoded version]
416: pa_CORD_pos_advance(info->pos, fragment_length);
417:
418: to_string(info->connection->quote(fragment_str, fragment_length));
1.138 misha 419: } else {
420: info->exception="untaint in SQL language failed - no connection specified";
421: info->fragment_begin=fragment_end;
422: return 1; // stop processing. can't throw exception here
423: }
1.119 paf 424: break;
1.120 paf 425: case String::L_JS:
1.140 misha 426: escape_fragment(switch(c) {
427: case '\n': to_string("\\n"); break;
1.119 paf 428: case '"': to_string("\\\""); break;
429: case '\'': to_string("\\'"); break;
430: case '\\': to_string("\\\\"); break;
431: case '\xFF': to_string("\\\xFF"); break;
1.133 paf 432: default: _default; break;
1.119 paf 433: });
434: break;
1.120 paf 435: case String::L_XML:
1.133 paf 436: // [2] Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
1.140 misha 437: escape_fragment(switch(c) {
438: case '\x20':
439: case '\x9':
440: case '\xA':
1.133 paf 441: case '\xD': // this is usually removed on input
442: _default;
443: break;
1.119 paf 444: case '&': to_string("&"); break;
445: case '>': to_string(">"); break;
446: case '<': to_string("<"); break;
447: case '"': to_string("""); break;
448: case '\'': to_string("'"); break;
1.133 paf 449: default:
450: if(((unsigned char)c)<0x20) {
451: // fixing it, so that libxml would not result
452: // in fatal error parsing text
453: // though it really violates standard.
454: // to indicate there were an error
455: // replace bad char not to it's code,
456: // which we can do,
457: // but rather to '!' to show that input were actually
458: // invalid.
459: // life: shows that MSIE can somehow garble form values
460: // so that they contain these chars.
461: to_char('!');
462: } else {
463: _default;
464: }
465: break;
1.119 paf 466: });
467: break;
1.120 paf 468: case String::L_HTML:
1.140 misha 469: escape_fragment(switch(c) {
1.119 paf 470: case '&': to_string("&"); break;
471: case '>': to_string(">"); break;
472: case '<': to_string("<"); break;
473: case '"': to_string("""); break;
1.133 paf 474: default: _default; break;
1.119 paf 475: });
476: break;
1.136 paf 477: case String::L_REGEX:
478: // tainted, untaint language: regex
1.140 misha 479: escape_fragment(
1.136 paf 480: if(need_regex_escape(c))
481: to_char('\\')
482: _default;
483: );
484: break;
1.140 misha 485: case String::L_HTTP_COOKIE:
486: // tainted, untaint language: cookie (3.3.0 and higher: %uXXXX in UTF-8)
487: {
488: const char *fragment_str=info->body->mid(info->fragment_begin, fragment_length).cstr();
489: // skip source [we use recoded version]
490: pa_CORD_pos_advance(info->pos, fragment_length);
491: String::C output(fragment_str, fragment_length);
492:
493: output=Charset::escape(output, info->charsets->source());
494: //throw Exception(0, 0, output);
495: to_string(output);
496:
497: }
498: break;
1.119 paf 499: default:
1.127 paf 500: SAPI::abort("unknown untaint language #%d",
1.119 paf 501: static_cast<int>(to_lang)); // should never
502: break; // never
1.117 paf 503: }
1.55 parser 504:
1.119 paf 505: info->fragment_begin=fragment_end;
506:
507: return 0; // 0=continue
508: }
509:
510:
511: String::Body String::cstr_to_string_body(Language lang,
512: SQL_Connection* connection,
513: const Request_charsets *charsets) const {
1.134 paf 514: if(is_empty())
515: return String::Body();
1.119 paf 516:
517: Cstr_to_string_body_block_info info;
518: // input
519: info.lang=lang;
520: info.connection=connection;
521: info.charsets=charsets;
522: info.body=&body;
523: // output
524: CORD_ec_init(info.result);
525: // private
526: body.set_pos(info.pos, 0);
527: info.fragment_begin=0;
1.138 misha 528: info.exception=0;
1.119 paf 529: info.whitespace=true;
530:
1.134 paf 531: langs.for_each(body, cstr_to_string_body_block, &info);
1.138 misha 532: if(info.exception){
533: throw Exception(0,
534: 0,
535: info.exception);
536: }
537:
1.119 paf 538: return String::Body(CORD_ec_to_cord(info.result));
1.1 paf 539: }
E-mail: