bsd-base64.c

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