Annotation of parser3/src/main/untaint.C, revision 1.59

1.7       paf         1: /** @file
1.8       paf         2:        Parser: String class part: untaint mechanizm.
                      3: 
1.13      paf         4:        Copyright(c) 2001 ArtLebedev Group(http://www.artlebedev.com)
1.8       paf         5: 
1.13      paf         6:        Author: Alexander Petrosyan <paf@design.ru>(http://design.ru/paf)
1.1       paf         7: */
1.59    ! parser      8: static const char *RCSId="$Id: untaint.C,v 1.58 2001/08/01 12:08:40 parser Exp $"; 
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.1       paf        18: 
1.18      paf        19: #define escape(action) \
1.1       paf        20:        { \
1.13      paf        21:                const char *src=row->item.ptr; \
                     22:                for(int size=row->item.size; size--; src++) \
1.18      paf        23:                        action \
1.1       paf        24:        }
1.13      paf        25: #define _default  default: *dest++=*src; break
                     26: #define encode(need_encode_func, prefix)  \
1.5       paf        27:                default: \
1.13      paf        28:                        if(need_encode_func(*src)) { \
1.5       paf        29:                                static const char *hex="0123456789ABCDEF"; \
1.9       paf        30:                                char chunk[3]={prefix}; \
1.13      paf        31:                                chunk[1]=hex[((unsigned char)*src)/0x10]; \
                     32:                                chunk[2]=hex[((unsigned char)*src)%0x10]; \
                     33:                                strncpy(dest, chunk, 3);  dest+=3; \
1.5       paf        34:                        } else \
1.13      paf        35:                                *dest++=*src; \
1.5       paf        36:                        break
1.18      paf        37: #define to_char(c)  *dest++=c
                     38: #define to_string(b, bsize)  \
                     39:                strncpy(dest, b, bsize); \
                     40:                dest+=bsize; \
1.4       paf        41: 
1.9       paf        42: inline bool need_file_encode(unsigned char c){
1.13      paf        43:     if((c>='0') &&(c<='9') ||(c>='A') &&(c<='Z') ||(c>='a') &&(c<='z')) 
1.9       paf        44:                return false;
                     45: 
1.31      paf        46:     return !strchr(
                     47: #ifdef WIN32
1.37      paf        48:                ":\\~"
1.31      paf        49: #endif
1.39      paf        50:                "./()_-", c);
1.9       paf        51: }
1.5       paf        52: inline bool need_uri_encode(unsigned char c){
1.13      paf        53:     if((c>='0') &&(c<='9') ||(c>='A') &&(c<='Z') ||(c>='a') &&(c<='z')) 
1.4       paf        54:                return false;
                     55: 
1.5       paf        56:     return !strchr("_-./", c);
                     57: }
1.36      paf        58: inline bool need_http_header_encode(unsigned char c){
1.18      paf        59:     if(strchr(" , :", c))
1.5       paf        60:                return false;
                     61: 
                     62:        return need_uri_encode(c);
1.4       paf        63: }
1.1       paf        64: 
1.56      parser     65: //
                     66: 
                     67: static const char * String_Untaint_lang_name[]={
                     68:        "U", ///< zero value handy for hash lookup @see untaint_lang_name2enum
                     69:        "C", ///< clean
                     70:        "T",  ///< tainted, untaint language as assigned later 
                     71:        // untaint languages. assigned by ^untaint[lang]{...}
                     72:        "P",
                     73:                /**<
                     74:                        leave language built into string being appended.
                     75:                        just a flag, that value not stored
                     76:                */
                     77:        "A",     ///< leave all characters intact
                     78:        "F", ///< filename
                     79:        "H",    ///< text in HTTP response header
                     80:        "M",    ///< text in mail header
                     81:        "URI",       ///< text in uri
                     82:        "T",     ///< ^table:set body
                     83:        "SQL",       ///< ^table:sql body
                     84:        "JS",        ///< JavaScript code
                     85:        "HTML",      ///< HTML code (for editing)
                     86:        "UHTML", ///< HTML code with USER chars
                     87: };
                     88: 
                     89: 
