contrib/ldns/compat/b64_ntop.c

   1 /*
   2  * Copyright (c) 1996, 1998 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 #include <ldns/config.h>
  43
  44 #include <ldns/ldns.h>
  45
  46 #include <sys/types.h>
  47 #include <sys/param.h>
  48 #ifdef HAVE_SYS_SOCKET_H
  49 #include <sys/socket.h>
  50 #endif
  51
  52 #ifdef HAVE_NETINET_IN_H
  53 #include <netinet/in.h>
  54 #endif
  55 #ifdef HAVE_ARPA_INET_H
  56 #include <arpa/inet.h>
  57 #endif
  58
  59 #include <ctype.h>
  60 #include <stdio.h>
  61 #include <stdlib.h>
  62 #include <string.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 ldns_b64_ntop(uint8_t const *src, size_t srclength, char *target, size_t targsize) {
 135         size_t datalength = 0;
 136         uint8_t input[3];
 137         uint8_t output[4];
 138         size_t i;
 139
 140         if (srclength == 0) {
 141                 if (targsize > 0) {
 142                         target[0] = '\0';
 143                         return 0;
 144                 } else {
 145                         return -1;
 146                 }
 147         }
 148
 149         while (2 < srclength) {
 150                 input[0] = *src++;
 151                 input[1] = *src++;
 152                 input[2] = *src++;
 153                 srclength -= 3;
 154
 155                 output[0] = input[0] >> 2;
 156                 output[1] = ((input[0] & 0x03) << 4) + (input[1] >> 4);
 157                 output[2] = ((input[1] & 0x0f) << 2) + (input[2] >> 6);
 158                 output[3] = input[2] & 0x3f;
 159                 Assert(output[0] < 64);
 160                 Assert(output[1] < 64);
 161                 Assert(output[2] < 64);
 162                 Assert(output[3] < 64);
 163
 164                 if (datalength + 4 > targsize) {
 165                         return (-1);
 166                 }
 167                 target[datalength++] = Base64[output[0]];
 168                 target[datalength++] = Base64[output[1]];
 169                 target[datalength++] = Base64[output[2]];
 170                 target[datalength++] = Base64[output[3]];
 171         }
 172
 173         /* Now we worry about padding. */
 174         if (0 != srclength) {
 175                 /* Get what's left. */
 176                 input[0] = input[1] = input[2] = (uint8_t) '\0';
 177                 for (i = 0; i < srclength; i++)
 178                         input[i] = *src++;
 179
 180                 output[0] = input[0] >> 2;
 181                 output[1] = ((input[0] & 0x03) << 4) + (input[1] >> 4);
 182                 output[2] = ((input[1] & 0x0f) << 2) + (input[2] >> 6);
 183                 Assert(output[0] < 64);
 184                 Assert(output[1] < 64);
 185                 Assert(output[2] < 64);
 186
 187                 if (datalength + 4 > targsize) {
 188                         return (-2);
 189                 }
 190                 target[datalength++] = Base64[output[0]];
 191                 target[datalength++] = Base64[output[1]];
 192                 if (srclength == 1) {
 193                         target[datalength++] = Pad64;
 194                 } else {
 195                         target[datalength++] = Base64[output[2]];
 196                 }
 197                 target[datalength++] = Pad64;
 198         }
 199         if (datalength >= targsize) {
 200                 return (-3);
 201         }
 202         target[datalength] = '\0';      /* Returned value doesn't count \0. */
 203         return (int) (datalength);
 204 }