chachapoly.c 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540
  1. /**
  2. * \file chachapoly.c
  3. *
  4. * \brief ChaCha20-Poly1305 AEAD construction based on RFC 7539.
  5. *
  6. * Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
  7. * SPDX-License-Identifier: Apache-2.0
  8. *
  9. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  10. * not use this file except in compliance with the License.
  11. * You may obtain a copy of the License at
  12. *
  13. * http://www.apache.org/licenses/LICENSE-2.0
  14. *
  15. * Unless required by applicable law or agreed to in writing, software
  16. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18. * See the License for the specific language governing permissions and
  19. * limitations under the License.
  20. *
  21. * This file is part of mbed TLS (https://tls.mbed.org)
  22. */
  23. #if !defined(MBEDTLS_CONFIG_FILE)
  24. #include "mbedtls/config.h"
  25. #else
  26. #include MBEDTLS_CONFIG_FILE
  27. #endif
  28. #if defined(MBEDTLS_CHACHAPOLY_C)
  29. #include "mbedtls/chachapoly.h"
  30. #include "mbedtls/platform_util.h"
  31. #include <string.h>
  32. #if defined(MBEDTLS_SELF_TEST)
  33. #if defined(MBEDTLS_PLATFORM_C)
  34. #include "mbedtls/platform.h"
  35. #else
  36. #include <stdio.h>
  37. #define mbedtls_printf printf
  38. #endif /* MBEDTLS_PLATFORM_C */
  39. #endif /* MBEDTLS_SELF_TEST */
  40. #if !defined(MBEDTLS_CHACHAPOLY_ALT)
  41. /* Parameter validation macros */
  42. #define CHACHAPOLY_VALIDATE_RET( cond ) \
  43. MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_POLY1305_BAD_INPUT_DATA )
  44. #define CHACHAPOLY_VALIDATE( cond ) \
  45. MBEDTLS_INTERNAL_VALIDATE( cond )
  46. #define CHACHAPOLY_STATE_INIT ( 0 )
  47. #define CHACHAPOLY_STATE_AAD ( 1 )
  48. #define CHACHAPOLY_STATE_CIPHERTEXT ( 2 ) /* Encrypting or decrypting */
  49. #define CHACHAPOLY_STATE_FINISHED ( 3 )
  50. /**
  51. * \brief Adds nul bytes to pad the AAD for Poly1305.
  52. *
  53. * \param ctx The ChaCha20-Poly1305 context.
  54. */
  55. static int chachapoly_pad_aad( mbedtls_chachapoly_context *ctx )
  56. {
  57. uint32_t partial_block_len = (uint32_t) ( ctx->aad_len % 16U );
  58. unsigned char zeroes[15];
  59. if( partial_block_len == 0U )
  60. return( 0 );
  61. memset( zeroes, 0, sizeof( zeroes ) );
  62. return( mbedtls_poly1305_update( &ctx->poly1305_ctx,
  63. zeroes,
  64. 16U - partial_block_len ) );
  65. }
  66. /**
  67. * \brief Adds nul bytes to pad the ciphertext for Poly1305.
  68. *
  69. * \param ctx The ChaCha20-Poly1305 context.
  70. */
  71. static int chachapoly_pad_ciphertext( mbedtls_chachapoly_context *ctx )
  72. {
  73. uint32_t partial_block_len = (uint32_t) ( ctx->ciphertext_len % 16U );
  74. unsigned char zeroes[15];
  75. if( partial_block_len == 0U )
  76. return( 0 );
  77. memset( zeroes, 0, sizeof( zeroes ) );
  78. return( mbedtls_poly1305_update( &ctx->poly1305_ctx,
  79. zeroes,
  80. 16U - partial_block_len ) );
  81. }
  82. void mbedtls_chachapoly_init( mbedtls_chachapoly_context *ctx )
  83. {
  84. CHACHAPOLY_VALIDATE( ctx != NULL );
  85. mbedtls_chacha20_init( &ctx->chacha20_ctx );
  86. mbedtls_poly1305_init( &ctx->poly1305_ctx );
  87. ctx->aad_len = 0U;
  88. ctx->ciphertext_len = 0U;
  89. ctx->state = CHACHAPOLY_STATE_INIT;
  90. ctx->mode = MBEDTLS_CHACHAPOLY_ENCRYPT;
  91. }
  92. void mbedtls_chachapoly_free( mbedtls_chachapoly_context *ctx )
  93. {
  94. if( ctx == NULL )
  95. return;
  96. mbedtls_chacha20_free( &ctx->chacha20_ctx );
  97. mbedtls_poly1305_free( &ctx->poly1305_ctx );
  98. ctx->aad_len = 0U;
  99. ctx->ciphertext_len = 0U;
  100. ctx->state = CHACHAPOLY_STATE_INIT;
  101. ctx->mode = MBEDTLS_CHACHAPOLY_ENCRYPT;
  102. }
  103. int mbedtls_chachapoly_setkey( mbedtls_chachapoly_context *ctx,
  104. const unsigned char key[32] )
  105. {
  106. int ret;
  107. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  108. CHACHAPOLY_VALIDATE_RET( key != NULL );
  109. ret = mbedtls_chacha20_setkey( &ctx->chacha20_ctx, key );
  110. return( ret );
  111. }
  112. int mbedtls_chachapoly_starts( mbedtls_chachapoly_context *ctx,
  113. const unsigned char nonce[12],
  114. mbedtls_chachapoly_mode_t mode )
  115. {
  116. int ret;
  117. unsigned char poly1305_key[64];
  118. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  119. CHACHAPOLY_VALIDATE_RET( nonce != NULL );
  120. /* Set counter = 0, will be update to 1 when generating Poly1305 key */
  121. ret = mbedtls_chacha20_starts( &ctx->chacha20_ctx, nonce, 0U );
  122. if( ret != 0 )
  123. goto cleanup;
  124. /* Generate the Poly1305 key by getting the ChaCha20 keystream output with
  125. * counter = 0. This is the same as encrypting a buffer of zeroes.
  126. * Only the first 256-bits (32 bytes) of the key is used for Poly1305.
  127. * The other 256 bits are discarded.
  128. */
  129. memset( poly1305_key, 0, sizeof( poly1305_key ) );
  130. ret = mbedtls_chacha20_update( &ctx->chacha20_ctx, sizeof( poly1305_key ),
  131. poly1305_key, poly1305_key );
  132. if( ret != 0 )
  133. goto cleanup;
  134. ret = mbedtls_poly1305_starts( &ctx->poly1305_ctx, poly1305_key );
  135. if( ret == 0 )
  136. {
  137. ctx->aad_len = 0U;
  138. ctx->ciphertext_len = 0U;
  139. ctx->state = CHACHAPOLY_STATE_AAD;
  140. ctx->mode = mode;
  141. }
  142. cleanup:
  143. mbedtls_platform_zeroize( poly1305_key, 64U );
  144. return( ret );
  145. }
  146. int mbedtls_chachapoly_update_aad( mbedtls_chachapoly_context *ctx,
  147. const unsigned char *aad,
  148. size_t aad_len )
  149. {
  150. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  151. CHACHAPOLY_VALIDATE_RET( aad_len == 0 || aad != NULL );
  152. if( ctx->state != CHACHAPOLY_STATE_AAD )
  153. return( MBEDTLS_ERR_CHACHAPOLY_BAD_STATE );
  154. ctx->aad_len += aad_len;
  155. return( mbedtls_poly1305_update( &ctx->poly1305_ctx, aad, aad_len ) );
  156. }
  157. int mbedtls_chachapoly_update( mbedtls_chachapoly_context *ctx,
  158. size_t len,
  159. const unsigned char *input,
  160. unsigned char *output )
  161. {
  162. int ret;
  163. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  164. CHACHAPOLY_VALIDATE_RET( len == 0 || input != NULL );
  165. CHACHAPOLY_VALIDATE_RET( len == 0 || output != NULL );
  166. if( ( ctx->state != CHACHAPOLY_STATE_AAD ) &&
  167. ( ctx->state != CHACHAPOLY_STATE_CIPHERTEXT ) )
  168. {
  169. return( MBEDTLS_ERR_CHACHAPOLY_BAD_STATE );
  170. }
  171. if( ctx->state == CHACHAPOLY_STATE_AAD )
  172. {
  173. ctx->state = CHACHAPOLY_STATE_CIPHERTEXT;
  174. ret = chachapoly_pad_aad( ctx );
  175. if( ret != 0 )
  176. return( ret );
  177. }
  178. ctx->ciphertext_len += len;
  179. if( ctx->mode == MBEDTLS_CHACHAPOLY_ENCRYPT )
  180. {
  181. ret = mbedtls_chacha20_update( &ctx->chacha20_ctx, len, input, output );
  182. if( ret != 0 )
  183. return( ret );
  184. ret = mbedtls_poly1305_update( &ctx->poly1305_ctx, output, len );
  185. if( ret != 0 )
  186. return( ret );
  187. }
  188. else /* DECRYPT */
  189. {
  190. ret = mbedtls_poly1305_update( &ctx->poly1305_ctx, input, len );
  191. if( ret != 0 )
  192. return( ret );
  193. ret = mbedtls_chacha20_update( &ctx->chacha20_ctx, len, input, output );
  194. if( ret != 0 )
  195. return( ret );
  196. }
  197. return( 0 );
  198. }
  199. int mbedtls_chachapoly_finish( mbedtls_chachapoly_context *ctx,
  200. unsigned char mac[16] )
  201. {
  202. int ret;
  203. unsigned char len_block[16];
  204. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  205. CHACHAPOLY_VALIDATE_RET( mac != NULL );
  206. if( ctx->state == CHACHAPOLY_STATE_INIT )
  207. {
  208. return( MBEDTLS_ERR_CHACHAPOLY_BAD_STATE );
  209. }
  210. if( ctx->state == CHACHAPOLY_STATE_AAD )
  211. {
  212. ret = chachapoly_pad_aad( ctx );
  213. if( ret != 0 )
  214. return( ret );
  215. }
  216. else if( ctx->state == CHACHAPOLY_STATE_CIPHERTEXT )
  217. {
  218. ret = chachapoly_pad_ciphertext( ctx );
  219. if( ret != 0 )
  220. return( ret );
  221. }
  222. ctx->state = CHACHAPOLY_STATE_FINISHED;
  223. /* The lengths of the AAD and ciphertext are processed by
  224. * Poly1305 as the final 128-bit block, encoded as little-endian integers.
  225. */
  226. len_block[ 0] = (unsigned char)( ctx->aad_len );
  227. len_block[ 1] = (unsigned char)( ctx->aad_len >> 8 );
  228. len_block[ 2] = (unsigned char)( ctx->aad_len >> 16 );
  229. len_block[ 3] = (unsigned char)( ctx->aad_len >> 24 );
  230. len_block[ 4] = (unsigned char)( ctx->aad_len >> 32 );
  231. len_block[ 5] = (unsigned char)( ctx->aad_len >> 40 );
  232. len_block[ 6] = (unsigned char)( ctx->aad_len >> 48 );
  233. len_block[ 7] = (unsigned char)( ctx->aad_len >> 56 );
  234. len_block[ 8] = (unsigned char)( ctx->ciphertext_len );
  235. len_block[ 9] = (unsigned char)( ctx->ciphertext_len >> 8 );
  236. len_block[10] = (unsigned char)( ctx->ciphertext_len >> 16 );
  237. len_block[11] = (unsigned char)( ctx->ciphertext_len >> 24 );
  238. len_block[12] = (unsigned char)( ctx->ciphertext_len >> 32 );
  239. len_block[13] = (unsigned char)( ctx->ciphertext_len >> 40 );
  240. len_block[14] = (unsigned char)( ctx->ciphertext_len >> 48 );
  241. len_block[15] = (unsigned char)( ctx->ciphertext_len >> 56 );
  242. ret = mbedtls_poly1305_update( &ctx->poly1305_ctx, len_block, 16U );
  243. if( ret != 0 )
  244. return( ret );
  245. ret = mbedtls_poly1305_finish( &ctx->poly1305_ctx, mac );
  246. return( ret );
  247. }
  248. static int chachapoly_crypt_and_tag( mbedtls_chachapoly_context *ctx,
  249. mbedtls_chachapoly_mode_t mode,
  250. size_t length,
  251. const unsigned char nonce[12],
  252. const unsigned char *aad,
  253. size_t aad_len,
  254. const unsigned char *input,
  255. unsigned char *output,
  256. unsigned char tag[16] )
  257. {
  258. int ret;
  259. ret = mbedtls_chachapoly_starts( ctx, nonce, mode );
  260. if( ret != 0 )
  261. goto cleanup;
  262. ret = mbedtls_chachapoly_update_aad( ctx, aad, aad_len );
  263. if( ret != 0 )
  264. goto cleanup;
  265. ret = mbedtls_chachapoly_update( ctx, length, input, output );
  266. if( ret != 0 )
  267. goto cleanup;
  268. ret = mbedtls_chachapoly_finish( ctx, tag );
  269. cleanup:
  270. return( ret );
  271. }
  272. int mbedtls_chachapoly_encrypt_and_tag( mbedtls_chachapoly_context *ctx,
  273. size_t length,
  274. const unsigned char nonce[12],
  275. const unsigned char *aad,
  276. size_t aad_len,
  277. const unsigned char *input,
  278. unsigned char *output,
  279. unsigned char tag[16] )
  280. {
  281. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  282. CHACHAPOLY_VALIDATE_RET( nonce != NULL );
  283. CHACHAPOLY_VALIDATE_RET( tag != NULL );
  284. CHACHAPOLY_VALIDATE_RET( aad_len == 0 || aad != NULL );
  285. CHACHAPOLY_VALIDATE_RET( length == 0 || input != NULL );
  286. CHACHAPOLY_VALIDATE_RET( length == 0 || output != NULL );
  287. return( chachapoly_crypt_and_tag( ctx, MBEDTLS_CHACHAPOLY_ENCRYPT,
  288. length, nonce, aad, aad_len,
  289. input, output, tag ) );
  290. }
  291. int mbedtls_chachapoly_auth_decrypt( mbedtls_chachapoly_context *ctx,
  292. size_t length,
  293. const unsigned char nonce[12],
  294. const unsigned char *aad,
  295. size_t aad_len,
  296. const unsigned char tag[16],
  297. const unsigned char *input,
  298. unsigned char *output )
  299. {
  300. int ret;
  301. unsigned char check_tag[16];
  302. size_t i;
  303. int diff;
  304. CHACHAPOLY_VALIDATE_RET( ctx != NULL );
  305. CHACHAPOLY_VALIDATE_RET( nonce != NULL );
  306. CHACHAPOLY_VALIDATE_RET( tag != NULL );
  307. CHACHAPOLY_VALIDATE_RET( aad_len == 0 || aad != NULL );
  308. CHACHAPOLY_VALIDATE_RET( length == 0 || input != NULL );
  309. CHACHAPOLY_VALIDATE_RET( length == 0 || output != NULL );
  310. if( ( ret = chachapoly_crypt_and_tag( ctx,
  311. MBEDTLS_CHACHAPOLY_DECRYPT, length, nonce,
  312. aad, aad_len, input, output, check_tag ) ) != 0 )
  313. {
  314. return( ret );
  315. }
  316. /* Check tag in "constant-time" */
  317. for( diff = 0, i = 0; i < sizeof( check_tag ); i++ )
  318. diff |= tag[i] ^ check_tag[i];
  319. if( diff != 0 )
  320. {
  321. mbedtls_platform_zeroize( output, length );
  322. return( MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED );
  323. }
  324. return( 0 );
  325. }
  326. #endif /* MBEDTLS_CHACHAPOLY_ALT */
  327. #if defined(MBEDTLS_SELF_TEST)
  328. static const unsigned char test_key[1][32] =
  329. {
  330. {
  331. 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
  332. 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
  333. 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
  334. 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f
  335. }
  336. };
  337. static const unsigned char test_nonce[1][12] =
  338. {
  339. {
  340. 0x07, 0x00, 0x00, 0x00, /* 32-bit common part */
  341. 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47 /* 64-bit IV */
  342. }
  343. };
  344. static const unsigned char test_aad[1][12] =
  345. {
  346. {
  347. 0x50, 0x51, 0x52, 0x53, 0xc0, 0xc1, 0xc2, 0xc3,
  348. 0xc4, 0xc5, 0xc6, 0xc7
  349. }
  350. };
  351. static const size_t test_aad_len[1] =
  352. {
  353. 12U
  354. };
  355. static const unsigned char test_input[1][114] =
  356. {
  357. {
  358. 0x4c, 0x61, 0x64, 0x69, 0x65, 0x73, 0x20, 0x61,
  359. 0x6e, 0x64, 0x20, 0x47, 0x65, 0x6e, 0x74, 0x6c,
  360. 0x65, 0x6d, 0x65, 0x6e, 0x20, 0x6f, 0x66, 0x20,
  361. 0x74, 0x68, 0x65, 0x20, 0x63, 0x6c, 0x61, 0x73,
  362. 0x73, 0x20, 0x6f, 0x66, 0x20, 0x27, 0x39, 0x39,
  363. 0x3a, 0x20, 0x49, 0x66, 0x20, 0x49, 0x20, 0x63,
  364. 0x6f, 0x75, 0x6c, 0x64, 0x20, 0x6f, 0x66, 0x66,
  365. 0x65, 0x72, 0x20, 0x79, 0x6f, 0x75, 0x20, 0x6f,
  366. 0x6e, 0x6c, 0x79, 0x20, 0x6f, 0x6e, 0x65, 0x20,
  367. 0x74, 0x69, 0x70, 0x20, 0x66, 0x6f, 0x72, 0x20,
  368. 0x74, 0x68, 0x65, 0x20, 0x66, 0x75, 0x74, 0x75,
  369. 0x72, 0x65, 0x2c, 0x20, 0x73, 0x75, 0x6e, 0x73,
  370. 0x63, 0x72, 0x65, 0x65, 0x6e, 0x20, 0x77, 0x6f,
  371. 0x75, 0x6c, 0x64, 0x20, 0x62, 0x65, 0x20, 0x69,
  372. 0x74, 0x2e
  373. }
  374. };
  375. static const unsigned char test_output[1][114] =
  376. {
  377. {
  378. 0xd3, 0x1a, 0x8d, 0x34, 0x64, 0x8e, 0x60, 0xdb,
  379. 0x7b, 0x86, 0xaf, 0xbc, 0x53, 0xef, 0x7e, 0xc2,
  380. 0xa4, 0xad, 0xed, 0x51, 0x29, 0x6e, 0x08, 0xfe,
  381. 0xa9, 0xe2, 0xb5, 0xa7, 0x36, 0xee, 0x62, 0xd6,
  382. 0x3d, 0xbe, 0xa4, 0x5e, 0x8c, 0xa9, 0x67, 0x12,
  383. 0x82, 0xfa, 0xfb, 0x69, 0xda, 0x92, 0x72, 0x8b,
  384. 0x1a, 0x71, 0xde, 0x0a, 0x9e, 0x06, 0x0b, 0x29,
  385. 0x05, 0xd6, 0xa5, 0xb6, 0x7e, 0xcd, 0x3b, 0x36,
  386. 0x92, 0xdd, 0xbd, 0x7f, 0x2d, 0x77, 0x8b, 0x8c,
  387. 0x98, 0x03, 0xae, 0xe3, 0x28, 0x09, 0x1b, 0x58,
  388. 0xfa, 0xb3, 0x24, 0xe4, 0xfa, 0xd6, 0x75, 0x94,
  389. 0x55, 0x85, 0x80, 0x8b, 0x48, 0x31, 0xd7, 0xbc,
  390. 0x3f, 0xf4, 0xde, 0xf0, 0x8e, 0x4b, 0x7a, 0x9d,
  391. 0xe5, 0x76, 0xd2, 0x65, 0x86, 0xce, 0xc6, 0x4b,
  392. 0x61, 0x16
  393. }
  394. };
  395. static const size_t test_input_len[1] =
  396. {
  397. 114U
  398. };
  399. static const unsigned char test_mac[1][16] =
  400. {
  401. {
  402. 0x1a, 0xe1, 0x0b, 0x59, 0x4f, 0x09, 0xe2, 0x6a,
  403. 0x7e, 0x90, 0x2e, 0xcb, 0xd0, 0x60, 0x06, 0x91
  404. }
  405. };
  406. #define ASSERT( cond, args ) \
  407. do \
  408. { \
  409. if( ! ( cond ) ) \
  410. { \
  411. if( verbose != 0 ) \
  412. mbedtls_printf args; \
  413. \
  414. return( -1 ); \
  415. } \
  416. } \
  417. while( 0 )
  418. int mbedtls_chachapoly_self_test( int verbose )
  419. {
  420. mbedtls_chachapoly_context ctx;
  421. unsigned i;
  422. int ret;
  423. unsigned char output[200];
  424. unsigned char mac[16];
  425. for( i = 0U; i < 1U; i++ )
  426. {
  427. if( verbose != 0 )
  428. mbedtls_printf( " ChaCha20-Poly1305 test %u ", i );
  429. mbedtls_chachapoly_init( &ctx );
  430. ret = mbedtls_chachapoly_setkey( &ctx, test_key[i] );
  431. ASSERT( 0 == ret, ( "setkey() error code: %i\n", ret ) );
  432. ret = mbedtls_chachapoly_encrypt_and_tag( &ctx,
  433. test_input_len[i],
  434. test_nonce[i],
  435. test_aad[i],
  436. test_aad_len[i],
  437. test_input[i],
  438. output,
  439. mac );
  440. ASSERT( 0 == ret, ( "crypt_and_tag() error code: %i\n", ret ) );
  441. ASSERT( 0 == memcmp( output, test_output[i], test_input_len[i] ),
  442. ( "failure (wrong output)\n" ) );
  443. ASSERT( 0 == memcmp( mac, test_mac[i], 16U ),
  444. ( "failure (wrong MAC)\n" ) );
  445. mbedtls_chachapoly_free( &ctx );
  446. if( verbose != 0 )
  447. mbedtls_printf( "passed\n" );
  448. }
  449. if( verbose != 0 )
  450. mbedtls_printf( "\n" );
  451. return( 0 );
  452. }
  453. #endif /* MBEDTLS_SELF_TEST */
  454. #endif /* MBEDTLS_CHACHAPOLY_C */