1.1       paf        90: // String
                     91: 
1.13      paf        92: static bool typo_present(Array::Item *value, const void *info) {
                     93:        Array *row=static_cast<Array *>(value);
                     94:        const char *src=static_cast<const char *>(info);
                     95: 
                     96:        int partial;
1.28      paf        97:        row->get_string(0)->cmp(partial, src);
1.14      paf        98:        return 
                     99:                partial==0 || // full match
                    100:                partial==1; // typo left column starts 'src'
1.13      paf       101: }
                    102: 
1.41      paf       103: /*
                    104: 
                    105: HTTP-header    = field-name ":" [ field-value ] CRLF
                    106: 
                    107:        field-name     = token
                    108:        field-value    = *( field-content | LWS )
                    109: 
                    110:        field-content  = <the OCTETs making up the field-value
                    111:                         and consisting of either *TEXT or combinations
                    112:                         of token, tspecials, and quoted-string>
                    113: 
                    114: 
                    115: 
                    116: word           = token | quoted-string
                    117: 
                    118: token          = 1*<any CHAR except CTLs or tspecials>
                    119: 
                    120: 
                    121: 
                    122: tspecials      = "(" | ")" | "<" | ">" | "@"
                    123:                       | "," | ";" | ":" | "\" | <">
                    124:                       | "/" | "[" | "]" | "?" | "="
                    125:                       | "{" | "}" | SP | HT
                    126: 
                    127: SP             = <US-ASCII SP, space (32)>
                    128: HT             = <US-ASCII HT, horizontal-tab (9)>
                    129: 
                    130: LWS            = [CRLF] 1*( SP | HT )
                    131: TEXT           = <any OCTET except CTLs,
                    132:                         but including LWS>
                    133: 
                    134: quoted-pair    = "\" CHAR
                    135: 
                    136:   if(strchr("()<>@,;:\\\"/[]?={} \t", *ptr))
                    137: */
                    138: inline bool need_quote_http_header(const char *ptr, size_t size) {
                    139:        for(; size--; ptr++)
1.42      paf       140:                if(strchr(";\\\"= \t" /* excluded ()<>@, :/ ? []{} */, *ptr))
1.41      paf       141:                        return true;
                    142:        return false;
                    143: }
                    144: 
1.55      parser    145: /** @todo maybe additional check "are all pieces are clean?" would be profitable?
                    146:        @todo fix potential forigins_mode buf overrun
                    147: */
1.51      parser    148: size_t String::cstr_bufsize(Untaint_lang lang) const {
1.55      parser    149:        return (lang==UL_AS_IS?size():size()*UNTAINT_TIMES_BIGGER*(forigins_mode?10:1)) +1;
1.51      parser    150: }
                    151: 
1.54      parser    152: /** @todo fix theoretical \n mem overrun in TYPO replacements
                    153: */
