git.sur5r.net Git - openldap/blob - libraries/liblutil/base64.c

   1 /*
   2  * Modified by Kurt D. Zeilenga for inclusion into OpenLDAP
   3  */
   4
   5 /*
   6  * Copyright (c) 1996, 1998 by Internet Software Consortium.
   7  *
   8  * Permission to use, copy, modify, and distribute this software for any
   9  * purpose with or without fee is hereby granted, provided that the above
  10  * copyright notice and this permission notice appear in all copies.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  13  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  14  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  15  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  16  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  17  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  18  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  19  * SOFTWARE.
  20  */
  21
  22 /*
  23  * Portions Copyright (c) 1995 by International Business Machines, Inc.
  24  *
  25  * International Business Machines, Inc. (hereinafter called IBM) grants
  26  * permission under its copyrights to use, copy, modify, and distribute this
  27  * Software with or without fee, provided that the above copyright notice and
  28  * all paragraphs of this notice appear in all copies, and that the name of IBM
  29  * not be used in connection with the marketing of any product incorporating
  30  * the Software or modifications thereof, without specific, written prior
  31  * permission.
  32  *
  33  * To the extent it has a right to do so, IBM grants an immunity from suit
  34  * under its patents, if any, for the use, sale or manufacture of products to
  35  * the extent that such products are used for performing Domain Name System
  36  * dynamic updates in TCP/IP networks by means of the Software.  No immunity is
  37  * granted for any product per se or for any other function of any product.
  38  *
  39  * THE SOFTWARE IS PROVIDED "AS IS", AND IBM DISCLAIMS ALL WARRANTIES,
  40  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  41  * PARTICULAR PURPOSE.  IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL,
  42  * DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER ARISING
  43  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE, EVEN
  44  * IF IBM IS APPRISED OF THE POSSIBILITY OF SUCH DAMAGES.
  45  */
  46
  47 #include <stdlib.h>
  48 #include <stddef.h>
  49 #include <string.h>
  50 #include <sys/types.h>
  51
  52 #include <lutil.h>
  53
  54 #define Assert(Cond) if (!(Cond)) abort()
  55
  56 static const char Base64[] =
  57         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  58 static const char Pad64 = '=';
  59
  60 /* (From RFC1521 and draft-ietf-dnssec-secext-03.txt)
  61    The following encoding technique is taken from RFC 1521 by Borenstein
  62    and Freed.  It is reproduced here in a slightly edited form for
  63    convenience.
  64
  65    A 65-character subset of US-ASCII is used, enabling 6 bits to be
  66    represented per printable character. (The extra 65th character, "=",
  67    is used to signify a special processing function.)
  68
  69    The encoding process represents 24-bit groups of input bits as output
  70    strings of 4 encoded characters. Proceeding from left to right, a
  71    24-bit input group is formed by concatenating 3 8-bit input groups.
  72    These 24 bits are then treated as 4 concatenated 6-bit groups, each
  73    of which is translated into a single digit in the base64 alphabet.
  74
  75    Each 6-bit group is used as an index into an array of 64 printable
  76    characters. The character referenced by the index is placed in the
  77    output string.
  78
  79                          Table 1: The Base64 Alphabet
  80
  81       Value Encoding  Value Encoding  Value Encoding  Value Encoding
  82           0 A            17 R            34 i            51 z
  83           1 B            18 S            35 j            52 0
  84           2 C            19 T            36 k            53 1
  85           3 D            20 U            37 l            54 2
  86           4 E            21 V            38 m            55 3
  87           5 F            22 W            39 n            56 4
  88           6 G            23 X            40 o            57 5
  89           7 H            24 Y            41 p            58 6
  90           8 I            25 Z            42 q            59 7
  91           9 J            26 a            43 r            60 8
  92          10 K            27 b            44 s            61 9
  93          11 L            28 c            45 t            62 +
  94          12 M            29 d            46 u            63 /
  95          13 N            30 e            47 v
  96          14 O            31 f            48 w         (pad) =
  97          15 P            32 g            49 x
  98          16 Q            33 h            50 y
  99
 100    Special processing is performed if fewer than 24 bits are available
 101    at the end of the data being encoded.  A full encoding quantum is
 102    always completed at the end of a quantity.  When fewer than 24 input
 103    bits are available in an input group, zero bits are added (on the
 104    right) to form an integral number of 6-bit groups.  Padding at the
 105    end of the data is performed using the '=' character.
 106
 107    Since all base64 input is an integral number of octets, only the
 108          -------------------------------------------------
 109    following cases can arise:
 110
 111        (1) the final quantum of encoding input is an integral
 112            multiple of 24 bits; here, the final unit of encoded
 113            output will be an integral multiple of 4 characters
 114            with no "=" padding,
 115        (2) the final quantum of encoding input is exactly 8 bits;
 116            here, the final unit of encoded output will be two
 117            characters followed by two "=" padding characters, or
 118        (3) the final quantum of encoding input is exactly 16 bits;
 119            here, the final unit of encoded output will be three
 120            characters followed by one "=" padding character.
 121    */
 122
 123 int
 124 b64_ntop(
 125         u_char const *src,
 126         size_t srclength,
 127         char *target,
 128         size_t targsize)
 129 {
 130         size_t datalength = 0;
 131         u_char input[3];
 132         u_char output[4];
 133         size_t i;
 134
 135         while (2 < srclength) {
 136                 input[0] = *src++;
 137                 input[1] = *src++;
 138                 input[2] = *src++;
 139                 srclength -= 3;
 140
 141                 output[0] = input[0] >> 2;
 142                 output[1] = ((input[0] & 0x03) << 4) + (input[1] >> 4);
 143                 output[2] = ((input[1] & 0x0f) << 2) + (input[2] >> 6);
 144                 output[3] = input[2] & 0x3f;
 145                 Assert(output[0] < 64);
 146                 Assert(output[1] < 64);
 147                 Assert(output[2] < 64);
 148                 Assert(output[3] < 64);
 149
 150                 if (datalength + 4 > targsize)
 151                         return (-1);
 152                 target[datalength++] = Base64[output[0]];
 153                 target[datalength++] = Base64[output[1]];
 154                 target[datalength++] = Base64[output[2]];
 155                 target[datalength++] = Base64[output[3]];
 156         }
 157
 158         /* Now we worry about padding. */
 159         if (0 != srclength) {
 160                 /* Get what's left. */
 161                 input[0] = input[1] = input[2] = '\0';
 162                 for (i = 0; i < srclength; i++)
 163                         input[i] = *src++;
 164
 165                 output[0] = input[0] >> 2;
 166                 output[1] = ((input[0] & 0x03) << 4) + (input[1] >> 4);
 167                 output[2] = ((input[1] & 0x0f) << 2) + (input[2] >> 6);
 168                 Assert(output[0] < 64);
 169                 Assert(output[1] < 64);
 170                 Assert(output[2] < 64);
 171
 172                 if (datalength + 4 > targsize)
 173                         return (-1);
 174                 target[datalength++] = Base64[output[0]];
 175                 target[datalength++] = Base64[output[1]];
 176                 if (srclength == 1)
 177                         target[datalength++] = Pad64;
 178                 else
 179                         target[datalength++] = Base64[output[2]];
 180                 target[datalength++] = Pad64;
 181         }
 182         if (datalength >= targsize)
 183                 return (-1);
 184         target[datalength] = '\0';      /* Returned value doesn't count \0. */
 185         return (datalength);
 186 }
 187
 188 /* skips all whitespace anywhere.
 189    converts characters, four at a time, starting at (or after)
 190    src from base - 64 numbers into three 8 bit bytes in the target area.
 191    it returns the number of data bytes stored at the target, or -1 on error.
 192  */
 193
 194 int
 195 b64_pton(
 196         char const *src,
 197         u_char *target,
 198         size_t targsize)
 199 {
 200         int tarindex, state, ch;
 201         char *pos;
 202
 203         state = 0;
 204         tarindex = 0;
 205
 206         while ((ch = *src++) != '\0') {
 207                 if (isspace(ch))        /* Skip whitespace anywhere. */
 208                         continue;
 209
 210                 if (ch == Pad64)
 211                         break;
 212
 213                 pos = strchr(Base64, ch);
 214                 if (pos == 0)           /* A non-base64 character. */
 215                         return (-1);
 216
 217                 switch (state) {
 218                 case 0:
 219                         if (target) {
 220                                 if ((size_t)tarindex >= targsize)
 221                                         return (-1);
 222                                 target[tarindex] = (pos - Base64) << 2;
 223                         }
 224                         state = 1;
 225                         break;
 226                 case 1:
 227                         if (target) {
 228                                 if ((size_t)tarindex + 1 >= targsize)
 229                                         return (-1);
 230                                 target[tarindex]   |=  (pos - Base64) >> 4;
 231                                 target[tarindex+1]  = ((pos - Base64) & 0x0f)
 232                                                         << 4 ;
 233                         }
 234                         tarindex++;
 235                         state = 2;
 236                         break;
 237                 case 2:
 238                         if (target) {
 239                                 if ((size_t)tarindex + 1 >= targsize)
 240                                         return (-1);
 241                                 target[tarindex]   |=  (pos - Base64) >> 2;
 242                                 target[tarindex+1]  = ((pos - Base64) & 0x03)
 243                                                         << 6;
 244                         }
 245                         tarindex++;
 246                         state = 3;
 247                         break;
 248                 case 3:
 249                         if (target) {
 250                                 if ((size_t)tarindex >= targsize)
 251                                         return (-1);
 252                                 target[tarindex] |= (pos - Base64);
 253                         }
 254                         tarindex++;
 255                         state = 0;
 256                         break;
 257                 default:
 258                         abort();
 259                 }
 260         }
 261
 262         /*
 263          * We are done decoding Base-64 chars.  Let's see if we ended
 264          * on a byte boundary, and/or with erroneous trailing characters.
 265          */
 266
 267         if (ch == Pad64) {              /* We got a pad char. */
 268                 ch = *src++;            /* Skip it, get next. */
 269                 switch (state) {
 270                 case 0:         /* Invalid = in first position */
 271                 case 1:         /* Invalid = in second position */
 272                         return (-1);
 273
 274                 case 2:         /* Valid, means one byte of info */
 275                         /* Skip any number of spaces. */
 276                         for ((void)NULL; ch != '\0'; ch = *src++)
 277                                 if (!isspace(ch))
 278                                         break;
 279                         /* Make sure there is another trailing = sign. */
 280                         if (ch != Pad64)
 281                                 return (-1);
 282                         ch = *src++;            /* Skip the = */
 283                         /* Fall through to "single trailing =" case. */
 284                         /* FALLTHROUGH */
 285
 286                 case 3:         /* Valid, means two bytes of info */
 287                         /*
 288                          * We know this char is an =.  Is there anything but
 289                          * whitespace after it?
 290                          */
 291                         for ((void)NULL; ch != '\0'; ch = *src++)
 292                                 if (!isspace(ch))
 293                                         return (-1);
 294
 295                         /*
 296                          * Now make sure for cases 2 and 3 that the "extra"
 297                          * bits that slopped past the last full byte were
 298                          * zeros.  If we don't check them, they become a
 299                          * subliminal channel.
 300                          */
 301                         if (target && target[tarindex] != 0)
 302                                 return (-1);
 303                 }
 304         } else {
 305                 /*
 306                  * We ended by seeing the end of the string.  Make sure we
 307                  * have no partial bytes lying around.
 308                  */
 309                 if (state != 0)
 310                         return (-1);
 311         }
 312
 313         return (tarindex);
 314 }