base64.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  1. /*
  2. * RFC 1521 base64 encoding/decoding
  3. *
  4. * Copyright The Mbed TLS Contributors
  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. #include "common.h"
  20. #if defined(MBEDTLS_BASE64_C)
  21. #include "mbedtls/base64.h"
  22. #include <stdint.h>
  23. #if defined(MBEDTLS_SELF_TEST)
  24. #include <string.h>
  25. #if defined(MBEDTLS_PLATFORM_C)
  26. #include "mbedtls/platform.h"
  27. #else
  28. #include <stdio.h>
  29. #define mbedtls_printf printf
  30. #endif /* MBEDTLS_PLATFORM_C */
  31. #endif /* MBEDTLS_SELF_TEST */
  32. static const unsigned char base64_enc_map[64] =
  33. {
  34. 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
  35. 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',
  36. 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd',
  37. 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
  38. 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x',
  39. 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7',
  40. '8', '9', '+', '/'
  41. };
  42. static const unsigned char base64_dec_map[128] =
  43. {
  44. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  45. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  46. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  47. 127, 127, 127, 127, 127, 127, 127, 127, 127, 127,
  48. 127, 127, 127, 62, 127, 127, 127, 63, 52, 53,
  49. 54, 55, 56, 57, 58, 59, 60, 61, 127, 127,
  50. 127, 64, 127, 127, 127, 0, 1, 2, 3, 4,
  51. 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  52. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  53. 25, 127, 127, 127, 127, 127, 127, 26, 27, 28,
  54. 29, 30, 31, 32, 33, 34, 35, 36, 37, 38,
  55. 39, 40, 41, 42, 43, 44, 45, 46, 47, 48,
  56. 49, 50, 51, 127, 127, 127, 127, 127
  57. };
  58. #define BASE64_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
  59. /*
  60. * Constant flow conditional assignment to unsigned char
  61. */
  62. static void mbedtls_base64_cond_assign_uchar( unsigned char * dest, const unsigned char * const src,
  63. unsigned char condition )
  64. {
  65. /* MSVC has a warning about unary minus on unsigned integer types,
  66. * but this is well-defined and precisely what we want to do here. */
  67. #if defined(_MSC_VER)
  68. #pragma warning( push )
  69. #pragma warning( disable : 4146 )
  70. #endif
  71. /* Generate bitmask from condition, mask will either be 0xFF or 0 */
  72. unsigned char mask = ( condition | -condition );
  73. mask >>= 7;
  74. mask = -mask;
  75. #if defined(_MSC_VER)
  76. #pragma warning( pop )
  77. #endif
  78. *dest = ( ( *src ) & mask ) | ( ( *dest ) & ~mask );
  79. }
  80. /*
  81. * Constant flow conditional assignment to uint_32
  82. */
  83. static void mbedtls_base64_cond_assign_uint32( uint32_t * dest, const uint32_t src,
  84. uint32_t condition )
  85. {
  86. /* MSVC has a warning about unary minus on unsigned integer types,
  87. * but this is well-defined and precisely what we want to do here. */
  88. #if defined(_MSC_VER)
  89. #pragma warning( push )
  90. #pragma warning( disable : 4146 )
  91. #endif
  92. /* Generate bitmask from condition, mask will either be 0xFFFFFFFF or 0 */
  93. uint32_t mask = ( condition | -condition );
  94. mask >>= 31;
  95. mask = -mask;
  96. #if defined(_MSC_VER)
  97. #pragma warning( pop )
  98. #endif
  99. *dest = ( src & mask ) | ( ( *dest ) & ~mask );
  100. }
  101. /*
  102. * Constant flow check for equality
  103. */
  104. static unsigned char mbedtls_base64_eq( size_t in_a, size_t in_b )
  105. {
  106. size_t difference = in_a ^ in_b;
  107. /* MSVC has a warning about unary minus on unsigned integer types,
  108. * but this is well-defined and precisely what we want to do here. */
  109. #if defined(_MSC_VER)
  110. #pragma warning( push )
  111. #pragma warning( disable : 4146 )
  112. #endif
  113. difference |= -difference;
  114. #if defined(_MSC_VER)
  115. #pragma warning( pop )
  116. #endif
  117. /* cope with the varying size of size_t per platform */
  118. difference >>= ( sizeof( difference ) * 8 - 1 );
  119. return (unsigned char) ( 1 ^ difference );
  120. }
  121. /*
  122. * Constant flow lookup into table.
  123. */
  124. static unsigned char mbedtls_base64_table_lookup( const unsigned char * const table,
  125. const size_t table_size, const size_t table_index )
  126. {
  127. size_t i;
  128. unsigned char result = 0;
  129. for( i = 0; i < table_size; ++i )
  130. {
  131. mbedtls_base64_cond_assign_uchar( &result, &table[i], mbedtls_base64_eq( i, table_index ) );
  132. }
  133. return result;
  134. }
  135. /*
  136. * Encode a buffer into base64 format
  137. */
  138. int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen,
  139. const unsigned char *src, size_t slen )
  140. {
  141. size_t i, n;
  142. int C1, C2, C3;
  143. unsigned char *p;
  144. if( slen == 0 )
  145. {
  146. *olen = 0;
  147. return( 0 );
  148. }
  149. n = slen / 3 + ( slen % 3 != 0 );
  150. if( n > ( BASE64_SIZE_T_MAX - 1 ) / 4 )
  151. {
  152. *olen = BASE64_SIZE_T_MAX;
  153. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  154. }
  155. n *= 4;
  156. if( ( dlen < n + 1 ) || ( NULL == dst ) )
  157. {
  158. *olen = n + 1;
  159. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  160. }
  161. n = ( slen / 3 ) * 3;
  162. for( i = 0, p = dst; i < n; i += 3 )
  163. {
  164. C1 = *src++;
  165. C2 = *src++;
  166. C3 = *src++;
  167. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  168. ( ( C1 >> 2 ) & 0x3F ) );
  169. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  170. ( ( ( ( C1 & 3 ) << 4 ) + ( C2 >> 4 ) ) & 0x3F ) );
  171. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  172. ( ( ( ( C2 & 15 ) << 2 ) + ( C3 >> 6 ) ) & 0x3F ) );
  173. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  174. ( C3 & 0x3F ) );
  175. }
  176. if( i < slen )
  177. {
  178. C1 = *src++;
  179. C2 = ( ( i + 1 ) < slen ) ? *src++ : 0;
  180. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  181. ( ( C1 >> 2 ) & 0x3F ) );
  182. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  183. ( ( ( ( C1 & 3 ) << 4 ) + ( C2 >> 4 ) ) & 0x3F ) );
  184. if( ( i + 1 ) < slen )
  185. *p++ = mbedtls_base64_table_lookup( base64_enc_map, sizeof( base64_enc_map ),
  186. ( ( ( C2 & 15 ) << 2 ) & 0x3F ) );
  187. else *p++ = '=';
  188. *p++ = '=';
  189. }
  190. *olen = p - dst;
  191. *p = 0;
  192. return( 0 );
  193. }
  194. /*
  195. * Decode a base64-formatted buffer
  196. */
  197. int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen,
  198. const unsigned char *src, size_t slen )
  199. {
  200. size_t i, n;
  201. uint32_t j, x;
  202. unsigned char *p;
  203. unsigned char dec_map_lookup;
  204. /* First pass: check for validity and get output length */
  205. for( i = n = j = 0; i < slen; i++ )
  206. {
  207. /* Skip spaces before checking for EOL */
  208. x = 0;
  209. while( i < slen && src[i] == ' ' )
  210. {
  211. ++i;
  212. ++x;
  213. }
  214. /* Spaces at end of buffer are OK */
  215. if( i == slen )
  216. break;
  217. if( ( slen - i ) >= 2 &&
  218. src[i] == '\r' && src[i + 1] == '\n' )
  219. continue;
  220. if( src[i] == '\n' )
  221. continue;
  222. /* Space inside a line is an error */
  223. if( x != 0 )
  224. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  225. if( src[i] == '=' && ++j > 2 )
  226. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  227. dec_map_lookup = mbedtls_base64_table_lookup( base64_dec_map, sizeof( base64_dec_map ), src[i] );
  228. if( src[i] > 127 || dec_map_lookup == 127 )
  229. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  230. if( dec_map_lookup < 64 && j != 0 )
  231. return( MBEDTLS_ERR_BASE64_INVALID_CHARACTER );
  232. n++;
  233. }
  234. if( n == 0 )
  235. {
  236. *olen = 0;
  237. return( 0 );
  238. }
  239. /* The following expression is to calculate the following formula without
  240. * risk of integer overflow in n:
  241. * n = ( ( n * 6 ) + 7 ) >> 3;
  242. */
  243. n = ( 6 * ( n >> 3 ) ) + ( ( 6 * ( n & 0x7 ) + 7 ) >> 3 );
  244. n -= j;
  245. if( dst == NULL || dlen < n )
  246. {
  247. *olen = n;
  248. return( MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL );
  249. }
  250. for( j = 3, n = x = 0, p = dst; i > 0; i--, src++ )
  251. {
  252. if( *src == '\r' || *src == '\n' || *src == ' ' )
  253. continue;
  254. dec_map_lookup = mbedtls_base64_table_lookup( base64_dec_map, sizeof( base64_dec_map ), *src );
  255. mbedtls_base64_cond_assign_uint32( &j, j - 1, mbedtls_base64_eq( dec_map_lookup, 64 ) );
  256. x = ( x << 6 ) | ( dec_map_lookup & 0x3F );
  257. if( ++n == 4 )
  258. {
  259. n = 0;
  260. if( j > 0 ) *p++ = (unsigned char)( x >> 16 );
  261. if( j > 1 ) *p++ = (unsigned char)( x >> 8 );
  262. if( j > 2 ) *p++ = (unsigned char)( x );
  263. }
  264. }
  265. *olen = p - dst;
  266. return( 0 );
  267. }
  268. #if defined(MBEDTLS_SELF_TEST)
  269. static const unsigned char base64_test_dec[64] =
  270. {
  271. 0x24, 0x48, 0x6E, 0x56, 0x87, 0x62, 0x5A, 0xBD,
  272. 0xBF, 0x17, 0xD9, 0xA2, 0xC4, 0x17, 0x1A, 0x01,
  273. 0x94, 0xED, 0x8F, 0x1E, 0x11, 0xB3, 0xD7, 0x09,
  274. 0x0C, 0xB6, 0xE9, 0x10, 0x6F, 0x22, 0xEE, 0x13,
  275. 0xCA, 0xB3, 0x07, 0x05, 0x76, 0xC9, 0xFA, 0x31,
  276. 0x6C, 0x08, 0x34, 0xFF, 0x8D, 0xC2, 0x6C, 0x38,
  277. 0x00, 0x43, 0xE9, 0x54, 0x97, 0xAF, 0x50, 0x4B,
  278. 0xD1, 0x41, 0xBA, 0x95, 0x31, 0x5A, 0x0B, 0x97
  279. };
  280. static const unsigned char base64_test_enc[] =
  281. "JEhuVodiWr2/F9mixBcaAZTtjx4Rs9cJDLbpEG8i7hPK"
  282. "swcFdsn6MWwINP+Nwmw4AEPpVJevUEvRQbqVMVoLlw==";
  283. /*
  284. * Checkup routine
  285. */
  286. int mbedtls_base64_self_test( int verbose )
  287. {
  288. size_t len;
  289. const unsigned char *src;
  290. unsigned char buffer[128];
  291. if( verbose != 0 )
  292. mbedtls_printf( " Base64 encoding test: " );
  293. src = base64_test_dec;
  294. if( mbedtls_base64_encode( buffer, sizeof( buffer ), &len, src, 64 ) != 0 ||
  295. memcmp( base64_test_enc, buffer, 88 ) != 0 )
  296. {
  297. if( verbose != 0 )
  298. mbedtls_printf( "failed\n" );
  299. return( 1 );
  300. }
  301. if( verbose != 0 )
  302. mbedtls_printf( "passed\n Base64 decoding test: " );
  303. src = base64_test_enc;
  304. if( mbedtls_base64_decode( buffer, sizeof( buffer ), &len, src, 88 ) != 0 ||
  305. memcmp( base64_test_dec, buffer, 64 ) != 0 )
  306. {
  307. if( verbose != 0 )
  308. mbedtls_printf( "failed\n" );
  309. return( 1 );
  310. }
  311. if( verbose != 0 )
  312. mbedtls_printf( "passed\n\n" );
  313. return( 0 );
  314. }
  315. #endif /* MBEDTLS_SELF_TEST */
  316. #endif /* MBEDTLS_BASE64_C */