contrib/apr/tools/gen_test_char.c

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #if defined(WIN32) || defined(OS2)
  18 #define NEED_ENHANCED_ESCAPES
  19 #endif
  20
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdio.h>
  24 #include <ctype.h>
  25
  26 /* A bunch of functions in util.c scan strings looking for certain characters.
  27  * To make that more efficient we encode a lookup table.
  28  */
  29 #define T_ESCAPE_SHELL_CMD    (0x01)
  30 #define T_ESCAPE_PATH_SEGMENT (0x02)
  31 #define T_OS_ESCAPE_PATH      (0x04)
  32 #define T_ESCAPE_ECHO         (0x08)
  33 #define T_ESCAPE_URLENCODED   (0x10)
  34 #define T_ESCAPE_XML          (0x20)
  35
  36 int main(int argc, char *argv[])
  37 {
  38     unsigned c;
  39     unsigned char flags;
  40
  41     printf("/* this file is automatically generated by gen_test_char, "
  42            "do not edit. \"make include/private/apr_escape_test_char.h\" to regenerate. */\n"
  43            "#define T_ESCAPE_SHELL_CMD     (%u)\n"
  44            "#define T_ESCAPE_PATH_SEGMENT  (%u)\n"
  45            "#define T_OS_ESCAPE_PATH       (%u)\n"
  46            "#define T_ESCAPE_ECHO          (%u)\n"
  47            "#define T_ESCAPE_URLENCODED    (%u)\n"
  48            "#define T_ESCAPE_XML           (%u)\n"
  49            "\n"
  50            "static const unsigned char test_char_table[256] = {",
  51            T_ESCAPE_SHELL_CMD,
  52            T_ESCAPE_PATH_SEGMENT,
  53            T_OS_ESCAPE_PATH,
  54            T_ESCAPE_ECHO,
  55            T_ESCAPE_URLENCODED,
  56            T_ESCAPE_XML);
  57
  58     for (c = 0; c < 256; ++c) {
  59         flags = 0;
  60         if (c % 20 == 0)
  61             printf("\n    ");
  62
  63         /* escape_shell_cmd */
  64 #ifdef NEED_ENHANCED_ESCAPES
  65         /* Win32/OS2 have many of the same vulnerable characters
  66          * as Unix sh, plus the carriage return and percent char.
  67          * The proper escaping of these characters varies from unix
  68          * since Win32/OS2 use carets or doubled-double quotes,
  69          * and neither lf nor cr can be escaped.  We escape unix
  70          * specific as well, to assure that cross-compiled unix
  71          * applications behave similiarly when invoked on win32/os2.
  72          *
  73          * Rem please keep in-sync with apr's list in win32/filesys.c
  74          */
  75         if (c && strchr("&;`'\"|*?~<>^()[]{}$\\\n\r%", c)) {
  76             flags |= T_ESCAPE_SHELL_CMD;
  77         }
  78 #else
  79         if (c && strchr("&;`'\"|*?~<>^()[]{}$\\\n", c)) {
  80             flags |= T_ESCAPE_SHELL_CMD;
  81         }
  82 #endif
  83
  84         if (!isalnum(c) && !strchr("$-_.+!*'(),:@&=~", c)) {
  85             flags |= T_ESCAPE_PATH_SEGMENT;
  86         }
  87
  88         if (!isalnum(c) && !strchr("$-_.+!*'(),:@&=/~", c)) {
  89             flags |= T_OS_ESCAPE_PATH;
  90         }
  91
  92         if (!isalnum(c) && !strchr(".-*_ ", c)) {
  93             flags |= T_ESCAPE_URLENCODED;
  94         }
  95
  96         /* For logging, escape all control characters,
  97          * double quotes (because they delimit the request in the log file)
  98          * backslashes (because we use backslash for escaping)
  99          * and 8-bit chars with the high bit set
 100          */
 101         if (c && (!isprint(c) || c == '"' || c == '\\' || iscntrl(c))) {
 102             flags |= T_ESCAPE_ECHO;
 103         }
 104
 105         if (strchr("<>&\"", c)) {
 106             flags |= T_ESCAPE_XML;
 107         }
 108
 109         printf("%u%c", flags, (c < 255) ? ',' : ' ');
 110     }
 111
 112     printf("\n};\n");
 113
 114     return 0;
 115 }