base64.c 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. /*
  2. * RFC 1521 base64 encoding/decoding
  3. *
  4. * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  5. * SPDX-License-Identifier: Apache-2.0
  6. *
  7. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  8. * not use this file except in compliance with the License.
  9. * You may obtain a copy of the License at
  10. *
  11. * http://www.apache.org/licenses/LICENSE-2.0
  12. *
  13. * Unless required by applicable law or agreed to in writing, software
  14. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16. * See the License for the specific language governing permissions and
  17. * limitations under the License.
  18. *
  19. * This file is part of mbed TLS (https://tls.mbed.org)
  20. */
  21. #if !defined(MBEDTLS_CONFIG_FILE)
  22. #include "mbedtls/config.h"
  23. #else
  24. #include MBEDTLS_CONFIG_FILE
  25. #endif
  26. #if defined(MBEDTLS_BASE64_C)
  27. #include "mbedtls/base64.h"
  28. #include <stdint.h>
  29. #if defined(MBEDTLS_SELF_TEST)
  30. #include <string.h>
  31. #if defined(MBEDTLS_PLATFORM_C)
  32. #include "mbedtls/platform.h"
  33. #else
  34. #ifdef PRINTF_STDLIB
  35. #include <stdio.h>
  36. #endif
  37. #ifdef PRINTF_CUSTOM
  38. #include "tinystdio.h"
  39. #endif
  40. #define mbedtls_printf printf
  41. #endif /* MBEDTLS_PLATFORM_C */
  42. #endif /* MBEDTLS_SELF_TEST */
  43. static const unsigned char base64_enc_map[64] =
  44. {
  45. 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
  46. 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',
  47. 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd',
  48. 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
  49. 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x',
  50. 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7',
  51. '8', '9', '+', '/'
  52. };
  53. static const unsigned char base64_dec_map[128] =
  54. {
  55. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  56. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  57. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  58. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  59. 127, 127, 127, 62, 127, 127, 127, 63, 52, 53,
  60. 54, 55, 56, 57, 58, 59, 60, 61, 127, 127,
  61. 127, 64, 127, 127, 127, 0, 1, 2, 3, 4,
  62. 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  63. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  64. 25, 127, 127, 127, 127, 127, 127, 26, 27, 28,
  65. 29, 30, 31, 32, 33, 34, 35, 36, 37, 38,
  66. 39, 40, 41, 42, 43, 44, 45, 46, 47, 48,
  67. 49, 50, 51, 127, 127, 127, 127, 127
  68. };
  69. #define BASE64_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
  70. /*
  71. * Encode a buffer into base64 format
  72. */
  73. int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen,
  74. const unsigned char *src, size_t slen )
  75. {
  76. size_t i, n;
  77. int C1, C2, C3;
  78. unsigned char *p;
  79. if( slen == 0 )
  80. {
  81. *olen = 0;
  82. return( 0 );
  83. }
  84. n = slen / 3 + ( slen % 3 != 0 );
  85. if( n > ( BASE64_SIZE_T_MAX - 1 ) / 4 )
  86. {
  87. *olen = BASE64_SIZE_T_MAX;
  88. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  89. }
  90. n *= 4;
  91. if( ( dlen < n + 1 ) || ( NULL == dst ) )
  92. {
  93. *olen = n + 1;
  94. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  95. }
  96. n = ( slen / 3 ) * 3;
  97. for( i = 0, p = dst; i < n; i += 3 )
  98. {
  99. C1 = *src++;
  100. C2 = *src++;
  101. C3 = *src++;
  102. *p++ = base64_enc_map[(C1 >> 2) & 0x3F];
  103. *p++ = base64_enc_map[(((C1 & 3) << 4) + (C2 >> 4)) & 0x3F];
  104. *p++ = base64_enc_map[(((C2 & 15) << 2) + (C3 >> 6)) & 0x3F];
  105. *p++ = base64_enc_map[C3 & 0x3F];
  106. }
  107. if( i < slen )
  108. {
  109. C1 = *src++;
  110. C2 = ( ( i + 1 ) < slen ) ? *src++ : 0;
  111. *p++ = base64_enc_map[(C1 >> 2) & 0x3F];
  112. *p++ = base64_enc_map[(((C1 & 3) << 4) + (C2 >> 4)) & 0x3F];
  113. if( ( i + 1 ) < slen )
  114. *p++ = base64_enc_map[((C2 & 15) << 2) & 0x3F];
  115. else *p++ = '=';
  116. *p++ = '=';
  117. }
  118. *olen = p - dst;
  119. *p = 0;
  120. return( 0 );
  121. }
  122. /*
  123. * Decode a base64-formatted buffer
  124. */
  125. int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen,
  126. const unsigned char *src, size_t slen )
  127. {
  128. size_t i, n;
  129. uint32_t j, x;
  130. unsigned char *p;
  131. /* First pass: check for validity and get output length */
  132. for( i = n = j = 0; i < slen; i++ )
  133. {
  134. /* Skip spaces before checking for EOL */
  135. x = 0;
  136. while( i < slen && src[i] == ' ' )
  137. {
  138. ++i;
  139. ++x;
  140. }
  141. /* Spaces at end of buffer are OK */
  142. if( i == slen )
  143. break;
  144. if( ( slen - i ) >= 2 &&
  145. src[i] == '\r' && src[i + 1] == '\n' )
  146. continue;
  147. if( src[i] == '\n' )
  148. continue;
  149. /* Space inside a line is an error */
  150. if( x != 0 )
  151. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  152. if( src[i] == '=' && ++j > 2 )
  153. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  154. if( src[i] > 127 || base64_dec_map[src[i]] == 127 )
  155. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  156. if( base64_dec_map[src[i]] < 64 && j != 0 )
  157. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  158. n++;
  159. }
  160. if( n == 0 )
  161. {
  162. *olen = 0;
  163. return( 0 );
  164. }
  165. /* The following expression is to calculate the following formula without
  166. * risk of integer overflow in n:
  167. * n = ( ( n * 6 ) + 7 ) >> 3;
  168. */
  169. n = ( 6 * ( n >> 3 ) ) + ( ( 6 * ( n & 0x7 ) + 7 ) >> 3 );
  170. n -= j;
  171. if( dst == NULL || dlen < n )
  172. {
  173. *olen = n;
  174. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  175. }
  176. for( j = 3, n = x = 0, p = dst; i > 0; i--, src++ )
  177. {
  178. if( *src == '\r' || *src == '\n' || *src == ' ' )
  179. continue;
  180. j -= ( base64_dec_map[*src] == 64 );
  181. x = ( x << 6 ) | ( base64_dec_map[*src] & 0x3F );
  182. if( ++n == 4 )
  183. {
  184. n = 0;
  185. if( j > 0 ) *p++ = (unsigned char)( x >> 16 );
  186. if( j > 1 ) *p++ = (unsigned char)( x >> 8 );
  187. if( j > 2 ) *p++ = (unsigned char)( x );
  188. }
  189. }
  190. *olen = p - dst;
  191. return( 0 );
  192. }
  193. #if defined(MBEDTLS_SELF_TEST)
  194. static const unsigned char base64_test_dec[64] =
  195. {
  196. 0x24, 0x48, 0x6E, 0x56, 0x87, 0x62, 0x5A, 0xBD,
  197. 0xBF, 0x17, 0xD9, 0xA2, 0xC4, 0x17, 0x1A, 0x01,
  198. 0x94, 0xED, 0x8F, 0x1E, 0x11, 0xB3, 0xD7, 0x09,
  199. 0x0C, 0xB6, 0xE9, 0x10, 0x6F, 0x22, 0xEE, 0x13,
  200. 0xCA, 0xB3, 0x07, 0x05, 0x76, 0xC9, 0xFA, 0x31,
  201. 0x6C, 0x08, 0x34, 0xFF, 0x8D, 0xC2, 0x6C, 0x38,
  202. 0x00, 0x43, 0xE9, 0x54, 0x97, 0xAF, 0x50, 0x4B,
  203. 0xD1, 0x41, 0xBA, 0x95, 0x31, 0x5A, 0x0B, 0x97
  204. };
  205. static const unsigned char base64_test_enc[] =
  206. "JEhuVodiWr2/F9mixBcaAZTtjx4Rs9cJDLbpEG8i7hPK"
  207. "swcFdsn6MWwINP+Nwmw4AEPpVJevUEvRQbqVMVoLlw==";
  208. /*
  209. * Checkup routine
  210. */
  211. int mbedtls_base64_self_test( int verbose )
  212. {
  213. size_t len;
  214. const unsigned char *src;
  215. unsigned char buffer[128];
  216. if( verbose != 0 )
  217. mbedtls_printf( " Base64 encoding test: " );
  218. src = base64_test_dec;
  219. if( mbedtls_base64_encode( buffer, sizeof( buffer ), &len, src, 64 ) != 0 ||
  220. memcmp( base64_test_enc, buffer, 88 ) != 0 )
  221. {
  222. if( verbose != 0 )
  223. mbedtls_printf( "failed\n" );
  224. return( 1 );
  225. }
  226. if( verbose != 0 )
  227. mbedtls_printf( "passed\n Base64 decoding test: " );
  228. src = base64_test_enc;
  229. if( mbedtls_base64_decode( buffer, sizeof( buffer ), &len, src, 88 ) != 0 ||
  230. memcmp( base64_test_dec, buffer, 64 ) != 0 )
  231. {
  232. if( verbose != 0 )
  233. mbedtls_printf( "failed\n" );
  234. return( 1 );
  235. }
  236. if( verbose != 0 )
  237. mbedtls_printf( "passed\n\n" );
  238. return( 0 );
  239. }
  240. #endif /* MBEDTLS_SELF_TEST */
  241. #endif /* MBEDTLS_BASE64_C */