base64.c 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  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 "constant_time_internal.h"
  23. #include <stdint.h>
  24. #if defined(MBEDTLS_SELF_TEST)
  25. #include <string.h>
  26. #include "mbedtls/platform.h"
  27. #endif /* MBEDTLS_SELF_TEST */
  28. #define BASE64_SIZE_T_MAX ((size_t) -1) /* SIZE_T_MAX is not standard */
  29. /*
  30. * Encode a buffer into base64 format
  31. */
  32. int mbedtls_base64_encode(unsigned char *dst, size_t dlen, size_t *olen,
  33. const unsigned char *src, size_t slen)
  34. {
  35. size_t i, n;
  36. int C1, C2, C3;
  37. unsigned char *p;
  38. if (slen == 0) {
  39. *olen = 0;
  40. return 0;
  41. }
  42. n = slen / 3 + (slen % 3 != 0);
  43. if (n > (BASE64_SIZE_T_MAX - 1) / 4) {
  44. *olen = BASE64_SIZE_T_MAX;
  45. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  46. }
  47. n *= 4;
  48. if ((dlen < n + 1) || (NULL == dst)) {
  49. *olen = n + 1;
  50. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  51. }
  52. n = (slen / 3) * 3;
  53. for (i = 0, p = dst; i < n; i += 3) {
  54. C1 = *src++;
  55. C2 = *src++;
  56. C3 = *src++;
  57. *p++ = mbedtls_ct_base64_enc_char((C1 >> 2) & 0x3F);
  58. *p++ = mbedtls_ct_base64_enc_char((((C1 & 3) << 4) + (C2 >> 4))
  59. & 0x3F);
  60. *p++ = mbedtls_ct_base64_enc_char((((C2 & 15) << 2) + (C3 >> 6))
  61. & 0x3F);
  62. *p++ = mbedtls_ct_base64_enc_char(C3 & 0x3F);
  63. }
  64. if (i < slen) {
  65. C1 = *src++;
  66. C2 = ((i + 1) < slen) ? *src++ : 0;
  67. *p++ = mbedtls_ct_base64_enc_char((C1 >> 2) & 0x3F);
  68. *p++ = mbedtls_ct_base64_enc_char((((C1 & 3) << 4) + (C2 >> 4))
  69. & 0x3F);
  70. if ((i + 1) < slen) {
  71. *p++ = mbedtls_ct_base64_enc_char(((C2 & 15) << 2) & 0x3F);
  72. } else {
  73. *p++ = '=';
  74. }
  75. *p++ = '=';
  76. }
  77. *olen = p - dst;
  78. *p = 0;
  79. return 0;
  80. }
  81. /*
  82. * Decode a base64-formatted buffer
  83. */
  84. int mbedtls_base64_decode(unsigned char *dst, size_t dlen, size_t *olen,
  85. const unsigned char *src, size_t slen)
  86. {
  87. size_t i; /* index in source */
  88. size_t n; /* number of digits or trailing = in source */
  89. uint32_t x; /* value accumulator */
  90. unsigned accumulated_digits = 0;
  91. unsigned equals = 0;
  92. int spaces_present = 0;
  93. unsigned char *p;
  94. /* First pass: check for validity and get output length */
  95. for (i = n = 0; i < slen; i++) {
  96. /* Skip spaces before checking for EOL */
  97. spaces_present = 0;
  98. while (i < slen && src[i] == ' ') {
  99. ++i;
  100. spaces_present = 1;
  101. }
  102. /* Spaces at end of buffer are OK */
  103. if (i == slen) {
  104. break;
  105. }
  106. if ((slen - i) >= 2 &&
  107. src[i] == '\r' && src[i + 1] == '\n') {
  108. continue;
  109. }
  110. if (src[i] == '\n') {
  111. continue;
  112. }
  113. /* Space inside a line is an error */
  114. if (spaces_present) {
  115. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  116. }
  117. if (src[i] > 127) {
  118. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  119. }
  120. if (src[i] == '=') {
  121. if (++equals > 2) {
  122. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  123. }
  124. } else {
  125. if (equals != 0) {
  126. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  127. }
  128. if (mbedtls_ct_base64_dec_value(src[i]) < 0) {
  129. return MBEDTLS_ERR_BASE64_INVALID_CHARACTER;
  130. }
  131. }
  132. n++;
  133. }
  134. if (n == 0) {
  135. *olen = 0;
  136. return 0;
  137. }
  138. /* The following expression is to calculate the following formula without
  139. * risk of integer overflow in n:
  140. * n = ( ( n * 6 ) + 7 ) >> 3;
  141. */
  142. n = (6 * (n >> 3)) + ((6 * (n & 0x7) + 7) >> 3);
  143. n -= equals;
  144. if (dst == NULL || dlen < n) {
  145. *olen = n;
  146. return MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL;
  147. }
  148. equals = 0;
  149. for (x = 0, p = dst; i > 0; i--, src++) {
  150. if (*src == '\r' || *src == '\n' || *src == ' ') {
  151. continue;
  152. }
  153. x = x << 6;
  154. if (*src == '=') {
  155. ++equals;
  156. } else {
  157. x |= mbedtls_ct_base64_dec_value(*src);
  158. }
  159. if (++accumulated_digits == 4) {
  160. accumulated_digits = 0;
  161. *p++ = MBEDTLS_BYTE_2(x);
  162. if (equals <= 1) {
  163. *p++ = MBEDTLS_BYTE_1(x);
  164. }
  165. if (equals <= 0) {
  166. *p++ = MBEDTLS_BYTE_0(x);
  167. }
  168. }
  169. }
  170. *olen = p - dst;
  171. return 0;
  172. }
  173. #if defined(MBEDTLS_SELF_TEST)
  174. static const unsigned char base64_test_dec[64] =
  175. {
  176. 0x24, 0x48, 0x6E, 0x56, 0x87, 0x62, 0x5A, 0xBD,
  177. 0xBF, 0x17, 0xD9, 0xA2, 0xC4, 0x17, 0x1A, 0x01,
  178. 0x94, 0xED, 0x8F, 0x1E, 0x11, 0xB3, 0xD7, 0x09,
  179. 0x0C, 0xB6, 0xE9, 0x10, 0x6F, 0x22, 0xEE, 0x13,
  180. 0xCA, 0xB3, 0x07, 0x05, 0x76, 0xC9, 0xFA, 0x31,
  181. 0x6C, 0x08, 0x34, 0xFF, 0x8D, 0xC2, 0x6C, 0x38,
  182. 0x00, 0x43, 0xE9, 0x54, 0x97, 0xAF, 0x50, 0x4B,
  183. 0xD1, 0x41, 0xBA, 0x95, 0x31, 0x5A, 0x0B, 0x97
  184. };
  185. static const unsigned char base64_test_enc[] =
  186. "JEhuVodiWr2/F9mixBcaAZTtjx4Rs9cJDLbpEG8i7hPK"
  187. "swcFdsn6MWwINP+Nwmw4AEPpVJevUEvRQbqVMVoLlw==";
  188. /*
  189. * Checkup routine
  190. */
  191. int mbedtls_base64_self_test(int verbose)
  192. {
  193. size_t len;
  194. const unsigned char *src;
  195. unsigned char buffer[128];
  196. if (verbose != 0) {
  197. mbedtls_printf(" Base64 encoding test: ");
  198. }
  199. src = base64_test_dec;
  200. if (mbedtls_base64_encode(buffer, sizeof(buffer), &len, src, 64) != 0 ||
  201. memcmp(base64_test_enc, buffer, 88) != 0) {
  202. if (verbose != 0) {
  203. mbedtls_printf("failed\n");
  204. }
  205. return 1;
  206. }
  207. if (verbose != 0) {
  208. mbedtls_printf("passed\n Base64 decoding test: ");
  209. }
  210. src = base64_test_enc;
  211. if (mbedtls_base64_decode(buffer, sizeof(buffer), &len, src, 88) != 0 ||
  212. memcmp(base64_test_dec, buffer, 64) != 0) {
  213. if (verbose != 0) {
  214. mbedtls_printf("failed\n");
  215. }
  216. return 1;
  217. }
  218. if (verbose != 0) {
  219. mbedtls_printf("passed\n\n");
  220. }
  221. return 0;
  222. }
  223. #endif /* MBEDTLS_SELF_TEST */
  224. #endif /* MBEDTLS_BASE64_C */