Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * encode.c
4 : * Various data encoding/decoding things.
5 : *
6 : * Copyright (c) 2001-2022, PostgreSQL Global Development Group
7 : *
8 : *
9 : * IDENTIFICATION
10 : * src/backend/utils/adt/encode.c
11 : *
12 : *-------------------------------------------------------------------------
13 : */
14 : #include "postgres.h"
15 :
16 : #include <ctype.h>
17 :
18 : #include "mb/pg_wchar.h"
19 : #include "utils/builtins.h"
20 : #include "utils/memutils.h"
21 :
22 :
23 : /*
24 : * Encoding conversion API.
25 : * encode_len() and decode_len() compute the amount of space needed, while
26 : * encode() and decode() perform the actual conversions. It is okay for
27 : * the _len functions to return an overestimate, but not an underestimate.
28 : * (Having said that, large overestimates could cause unnecessary errors,
29 : * so it's better to get it right.) The conversion routines write to the
30 : * buffer at *res and return the true length of their output.
31 : */
32 : struct pg_encoding
33 : {
34 : uint64 (*encode_len) (const char *data, size_t dlen);
35 : uint64 (*decode_len) (const char *data, size_t dlen);
36 : uint64 (*encode) (const char *data, size_t dlen, char *res);
37 : uint64 (*decode) (const char *data, size_t dlen, char *res);
38 : };
39 :
40 : static const struct pg_encoding *pg_find_encoding(const char *name);
41 :
42 : /*
43 : * SQL functions.
44 : */
45 :
46 : Datum
47 94 : binary_encode(PG_FUNCTION_ARGS)
48 : {
49 94 : bytea *data = PG_GETARG_BYTEA_PP(0);
50 94 : Datum name = PG_GETARG_DATUM(1);
51 : text *result;
52 : char *namebuf;
53 : char *dataptr;
54 : size_t datalen;
55 : uint64 resultlen;
56 : uint64 res;
57 : const struct pg_encoding *enc;
58 :
59 94 : namebuf = TextDatumGetCString(name);
60 :
61 94 : enc = pg_find_encoding(namebuf);
62 94 : if (enc == NULL)
63 0 : ereport(ERROR,
64 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
65 : errmsg("unrecognized encoding: \"%s\"", namebuf)));
66 :
67 94 : dataptr = VARDATA_ANY(data);
68 94 : datalen = VARSIZE_ANY_EXHDR(data);
69 :
70 94 : resultlen = enc->encode_len(dataptr, datalen);
71 :
72 : /*
73 : * resultlen possibly overflows uint32, therefore on 32-bit machines it's
74 : * unsafe to rely on palloc's internal check.
75 : */
76 94 : if (resultlen > MaxAllocSize - VARHDRSZ)
77 0 : ereport(ERROR,
78 : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
79 : errmsg("result of encoding conversion is too large")));
80 :
81 94 : result = palloc(VARHDRSZ + resultlen);
82 :
83 94 : res = enc->encode(dataptr, datalen, VARDATA(result));
84 :
85 : /* Make this FATAL 'cause we've trodden on memory ... */
86 94 : if (res > resultlen)
87 0 : elog(FATAL, "overflow - encode estimate too small");
88 :
89 94 : SET_VARSIZE(result, VARHDRSZ + res);
90 :
91 94 : PG_RETURN_TEXT_P(result);
92 : }
93 :
94 : Datum
95 32852 : binary_decode(PG_FUNCTION_ARGS)
96 : {
97 32852 : text *data = PG_GETARG_TEXT_PP(0);
98 32852 : Datum name = PG_GETARG_DATUM(1);
99 : bytea *result;
100 : char *namebuf;
101 : char *dataptr;
102 : size_t datalen;
103 : uint64 resultlen;
104 : uint64 res;
105 : const struct pg_encoding *enc;
106 :
107 32852 : namebuf = TextDatumGetCString(name);
108 :
109 32852 : enc = pg_find_encoding(namebuf);
110 32852 : if (enc == NULL)
111 0 : ereport(ERROR,
112 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
113 : errmsg("unrecognized encoding: \"%s\"", namebuf)));
114 :
115 32852 : dataptr = VARDATA_ANY(data);
116 32852 : datalen = VARSIZE_ANY_EXHDR(data);
117 :
118 32852 : resultlen = enc->decode_len(dataptr, datalen);
119 :
120 : /*
121 : * resultlen possibly overflows uint32, therefore on 32-bit machines it's
122 : * unsafe to rely on palloc's internal check.
123 : */
124 32852 : if (resultlen > MaxAllocSize - VARHDRSZ)
125 0 : ereport(ERROR,
126 : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
127 : errmsg("result of decoding conversion is too large")));
128 :
129 32852 : result = palloc(VARHDRSZ + resultlen);
130 :
131 32852 : res = enc->decode(dataptr, datalen, VARDATA(result));
132 :
133 : /* Make this FATAL 'cause we've trodden on memory ... */
134 32852 : if (res > resultlen)
135 0 : elog(FATAL, "overflow - decode estimate too small");
136 :
137 32852 : SET_VARSIZE(result, VARHDRSZ + res);
138 :
139 32852 : PG_RETURN_BYTEA_P(result);
140 : }
141 :
142 :
143 : /*
144 : * HEX
145 : */
146 :
147 : static const char hextbl[] = "0123456789abcdef";
148 :
149 : static const int8 hexlookup[128] = {
150 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
151 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
152 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
153 : 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1, -1, -1, -1,
154 : -1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1,
155 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
156 : -1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1,
157 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
158 : };
159 :
160 : uint64
161 214256 : hex_encode(const char *src, size_t len, char *dst)
162 : {
163 214256 : const char *end = src + len;
164 :
165 1518338 : while (src < end)
166 : {
167 1304082 : *dst++ = hextbl[(*src >> 4) & 0xF];
168 1304082 : *dst++ = hextbl[*src & 0xF];
169 1304082 : src++;
170 : }
171 214256 : return (uint64) len * 2;
172 : }
173 :
174 : static inline char
175 865758 : get_hex(const char *cp)
176 : {
177 865758 : unsigned char c = (unsigned char) *cp;
178 865758 : int res = -1;
179 :
180 865758 : if (c < 127)
181 865758 : res = hexlookup[c];
182 :
183 865758 : if (res < 0)
184 6 : ereport(ERROR,
185 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
186 : errmsg("invalid hexadecimal digit: \"%.*s\"",
187 : pg_mblen(cp), cp)));
188 :
189 865752 : return (char) res;
190 : }
191 :
192 : uint64
193 33604 : hex_decode(const char *src, size_t len, char *dst)
194 : {
195 : const char *s,
196 : *srcend;
197 : char v1,
198 : v2,
199 : *p;
200 :
201 33604 : srcend = src + len;
202 33604 : s = src;
203 33604 : p = dst;
204 466534 : while (s < srcend)
205 : {
206 432942 : if (*s == ' ' || *s == '\n' || *s == '\t' || *s == '\r')
207 : {
208 60 : s++;
209 60 : continue;
210 : }
211 432882 : v1 = get_hex(s) << 4;
212 432882 : s++;
213 432882 : if (s >= srcend)
214 6 : ereport(ERROR,
215 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
216 : errmsg("invalid hexadecimal data: odd number of digits")));
217 :
218 432876 : v2 = get_hex(s);
219 432870 : s++;
220 432870 : *p++ = v1 | v2;
221 : }
222 :
223 33592 : return p - dst;
224 : }
225 :
226 : static uint64
227 6 : hex_enc_len(const char *src, size_t srclen)
228 : {
229 6 : return (uint64) srclen << 1;
230 : }
231 :
232 : static uint64
233 32812 : hex_dec_len(const char *src, size_t srclen)
234 : {
235 32812 : return (uint64) srclen >> 1;
236 : }
237 :
238 : /*
239 : * BASE64
240 : */
241 :
242 : static const char _base64[] =
243 : "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
244 :
245 : static const int8 b64lookup[128] = {
246 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
247 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
248 : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
249 : 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1,
250 : -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
251 : 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1,
252 : -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
253 : 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1,
254 : };
255 :
256 : static uint64
257 12 : pg_base64_encode(const char *src, size_t len, char *dst)
258 : {
259 : char *p,
260 12 : *lend = dst + 76;
261 : const char *s,
262 12 : *end = src + len;
263 12 : int pos = 2;
264 12 : uint32 buf = 0;
265 :
266 12 : s = src;
267 12 : p = dst;
268 :
269 852 : while (s < end)
270 : {
271 840 : buf |= (unsigned char) *s << (pos << 3);
272 840 : pos--;
273 840 : s++;
274 :
275 : /* write it out */
276 840 : if (pos < 0)
277 : {
278 276 : *p++ = _base64[(buf >> 18) & 0x3f];
279 276 : *p++ = _base64[(buf >> 12) & 0x3f];
280 276 : *p++ = _base64[(buf >> 6) & 0x3f];
281 276 : *p++ = _base64[buf & 0x3f];
282 :
283 276 : pos = 2;
284 276 : buf = 0;
285 : }
286 840 : if (p >= lend)
287 : {
288 12 : *p++ = '\n';
289 12 : lend = p + 76;
290 : }
291 : }
292 12 : if (pos != 2)
293 : {
294 12 : *p++ = _base64[(buf >> 18) & 0x3f];
295 12 : *p++ = _base64[(buf >> 12) & 0x3f];
296 12 : *p++ = (pos == 0) ? _base64[(buf >> 6) & 0x3f] : '=';
297 12 : *p++ = '=';
298 : }
299 :
300 12 : return p - dst;
301 : }
302 :
303 : static uint64
304 10 : pg_base64_decode(const char *src, size_t len, char *dst)
305 : {
306 10 : const char *srcend = src + len,
307 10 : *s = src;
308 10 : char *p = dst;
309 : char c;
310 10 : int b = 0;
311 10 : uint32 buf = 0;
312 10 : int pos = 0,
313 10 : end = 0;
314 :
315 624 : while (s < srcend)
316 : {
317 614 : c = *s++;
318 :
319 614 : if (c == ' ' || c == '\t' || c == '\n' || c == '\r')
320 6 : continue;
321 :
322 608 : if (c == '=')
323 : {
324 : /* end sequence */
325 16 : if (!end)
326 : {
327 10 : if (pos == 2)
328 6 : end = 1;
329 4 : else if (pos == 3)
330 4 : end = 2;
331 : else
332 0 : ereport(ERROR,
333 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
334 : errmsg("unexpected \"=\" while decoding base64 sequence")));
335 : }
336 16 : b = 0;
337 : }
338 : else
339 : {
340 592 : b = -1;
341 592 : if (c > 0 && c < 127)
342 592 : b = b64lookup[(unsigned char) c];
343 592 : if (b < 0)
344 0 : ereport(ERROR,
345 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
346 : errmsg("invalid symbol \"%.*s\" found while decoding base64 sequence",
347 : pg_mblen(s - 1), s - 1)));
348 : }
349 : /* add it to buffer */
350 608 : buf = (buf << 6) + b;
351 608 : pos++;
352 608 : if (pos == 4)
353 : {
354 152 : *p++ = (buf >> 16) & 255;
355 152 : if (end == 0 || end > 1)
356 146 : *p++ = (buf >> 8) & 255;
357 152 : if (end == 0 || end > 2)
358 142 : *p++ = buf & 255;
359 152 : buf = 0;
360 152 : pos = 0;
361 : }
362 : }
363 :
364 10 : if (pos != 0)
365 0 : ereport(ERROR,
366 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
367 : errmsg("invalid base64 end sequence"),
368 : errhint("Input data is missing padding, is truncated, or is otherwise corrupted.")));
369 :
370 10 : return p - dst;
371 : }
372 :
373 :
374 : static uint64
375 12 : pg_base64_enc_len(const char *src, size_t srclen)
376 : {
377 : /* 3 bytes will be converted to 4, linefeed after 76 chars */
378 12 : return ((uint64) srclen + 2) * 4 / 3 + (uint64) srclen / (76 * 3 / 4);
379 : }
380 :
381 : static uint64
382 10 : pg_base64_dec_len(const char *src, size_t srclen)
383 : {
384 10 : return ((uint64) srclen * 3) >> 2;
385 : }
386 :
387 : /*
388 : * Escape
389 : * Minimally escape bytea to text.
390 : * De-escape text to bytea.
391 : *
392 : * We must escape zero bytes and high-bit-set bytes to avoid generating
393 : * text that might be invalid in the current encoding, or that might
394 : * change to something else if passed through an encoding conversion
395 : * (leading to failing to de-escape to the original bytea value).
396 : * Also of course backslash itself has to be escaped.
397 : *
398 : * De-escaping processes \\ and any \### octal
399 : */
400 :
401 : #define VAL(CH) ((CH) - '0')
402 : #define DIG(VAL) ((VAL) + '0')
403 :
404 : static uint64
405 76 : esc_encode(const char *src, size_t srclen, char *dst)
406 : {
407 76 : const char *end = src + srclen;
408 76 : char *rp = dst;
409 76 : uint64 len = 0;
410 :
411 732 : while (src < end)
412 : {
413 656 : unsigned char c = (unsigned char) *src;
414 :
415 656 : if (c == '\0' || IS_HIGHBIT_SET(c))
416 : {
417 78 : rp[0] = '\\';
418 78 : rp[1] = DIG(c >> 6);
419 78 : rp[2] = DIG((c >> 3) & 7);
420 78 : rp[3] = DIG(c & 7);
421 78 : rp += 4;
422 78 : len += 4;
423 : }
424 578 : else if (c == '\\')
425 : {
426 0 : rp[0] = '\\';
427 0 : rp[1] = '\\';
428 0 : rp += 2;
429 0 : len += 2;
430 : }
431 : else
432 : {
433 578 : *rp++ = c;
434 578 : len++;
435 : }
436 :
437 656 : src++;
438 : }
439 :
440 76 : return len;
441 : }
442 :
443 : static uint64
444 30 : esc_decode(const char *src, size_t srclen, char *dst)
445 : {
446 30 : const char *end = src + srclen;
447 30 : char *rp = dst;
448 30 : uint64 len = 0;
449 :
450 2400084 : while (src < end)
451 : {
452 2400054 : if (src[0] != '\\')
453 2400024 : *rp++ = *src++;
454 30 : else if (src + 3 < end &&
455 30 : (src[1] >= '0' && src[1] <= '3') &&
456 30 : (src[2] >= '0' && src[2] <= '7') &&
457 30 : (src[3] >= '0' && src[3] <= '7'))
458 30 : {
459 : int val;
460 :
461 30 : val = VAL(src[1]);
462 30 : val <<= 3;
463 30 : val += VAL(src[2]);
464 30 : val <<= 3;
465 30 : *rp++ = val + VAL(src[3]);
466 30 : src += 4;
467 : }
468 0 : else if (src + 1 < end &&
469 0 : (src[1] == '\\'))
470 : {
471 0 : *rp++ = '\\';
472 0 : src += 2;
473 : }
474 : else
475 : {
476 : /*
477 : * One backslash, not followed by ### valid octal. Should never
478 : * get here, since esc_dec_len does same check.
479 : */
480 0 : ereport(ERROR,
481 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
482 : errmsg("invalid input syntax for type %s", "bytea")));
483 : }
484 :
485 2400054 : len++;
486 : }
487 :
488 30 : return len;
489 : }
490 :
491 : static uint64
492 76 : esc_enc_len(const char *src, size_t srclen)
493 : {
494 76 : const char *end = src + srclen;
495 76 : uint64 len = 0;
496 :
497 732 : while (src < end)
498 : {
499 656 : if (*src == '\0' || IS_HIGHBIT_SET(*src))
500 78 : len += 4;
501 578 : else if (*src == '\\')
502 0 : len += 2;
503 : else
504 578 : len++;
505 :
506 656 : src++;
507 : }
508 :
509 76 : return len;
510 : }
511 :
512 : static uint64
513 30 : esc_dec_len(const char *src, size_t srclen)
514 : {
515 30 : const char *end = src + srclen;
516 30 : uint64 len = 0;
517 :
518 2400084 : while (src < end)
519 : {
520 2400054 : if (src[0] != '\\')
521 2400024 : src++;
522 30 : else if (src + 3 < end &&
523 30 : (src[1] >= '0' && src[1] <= '3') &&
524 30 : (src[2] >= '0' && src[2] <= '7') &&
525 30 : (src[3] >= '0' && src[3] <= '7'))
526 : {
527 : /*
528 : * backslash + valid octal
529 : */
530 30 : src += 4;
531 : }
532 0 : else if (src + 1 < end &&
533 0 : (src[1] == '\\'))
534 : {
535 : /*
536 : * two backslashes = backslash
537 : */
538 0 : src += 2;
539 : }
540 : else
541 : {
542 : /*
543 : * one backslash, not followed by ### valid octal
544 : */
545 0 : ereport(ERROR,
546 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
547 : errmsg("invalid input syntax for type %s", "bytea")));
548 : }
549 :
550 2400054 : len++;
551 : }
552 30 : return len;
553 : }
554 :
555 : /*
556 : * Common
557 : */
558 :
559 : static const struct
560 : {
561 : const char *name;
562 : struct pg_encoding enc;
563 : } enclist[] =
564 :
565 : {
566 : {
567 : "hex",
568 : {
569 : hex_enc_len, hex_dec_len, hex_encode, hex_decode
570 : }
571 : },
572 : {
573 : "base64",
574 : {
575 : pg_base64_enc_len, pg_base64_dec_len, pg_base64_encode, pg_base64_decode
576 : }
577 : },
578 : {
579 : "escape",
580 : {
581 : esc_enc_len, esc_dec_len, esc_encode, esc_decode
582 : }
583 : },
584 : {
585 : NULL,
586 : {
587 : NULL, NULL, NULL, NULL
588 : }
589 : }
590 : };
591 :
592 : static const struct pg_encoding *
593 32946 : pg_find_encoding(const char *name)
594 : {
595 : int i;
596 :
597 33180 : for (i = 0; enclist[i].name; i++)
598 33180 : if (pg_strcasecmp(enclist[i].name, name) == 0)
599 32946 : return &enclist[i].enc;
600 :
601 0 : return NULL;
602 : }
|
