ccm.c 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547
  1. /*
  2. * NIST SP800-38C compliant CCM implementation
  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. /*
  20. * Definition of CCM:
  21. * http://csrc.nist.gov/publications/nistpubs/800-38C/SP800-38C_updated-July20_2007.pdf
  22. * RFC 3610 "Counter with CBC-MAC (CCM)"
  23. *
  24. * Related:
  25. * RFC 5116 "An Interface and Algorithms for Authenticated Encryption"
  26. */
  27. #include "common.h"
  28. #if defined(MBEDTLS_CCM_C)
  29. #include "mbedtls/ccm.h"
  30. #include "mbedtls/platform_util.h"
  31. #include "mbedtls/error.h"
  32. #include <string.h>
  33. #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
  34. #if defined(MBEDTLS_PLATFORM_C)
  35. #include "mbedtls/platform.h"
  36. #else
  37. #include <stdio.h>
  38. #define mbedtls_printf printf
  39. #endif /* MBEDTLS_PLATFORM_C */
  40. #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
  41. #if !defined(MBEDTLS_CCM_ALT)
  42. #define CCM_VALIDATE_RET( cond ) \
  43. MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_CCM_BAD_INPUT )
  44. #define CCM_VALIDATE( cond ) \
  45. MBEDTLS_INTERNAL_VALIDATE( cond )
  46. #define CCM_ENCRYPT 0
  47. #define CCM_DECRYPT 1
  48. /*
  49. * Initialize context
  50. */
  51. void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
  52. {
  53. CCM_VALIDATE( ctx != NULL );
  54. memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
  55. }
  56. int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
  57. mbedtls_cipher_id_t cipher,
  58. const unsigned char *key,
  59. unsigned int keybits )
  60. {
  61. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  62. const mbedtls_cipher_info_t *cipher_info;
  63. CCM_VALIDATE_RET( ctx != NULL );
  64. CCM_VALIDATE_RET( key != NULL );
  65. cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
  66. MBEDTLS_MODE_ECB );
  67. if( cipher_info == NULL )
  68. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  69. if( cipher_info->block_size != 16 )
  70. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  71. mbedtls_cipher_free( &ctx->cipher_ctx );
  72. if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
  73. return( ret );
  74. if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
  75. MBEDTLS_ENCRYPT ) ) != 0 )
  76. {
  77. return( ret );
  78. }
  79. return( 0 );
  80. }
  81. /*
  82. * Free context
  83. */
  84. void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
  85. {
  86. if( ctx == NULL )
  87. return;
  88. mbedtls_cipher_free( &ctx->cipher_ctx );
  89. mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
  90. }
  91. /*
  92. * Macros for common operations.
  93. * Results in smaller compiled code than static inline functions.
  94. */
  95. /*
  96. * Update the CBC-MAC state in y using a block in b
  97. * (Always using b as the source helps the compiler optimise a bit better.)
  98. */
  99. #define UPDATE_CBC_MAC \
  100. for( i = 0; i < 16; i++ ) \
  101. y[i] ^= b[i]; \
  102. \
  103. if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, y, 16, y, &olen ) ) != 0 ) \
  104. return( ret );
  105. /*
  106. * Encrypt or decrypt a partial block with CTR
  107. * Warning: using b for temporary storage! src and dst must not be b!
  108. * This avoids allocating one more 16 bytes buffer while allowing src == dst.
  109. */
  110. #define CTR_CRYPT( dst, src, len ) \
  111. do \
  112. { \
  113. if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctr, \
  114. 16, b, &olen ) ) != 0 ) \
  115. { \
  116. return( ret ); \
  117. } \
  118. \
  119. for( i = 0; i < (len); i++ ) \
  120. (dst)[i] = (src)[i] ^ b[i]; \
  121. } while( 0 )
  122. /*
  123. * Authenticated encryption or decryption
  124. */
  125. static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
  126. const unsigned char *iv, size_t iv_len,
  127. const unsigned char *add, size_t add_len,
  128. const unsigned char *input, unsigned char *output,
  129. unsigned char *tag, size_t tag_len )
  130. {
  131. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  132. unsigned char i;
  133. unsigned char q;
  134. size_t len_left, olen;
  135. unsigned char b[16];
  136. unsigned char y[16];
  137. unsigned char ctr[16];
  138. const unsigned char *src;
  139. unsigned char *dst;
  140. /*
  141. * Check length requirements: SP800-38C A.1
  142. * Additional requirement: a < 2^16 - 2^8 to simplify the code.
  143. * 'length' checked later (when writing it to the first block)
  144. *
  145. * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
  146. */
  147. if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
  148. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  149. /* Also implies q is within bounds */
  150. if( iv_len < 7 || iv_len > 13 )
  151. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  152. if( add_len >= 0xFF00 )
  153. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  154. q = 16 - 1 - (unsigned char) iv_len;
  155. /*
  156. * First block B_0:
  157. * 0 .. 0 flags
  158. * 1 .. iv_len nonce (aka iv)
  159. * iv_len+1 .. 15 length
  160. *
  161. * With flags as (bits):
  162. * 7 0
  163. * 6 add present?
  164. * 5 .. 3 (t - 2) / 2
  165. * 2 .. 0 q - 1
  166. */
  167. b[0] = 0;
  168. b[0] |= ( add_len > 0 ) << 6;
  169. b[0] |= ( ( tag_len - 2 ) / 2 ) << 3;
  170. b[0] |= q - 1;
  171. memcpy( b + 1, iv, iv_len );
  172. for( i = 0, len_left = length; i < q; i++, len_left >>= 8 )
  173. b[15-i] = (unsigned char)( len_left & 0xFF );
  174. if( len_left > 0 )
  175. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  176. /* Start CBC-MAC with first block */
  177. memset( y, 0, 16 );
  178. UPDATE_CBC_MAC;
  179. /*
  180. * If there is additional data, update CBC-MAC with
  181. * add_len, add, 0 (padding to a block boundary)
  182. */
  183. if( add_len > 0 )
  184. {
  185. size_t use_len;
  186. len_left = add_len;
  187. src = add;
  188. memset( b, 0, 16 );
  189. b[0] = (unsigned char)( ( add_len >> 8 ) & 0xFF );
  190. b[1] = (unsigned char)( ( add_len ) & 0xFF );
  191. use_len = len_left < 16 - 2 ? len_left : 16 - 2;
  192. memcpy( b + 2, src, use_len );
  193. len_left -= use_len;
  194. src += use_len;
  195. UPDATE_CBC_MAC;
  196. while( len_left > 0 )
  197. {
  198. use_len = len_left > 16 ? 16 : len_left;
  199. memset( b, 0, 16 );
  200. memcpy( b, src, use_len );
  201. UPDATE_CBC_MAC;
  202. len_left -= use_len;
  203. src += use_len;
  204. }
  205. }
  206. /*
  207. * Prepare counter block for encryption:
  208. * 0 .. 0 flags
  209. * 1 .. iv_len nonce (aka iv)
  210. * iv_len+1 .. 15 counter (initially 1)
  211. *
  212. * With flags as (bits):
  213. * 7 .. 3 0
  214. * 2 .. 0 q - 1
  215. */
  216. ctr[0] = q - 1;
  217. memcpy( ctr + 1, iv, iv_len );
  218. memset( ctr + 1 + iv_len, 0, q );
  219. ctr[15] = 1;
  220. /*
  221. * Authenticate and {en,de}crypt the message.
  222. *
  223. * The only difference between encryption and decryption is
  224. * the respective order of authentication and {en,de}cryption.
  225. */
  226. len_left = length;
  227. src = input;
  228. dst = output;
  229. while( len_left > 0 )
  230. {
  231. size_t use_len = len_left > 16 ? 16 : len_left;
  232. if( mode == CCM_ENCRYPT )
  233. {
  234. memset( b, 0, 16 );
  235. memcpy( b, src, use_len );
  236. UPDATE_CBC_MAC;
  237. }
  238. CTR_CRYPT( dst, src, use_len );
  239. if( mode == CCM_DECRYPT )
  240. {
  241. memset( b, 0, 16 );
  242. memcpy( b, dst, use_len );
  243. UPDATE_CBC_MAC;
  244. }
  245. dst += use_len;
  246. src += use_len;
  247. len_left -= use_len;
  248. /*
  249. * Increment counter.
  250. * No need to check for overflow thanks to the length check above.
  251. */
  252. for( i = 0; i < q; i++ )
  253. if( ++ctr[15-i] != 0 )
  254. break;
  255. }
  256. /*
  257. * Authentication: reset counter and crypt/mask internal tag
  258. */
  259. for( i = 0; i < q; i++ )
  260. ctr[15-i] = 0;
  261. CTR_CRYPT( y, y, 16 );
  262. memcpy( tag, y, tag_len );
  263. return( 0 );
  264. }
  265. /*
  266. * Authenticated encryption
  267. */
  268. int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
  269. const unsigned char *iv, size_t iv_len,
  270. const unsigned char *add, size_t add_len,
  271. const unsigned char *input, unsigned char *output,
  272. unsigned char *tag, size_t tag_len )
  273. {
  274. CCM_VALIDATE_RET( ctx != NULL );
  275. CCM_VALIDATE_RET( iv != NULL );
  276. CCM_VALIDATE_RET( add_len == 0 || add != NULL );
  277. CCM_VALIDATE_RET( length == 0 || input != NULL );
  278. CCM_VALIDATE_RET( length == 0 || output != NULL );
  279. CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
  280. return( ccm_auth_crypt( ctx, CCM_ENCRYPT, length, iv, iv_len,
  281. add, add_len, input, output, tag, tag_len ) );
  282. }
  283. int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
  284. const unsigned char *iv, size_t iv_len,
  285. const unsigned char *add, size_t add_len,
  286. const unsigned char *input, unsigned char *output,
  287. unsigned char *tag, size_t tag_len )
  288. {
  289. CCM_VALIDATE_RET( ctx != NULL );
  290. CCM_VALIDATE_RET( iv != NULL );
  291. CCM_VALIDATE_RET( add_len == 0 || add != NULL );
  292. CCM_VALIDATE_RET( length == 0 || input != NULL );
  293. CCM_VALIDATE_RET( length == 0 || output != NULL );
  294. CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
  295. if( tag_len == 0 )
  296. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  297. return( mbedtls_ccm_star_encrypt_and_tag( ctx, length, iv, iv_len, add,
  298. add_len, input, output, tag, tag_len ) );
  299. }
  300. /*
  301. * Authenticated decryption
  302. */
  303. int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
  304. const unsigned char *iv, size_t iv_len,
  305. const unsigned char *add, size_t add_len,
  306. const unsigned char *input, unsigned char *output,
  307. const unsigned char *tag, size_t tag_len )
  308. {
  309. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  310. unsigned char check_tag[16];
  311. unsigned char i;
  312. int diff;
  313. CCM_VALIDATE_RET( ctx != NULL );
  314. CCM_VALIDATE_RET( iv != NULL );
  315. CCM_VALIDATE_RET( add_len == 0 || add != NULL );
  316. CCM_VALIDATE_RET( length == 0 || input != NULL );
  317. CCM_VALIDATE_RET( length == 0 || output != NULL );
  318. CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
  319. if( ( ret = ccm_auth_crypt( ctx, CCM_DECRYPT, length,
  320. iv, iv_len, add, add_len,
  321. input, output, check_tag, tag_len ) ) != 0 )
  322. {
  323. return( ret );
  324. }
  325. /* Check tag in "constant-time" */
  326. for( diff = 0, i = 0; i < tag_len; i++ )
  327. diff |= tag[i] ^ check_tag[i];
  328. if( diff != 0 )
  329. {
  330. mbedtls_platform_zeroize( output, length );
  331. return( MBEDTLS_ERR_CCM_AUTH_FAILED );
  332. }
  333. return( 0 );
  334. }
  335. int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
  336. const unsigned char *iv, size_t iv_len,
  337. const unsigned char *add, size_t add_len,
  338. const unsigned char *input, unsigned char *output,
  339. const unsigned char *tag, size_t tag_len )
  340. {
  341. CCM_VALIDATE_RET( ctx != NULL );
  342. CCM_VALIDATE_RET( iv != NULL );
  343. CCM_VALIDATE_RET( add_len == 0 || add != NULL );
  344. CCM_VALIDATE_RET( length == 0 || input != NULL );
  345. CCM_VALIDATE_RET( length == 0 || output != NULL );
  346. CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
  347. if( tag_len == 0 )
  348. return( MBEDTLS_ERR_CCM_BAD_INPUT );
  349. return( mbedtls_ccm_star_auth_decrypt( ctx, length, iv, iv_len, add,
  350. add_len, input, output, tag, tag_len ) );
  351. }
  352. #endif /* !MBEDTLS_CCM_ALT */
  353. #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
  354. /*
  355. * Examples 1 to 3 from SP800-38C Appendix C
  356. */
  357. #define NB_TESTS 3
  358. #define CCM_SELFTEST_PT_MAX_LEN 24
  359. #define CCM_SELFTEST_CT_MAX_LEN 32
  360. /*
  361. * The data is the same for all tests, only the used length changes
  362. */
  363. static const unsigned char key_test_data[] = {
  364. 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
  365. 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
  366. };
  367. static const unsigned char iv_test_data[] = {
  368. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  369. 0x18, 0x19, 0x1a, 0x1b
  370. };
  371. static const unsigned char ad_test_data[] = {
  372. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  373. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  374. 0x10, 0x11, 0x12, 0x13
  375. };
  376. static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
  377. 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
  378. 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
  379. 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
  380. };
  381. static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
  382. static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
  383. static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
  384. static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
  385. static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
  386. { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
  387. { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
  388. 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
  389. 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
  390. { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
  391. 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
  392. 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
  393. 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
  394. };
  395. int mbedtls_ccm_self_test( int verbose )
  396. {
  397. mbedtls_ccm_context ctx;
  398. /*
  399. * Some hardware accelerators require the input and output buffers
  400. * would be in RAM, because the flash is not accessible.
  401. * Use buffers on the stack to hold the test vectors data.
  402. */
  403. unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
  404. unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
  405. size_t i;
  406. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  407. mbedtls_ccm_init( &ctx );
  408. if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
  409. 8 * sizeof key_test_data ) != 0 )
  410. {
  411. if( verbose != 0 )
  412. mbedtls_printf( " CCM: setup failed" );
  413. return( 1 );
  414. }
  415. for( i = 0; i < NB_TESTS; i++ )
  416. {
  417. if( verbose != 0 )
  418. mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
  419. memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
  420. memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
  421. memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
  422. ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
  423. iv_test_data, iv_len_test_data[i],
  424. ad_test_data, add_len_test_data[i],
  425. plaintext, ciphertext,
  426. ciphertext + msg_len_test_data[i],
  427. tag_len_test_data[i] );
  428. if( ret != 0 ||
  429. memcmp( ciphertext, res_test_data[i],
  430. msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
  431. {
  432. if( verbose != 0 )
  433. mbedtls_printf( "failed\n" );
  434. return( 1 );
  435. }
  436. memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
  437. ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
  438. iv_test_data, iv_len_test_data[i],
  439. ad_test_data, add_len_test_data[i],
  440. ciphertext, plaintext,
  441. ciphertext + msg_len_test_data[i],
  442. tag_len_test_data[i] );
  443. if( ret != 0 ||
  444. memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
  445. {
  446. if( verbose != 0 )
  447. mbedtls_printf( "failed\n" );
  448. return( 1 );
  449. }
  450. if( verbose != 0 )
  451. mbedtls_printf( "passed\n" );
  452. }
  453. mbedtls_ccm_free( &ctx );
  454. if( verbose != 0 )
  455. mbedtls_printf( "\n" );
  456. return( 0 );
  457. }
  458. #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
  459. #endif /* MBEDTLS_CCM_C */