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