base64.c 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. /*
  2. * RFC 1521 base64 encoding/decoding
  3. *
  4. * Copyright The Mbed TLS Contributors
  5. * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
  6. */
  7. #include <limits.h>
  8. #include "common.h"
  9. #if defined(MBEDTLS_BASE64_C)
  10. #include "mbedtls/base64.h"
  11. #include "base64_internal.h"
  12. #include "constant_time_internal.h"
  13. #include <stdint.h>
  14. #if defined(MBEDTLS_SELF_TEST)
  15. #include <string.h>
  16. #include "mbedtls/platform.h"
  17. #endif /* MBEDTLS_SELF_TEST */
  18. MBEDTLS_STATIC_TESTABLE
  19. unsigned char mbedtls_ct_base64_enc_char(unsigned char value)
  20. {
  21. unsigned char digit = 0;
  22. /* For each range of values, if value is in that range, mask digit with
  23. * the corresponding value. Since value can only be in a single range,
  24. * only at most one masking will change digit. */
  25. digit |= mbedtls_ct_uchar_in_range_if(0, 25, value, 'A' + value);
  26. digit |= mbedtls_ct_uchar_in_range_if(26, 51, value, 'a' + value - 26);
  27. digit |= mbedtls_ct_uchar_in_range_if(52, 61, value, '0' + value - 52);
  28. digit |= mbedtls_ct_uchar_in_range_if(62, 62, value, '+');
  29. digit |= mbedtls_ct_uchar_in_range_if(63, 63, value, '/');
  30. return digit;
  31. }
  32. MBEDTLS_STATIC_TESTABLE
  33. signed char mbedtls_ct_base64_dec_value(unsigned char c)
  34. {
  35. unsigned char val = 0;
  36. /* For each range of digits, if c is in that range, mask val with
  37. * the corresponding value. Since c can only be in a single range,
  38. * only at most one masking will change val. Set val to one plus
  39. * the desired value so that it stays 0 if c is in none of the ranges. */
  40. val |= mbedtls_ct_uchar_in_range_if('A', 'Z', c, c - 'A' + 0 + 1);
  41. val |= mbedtls_ct_uchar_in_range_if('a', 'z', c, c - 'a' + 26 + 1);
  42. val |= mbedtls_ct_uchar_in_range_if('0', '9', c, c - '0' + 52 + 1);
  43. val |= mbedtls_ct_uchar_in_range_if('+', '+', c, c - '+' + 62 + 1);
  44. val |= mbedtls_ct_uchar_in_range_if('/', '/', c, c - '/' + 63 + 1);
  45. /* At this point, val is 0 if c is an invalid digit and v+1 if c is
  46. * a digit with the value v. */
  47. return val - 1;
  48. }
  49. /*
  50. * Encode a buffer into base64 format
  51. */
  52. int mbedtls_base64_encode(unsigned char *dst, size_t dlen, size_t *olen,
  53. const unsigned char *src, size_t slen)
  54. {
  55. size_t i, n;
  56. int C1, C2, C3;
  57. unsigned char *p;
  58. if (slen == 0) {
  59. *olen = 0;
  60. return 0;
  61. }
  62. n = slen / 3 + (slen % 3 != 0);
  63. if (n > (SIZE_MAX - 1) / 4) {
  64. *olen = SIZE_MAX;
  65. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  66. }
  67. n *= 4;
  68. if ((dlen < n + 1) || (NULL == dst)) {
  69. *olen = n + 1;
  70. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  71. }
  72. n = (slen / 3) * 3;
  73. for (i = 0, p = dst; i < n; i += 3) {
  74. C1 = *src++;
  75. C2 = *src++;
  76. C3 = *src++;
  77. *p++ = mbedtls_ct_base64_enc_char((C1 >> 2) & 0x3F);
  78. *p++ = mbedtls_ct_base64_enc_char((((C1 & 3) << 4) + (C2 >> 4))
  79. & 0x3F);
  80. *p++ = mbedtls_ct_base64_enc_char((((C2 & 15) << 2) + (C3 >> 6))
  81. & 0x3F);
  82. *p++ = mbedtls_ct_base64_enc_char(C3 & 0x3F);
  83. }
  84. if (i < slen) {
  85. C1 = *src++;
  86. C2 = ((i + 1) < slen) ? *src++ : 0;
  87. *p++ = mbedtls_ct_base64_enc_char((C1 >> 2) & 0x3F);
  88. *p++ = mbedtls_ct_base64_enc_char((((C1 & 3) << 4) + (C2 >> 4))
  89. & 0x3F);
  90. if ((i + 1) < slen) {
  91. *p++ = mbedtls_ct_base64_enc_char(((C2 & 15) << 2) & 0x3F);
  92. } else {
  93. *p++ = '=';
  94. }
  95. *p++ = '=';
  96. }
  97. *olen = (size_t) (p - dst);
  98. *p = 0;
  99. return 0;
  100. }
  101. /*
  102. * Decode a base64-formatted buffer
  103. */
  104. int mbedtls_base64_decode(unsigned char *dst, size_t dlen, size_t *olen,
  105. const unsigned char *src, size_t slen)
  106. {
  107. size_t i; /* index in source */
  108. size_t n; /* number of digits or trailing = in source */
  109. uint32_t x; /* value accumulator */
  110. unsigned accumulated_digits = 0;
  111. unsigned equals = 0;
  112. int spaces_present = 0;
  113. unsigned char *p;
  114. /* First pass: check for validity and get output length */
  115. for (i = n = 0; i < slen; i++) {
  116. /* Skip spaces before checking for EOL */
  117. spaces_present = 0;
  118. while (i < slen && src[i] == ' ') {
  119. ++i;
  120. spaces_present = 1;
  121. }
  122. /* Spaces at end of buffer are OK */
  123. if (i == slen) {
  124. break;
  125. }
  126. if ((slen - i) >= 2 &&
  127. src[i] == '\r' && src[i + 1] == '\n') {
  128. continue;
  129. }
  130. if (src[i] == '\n') {
  131. continue;
  132. }
  133. /* Space inside a line is an error */
  134. if (spaces_present) {
  135. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  136. }
  137. if (src[i] > 127) {
  138. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  139. }
  140. if (src[i] == '=') {
  141. if (++equals > 2) {
  142. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  143. }
  144. } else {
  145. if (equals != 0) {
  146. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  147. }
  148. if (mbedtls_ct_base64_dec_value(src[i]) < 0) {
  149. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  150. }
  151. }
  152. n++;
  153. }
  154. if (n == 0) {
  155. *olen = 0;
  156. return 0;
  157. }
  158. /* The following expression is to calculate the following formula without
  159. * risk of integer overflow in n:
  160. * n = ( ( n * 6 ) + 7 ) >> 3;
  161. */
  162. n = (6 * (n >> 3)) + ((6 * (n & 0x7) + 7) >> 3);
  163. n -= equals;
  164. if (dst == NULL || dlen < n) {
  165. *olen = n;
  166. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  167. }
  168. equals = 0;
  169. for (x = 0, p = dst; i > 0; i--, src++) {
  170. if (*src == '\r' || *src == '\n' || *src == ' ') {
  171. continue;
  172. }
  173. x = x << 6;
  174. if (*src == '=') {
  175. ++equals;
  176. } else {
  177. x |= mbedtls_ct_base64_dec_value(*src);
  178. }
  179. if (++accumulated_digits == 4) {
  180. accumulated_digits = 0;
  181. *p++ = MBEDTLS_BYTE_2(x);
  182. if (equals <= 1) {
  183. *p++ = MBEDTLS_BYTE_1(x);
  184. }
  185. if (equals <= 0) {
  186. *p++ = MBEDTLS_BYTE_0(x);
  187. }
  188. }
  189. }
  190. *olen = (size_t) (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. }
  219. src = base64_test_dec;
  220. if (mbedtls_base64_encode(buffer, sizeof(buffer), &len, src, 64) != 0 ||
  221. memcmp(base64_test_enc, buffer, 88) != 0) {
  222. if (verbose != 0) {
  223. mbedtls_printf("failed\n");
  224. }
  225. return 1;
  226. }
  227. if (verbose != 0) {
  228. mbedtls_printf("passed\n Base64 decoding test: ");
  229. }
  230. src = base64_test_enc;
  231. if (mbedtls_base64_decode(buffer, sizeof(buffer), &len, src, 88) != 0 ||
  232. memcmp(base64_test_dec, buffer, 64) != 0) {
  233. if (verbose != 0) {
  234. mbedtls_printf("failed\n");
  235. }
  236. return 1;
  237. }
  238. if (verbose != 0) {
  239. mbedtls_printf("passed\n\n");
  240. }
  241. return 0;
  242. }
  243. #endif /* MBEDTLS_SELF_TEST */
  244. #endif /* MBEDTLS_BASE64_C */