Annotation of parser3/src/main/untaint.C, revision 1.115.2.12
1.7 paf 1: /** @file
1.8 paf 2: Parser: String class part: untaint mechanizm.
3:
1.115.2.6 paf 4: Copyright(c) 2001-2003 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.115.2.12! paf 8: static const char* IDENT_UNTAINT_C="$Date: 2003/03/03 13:44:26 $";
1.1 paf 9:
10: #include "pa_pool.h"
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.34 paf 16: #include "pa_sql_connection.h"
1.58 parser 17: #include "pa_dictionary.h"
1.66 parser 18: #include "pa_common.h"
1.85 paf 19: #include "pa_charset.h"
1.115.2.4 paf 20: #include "pa_request_charsets.h"
1.1 paf 21:
1.18 paf 22: #define escape(action) \
1.1 paf 23: { \
1.115.2.6 paf 24: const char* src=fragment->ptr; \
1.115.2.1 paf 25: for(int size=fragment->size; size--; src++) \
1.18 paf 26: action \
1.1 paf 27: }
1.13 paf 28: #define _default default: *dest++=*src; break
29: #define encode(need_encode_func, prefix) \
30: if(need_encode_func(*src)) { \
1.115.2.6 paf 31: static const char* hex="0123456789ABCDEF"; \
1.9 paf 32: char chunk[3]={prefix}; \
1.13 paf 33: chunk[1]=hex[((unsigned char)*src)/0x10]; \
34: chunk[2]=hex[((unsigned char)*src)%0x10]; \
1.60 parser 35: memcpy(dest, chunk, 3); dest+=3; \
1.5 paf 36: } else \
1.13 paf 37: *dest++=*src; \
1.5 paf 38: break
1.18 paf 39: #define to_char(c) *dest++=c
40: #define to_string(b, bsize) \
1.60 parser 41: memcpy(dest, b, bsize); \
1.18 paf 42: dest+=bsize; \
1.4 paf 43:
1.9 paf 44: inline bool need_file_encode(unsigned char c){
1.108 paf 45: // russian letters and space ENABLED
46: // encoding only these...
47: return strchr(
48: "*?'\"<>|"
49: #ifndef WIN32
50: ":\\~"
1.31 paf 51: #endif
1.108 paf 52: , c)!=0;
1.9 paf 53: }
1.5 paf 54: inline bool need_uri_encode(unsigned char c){
1.13 paf 55: if((c>='0') &&(c<='9') ||(c>='A') &&(c<='Z') ||(c>='a') &&(c<='z'))
1.4 paf 56: return false;
57:
1.5 paf 58: return !strchr("_-./", c);
59: }
1.36 paf 60: inline bool need_http_header_encode(unsigned char c){
1.18 paf 61: if(strchr(" , :", c))
1.5 paf 62: return false;
63:
64: return need_uri_encode(c);
1.4 paf 65: }
1.1 paf 66:
1.56 parser 67: //
68:
1.115.2.6 paf 69: static const char* String_Untaint_lang_name[]={
1.56 parser 70: "U", ///< zero value handy for hash lookup @see untaint_lang_name2enum
71: "C", ///< clean
72: "T", ///< tainted, untaint language as assigned later
73: // untaint languages. assigned by ^untaint[lang]{...}
74: "P",
75: /**<
76: leave language built into string being appended.
77: just a flag, that value not stored
78: */
79: "A", ///< leave all characters intact
1.68 parser 80: "F", ///< file specification
81: "H", ///< ext in HTTP response header
1.56 parser 82: "M", ///< text in mail header
83: "URI", ///< text in uri
84: "T", ///< ^table:set body
85: "SQL", ///< ^table:sql body
86: "JS", ///< JavaScript code
1.68 parser 87: "XML", ///< ^dom:set xml
1.82 paf 88: "HTML" ///< HTML code (for editing)
1.56 parser 89: };
90:
91:
1.1 paf 92: // String
93:
1.41 paf 94: /*
95:
96: HTTP-header = field-name ":" [ field-value ] CRLF
97:
98: field-name = token
99: field-value = *( field-content | LWS )
100:
101: field-content = <the OCTETs making up the field-value
102: and consisting of either *TEXT or combinations
103: of token, tspecials, and quoted-string>
104:
105:
106:
107: word = token | quoted-string
108:
109: token = 1*<any CHAR except CTLs or tspecials>
110:
111:
112:
113: tspecials = "(" | ")" | "<" | ">" | "@"
114: | "," | ";" | ":" | "\" | <">
115: | "/" | "[" | "]" | "?" | "="
116: | "{" | "}" | SP | HT
117:
118: SP = <US-ASCII SP, space (32)>
119: HT = <US-ASCII HT, horizontal-tab (9)>
120:
121: LWS = [CRLF] 1*( SP | HT )
122: TEXT = <any OCTET except CTLs,
123: but including LWS>
124:
125: quoted-pair = "\" CHAR
126:
127: if(strchr("()<>@,;:\\\"/[]?={} \t", *ptr))
128: */
1.115.2.6 paf 129: inline bool need_quote_http_header(const char* ptr, size_t size) {
1.41 paf 130: for(; size--; ptr++)
1.42 paf 131: if(strchr(";\\\"= \t" /* excluded ()<>@, :/ ? []{} */, *ptr))
1.41 paf 132: return true;
133: return false;
134: }
135:
1.91 paf 136: //#include "pa_sapi.h"
137: /**
1.115.2.1 paf 138: appends to other String,
1.91 paf 139: marking all tainted pieces of it with @a lang.
1.92 paf 140: or marking ALL pieces of it with a @a lang when @a forced to,
141: and propagating OPTIMIZE language bit.
1.91 paf 142: */
1.115.2.11 paf 143: String& String::append_to(String& dest, String_UL lang, bool forced) const {
1.115.2.1 paf 144: if(is_empty())
145: return dest;
146:
1.115.2.9 paf 147: // without language-chage string?
148: if(lang==UL_PASS_APPENDED) {
149: // can simply append elements
150: ssize_t delta=fused-(dest.fallocated-dest.fused);
151: if(delta>0) // they don't fit?
152: dest.expand(delta);
153:
1.115.2.1 paf 154: // felements[fused...]=src.felements[0..fused], fused+=src.fused
155: memcpy(&dest.felements[dest.fused], felements, sizeof(felements[0])*fused);
156: dest.fused+=fused;
1.115.2.10 paf 157: dest.fsize+=fsize;
1.115.2.1 paf 158: return dest;
1.91 paf 159: }
160:
1.77 paf 161: // manually unrolled code to avoid do{if(const)} constructs
162: if(forced)
1.115.2.1 paf 163: STRING_FOREACH_FRAGMENT(
164: dest.APPEND(fragment->ptr, fragment->size,
1.77 paf 165: lang, //forcing passed lang
1.115.2.1 paf 166: fragment->origin.file, fragment->origin.line);
1.77 paf 167: )
168: else if(lang==UL_PASS_APPENDED)
1.115.2.1 paf 169: STRING_FOREACH_FRAGMENT(
170: dest.APPEND(fragment->ptr, fragment->size,
171: fragment->lang, // passing item's lang
172: fragment->origin.file, fragment->origin.line);
1.77 paf 173: )
174: else if(lang&UL_OPTIMIZE_BIT) // main idea here
175: // tainted piece would get OPTIMIZED bit from 'lang'
176: // clean piece would be marked OPTIMIZED manually
177: // pieces with determined languages [not tainted|clean] would retain theirs langs
1.115.2.1 paf 178: STRING_FOREACH_FRAGMENT(
179: dest.APPEND(fragment->ptr, fragment->size,
180: fragment->lang==UL_TAINTED?lang:(
181: fragment->lang==UL_CLEAN?UL_CLEAN|UL_OPTIMIZE_BIT: // ORing with OPTIMIZED flag
182: fragment->lang
1.77 paf 183: ),
1.115.2.1 paf 184: fragment->origin.file, fragment->origin.line);
1.77 paf 185: )
186: else
1.115.2.1 paf 187: STRING_FOREACH_FRAGMENT(
188: dest.APPEND(fragment->ptr, fragment->size,
189: fragment->lang==UL_TAINTED?lang:fragment->lang,
190: fragment->origin.file, fragment->origin.line);
1.77 paf 191: );
1.115.2.1 paf 192:
193: return dest;
1.77 paf 194: }
195:
1.75 paf 196: size_t String::cstr_bufsize(Untaint_lang lang,
197: SQL_Connection *connection,
1.115.2.3 paf 198: const Request_charsets *charsets) const {
1.77 paf 199: size_t dest=1; // for terminating 0
1.115.2.1 paf 200: STRING_FOREACH_FRAGMENT(
1.115.2.11 paf 201: String_UL to_lang=lang==UL_UNSPECIFIED?fragment->lang:lang;
1.77 paf 202:
203: switch(to_lang & ~UL_OPTIMIZE_BIT) {
204: case UL_CLEAN:
205: case UL_TAINTED:
206: case UL_AS_IS:
207: // clean piece
208:
209: // tainted piece, but undefined untaint language
210: // for VString.as_double of tainted values
211: // for ^process{body} evaluation
212:
213: // tainted, untaint language: as-is
1.115.2.1 paf 214: dest+=fragment->size;
1.77 paf 215: break;
216: case UL_FILE_SPEC:
217: // tainted, untaint language: file [name]
1.115.2.1 paf 218: dest+=fragment->size*3/* worst: Z->%XX */;
1.77 paf 219: break;
220: case UL_URI:
221: // tainted, untaint language: uri
1.115.2.1 paf 222: dest+=fragment->size*6*3/* worst utf8 x worst Z->%XX */;
1.77 paf 223: break;
224: case UL_HTTP_HEADER:
225: // tainted, untaint language: http-field-content-text
1.115.2.1 paf 226: dest+=fragment->size*3/* worst: Z->%XX */;
1.77 paf 227: break;
228: case UL_MAIL_HEADER:
229: // tainted, untaint language: mail-header
1.115.2.4 paf 230: if(charsets) {
1.111 paf 231: int parts_count=1;
1.115.2.6 paf 232: const char* prev=fragment->ptr;
1.115.2.1 paf 233: size_t size=fragment->size;
1.115.2.6 paf 234: while(const char* comma_at=(const char*)memchr(prev, ',', size)) {
1.111 paf 235: parts_count++;
236: size-=comma_at-prev;
237: prev=comma_at+1;
238: }
1.77 paf 239: // Subject: Re: parser3: =?koi8-r?Q?=D3=C5=CD=C9=CE=C1=D2?=
1.87 paf 240: dest+=
1.115.2.1 paf 241: fragment->size*3+
1.115.2.4 paf 242: parts_count*(charsets->mail().name()->size()+MAX_STRING/* worst: =?charset?Q?=%XX?= */);
1.87 paf 243: } else
1.115.2.1 paf 244: dest+=fragment->size;
1.77 paf 245: break;
246: case UL_TABLE:
247: // tainted, untaint language: table
1.115.2.1 paf 248: dest+=fragment->size;
1.77 paf 249: break;
250: case UL_SQL:
251: // tainted, untaint language: sql
252: if(connection)
1.115.2.1 paf 253: dest+=connection->quote(0, fragment->ptr, fragment->size);
1.77 paf 254: break;
255: case UL_JS:
256: escape(switch(*src) {
257: case '"': case '\'': case '\n': case '\\': case '\xFF':
258: dest+=2; break;
259: default:
260: dest++; break;
261: });
262: break;
263: case UL_XML:
264: escape(switch(*src) {
265: case '&': case '>': case '<': case '"': case '\'':
266: dest+= 6; break;
267: default:
268: dest++; break;
269: });
270: break;
271: case UL_HTML:
272: escape(switch(*src) {
273: case '&':
274: case '>':
275: case '<':
276: case '"':
277: dest+=6; break;
278: default:
279: dest++; break;
280: });
281: break;
1.75 paf 282: }
1.77 paf 283: );
1.75 paf 284: return dest;
1.51 parser 285: }
286:
1.109 paf 287: /** http://www.ietf.org/rfc/rfc2047.txt
288: RFC
289: (3) As a replacement for a 'word' entity within a 'phrase', for example,
290: one that precedes an address in a From, To, or Cc header. The ABNF
291: definition for 'phrase' from RFC 822 thus becomes:
292:
293: phrase = 1*( encoded-word / word )
294:
295: In this case the set of characters that may be used in a "Q"-encoded
296: 'encoded-word' is restricted to: <upper and lower case ASCII
297: letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
298: (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
299: 'phrase' MUST be separated from any adjacent 'word', 'text' or
300: 'special' by 'linear-white-space'.
301: ...
302: (2) The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE) may be
303: represented as "_" (underscore, ASCII 95.). (This character may
304: not pass through some internetwork mail gateways, but its use
305: will greatly enhance readability of "Q" encoded data with mail
306: readers that do not support this encoding.) Note that the "_"
307: always represents hexadecimal 20, even if the SPACE character
308: occupies a different code position in the character set in use.
309:
310: paf: obviously,
311: without "=", or one could not differ "=E0" and "russian letter a"
312: and without "_", or in would mean 0x20
313: */
314: static bool mail_header_char_valid_within_Qencoded(char c) {
315: return c>='A' && c<='Z'
316: || c>='a' && c<='Z'
317: || c>='0' && c<='9'
318: || strchr("!*+-/", c);
319: }
1.43 paf 320: char *String::store_to(char *dest, Untaint_lang lang,
321: SQL_Connection *connection,
1.115.2.3 paf 322: const Request_charsets *charsets) const {
1.75 paf 323: // WARNING:
324: // before any changes check cstr_bufsize first!!!
1.44 paf 325: bool whitespace=true;
1.115.2.1 paf 326: // STRING_FOREACH_FRAGMENT(
327: element_type *last = felements+fused; element_type *fragment = felements; for(; fragment<last; fragment++) {
1.111 paf 328:
1.115.2.11 paf 329: String_UL to_lang=lang==UL_UNSPECIFIED?fragment->lang:lang;
1.77 paf 330:
331: char *start=dest;
332:
333: switch(to_lang & ~UL_OPTIMIZE_BIT) {
334: case UL_CLEAN:
335: case UL_TAINTED:
336: case UL_AS_IS:
337: // clean piece
338:
339: // tainted piece, but undefined untaint language
340: // for VString.as_double of tainted values
341: // for ^process{body} evaluation
342:
343: // tainted, untaint language: as-is
1.115.2.1 paf 344: memcpy(dest, fragment->ptr, fragment->size);
345: dest+=fragment->size;
1.77 paf 346: break;
347: case UL_FILE_SPEC:
348: // tainted, untaint language: file [name]
1.83 paf 349: escape(
1.113 paf 350: // Macintosh has problems with small Russian letter 'r'
1.115.2.4 paf 351: if( *src=='\xF0' && charsets && *charsets->source().name()=="windows-1251" ) {
1.113 paf 352: // fixing that letter for most common charset
1.115.2.2 paf 353: to_char('p');
1.114 paf 354: } else // fallback to default
355: encode(need_file_encode, '_');
1.83 paf 356: );
1.77 paf 357: break;
358: case UL_URI:
359: // tainted, untaint language: uri
1.85 paf 360: const void *client_ptr;
361: size_t client_size;
1.115.2.2 paf 362: if(charsets)
1.115.2.4 paf 363: Charset::transcode(charsets->pool(),
364: charsets->source(), fragment->ptr, fragment->size,
365: charsets->client(), client_ptr, client_size);
1.115.2.2 paf 366: else {
367: client_ptr=fragment->ptr;
368: client_size=fragment->size;
369: }
370:
1.85 paf 371: {
1.115.2.6 paf 372: const char* src=(const char* )client_ptr;
1.85 paf 373: for(int size=client_size; size--; src++)
1.108 paf 374: encode(need_uri_encode, '%');
1.85 paf 375: }
1.77 paf 376: break;
377: case UL_HTTP_HEADER:
378: // tainted, untaint language: http-field-content-text
1.108 paf 379: escape(
380: encode(need_uri_encode, '%');
381: );
1.77 paf 382: break;
383: case UL_MAIL_HEADER:
384: // tainted, untaint language: mail-header
1.105 paf 385: // http://www.ietf.org/rfc/rfc2047.txt
1.115.2.4 paf 386: if(charsets) {
1.115.2.12! paf 387: const void *mail_ptr=fragment->ptr;
! 388: size_t mail_size=fragment->size;
1.115.2.4 paf 389: CharPtr charset_name=charsets->mail().name()->cstr();
1.87 paf 390:
1.77 paf 391: // Subject: Re: parser3: =?koi8-r?Q?=D3=C5=CD=C9=CE=C1=D2?=
1.115.2.6 paf 392: const char* src=(const char* )mail_ptr;
1.77 paf 393: bool to_quoted_printable=false;
1.105 paf 394:
1.111 paf 395: bool email=false;
1.115.2.6 paf 396: for(const char* end=src+mail_size; src<end; src++) {
1.111 paf 397: //RFC + An 'encoded-word' MUST NOT appear in any portion of an 'addr-spec'.
398: if(to_quoted_printable && (*src==',' || *src=='<')) {
399: email=*src=='<';
1.105 paf 400: dest+=sprintf(dest, "?=");
1.107 paf 401: to_quoted_printable=false;
1.105 paf 402: }
1.111 paf 403: if(!email && (
1.109 paf 404: !to_quoted_printable && (*src & 0x80) // starting quote-printable-encoding on first 8bit char
405: || to_quoted_printable && !mail_header_char_valid_within_Qencoded(*src)
1.105 paf 406: )) {
1.77 paf 407: if(!to_quoted_printable) {
1.115.2.7 paf 408: dest+=sprintf(dest, "=?%s?Q?", charset_name.get());
1.77 paf 409: to_quoted_printable=true;
410: }
1.105 paf 411: //RFC Upper case should be used for hexadecimal digits "A" through "F"
1.109 paf 412: if(*src == 0x20) // RFC The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE)
413: *dest++='_'; // RFC may be represented as "_"
414: else
415: dest+=sprintf(dest, "=%02X", *src & 0xFF);
1.105 paf 416: } else
1.109 paf 417: *dest++=*src;
1.111 paf 418: if(*src=='>')
419: email=false;
1.44 paf 420: }
1.112 paf 421: if(to_quoted_printable) // close
1.77 paf 422: dest+=sprintf(dest, "?=");
1.87 paf 423:
1.77 paf 424: } else {
1.115.2.1 paf 425: memcpy(dest, fragment->ptr, fragment->size);
426: dest+=fragment->size;
1.1 paf 427: }
1.77 paf 428: break;
429: case UL_TABLE:
430: // tainted, untaint language: table
431: escape(switch(*src) {
432: case '\t': to_char(' '); break;
433: case '\n': to_char(' '); break;
434: _default;
435: });
436: break;
437: case UL_SQL:
438: // tainted, untaint language: sql
439: if(connection)
1.115.2.1 paf 440: dest+=connection->quote(dest, fragment->ptr, fragment->size);
1.77 paf 441: else
1.115.2.5 paf 442: throw Exception(Exception::undefined_type,
443: Exception::undefined_source,
1.77 paf 444: "untaint in SQL language failed - no connection specified");
445: break;
446: case UL_JS:
447: escape(switch(*src) {
448: case '"': to_string("\\\"", 2); break;
449: case '\'': to_string("\\'", 2); break;
450: case '\n': to_string("\\n", 2); break;
451: case '\\': to_string("\\\\", 2); break;
452: case '\xFF': to_string("\\\xFF", 2); break;
453: _default;
454: });
455: break;
456: case UL_XML:
457: escape(switch(*src) {
458: case '&': to_string("&", 5); break;
459: case '>': to_string(">", 4); break;
460: case '<': to_string("<", 4); break;
461: case '"': to_string(""", 6); break;
462: case '\'': to_string("'", 6); break;
463: _default;
464: });
465: break;
466: case UL_HTML:
467: escape(switch(*src) {
468: case '&': to_string("&", 5); break;
469: case '>': to_string(">", 4); break;
470: case '<': to_string("<", 4); break;
471: case '"': to_string(""", 6); break;
472: _default;
473: });
474: break;
475: default:
1.115.2.5 paf 476: throw Exception(Exception::undefined_type,
477: Exception::undefined_source,
1.81 paf 478: "unknown untaint language #%d",
1.110 paf 479: static_cast<int>(to_lang)); // should never
1.77 paf 480: break; // never
1.76 paf 481: }
1.55 parser 482:
1.77 paf 483: if(to_lang & UL_OPTIMIZE_BIT) {
484: // optimizing whitespace
485: char *stop=dest; dest=start;
486: for(char *src=start; src<stop; src++)
487: switch(*src) {
488: // of all consequent white space chars leaving only first one
1.80 paf 489: case ' ': case '\r': case '\n': case '\t':
1.77 paf 490: if(!whitespace) {
491: *dest++=*src;
492: whitespace=true;
493: }
494: break;
495: default:
496: whitespace=false;
497: *dest++=*src;
498: break;
499: };
500: } else // piece without optimization
501: whitespace=false;
1.115.2.1 paf 502: // );
503: }
504:
1.76 paf 505: return dest;
506: }
507:
1.115.2.2 paf 508: char *String::cstr_debug_origins(Pool& pool) const {
1.81 paf 509: //_asm int 3;
1.115.2.2 paf 510: char *result=new(pool) char[size()+fused*MAX_STRING*2];
1.76 paf 511: char *dest=result;
512:
1.115.2.1 paf 513: STRING_FOREACH_FRAGMENT(
1.96 paf 514: IFNDEF_NO_STRING_ORIGIN(
1.115.2.1 paf 515: if(fragment->origin.file)
1.96 paf 516: dest+=sprintf(dest, ORIGIN_FILE_LINE_FORMAT,
1.115.2.1 paf 517: fragment->origin.file,
518: 1+fragment->origin.line);
1.96 paf 519: else
520: dest+=sprintf(dest, "<unknown>");
521: );
1.115.2.11 paf 522: String_UL show_lang=fragment->lang & ~UL_OPTIMIZE_BIT;
1.96 paf 523: if(show_lang>=sizeof(String_Untaint_lang_name)/sizeof(String_Untaint_lang_name[0]))
1.115.2.5 paf 524: throw Exception(Exception::undefined_type,
525: Exception::undefined_source,
1.96 paf 526: "unknown untaint language #%d",
527: static_cast<int>(show_lang)); // sould never
528:
529: dest+=sprintf(dest, "#%s%s: ",
530: String_Untaint_lang_name[show_lang],
1.115.2.1 paf 531: fragment->lang & UL_OPTIMIZE_BIT?".O":"");
1.96 paf 532: char *dest_after_origins=dest;
1.76 paf 533:
1.115.2.1 paf 534: memcpy(dest, fragment->ptr, fragment->size);
535: dest+=fragment->size;
1.76 paf 536:
1.96 paf 537: remove_crlf(dest_after_origins, dest);
538: to_char('\n');
539: );
1.64 parser 540:
1.76 paf 541: *dest=0;
542: return result;
1.1 paf 543: }
E-mail: