lib/base64.c

   1 /* base64.c -- Encode binary data using printable characters.
   2    Copyright (C) 1999-2001, 2004-2006, 2009-2011 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  17
  18 /* Written by Simon Josefsson.  Partially adapted from GNU MailUtils
  19  * (mailbox/filter_trans.c, as of 2004-11-28).  Improved by review
  20  * from Paul Eggert, Bruno Haible, and Stepan Kasal.
  21  *
  22  * See also RFC 3548 <http://www.ietf.org/rfc/rfc3548.txt>.
  23  *
  24  * Be careful with error checking.  Here is how you would typically
  25  * use these functions:
  26  *
  27  * bool ok = base64_decode_alloc (in, inlen, &out, &outlen);
  28  * if (!ok)
  29  *   FAIL: input was not valid base64
  30  * if (out == NULL)
  31  *   FAIL: memory allocation error
  32  * OK: data in OUT/OUTLEN
  33  *
  34  * size_t outlen = base64_encode_alloc (in, inlen, &out);
  35  * if (out == NULL && outlen == 0 && inlen != 0)
  36  *   FAIL: input too long
  37  * if (out == NULL)
  38  *   FAIL: memory allocation error
  39  * OK: data in OUT/OUTLEN.
  40  *
  41  */
  42
  43 #include <config.h>
  44
  45 /* Get prototype. */
  46 #include "base64.h"
  47
  48 /* Get malloc. */
  49 #include <stdlib.h>
  50
  51 /* Get UCHAR_MAX. */
  52 #include <limits.h>
  53
  54 #include <string.h>
  55
  56 /* The attribute __const__ was added in gcc 2.95.  */
  57 #undef _GL_ATTRIBUTE_CONST
  58 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
  59 # define _GL_ATTRIBUTE_CONST __attribute__ ((__const__))
  60 #else
  61 # define _GL_ATTRIBUTE_CONST /* empty */
  62 #endif
  63
  64 /* C89 compliant way to cast 'char' to 'unsigned char'. */
  65 static inline unsigned char
  66 to_uchar (char ch)
  67 {
  68   return ch;
  69 }
  70
  71 /* Base64 encode IN array of size INLEN into OUT array of size OUTLEN.
  72    If OUTLEN is less than BASE64_LENGTH(INLEN), write as many bytes as
  73    possible.  If OUTLEN is larger than BASE64_LENGTH(INLEN), also zero
  74    terminate the output buffer. */
  75 void
  76 base64_encode (const char *restrict in, size_t inlen,
  77                char *restrict out, size_t outlen)
  78 {
  79   static const char b64str[64] =
  80     "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  81
  82   while (inlen && outlen)
  83     {
  84       *out++ = b64str[(to_uchar (in[0]) >> 2) & 0x3f];
  85       if (!--outlen)
  86         break;
  87       *out++ = b64str[((to_uchar (in[0]) << 4)
  88                        + (--inlen ? to_uchar (in[1]) >> 4 : 0))
  89                       & 0x3f];
  90       if (!--outlen)
  91         break;
  92       *out++ =
  93         (inlen
  94          ? b64str[((to_uchar (in[1]) << 2)
  95                    + (--inlen ? to_uchar (in[2]) >> 6 : 0))
  96                   & 0x3f]
  97          : '=');
  98       if (!--outlen)
  99         break;
 100       *out++ = inlen ? b64str[to_uchar (in[2]) & 0x3f] : '=';
 101       if (!--outlen)
 102         break;
 103       if (inlen)
 104         inlen--;
 105       if (inlen)
 106         in += 3;
 107     }
 108
 109   if (outlen)
 110     *out = '\0';
 111 }
 112
 113 /* Allocate a buffer and store zero terminated base64 encoded data
 114    from array IN of size INLEN, returning BASE64_LENGTH(INLEN), i.e.,
 115    the length of the encoded data, excluding the terminating zero.  On
 116    return, the OUT variable will hold a pointer to newly allocated
 117    memory that must be deallocated by the caller.  If output string
 118    length would overflow, 0 is returned and OUT is set to NULL.  If
 119    memory allocation failed, OUT is set to NULL, and the return value
 120    indicates length of the requested memory block, i.e.,
 121    BASE64_LENGTH(inlen) + 1. */
 122 size_t
 123 base64_encode_alloc (const char *in, size_t inlen, char **out)
 124 {
 125   size_t outlen = 1 + BASE64_LENGTH (inlen);
 126
 127   /* Check for overflow in outlen computation.
 128    *
 129    * If there is no overflow, outlen >= inlen.
 130    *
 131    * If the operation (inlen + 2) overflows then it yields at most +1, so
 132    * outlen is 0.
 133    *
 134    * If the multiplication overflows, we lose at least half of the
 135    * correct value, so the result is < ((inlen + 2) / 3) * 2, which is
 136    * less than (inlen + 2) * 0.66667, which is less than inlen as soon as
 137    * (inlen > 4).
 138    */
 139   if (inlen > outlen)
 140     {
 141       *out = NULL;
 142       return 0;
 143     }
 144
 145   *out = malloc (outlen);
 146   if (!*out)
 147     return outlen;
 148
 149   base64_encode (in, inlen, *out, outlen);
 150
 151   return outlen - 1;
 152 }
 153
 154 /* With this approach this file works independent of the charset used
 155    (think EBCDIC).  However, it does assume that the characters in the
 156    Base64 alphabet (A-Za-z0-9+/) are encoded in 0..255.  POSIX
 157    1003.1-2001 require that char and unsigned char are 8-bit
 158    quantities, though, taking care of that problem.  But this may be a
 159    potential problem on non-POSIX C99 platforms.
 160
 161    IBM C V6 for AIX mishandles "#define B64(x) ...'x'...", so use "_"
 162    as the formal parameter rather than "x".  */
 163 #define B64(_)                                  \
 164   ((_) == 'A' ? 0                               \
 165    : (_) == 'B' ? 1                             \
 166    : (_) == 'C' ? 2                             \
 167    : (_) == 'D' ? 3                             \
 168    : (_) == 'E' ? 4                             \
 169    : (_) == 'F' ? 5                             \
 170    : (_) == 'G' ? 6                             \
 171    : (_) == 'H' ? 7                             \
 172    : (_) == 'I' ? 8                             \
 173    : (_) == 'J' ? 9                             \
 174    : (_) == 'K' ? 10                            \
 175    : (_) == 'L' ? 11                            \
 176    : (_) == 'M' ? 12                            \
 177    : (_) == 'N' ? 13                            \
 178    : (_) == 'O' ? 14                            \
 179    : (_) == 'P' ? 15                            \
 180    : (_) == 'Q' ? 16                            \
 181    : (_) == 'R' ? 17                            \
 182    : (_) == 'S' ? 18                            \
 183    : (_) == 'T' ? 19                            \
 184    : (_) == 'U' ? 20                            \
 185    : (_) == 'V' ? 21                            \
 186    : (_) == 'W' ? 22                            \
 187    : (_) == 'X' ? 23                            \
 188    : (_) == 'Y' ? 24                            \
 189    : (_) == 'Z' ? 25                            \
 190    : (_) == 'a' ? 26                            \
 191    : (_) == 'b' ? 27                            \
 192    : (_) == 'c' ? 28                            \
 193    : (_) == 'd' ? 29                            \
 194    : (_) == 'e' ? 30                            \
 195    : (_) == 'f' ? 31                            \
 196    : (_) == 'g' ? 32                            \
 197    : (_) == 'h' ? 33                            \
 198    : (_) == 'i' ? 34                            \
 199    : (_) == 'j' ? 35                            \
 200    : (_) == 'k' ? 36                            \
 201    : (_) == 'l' ? 37                            \
 202    : (_) == 'm' ? 38                            \
 203    : (_) == 'n' ? 39                            \
 204    : (_) == 'o' ? 40                            \
 205    : (_) == 'p' ? 41                            \
 206    : (_) == 'q' ? 42                            \
 207    : (_) == 'r' ? 43                            \
 208    : (_) == 's' ? 44                            \
 209    : (_) == 't' ? 45                            \
 210    : (_) == 'u' ? 46                            \
 211    : (_) == 'v' ? 47                            \
 212    : (_) == 'w' ? 48                            \
 213    : (_) == 'x' ? 49                            \
 214    : (_) == 'y' ? 50                            \
 215    : (_) == 'z' ? 51                            \
 216    : (_) == '0' ? 52                            \
 217    : (_) == '1' ? 53                            \
 218    : (_) == '2' ? 54                            \
 219    : (_) == '3' ? 55                            \
 220    : (_) == '4' ? 56                            \
 221    : (_) == '5' ? 57                            \
 222    : (_) == '6' ? 58                            \
 223    : (_) == '7' ? 59                            \
 224    : (_) == '8' ? 60                            \
 225    : (_) == '9' ? 61                            \
 226    : (_) == '+' ? 62                            \
 227    : (_) == '/' ? 63                            \
 228    : -1)
 229
 230 static const signed char b64[0x100] = {
 231   B64 (0), B64 (1), B64 (2), B64 (3),
 232   B64 (4), B64 (5), B64 (6), B64 (7),
 233   B64 (8), B64 (9), B64 (10), B64 (11),
 234   B64 (12), B64 (13), B64 (14), B64 (15),
 235   B64 (16), B64 (17), B64 (18), B64 (19),
 236   B64 (20), B64 (21), B64 (22), B64 (23),
 237   B64 (24), B64 (25), B64 (26), B64 (27),
 238   B64 (28), B64 (29), B64 (30), B64 (31),
 239   B64 (32), B64 (33), B64 (34), B64 (35),
 240   B64 (36), B64 (37), B64 (38), B64 (39),
 241   B64 (40), B64 (41), B64 (42), B64 (43),
 242   B64 (44), B64 (45), B64 (46), B64 (47),
 243   B64 (48), B64 (49), B64 (50), B64 (51),
 244   B64 (52), B64 (53), B64 (54), B64 (55),
 245   B64 (56), B64 (57), B64 (58), B64 (59),
 246   B64 (60), B64 (61), B64 (62), B64 (63),
 247   B64 (64), B64 (65), B64 (66), B64 (67),
 248   B64 (68), B64 (69), B64 (70), B64 (71),
 249   B64 (72), B64 (73), B64 (74), B64 (75),
 250   B64 (76), B64 (77), B64 (78), B64 (79),
 251   B64 (80), B64 (81), B64 (82), B64 (83),
 252   B64 (84), B64 (85), B64 (86), B64 (87),
 253   B64 (88), B64 (89), B64 (90), B64 (91),
 254   B64 (92), B64 (93), B64 (94), B64 (95),
 255   B64 (96), B64 (97), B64 (98), B64 (99),
 256   B64 (100), B64 (101), B64 (102), B64 (103),
 257   B64 (104), B64 (105), B64 (106), B64 (107),
 258   B64 (108), B64 (109), B64 (110), B64 (111),
 259   B64 (112), B64 (113), B64 (114), B64 (115),
 260   B64 (116), B64 (117), B64 (118), B64 (119),
 261   B64 (120), B64 (121), B64 (122), B64 (123),
 262   B64 (124), B64 (125), B64 (126), B64 (127),
 263   B64 (128), B64 (129), B64 (130), B64 (131),
 264   B64 (132), B64 (133), B64 (134), B64 (135),
 265   B64 (136), B64 (137), B64 (138), B64 (139),
 266   B64 (140), B64 (141), B64 (142), B64 (143),
 267   B64 (144), B64 (145), B64 (146), B64 (147),
 268   B64 (148), B64 (149), B64 (150), B64 (151),
 269   B64 (152), B64 (153), B64 (154), B64 (155),
 270   B64 (156), B64 (157), B64 (158), B64 (159),
 271   B64 (160), B64 (161), B64 (162), B64 (163),
 272   B64 (164), B64 (165), B64 (166), B64 (167),
 273   B64 (168), B64 (169), B64 (170), B64 (171),
 274   B64 (172), B64 (173), B64 (174), B64 (175),
 275   B64 (176), B64 (177), B64 (178), B64 (179),
 276   B64 (180), B64 (181), B64 (182), B64 (183),
 277   B64 (184), B64 (185), B64 (186), B64 (187),
 278   B64 (188), B64 (189), B64 (190), B64 (191),
 279   B64 (192), B64 (193), B64 (194), B64 (195),
 280   B64 (196), B64 (197), B64 (198), B64 (199),
 281   B64 (200), B64 (201), B64 (202), B64 (203),
 282   B64 (204), B64 (205), B64 (206), B64 (207),
 283   B64 (208), B64 (209), B64 (210), B64 (211),
 284   B64 (212), B64 (213), B64 (214), B64 (215),
 285   B64 (216), B64 (217), B64 (218), B64 (219),
 286   B64 (220), B64 (221), B64 (222), B64 (223),
 287   B64 (224), B64 (225), B64 (226), B64 (227),
 288   B64 (228), B64 (229), B64 (230), B64 (231),
 289   B64 (232), B64 (233), B64 (234), B64 (235),
 290   B64 (236), B64 (237), B64 (238), B64 (239),
 291   B64 (240), B64 (241), B64 (242), B64 (243),
 292   B64 (244), B64 (245), B64 (246), B64 (247),
 293   B64 (248), B64 (249), B64 (250), B64 (251),
 294   B64 (252), B64 (253), B64 (254), B64 (255)
 295 };
 296
 297 #if UCHAR_MAX == 255
 298 # define uchar_in_range(c) true
 299 #else
 300 # define uchar_in_range(c) ((c) <= 255)
 301 #endif
 302
 303 /* Return true if CH is a character from the Base64 alphabet, and
 304    false otherwise.  Note that '=' is padding and not considered to be
 305    part of the alphabet.  */
 306 bool _GL_ATTRIBUTE_CONST
 307 isbase64 (char ch)
 308 {
 309   return uchar_in_range (to_uchar (ch)) && 0 <= b64[to_uchar (ch)];
 310 }
 311
 312 /* Initialize decode-context buffer, CTX.  */
 313 void
 314 base64_decode_ctx_init (struct base64_decode_context *ctx)
 315 {
 316   ctx->i = 0;
 317 }
 318
 319 /* If CTX->i is 0 or 4, there are four or more bytes in [*IN..IN_END), and
 320    none of those four is a newline, then return *IN.  Otherwise, copy up to
 321    4 - CTX->i non-newline bytes from that range into CTX->buf, starting at
 322    index CTX->i and setting CTX->i to reflect the number of bytes copied,
 323    and return CTX->buf.  In either case, advance *IN to point to the byte
 324    after the last one processed, and set *N_NON_NEWLINE to the number of
 325    verified non-newline bytes accessible through the returned pointer.  */
 326 static inline char *
 327 get_4 (struct base64_decode_context *ctx,
 328        char const *restrict *in, char const *restrict in_end,
 329        size_t *n_non_newline)
 330 {
 331   if (ctx->i == 4)
 332     ctx->i = 0;
 333
 334   if (ctx->i == 0)
 335     {
 336       char const *t = *in;
 337       if (4 <= in_end - *in && memchr (t, '\n', 4) == NULL)
 338         {
 339           /* This is the common case: no newline.  */
 340           *in += 4;
 341           *n_non_newline = 4;
 342           return (char *) t;
 343         }
 344     }
 345
 346   {
 347     /* Copy non-newline bytes into BUF.  */
 348     char const *p = *in;
 349     while (p < in_end)
 350       {
 351         char c = *p++;
 352         if (c != '\n')
 353           {
 354             ctx->buf[ctx->i++] = c;
 355             if (ctx->i == 4)
 356               break;
 357           }
 358       }
 359
 360     *in = p;
 361     *n_non_newline = ctx->i;
 362     return ctx->buf;
 363   }
 364 }
 365
 366 #define return_false                            \
 367   do                                            \
 368     {                                           \
 369       *outp = out;                              \
 370       return false;                             \
 371     }                                           \
 372   while (false)
 373
 374 /* Decode up to four bytes of base64-encoded data, IN, of length INLEN
 375    into the output buffer, *OUT, of size *OUTLEN bytes.  Return true if
 376    decoding is successful, false otherwise.  If *OUTLEN is too small,
 377    as many bytes as possible are written to *OUT.  On return, advance
 378    *OUT to point to the byte after the last one written, and decrement
 379    *OUTLEN to reflect the number of bytes remaining in *OUT.  */
 380 static inline bool
 381 decode_4 (char const *restrict in, size_t inlen,
 382           char *restrict *outp, size_t *outleft)
 383 {
 384   char *out = *outp;
 385   if (inlen < 2)
 386     return false;
 387
 388   if (!isbase64 (in[0]) || !isbase64 (in[1]))
 389     return false;
 390
 391   if (*outleft)
 392     {
 393       *out++ = ((b64[to_uchar (in[0])] << 2)
 394                 | (b64[to_uchar (in[1])] >> 4));
 395       --*outleft;
 396     }
 397
 398   if (inlen == 2)
 399     return_false;
 400
 401   if (in[2] == '=')
 402     {
 403       if (inlen != 4)
 404         return_false;
 405
 406       if (in[3] != '=')
 407         return_false;
 408     }
 409   else
 410     {
 411       if (!isbase64 (in[2]))
 412         return_false;
 413
 414       if (*outleft)
 415         {
 416           *out++ = (((b64[to_uchar (in[1])] << 4) & 0xf0)
 417                     | (b64[to_uchar (in[2])] >> 2));
 418           --*outleft;
 419         }
 420
 421       if (inlen == 3)
 422         return_false;
 423
 424       if (in[3] == '=')
 425         {
 426           if (inlen != 4)
 427             return_false;
 428         }
 429       else
 430         {
 431           if (!isbase64 (in[3]))
 432             return_false;
 433
 434           if (*outleft)
 435             {
 436               *out++ = (((b64[to_uchar (in[2])] << 6) & 0xc0)
 437                         | b64[to_uchar (in[3])]);
 438               --*outleft;
 439             }
 440         }
 441     }
 442
 443   *outp = out;
 444   return true;
 445 }
 446
 447 /* Decode base64-encoded input array IN of length INLEN to output array
 448    OUT that can hold *OUTLEN bytes.  The input data may be interspersed
 449    with newlines.  Return true if decoding was successful, i.e. if the
 450    input was valid base64 data, false otherwise.  If *OUTLEN is too
 451    small, as many bytes as possible will be written to OUT.  On return,
 452    *OUTLEN holds the length of decoded bytes in OUT.  Note that as soon
 453    as any non-alphabet, non-newline character is encountered, decoding
 454    is stopped and false is returned.  If INLEN is zero, then process
 455    only whatever data is stored in CTX.
 456
 457    Initially, CTX must have been initialized via base64_decode_ctx_init.
 458    Subsequent calls to this function must reuse whatever state is recorded
 459    in that buffer.  It is necessary for when a quadruple of base64 input
 460    bytes spans two input buffers.
 461
 462    If CTX is NULL then newlines are treated as garbage and the input
 463    buffer is processed as a unit.  */
 464
 465 bool
 466 base64_decode_ctx (struct base64_decode_context *ctx,
 467                    const char *restrict in, size_t inlen,
 468                    char *restrict out, size_t *outlen)
 469 {
 470   size_t outleft = *outlen;
 471   bool ignore_newlines = ctx != NULL;
 472   bool flush_ctx = false;
 473   unsigned int ctx_i = 0;
 474
 475   if (ignore_newlines)
 476     {
 477       ctx_i = ctx->i;
 478       flush_ctx = inlen == 0;
 479     }
 480
 481
 482   while (true)
 483     {
 484       size_t outleft_save = outleft;
 485       if (ctx_i == 0 && !flush_ctx)
 486         {
 487           while (true)
 488             {
 489               /* Save a copy of outleft, in case we need to re-parse this
 490                  block of four bytes.  */
 491               outleft_save = outleft;
 492               if (!decode_4 (in, inlen, &out, &outleft))
 493                 break;
 494
 495               in += 4;
 496               inlen -= 4;
 497             }
 498         }
 499
 500       if (inlen == 0 && !flush_ctx)
 501         break;
 502
 503       /* Handle the common case of 72-byte wrapped lines.
 504          This also handles any other multiple-of-4-byte wrapping.  */
 505       if (inlen && *in == '\n' && ignore_newlines)
 506         {
 507           ++in;
 508           --inlen;
 509           continue;
 510         }
 511
 512       /* Restore OUT and OUTLEFT.  */
 513       out -= outleft_save - outleft;
 514       outleft = outleft_save;
 515
 516       {
 517         char const *in_end = in + inlen;
 518         char const *non_nl;
 519
 520         if (ignore_newlines)
 521           non_nl = get_4 (ctx, &in, in_end, &inlen);
 522         else
 523           non_nl = in;  /* Might have nl in this case. */
 524
 525         /* If the input is empty or consists solely of newlines (0 non-newlines),
 526            then we're done.  Likewise if there are fewer than 4 bytes when not
 527            flushing context and not treating newlines as garbage.  */
 528         if (inlen == 0 || (inlen < 4 && !flush_ctx && ignore_newlines))
 529           {
 530             inlen = 0;
 531             break;
 532           }
 533         if (!decode_4 (non_nl, inlen, &out, &outleft))
 534           break;
 535
 536         inlen = in_end - in;
 537       }
 538     }
 539
 540   *outlen -= outleft;
 541
 542   return inlen == 0;
 543 }
 544
 545 /* Allocate an output buffer in *OUT, and decode the base64 encoded
 546    data stored in IN of size INLEN to the *OUT buffer.  On return, the
 547    size of the decoded data is stored in *OUTLEN.  OUTLEN may be NULL,
 548    if the caller is not interested in the decoded length.  *OUT may be
 549    NULL to indicate an out of memory error, in which case *OUTLEN
 550    contains the size of the memory block needed.  The function returns
 551    true on successful decoding and memory allocation errors.  (Use the
 552    *OUT and *OUTLEN parameters to differentiate between successful
 553    decoding and memory error.)  The function returns false if the
 554    input was invalid, in which case *OUT is NULL and *OUTLEN is
 555    undefined. */
 556 bool
 557 base64_decode_alloc_ctx (struct base64_decode_context *ctx,
 558                          const char *in, size_t inlen, char **out,
 559                          size_t *outlen)
 560 {
 561   /* This may allocate a few bytes too many, depending on input,
 562      but it's not worth the extra CPU time to compute the exact size.
 563      The exact size is 3 * inlen / 4, minus 1 if the input ends
 564      with "=" and minus another 1 if the input ends with "==".
 565      Dividing before multiplying avoids the possibility of overflow.  */
 566   size_t needlen = 3 * (inlen / 4) + 2;
 567
 568   *out = malloc (needlen);
 569   if (!*out)
 570     return true;
 571
 572   if (!base64_decode_ctx (ctx, in, inlen, *out, &needlen))
 573     {
 574       free (*out);
 575       *out = NULL;
 576       return false;
 577     }
 578
 579   if (outlen)
 580     *outlen = needlen;
 581
 582   return true;
 583 }