lib/escape.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at https://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ***************************************************************************/
  22
  23 /* Escape and unescape URL encoding in strings. The functions return a new
  24  * allocated string or NULL if an error occurred.  */
  25
  26 #include "curl_setup.h"
  27
  28 #include <curl/curl.h>
  29
  30 #include "urldata.h"
  31 #include "warnless.h"
  32 #include "non-ascii.h"
  33 #include "escape.h"
  34 /* The last 3 #include files should be in this order */
  35 #include "curl_printf.h"
  36 #include "curl_memory.h"
  37 #include "memdebug.h"
  38
  39 /* Portable character check (remember EBCDIC). Do not use isalnum() because
  40    its behavior is altered by the current locale.
  41    See https://tools.ietf.org/html/rfc3986#section-2.3
  42 */
  43 static bool Curl_isunreserved(unsigned char in)
  44 {
  45   switch (in) {
  46     case '0': case '1': case '2': case '3': case '4':
  47     case '5': case '6': case '7': case '8': case '9':
  48     case 'a': case 'b': case 'c': case 'd': case 'e':
  49     case 'f': case 'g': case 'h': case 'i': case 'j':
  50     case 'k': case 'l': case 'm': case 'n': case 'o':
  51     case 'p': case 'q': case 'r': case 's': case 't':
  52     case 'u': case 'v': case 'w': case 'x': case 'y': case 'z':
  53     case 'A': case 'B': case 'C': case 'D': case 'E':
  54     case 'F': case 'G': case 'H': case 'I': case 'J':
  55     case 'K': case 'L': case 'M': case 'N': case 'O':
  56     case 'P': case 'Q': case 'R': case 'S': case 'T':
  57     case 'U': case 'V': case 'W': case 'X': case 'Y': case 'Z':
  58     case '-': case '.': case '_': case '~':
  59       return TRUE;
  60     default:
  61       break;
  62   }
  63   return FALSE;
  64 }
  65
  66 /* for ABI-compatibility with previous versions */
  67 char *curl_escape(const char *string, int inlength)
  68 {
  69   return curl_easy_escape(NULL, string, inlength);
  70 }
  71
  72 /* for ABI-compatibility with previous versions */
  73 char *curl_unescape(const char *string, int length)
  74 {
  75   return curl_easy_unescape(NULL, string, length, NULL);
  76 }
  77
  78 char *curl_easy_escape(struct Curl_easy *data, const char *string,
  79                        int inlength)
  80 {
  81   size_t alloc;
  82   char *ns;
  83   char *testing_ptr = NULL;
  84   unsigned char in; /* we need to treat the characters unsigned */
  85   size_t newlen;
  86   size_t strindex=0;
  87   size_t length;
  88   CURLcode result;
  89
  90   if(inlength < 0)
  91     return NULL;
  92
  93   alloc = (inlength?(size_t)inlength:strlen(string))+1;
  94   newlen = alloc;
  95
  96   ns = malloc(alloc);
  97   if(!ns)
  98     return NULL;
  99
 100   length = alloc-1;
 101   while(length--) {
 102     in = *string;
 103
 104     if(Curl_isunreserved(in))
 105       /* just copy this */
 106       ns[strindex++]=in;
 107     else {
 108       /* encode it */
 109       newlen += 2; /* the size grows with two, since this'll become a %XX */
 110       if(newlen > alloc) {
 111         alloc *= 2;
 112         testing_ptr = realloc(ns, alloc);
 113         if(!testing_ptr) {
 114           free(ns);
 115           return NULL;
 116         }
 117         else {
 118           ns = testing_ptr;
 119         }
 120       }
 121
 122       result = Curl_convert_to_network(data, &in, 1);
 123       if(result) {
 124         /* Curl_convert_to_network calls failf if unsuccessful */
 125         free(ns);
 126         return NULL;
 127       }
 128
 129       snprintf(&ns[strindex], 4, "%%%02X", in);
 130
 131       strindex+=3;
 132     }
 133     string++;
 134   }
 135   ns[strindex]=0; /* terminate it */
 136   return ns;
 137 }
 138
 139 /*
 140  * Curl_urldecode() URL decodes the given string.
 141  *
 142  * Optionally detects control characters (byte codes lower than 32) in the
 143  * data and rejects such data.
 144  *
 145  * Returns a pointer to a malloced string in *ostring with length given in
 146  * *olen. If length == 0, the length is assumed to be strlen(string).
 147  *
 148  */
 149 CURLcode Curl_urldecode(struct Curl_easy *data,
 150                         const char *string, size_t length,
 151                         char **ostring, size_t *olen,
 152                         bool reject_ctrl)
 153 {
 154   size_t alloc = (length?length:strlen(string))+1;
 155   char *ns = malloc(alloc);
 156   unsigned char in;
 157   size_t strindex=0;
 158   unsigned long hex;
 159   CURLcode result;
 160
 161   if(!ns)
 162     return CURLE_OUT_OF_MEMORY;
 163
 164   while(--alloc > 0) {
 165     in = *string;
 166     if(('%' == in) && (alloc > 2) &&
 167        ISXDIGIT(string[1]) && ISXDIGIT(string[2])) {
 168       /* this is two hexadecimal digits following a '%' */
 169       char hexstr[3];
 170       char *ptr;
 171       hexstr[0] = string[1];
 172       hexstr[1] = string[2];
 173       hexstr[2] = 0;
 174
 175       hex = strtoul(hexstr, &ptr, 16);
 176
 177       in = curlx_ultouc(hex); /* this long is never bigger than 255 anyway */
 178
 179       result = Curl_convert_from_network(data, &in, 1);
 180       if(result) {
 181         /* Curl_convert_from_network calls failf if unsuccessful */
 182         free(ns);
 183         return result;
 184       }
 185
 186       string+=2;
 187       alloc-=2;
 188     }
 189
 190     if(reject_ctrl && (in < 0x20)) {
 191       free(ns);
 192       return CURLE_URL_MALFORMAT;
 193     }
 194
 195     ns[strindex++] = in;
 196     string++;
 197   }
 198   ns[strindex]=0; /* terminate it */
 199
 200   if(olen)
 201     /* store output size */
 202     *olen = strindex;
 203
 204   /* store output string */
 205   *ostring = ns;
 206
 207   return CURLE_OK;
 208 }
 209
 210 /*
 211  * Unescapes the given URL escaped string of given length. Returns a
 212  * pointer to a malloced string with length given in *olen.
 213  * If length == 0, the length is assumed to be strlen(string).
 214  * If olen == NULL, no output length is stored.
 215  */
 216 char *curl_easy_unescape(struct Curl_easy *data, const char *string,
 217                          int length, int *olen)
 218 {
 219   char *str = NULL;
 220   if(length >= 0) {
 221     size_t inputlen = length;
 222     size_t outputlen;
 223     CURLcode res = Curl_urldecode(data, string, inputlen, &str, &outputlen,
 224                                   FALSE);
 225     if(res)
 226       return NULL;
 227     if(olen)
 228       *olen = curlx_uztosi(outputlen);
 229   }
 230   return str;
 231 }
 232
 233 /* For operating systems/environments that use different malloc/free
 234    systems for the app and for this library, we provide a free that uses
 235    the library's memory system */
 236 void curl_free(void *p)
 237 {
 238   free(p);
 239 }