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