blob: 34531a4162c618ed50754c9509362dd3e6a471a6 [file] [log] [blame]
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001/*
2 * NIST SP800-38C compliant CCM implementation
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * 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.
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020018 */
19
20/*
21 * Definition of CCM:
22 * http://csrc.nist.gov/publications/nistpubs/800-38C/SP800-38C_updated-July20_2007.pdf
23 * RFC 3610 "Counter with CBC-MAC (CCM)"
24 *
25 * Related:
26 * RFC 5116 "An Interface and Algorithms for Authenticated Encryption"
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_CCM_C)
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020032
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/ccm.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050034#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000035#include "mbedtls/error.h"
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020036
Rich Evans00ab4702015-02-06 13:43:58 +000037#include <string.h>
38
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
40#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/platform.h"
Rich Evans00ab4702015-02-06 13:43:58 +000042#else
43#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#define mbedtls_printf printf
45#endif /* MBEDTLS_PLATFORM_C */
46#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Rich Evans00ab4702015-02-06 13:43:58 +000047
Steven Cooreman222e2ff2017-04-04 11:37:15 +020048#if !defined(MBEDTLS_CCM_ALT)
49
k-stachowiak26d365e2018-12-11 12:22:16 +010050#define CCM_VALIDATE_RET( cond ) \
51 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_CCM_BAD_INPUT )
52#define CCM_VALIDATE( cond ) \
53 MBEDTLS_INTERNAL_VALIDATE( cond )
54
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +020055#define CCM_ENCRYPT 0
56#define CCM_DECRYPT 1
57
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020058/*
59 * Initialize context
60 */
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020061void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
62{
k-stachowiak26d365e2018-12-11 12:22:16 +010063 CCM_VALIDATE( ctx != NULL );
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020064 memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
65}
66
67int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
68 mbedtls_cipher_id_t cipher,
69 const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020070 unsigned int keybits )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020071{
Janos Follath24eed8d2019-11-22 13:21:35 +000072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073 const mbedtls_cipher_info_t *cipher_info;
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020074
k-stachowiak26d365e2018-12-11 12:22:16 +010075 CCM_VALIDATE_RET( ctx != NULL );
76 CCM_VALIDATE_RET( key != NULL );
77
Andrzej Kurekee3c4352019-01-10 03:10:02 -050078 cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
79 MBEDTLS_MODE_ECB );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020080 if( cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020082
83 if( cipher_info->block_size != 16 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020085
Manuel Pégourié-Gonnard43b08572015-05-27 17:23:30 +020086 mbedtls_cipher_free( &ctx->cipher_ctx );
87
Manuel Pégourié-Gonnard8473f872015-05-14 13:51:45 +020088 if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020089 return( ret );
90
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020091 if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092 MBEDTLS_ENCRYPT ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020093 {
94 return( ret );
95 }
96
97 return( 0 );
98}
99
100/*
101 * Free context
102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200104{
k-stachowiakfd42d532018-12-11 14:37:51 +0100105 if( ctx == NULL )
106 return;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107 mbedtls_cipher_free( &ctx->cipher_ctx );
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500108 mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200109}
110
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200111/*
112 * Macros for common operations.
113 * Results in smaller compiled code than static inline functions.
114 */
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200115
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200116/*
117 * Update the CBC-MAC state in y using a block in b
118 * (Always using b as the source helps the compiler optimise a bit better.)
119 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200120#define UPDATE_CBC_MAC \
121 for( i = 0; i < 16; i++ ) \
122 ctx->y[i] ^= ctx->b[i]; \
123 \
124 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 ) \
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200125 { \
126 ctx->state |= CCM_STATE__ERROR; \
127 return( ret ); \
128 } \
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200129
130/*
131 * Encrypt or decrypt a partial block with CTR
132 * Warning: using b for temporary storage! src and dst must not be b!
Manuel Pégourié-Gonnard0f6b66d2014-05-07 14:43:46 +0200133 * This avoids allocating one more 16 bytes buffer while allowing src == dst.
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200134 */
135#define CTR_CRYPT( dst, src, len ) \
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200136 do \
137 { \
138 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, \
139 16, ctx->b, &olen ) ) != 0 ) \
140 { \
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200141 ctx->state |= CCM_STATE__ERROR; \
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200142 return( ret ); \
143 } \
144 \
145 for( i = 0; i < (len); i++ ) \
146 (dst)[i] = (src)[i] ^ ctx->b[i]; \
Hanno Becker1eeca412018-10-15 12:01:35 +0100147 } while( 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200148
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200149#define CCM_STATE__CLEAR 0
150#define CCM_STATE__STARTED 0x0001
151#define CCM_STATE__LENGHTS_SET 0x0002
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200152#define CCM_STATE__ERROR 0x0004
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200153
154static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
155 ctx->state = CCM_STATE__CLEAR;
156 memset( ctx->b, 0, 16);
157 memset( ctx->y, 0, 16);
158 memset( ctx->ctr, 0, 16);
159}
160
161static int mbedtls_ccm_calculate_first_block(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200162{
Janos Follath24eed8d2019-11-22 13:21:35 +0000163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200164 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200165 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200166
167 /* length calulcation can be done only after both
168 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
169 */
170 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
171 return 0;
172
173 /*
174 * First block B_0:
175 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
176 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
177 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
178 */
179 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
180 ctx->b[15-i] = (unsigned char)( len_left & 0xFF );
181
182 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200183 {
184 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200185 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200186 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200187
188 /* Start CBC-MAC with first block*/
189 UPDATE_CBC_MAC;
190
191 return (0);
192}
193
194int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
195 int mode,
196 const unsigned char *iv,
197 size_t iv_len )
198{
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200199 /* Also implies q is within bounds */
200 if( iv_len < 7 || iv_len > 13 )
201 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200202
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200203 if( ctx->state & CCM_STATE__ERROR )
204 {
205 mbedtls_ccm_clear_state(ctx);
206 }
207
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200208 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200209 ctx->q = 16 - 1 - (unsigned char) iv_len;
210
211 /*
212 * Prepare counter block for encryption:
213 * 0 .. 0 flags
214 * 1 .. iv_len nonce (aka iv)
215 * iv_len+1 .. 15 counter (initially 1)
216 *
217 * With flags as (bits):
218 * 7 .. 3 0
219 * 2 .. 0 q - 1
220 */
221 memset( ctx->ctr, 0, 16);
222 ctx->ctr[0] = ctx->q - 1;
223 memcpy( ctx->ctr + 1, iv, iv_len );
224 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
225 ctx->ctr[15] = 1;
226
227 /*
228 * First block B_0:
229 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
230 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
231 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
232 *
233 * With flags as (bits):
234 * 7 0
235 * 6 add present? - set by: mbedtls_ccm_set_lengths()
236 * 5 .. 3 (t - 2) / 2 - set by: mbedtls_ccm_set_lengths()
237 * 2 .. 0 q - 1 - set by: mbedtls_ccm_starts()
238 */
239 ctx->b[0] |= ctx->q - 1;
240
241 memcpy( ctx->b + 1, iv, iv_len );
242
243 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200244 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200245}
246
247int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
248 size_t total_ad_len,
249 size_t plaintext_len,
250 size_t tag_len )
251{
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200252 /*
253 * Check length requirements: SP800-38C A.1
254 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
255 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100256 *
257 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200258 */
Janos Follath997e85c2018-05-29 11:33:45 +0100259 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100260 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200261
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200262 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200264
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200265 if( ctx->state & CCM_STATE__ERROR )
266 {
267 mbedtls_ccm_clear_state(ctx);
268 }
269
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200270 /*
271 * First block B_0:
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200272 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
273 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
274 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200275 *
276 * With flags as (bits):
277 * 7 0
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200278 * 6 add present? - set by: mbedtls_ccm_set_lengths()
279 * 5 .. 3 (t - 2) / 2 - set by: mbedtls_ccm_set_lengths()
280 * 2 .. 0 q - 1 - set by: mbedtls_ccm_starts()
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200281 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200282 ctx->b[0] |= ( total_ad_len > 0 ) << 6;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200283 ctx->b[0] |= ( ( tag_len - 2 ) / 2 ) << 3;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200284
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200285 ctx->plaintext_len = plaintext_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200286
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200287 ctx->state |= CCM_STATE__LENGHTS_SET;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200288 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200289}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200290
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200291int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
292 const unsigned char *add,
293 size_t add_len )
294{
295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
296 unsigned char i;
297 size_t len_left, olen;
298 const unsigned char *src;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200299
300 /*
301 * If there is additional data, update CBC-MAC with
302 * add_len, add, 0 (padding to a block boundary)
303 */
304 if( add_len > 0 )
305 {
306 size_t use_len;
307 len_left = add_len;
308 src = add;
309
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200310 memset( ctx->b, 0, 16 );
311 ctx->b[0] = (unsigned char)( ( add_len >> 8 ) & 0xFF );
312 ctx->b[1] = (unsigned char)( ( add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200313
314 use_len = len_left < 16 - 2 ? len_left : 16 - 2;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200315 memcpy( ctx->b + 2, src, use_len );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200316 len_left -= use_len;
317 src += use_len;
318
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200319 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200320
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200321 while( len_left > 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200322 {
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200323 use_len = len_left > 16 ? 16 : len_left;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200324
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200325 memset( ctx->b, 0, 16 );
326 memcpy( ctx->b, src, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200327 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200328
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200329 len_left -= use_len;
330 src += use_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200331 }
332 }
333
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200334 return (0);
335}
336
337int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
338 const unsigned char *input, size_t input_len,
339 unsigned char *output, size_t output_size,
340 size_t *output_len )
341{
342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
343 unsigned char i;
344 size_t len_left, olen;
345 const unsigned char *src;
346 unsigned char *dst;
347
348 if( output_size < input_len )
349 return( MBEDTLS_ERR_CCM_BAD_INPUT );
350 CCM_VALIDATE_RET( output_length != NULL );
351 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200352
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200353 /*
354 * Authenticate and {en,de}crypt the message.
355 *
356 * The only difference between encryption and decryption is
357 * the respective order of authentication and {en,de}cryption.
358 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200359 len_left = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200360 src = input;
361 dst = output;
362
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200363 while( len_left > 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200364 {
Manuel Pégourié-Gonnard9de64f52015-07-01 15:51:43 +0200365 size_t use_len = len_left > 16 ? 16 : len_left;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200366
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200367 if( ctx->mode == CCM_ENCRYPT )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200368 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200369 memset( ctx->b, 0, 16 );
370 memcpy( ctx->b, src, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200371 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200372 }
373
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200374 CTR_CRYPT( dst, src, use_len );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200375
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200376 if( ctx->mode == CCM_DECRYPT )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200377 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200378 memset( ctx->b, 0, 16 );
379 memcpy( ctx->b, dst, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200380 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200381 }
382
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200383 dst += use_len;
384 src += use_len;
385 len_left -= use_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200386
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200387 /*
388 * Increment counter.
389 * No need to check for overflow thanks to the length check above.
390 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200391 for( i = 0; i < ctx->q; i++ )
392 if( ++(ctx->ctr)[15-i] != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200393 break;
394 }
395
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200396 return (0);
397}
398
399int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
400 unsigned char *tag, size_t tag_len )
401{
402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
403 unsigned char i;
404 size_t olen;
405
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200406 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200407 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200408 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200409 for( i = 0; i < ctx->q; i++ )
410 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200411
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200412 CTR_CRYPT( ctx->y, ctx->y, 16 );
413 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200414 mbedtls_ccm_clear_state(ctx);
415
416 return( 0 );
417}
418
419/*
420 * Authenticated encryption or decryption
421 */
422static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
423 const unsigned char *iv, size_t iv_len,
424 const unsigned char *add, size_t add_len,
425 const unsigned char *input, unsigned char *output,
426 unsigned char *tag, size_t tag_len )
427{
428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
429 size_t olen;
430
431 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
432 return( ret );
433
434 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
435 return( ret );
436
437 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
438 return( ret );
439
440 if( ( ret = mbedtls_ccm_update( ctx, input, length,
441 output, length, &olen ) ) != 0 )
442 return( ret );
443
444 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
445 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200446
447 return( 0 );
448}
449
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200450/*
451 * Authenticated encryption
452 */
Janos Follathb5734a22018-05-14 14:31:49 +0100453int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200454 const unsigned char *iv, size_t iv_len,
455 const unsigned char *add, size_t add_len,
456 const unsigned char *input, unsigned char *output,
457 unsigned char *tag, size_t tag_len )
458{
k-stachowiak26d365e2018-12-11 12:22:16 +0100459 CCM_VALIDATE_RET( ctx != NULL );
460 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100461 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
462 CCM_VALIDATE_RET( length == 0 || input != NULL );
463 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100464 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200465 return( ccm_auth_crypt( ctx, CCM_ENCRYPT, length, iv, iv_len,
466 add, add_len, input, output, tag, tag_len ) );
467}
468
Janos Follathb5734a22018-05-14 14:31:49 +0100469int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
470 const unsigned char *iv, size_t iv_len,
471 const unsigned char *add, size_t add_len,
472 const unsigned char *input, unsigned char *output,
473 unsigned char *tag, size_t tag_len )
474{
k-stachowiak26d365e2018-12-11 12:22:16 +0100475 CCM_VALIDATE_RET( ctx != NULL );
476 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100477 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
478 CCM_VALIDATE_RET( length == 0 || input != NULL );
479 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100480 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Janos Follathb5734a22018-05-14 14:31:49 +0100481 if( tag_len == 0 )
482 return( MBEDTLS_ERR_CCM_BAD_INPUT );
483
484 return( mbedtls_ccm_star_encrypt_and_tag( ctx, length, iv, iv_len, add,
485 add_len, input, output, tag, tag_len ) );
486}
487
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200488/*
489 * Authenticated decryption
490 */
Janos Follathb5734a22018-05-14 14:31:49 +0100491int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200492 const unsigned char *iv, size_t iv_len,
493 const unsigned char *add, size_t add_len,
494 const unsigned char *input, unsigned char *output,
495 const unsigned char *tag, size_t tag_len )
496{
Janos Follath24eed8d2019-11-22 13:21:35 +0000497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200498 unsigned char check_tag[16];
499 unsigned char i;
500 int diff;
501
k-stachowiak26d365e2018-12-11 12:22:16 +0100502 CCM_VALIDATE_RET( ctx != NULL );
503 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100504 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
505 CCM_VALIDATE_RET( length == 0 || input != NULL );
506 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100507 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiak26d365e2018-12-11 12:22:16 +0100508
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200509 if( ( ret = ccm_auth_crypt( ctx, CCM_DECRYPT, length,
510 iv, iv_len, add, add_len,
511 input, output, check_tag, tag_len ) ) != 0 )
512 {
513 return( ret );
514 }
515
516 /* Check tag in "constant-time" */
517 for( diff = 0, i = 0; i < tag_len; i++ )
518 diff |= tag[i] ^ check_tag[i];
519
520 if( diff != 0 )
521 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500522 mbedtls_platform_zeroize( output, length );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200524 }
525
526 return( 0 );
527}
528
Janos Follathb5734a22018-05-14 14:31:49 +0100529int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
530 const unsigned char *iv, size_t iv_len,
531 const unsigned char *add, size_t add_len,
532 const unsigned char *input, unsigned char *output,
533 const unsigned char *tag, size_t tag_len )
534{
k-stachowiakf7125342018-12-11 15:57:19 +0100535 CCM_VALIDATE_RET( ctx != NULL );
536 CCM_VALIDATE_RET( iv != NULL );
537 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
538 CCM_VALIDATE_RET( length == 0 || input != NULL );
539 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100540 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiakf7125342018-12-11 15:57:19 +0100541
Janos Follathb5734a22018-05-14 14:31:49 +0100542 if( tag_len == 0 )
543 return( MBEDTLS_ERR_CCM_BAD_INPUT );
544
545 return( mbedtls_ccm_star_auth_decrypt( ctx, length, iv, iv_len, add,
546 add_len, input, output, tag, tag_len ) );
547}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200548#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200551/*
552 * Examples 1 to 3 from SP800-38C Appendix C
553 */
554
555#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300556#define CCM_SELFTEST_PT_MAX_LEN 24
557#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200558/*
559 * The data is the same for all tests, only the used length changes
560 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100561static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200562 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
563 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
564};
565
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100566static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200567 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
568 0x18, 0x19, 0x1a, 0x1b
569};
570
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100571static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200572 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
573 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
574 0x10, 0x11, 0x12, 0x13
575};
576
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100577static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200578 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
579 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
580 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
581};
582
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100583static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
584static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
585static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
586static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200587
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100588static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200589 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
590 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
591 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
592 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
593 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
594 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
595 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
596 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
597};
598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200600{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300602 /*
603 * Some hardware accelerators require the input and output buffers
604 * would be in RAM, because the flash is not accessible.
605 * Use buffers on the stack to hold the test vectors data.
606 */
607 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
608 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200609 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200611
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200612 mbedtls_ccm_init( &ctx );
613
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500614 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
615 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200616 {
617 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200619
620 return( 1 );
621 }
622
623 for( i = 0; i < NB_TESTS; i++ )
624 {
625 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200627
Ron Eldor1b9b2172018-04-26 14:15:01 +0300628 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
629 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100630 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300631
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100632 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100633 iv_test_data, iv_len_test_data[i],
634 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300635 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500636 ciphertext + msg_len_test_data[i],
637 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200638
639 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500640 memcmp( ciphertext, res_test_data[i],
641 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200642 {
643 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200645
646 return( 1 );
647 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300648 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200649
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100650 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100651 iv_test_data, iv_len_test_data[i],
652 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300653 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500654 ciphertext + msg_len_test_data[i],
655 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200656
657 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100658 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200659 {
660 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200662
663 return( 1 );
664 }
665
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200666 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200668 }
669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200671
672 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200674
675 return( 0 );
676}
677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680#endif /* MBEDTLS_CCM_C */