contrib/isc-dhcp/dst/base64.c

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