1.43      paf       154: char *String::store_to(char *dest, Untaint_lang lang, 
                    155:                                           SQL_Connection *connection,
                    156:                                           const char *charset) const {
1.13      paf       157:        // $MAIN:html-typo table
1.58      parser    158:        Dictionary *user_typo_dict=static_cast<Dictionary *>(pool().tag());
                    159:        Dictionary *typo_dict=user_typo_dict?user_typo_dict:default_typo_dict;
1.1       paf       160: 
1.44      paf       161:        bool whitespace=true;
1.1       paf       162:        const Chunk *chunk=&head; 
                    163:        do {
                    164:                const Chunk::Row *row=chunk->rows;
1.28      paf       165:                for(size_t i=0; i<chunk->count; i++, row++) {
1.1       paf       166:                        if(row==append_here)
                    167:                                goto break2;
                    168: 
1.55      parser    169:                        Untaint_lang to_lang=lang==UL_UNSPECIFIED?row->item.lang:lang;
                    170: 
                    171:                        char *dest_before_origins=dest;
                    172: 
                    173:                        if(forigins_mode) {
                    174: #ifndef NO_STRING_ORIGIN
                    175:                                if(row->item.origin.file)
                    176:                                        dest+=sprintf(dest, "%s(%d)",
                    177:                                                row->item.origin.file,
                    178:                                                1+row->item.origin.line);
                    179:                                else
                    180:                                        dest+=sprintf(dest, "unknown");
                    181: #endif
1.56      parser    182:                                dest+=sprintf(dest, "#%s: ",
                    183:                                        String_Untaint_lang_name[to_lang]);
1.55      parser    184:                        }
                    185:                        char *dest_after_origins=dest;
                    186: 
1.1       paf       187:                        // WARNING:
                    188:                        //      string can grow only UNTAINT_TIMES_BIGGER
1.55      parser    189:                        switch(to_lang) {
1.29      paf       190:                        case UL_CLEAN:
1.1       paf       191:                                // clean piece
1.44      paf       192:                                { // optimizing whitespace
                    193:                                        const char *src=row->item.ptr; 
                    194:                                        for(int size=row->item.size; size--; src++)
                    195:                                                switch(*src) {
                    196:                                                case ' ': case '\n': case '\r': case '\t':
                    197:                                                        if(!whitespace) {
                    198:                                                                *dest++=*src;
                    199:                                                                whitespace=true;
                    200:                                                        }
                    201:                                                        break;
                    202:                                                default:
                    203:                                                        whitespace=false;
                    204:                                                        *dest++=*src;
                    205:                                                        break;
                    206:                                                }
                    207:                                }
                    208:                                break;
1.29      paf       209:                        case UL_TAINTED:
1.1       paf       210:                                // tainted piece, but undefined untaint language
1.23      paf       211:                                // for VString.as_double of tainted values
1.1       paf       212:                                // for ^process{body} evaluation
1.11      paf       213:                        case UL_AS_IS:
1.1       paf       214:                                // tainted, untaint language: as-is
1.13      paf       215:                                memcpy(dest, row->item.ptr, row->item.size); 
                    216:                                dest+=row->item.size;
1.1       paf       217:                                break;
1.11      paf       218:                        case UL_FILE_NAME:
1.9       paf       219:                                // tainted, untaint language: file [name]
1.18      paf       220:                                escape(switch(*src) {
                    221:                                        case ' ': to_char('_');  break;
1.39      paf       222:                                        encode(need_file_encode, '+');
1.18      paf       223:                                });
1.9       paf       224:                                break;
1.11      paf       225:                        case UL_URI:
1.4       paf       226:                                // tainted, untaint language: uri
1.18      paf       227:                                escape(switch(*src) {
                    228:                                        case ' ': to_char('+');  break;
1.13      paf       229:                                        encode(need_uri_encode, '%');
1.18      paf       230:                                });
1.5       paf       231:                                break;
1.36      paf       232:                        case UL_HTTP_HEADER:
                    233:                                // tainted, untaint language: http-header
1.41      paf       234:                                if(need_quote_http_header(row->item.ptr, row->item.size)) {
                    235:                                        *dest++='\"';
                    236:                                        escape(switch(*src) {
                    237:                                                case '\"': to_string("\\\"", 2);  break;
                    238:                                                _default;
                    239:                                        });
                    240:                                        *dest++='\"';
                    241:                                } else {
                    242:                                        memcpy(dest, row->item.ptr, row->item.size); 
                    243:                                        dest+=row->item.size;
                    244:                                }
1.36      paf       245:                                break;
                    246:                        case UL_MAIL_HEADER:
                    247:                                // tainted, untaint language: mail-header
1.46      paf       248:                                if(charset) {
1.43      paf       249:                                        // Subject: Re: parser3: =?koi8-r?Q?=D3=C5=CD=C9=CE=C1=D2?=
                    250:                                        const char *src=row->item.ptr; 
1.59    ! parser    251:                                        bool to_quoted_printable=false;
1.43      paf       252:                                        for(int size=row->item.size; size--; src++) {
                    253:                                                if(*src & 0x80) {
1.59    ! parser    254:                                                        if(!to_quoted_printable) {
1.43      paf       255:                                                                dest+=sprintf(dest, "=?%.15s?Q?", charset);
1.59    ! parser    256:                                                                to_quoted_printable=true;
1.43      paf       257:                                                        }
1.45      paf       258:                                                        dest+=sprintf(dest, "=%02X", *src & 0xFF);
1.43      paf       259:                                                } else {
                    260:                                                        *dest++=*src;                                           
                    261:                                                }
                    262:                                        }
1.59    ! parser    263:                                        if(to_quoted_printable) // close
1.43      paf       264:                                                dest+=sprintf(dest, "?=");
1.46      paf       265:                                } else {
                    266:                                        memcpy(dest, row->item.ptr, row->item.size); 
                    267:                                        dest+=row->item.size;
1.43      paf       268:                                }
1.4       paf       269:                                break;
1.11      paf       270:                        case UL_TABLE: 
1.15      paf       271:                                // tainted, untaint language: table
1.18      paf       272:                                escape(switch(*src) {
                    273:                                        case '\t': to_char(' ');  break;
                    274:                                        case '\n': to_char(' ');  break;
1.13      paf       275:                                        _default;
1.18      paf       276:                                });
1.1       paf       277:                                break;
1.11      paf       278:                        case UL_SQL:
1.1       paf       279:                                // tainted, untaint language: sql
1.34      paf       280:                                if(connection)
                    281:                                        dest+=connection->quote(dest, row->item.ptr, row->item.size);
                    282:                                else
                    283:                                        THROW(0, 0,
                    284:                                                this,
                    285:                                                "untaint in SQL language failed - no connection specified");
1.1       paf       286:                                break;
1.11      paf       287:                        case UL_JS:
1.18      paf       288:                                escape(switch(*src) {
                    289:                                        case '"': to_string("\\\"", 2);  break;
                    290:                                        case '\'': to_string("\\'", 2);  break;
                    291:                                        case '\n': to_string("\\n", 2);  break;
                    292:                                        case '\\': to_string("\\\\", 2);  break;
                    293:                                        case '\xFF': to_string("\\\xFF", 2);  break;
1.13      paf       294:                                        _default;
1.18      paf       295:                                });
1.1       paf       296:                                break;
1.11      paf       297:                        case UL_HTML:
1.18      paf       298:                                escape(switch(*src) {
                    299:                                        case '&': to_string("&amp;", 5);  break;
                    300:                                        case '>': to_string("&gt;", 4);  break;
                    301:                                        case '<': to_string("&lt;", 4);  break;
                    302:                                        case '"': to_string("&quot;", 6);  break;
1.19      paf       303:                                        //TODO: XSLT case '\'': to_string("&apos;", 6);  break;
1.13      paf       304:                                        _default;
1.18      paf       305:                                });
1.1       paf       306:                                break;
1.47      paf       307:                        case UL_USER_HTML: {
1.1       paf       308:                                // tainted, untaint language: html-typo
1.58      parser    309:                                if(!typo_dict) // never, always has default
1.57      parser    310:                                        THROW(0, 0,
                    311:                                                this,
                    312:                                                "untaint to user-html lang failed, no typo table");
                    313: 
1.50      parser    314:                                char *html_for_typo=
                    315:                                        (char *)malloc(row->item.size*2/* '\n' -> '\' 'n' */+1);
1.19      paf       316:                                // note:
                    317:                                //   there still is a possibility that user 
                    318:                                //   would not replace \n as she supposed to
                    319:                                //   and rather replace \ and n into huge strings
                    320:                                //   thus causing memory overrun
                    321:                                //   this can be dealed by allocating *2 memory, but that's too expensive
1.18      paf       322:                                size_t html_for_typo_size;
1.13      paf       323:                                { // local dest
1.18      paf       324:                                        char *dest=html_for_typo;
                    325:                                        escape(switch(*src) {
1.16      paf       326:                                                // convinient name for typo match "\n"
                    327:                                                case '\r': 
1.57      parser    328:                                                        to_string("\\n", 2); // \r -> "\n"
                    329:                                                        if(size && src[1]=='\n') { // \r\n -> remove \n
                    330:                                                                size--; src++;
1.18      paf       331:                                                        }
                    332:                                                        break;
                    333:                                                case '\n': 
1.57      parser    334:                                                        to_string("\\n", 2);
1.16      paf       335:                                                        break;
1.19      paf       336:                                                //TODO: XSLT case '\'': to_string("&apos;", 6);  break;
1.13      paf       337:                                                _default;
1.18      paf       338:                                        });
1.13      paf       339:                                        *dest=0;
1.18      paf       340:                                        html_for_typo_size=dest-html_for_typo;
1.13      paf       341:                                }
                    342:                                // typo table replacements
1.21      paf       343:                                const char *src=html_for_typo;
                    344:                                do {
                    345:                                        // there is a row where first column starts 'src'
1.58      parser    346:                                        if(Table::Item *item=typo_dict->first_that_starts(src)) {
1.21      paf       347:                                                // get a=>b values
                    348:                                                const String& a=*static_cast<Array *>(item)->get_string(0);
                    349:                                                const String& b=*static_cast<Array *>(item)->get_string(1);
                    350:                                                // overflow check:
                    351:                                                //   b allowed to be max UNTAINT_TIMES_BIGGER then a
                    352:                                                if(b.size()>UNTAINT_TIMES_BIGGER*a.size()) {
1.58      parser    353:                                                        pool().set_tag(0); // avoid recursion
1.21      paf       354:                                                        THROW(0, 0, 
                    355:                                                                &b, 
                    356:                                                                "is %g times longer then '%s', "
                    357:                                                                "while maximum, handled by Parser, is %d", 
1.50      parser    358:                                                                        ((double)b.size())/a.size(), 
                    359:                                                                        a.cstr(), 
                    360:                                                                        UNTAINT_TIMES_BIGGER);
1.21      paf       361:                                                }
                    362:                                                
                    363:                                                // skip 'a' in 'src'
                    364:                                                src+=a.size();
                    365:                                                // write 'b' to 'dest'
                    366:                                                b.store_to(dest);
1.59    ! parser    367:                                                // skip 'b' in 'dest'
1.21      paf       368:                                                dest+=b.size();
                    369:                                        } else
                    370:                                                *dest++=*src++;
                    371:                                } while(*src);
1.1       paf       372:                                break;
1.13      paf       373:                                }
1.1       paf       374:                        default:
1.18      paf       375:                                THROW(0, 0, 
                    376:                                        this, 
1.1       paf       377:                                        "unknown untaint language #%d of %d piece", 
1.18      paf       378:                                                static_cast<int>(row->item.lang), 
1.38      paf       379:                                                i); // never
1.48      parser    380:                                break; // never
1.1       paf       381:                        }
1.44      paf       382: 
                    383:                        if((lang==UL_UNSPECIFIED?row->item.lang:lang)!=UL_CLEAN)
                    384:                                whitespace=false;
1.55      parser    385: 
                    386:                        if(forigins_mode)
                    387:                                if(dest==dest_after_origins) // never moved==optimized space
                    388:                                        dest=dest_before_origins;
                    389:                                else {
                    390:                                        for(char *p=dest_after_origins; p<dest; p++)
                    391:                                                if(*p=='\n')
                    392:                                                        *p='|';
                    393: 
                    394:                                        to_char('\n');
                    395:                                }
1.1       paf       396:                }
                    397:                chunk=row->link;
                    398:        } while(chunk);
                    399: break2:
1.13      paf       400:        return dest;
1.1       paf       401: }

E-mail: