blob: 4b1b499ad1858bbe12c7de73ecf74b1338ab0540 [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/*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200112 * Update the CBC-MAC state in y using a block in b
113 * (Always using b as the source helps the compiler optimise a bit better.)
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200114 *
115 * Macro results in smaller compiled code than static inline functions.
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200116 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200117#define UPDATE_CBC_MAC \
118 for( i = 0; i < 16; i++ ) \
119 ctx->y[i] ^= ctx->b[i]; \
120 \
121 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 ) \
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200122 { \
123 ctx->state |= CCM_STATE__ERROR; \
124 return( ret ); \
125 } \
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200126
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200127#define CCM_STATE__CLEAR 0
128#define CCM_STATE__STARTED 0x0001
129#define CCM_STATE__LENGHTS_SET 0x0002
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200130#define CCM_STATE__ERROR 0x0004
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200131
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200132/*
133 * Encrypt or decrypt a partial block with CTR
134 */
135static int mbedtls_ccm_crypt( mbedtls_ccm_context *ctx,
136 size_t offset, size_t use_len,
137 const unsigned char *input,
138 unsigned char *output )
139{
140 size_t i;
141 size_t olen = 0;
142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
143 unsigned char tmp_buf[16] = {0};
144
145 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, 16, tmp_buf,
146 &olen ) ) != 0 )
147 {
148 ctx->state |= CCM_STATE__ERROR; \
149 return ret;
150 }
151
152 for( i = 0; i < use_len; i++ )
153 output[i] = input[i] ^ tmp_buf[offset + i];
154
155 return ret;
156}
157
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200158static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
159 ctx->state = CCM_STATE__CLEAR;
160 memset( ctx->b, 0, 16);
161 memset( ctx->y, 0, 16);
162 memset( ctx->ctr, 0, 16);
163}
164
165static int mbedtls_ccm_calculate_first_block(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200166{
Janos Follath24eed8d2019-11-22 13:21:35 +0000167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200168 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200169 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200170
171 /* length calulcation can be done only after both
172 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
173 */
174 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
175 return 0;
176
177 /*
178 * First block B_0:
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200179 * 0 .. 0 flags
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200180 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200181 * iv_len+1 .. 15 length
182 *
183 * With flags as (bits):
184 * 7 0
185 * 6 add present?
186 * 5 .. 3 (t - 2) / 2
187 * 2 .. 0 q - 1
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200188 */
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200189 ctx->b[0] |= ( ctx->add_len > 0 ) << 6;
190 ctx->b[0] |= ( ( ctx->tag_len - 2 ) / 2 ) << 3;
191 ctx->b[0] |= ctx->q - 1;
192
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200193 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
194 ctx->b[15-i] = (unsigned char)( len_left & 0xFF );
195
196 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200197 {
198 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200199 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200200 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200201
202 /* Start CBC-MAC with first block*/
203 UPDATE_CBC_MAC;
204
205 return (0);
206}
207
208int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
209 int mode,
210 const unsigned char *iv,
211 size_t iv_len )
212{
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200213 /* Also implies q is within bounds */
214 if( iv_len < 7 || iv_len > 13 )
215 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200216
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200217 if( ctx->state & CCM_STATE__ERROR )
218 {
219 mbedtls_ccm_clear_state(ctx);
220 }
221
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200222 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200223 ctx->q = 16 - 1 - (unsigned char) iv_len;
224
225 /*
226 * Prepare counter block for encryption:
227 * 0 .. 0 flags
228 * 1 .. iv_len nonce (aka iv)
229 * iv_len+1 .. 15 counter (initially 1)
230 *
231 * With flags as (bits):
232 * 7 .. 3 0
233 * 2 .. 0 q - 1
234 */
235 memset( ctx->ctr, 0, 16);
236 ctx->ctr[0] = ctx->q - 1;
237 memcpy( ctx->ctr + 1, iv, iv_len );
238 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
239 ctx->ctr[15] = 1;
240
241 /*
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200242 * See mbedtls_ccm_calculate_first_block() for B block layout description
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200243 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200244 memcpy( ctx->b + 1, iv, iv_len );
245
246 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200247 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200248}
249
250int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
251 size_t total_ad_len,
252 size_t plaintext_len,
253 size_t tag_len )
254{
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200255 /*
256 * Check length requirements: SP800-38C A.1
257 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
258 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100259 *
260 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200261 */
Janos Follath997e85c2018-05-29 11:33:45 +0100262 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100263 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200264
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200265 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200267
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200268 if( ctx->state & CCM_STATE__ERROR )
269 {
270 mbedtls_ccm_clear_state(ctx);
271 }
272
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200273 ctx->plaintext_len = plaintext_len;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200274 ctx->add_len = total_ad_len;
275 ctx->tag_len = tag_len;
276 ctx->processed = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200277
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200278 ctx->state |= CCM_STATE__LENGHTS_SET;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200279 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200280}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200281
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200282int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
283 const unsigned char *add,
284 size_t add_len )
285{
286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
287 unsigned char i;
Mateusz Starzyk33392452021-07-06 15:38:35 +0200288 size_t olen, use_len, offset;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200289
Mateusz Starzyk33392452021-07-06 15:38:35 +0200290 if( ctx->add_len > 0 && add_len > 0)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200291 {
Mateusz Starzyk33392452021-07-06 15:38:35 +0200292 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200293 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200294 memset( ctx->b, 0, 16 );
Mateusz Starzyk33392452021-07-06 15:38:35 +0200295 ctx->b[0] = (unsigned char)( ( ctx->add_len >> 8 ) & 0xFF );
296 ctx->b[1] = (unsigned char)( ( ctx->add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200297
Mateusz Starzyk33392452021-07-06 15:38:35 +0200298 ctx->processed += 2;
299 }
300
301 while( add_len > 0 )
302 {
303 offset = ctx->processed % 16;
304
305 use_len = 16 - offset;
306
307 if( use_len > add_len )
308 use_len = add_len;
309
310 memcpy( ctx->b + offset, add, use_len );
311 ctx->processed += use_len;
312 add_len -= use_len;
313 add += use_len;
314
315 if( use_len + offset == 16 || ctx->processed - 2 == ctx->add_len )
316 {
317 UPDATE_CBC_MAC;
318 memset( ctx->b, 0, 16 );
319 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200320 }
321 }
322
Mateusz Starzyk33392452021-07-06 15:38:35 +0200323 if( ctx->processed - 2 == ctx->add_len )
324 ctx->processed = 0; // prepare for mbedtls_ccm_update()
325
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200326 return (0);
327}
328
329int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
330 const unsigned char *input, size_t input_len,
331 unsigned char *output, size_t output_size,
332 size_t *output_len )
333{
334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
335 unsigned char i;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200336 size_t use_len, offset, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200337
338 if( output_size < input_len )
339 return( MBEDTLS_ERR_CCM_BAD_INPUT );
340 CCM_VALIDATE_RET( output_length != NULL );
341 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200342
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200343 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200344 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200345 memset( ctx->b, 0, 16 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200346 }
347
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200348 while ( input_len > 0 )
349 {
350 offset = ctx->processed % 16;
351
352 use_len = 16 - offset;
353
354 if( use_len > input_len )
355 use_len = input_len;
356
357 ctx->processed += use_len;
358 memcpy( ctx->b + offset, input, use_len );
359
360 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
361 {
362 if( ctx->mode == CCM_ENCRYPT )
363 {
364 UPDATE_CBC_MAC;
365 ret = mbedtls_ccm_crypt( ctx, 0, use_len, ctx->b, output );
366 if( ret != 0 )
367 return ret;
368 memset( ctx->b, 0, 16 );
369 }
370
371 if( ctx->mode == CCM_DECRYPT )
372 {
373 ret = mbedtls_ccm_crypt( ctx, 0, use_len, ctx->b, output );
374 if( ret != 0 )
375 return ret;
376 memset( ctx->b, 0, 16 );
377 memcpy( ctx->b, output, use_len );
378 UPDATE_CBC_MAC;
379 memset( ctx->b, 0, 16 );
380 }
381
382 input_len -= use_len;
383 input += use_len;
384 output += use_len;
385
386 /*
387 * Increment counter.
388 * No need to check for overflow thanks to the length check above.
389 */
390 for( i = 0; i < ctx->q; i++ )
391 if( ++(ctx->ctr)[15-i] != 0 )
392 break;
393 }
394 }
395
396 return 0;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200397}
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;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200404
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200405 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200406 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200407 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200408 for( i = 0; i < ctx->q; i++ )
409 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200410
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200411 ret = mbedtls_ccm_crypt( ctx, 0, 16, ctx->y, ctx->y );
412 if( ret != 0 )
413 return ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200414 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200415 mbedtls_ccm_clear_state(ctx);
416
417 return( 0 );
418}
419
420/*
421 * Authenticated encryption or decryption
422 */
423static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
424 const unsigned char *iv, size_t iv_len,
425 const unsigned char *add, size_t add_len,
426 const unsigned char *input, unsigned char *output,
427 unsigned char *tag, size_t tag_len )
428{
429 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
430 size_t olen;
431
432 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
433 return( ret );
434
435 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
436 return( ret );
437
438 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
439 return( ret );
440
441 if( ( ret = mbedtls_ccm_update( ctx, input, length,
442 output, length, &olen ) ) != 0 )
443 return( ret );
444
445 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
446 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200447
448 return( 0 );
449}
450
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200451/*
452 * Authenticated encryption
453 */
Janos Follathb5734a22018-05-14 14:31:49 +0100454int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200455 const unsigned char *iv, size_t iv_len,
456 const unsigned char *add, size_t add_len,
457 const unsigned char *input, unsigned char *output,
458 unsigned char *tag, size_t tag_len )
459{
k-stachowiak26d365e2018-12-11 12:22:16 +0100460 CCM_VALIDATE_RET( ctx != NULL );
461 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100462 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
463 CCM_VALIDATE_RET( length == 0 || input != NULL );
464 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100465 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200466 return( ccm_auth_crypt( ctx, CCM_ENCRYPT, length, iv, iv_len,
467 add, add_len, input, output, tag, tag_len ) );
468}
469
Janos Follathb5734a22018-05-14 14:31:49 +0100470int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
471 const unsigned char *iv, size_t iv_len,
472 const unsigned char *add, size_t add_len,
473 const unsigned char *input, unsigned char *output,
474 unsigned char *tag, size_t tag_len )
475{
k-stachowiak26d365e2018-12-11 12:22:16 +0100476 CCM_VALIDATE_RET( ctx != NULL );
477 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100478 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
479 CCM_VALIDATE_RET( length == 0 || input != NULL );
480 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100481 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Janos Follathb5734a22018-05-14 14:31:49 +0100482 if( tag_len == 0 )
483 return( MBEDTLS_ERR_CCM_BAD_INPUT );
484
485 return( mbedtls_ccm_star_encrypt_and_tag( ctx, length, iv, iv_len, add,
486 add_len, input, output, tag, tag_len ) );
487}
488
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200489/*
490 * Authenticated decryption
491 */
Janos Follathb5734a22018-05-14 14:31:49 +0100492int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200493 const unsigned char *iv, size_t iv_len,
494 const unsigned char *add, size_t add_len,
495 const unsigned char *input, unsigned char *output,
496 const unsigned char *tag, size_t tag_len )
497{
Janos Follath24eed8d2019-11-22 13:21:35 +0000498 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200499 unsigned char check_tag[16];
500 unsigned char i;
501 int diff;
502
k-stachowiak26d365e2018-12-11 12:22:16 +0100503 CCM_VALIDATE_RET( ctx != NULL );
504 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100505 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
506 CCM_VALIDATE_RET( length == 0 || input != NULL );
507 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100508 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiak26d365e2018-12-11 12:22:16 +0100509
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200510 if( ( ret = ccm_auth_crypt( ctx, CCM_DECRYPT, length,
511 iv, iv_len, add, add_len,
512 input, output, check_tag, tag_len ) ) != 0 )
513 {
514 return( ret );
515 }
516
517 /* Check tag in "constant-time" */
518 for( diff = 0, i = 0; i < tag_len; i++ )
519 diff |= tag[i] ^ check_tag[i];
520
521 if( diff != 0 )
522 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500523 mbedtls_platform_zeroize( output, length );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200525 }
526
527 return( 0 );
528}
529
Janos Follathb5734a22018-05-14 14:31:49 +0100530int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
531 const unsigned char *iv, size_t iv_len,
532 const unsigned char *add, size_t add_len,
533 const unsigned char *input, unsigned char *output,
534 const unsigned char *tag, size_t tag_len )
535{
k-stachowiakf7125342018-12-11 15:57:19 +0100536 CCM_VALIDATE_RET( ctx != NULL );
537 CCM_VALIDATE_RET( iv != NULL );
538 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
539 CCM_VALIDATE_RET( length == 0 || input != NULL );
540 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100541 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiakf7125342018-12-11 15:57:19 +0100542
Janos Follathb5734a22018-05-14 14:31:49 +0100543 if( tag_len == 0 )
544 return( MBEDTLS_ERR_CCM_BAD_INPUT );
545
546 return( mbedtls_ccm_star_auth_decrypt( ctx, length, iv, iv_len, add,
547 add_len, input, output, tag, tag_len ) );
548}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200549#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200552/*
553 * Examples 1 to 3 from SP800-38C Appendix C
554 */
555
556#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300557#define CCM_SELFTEST_PT_MAX_LEN 24
558#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200559/*
560 * The data is the same for all tests, only the used length changes
561 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100562static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200563 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
564 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
565};
566
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100567static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200568 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
569 0x18, 0x19, 0x1a, 0x1b
570};
571
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100572static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200573 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
574 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
575 0x10, 0x11, 0x12, 0x13
576};
577
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100578static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200579 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
580 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
581 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
582};
583
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100584static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
585static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
586static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
587static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200588
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100589static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200590 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
591 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
592 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
593 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
594 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
595 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
596 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
597 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
598};
599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200601{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300603 /*
604 * Some hardware accelerators require the input and output buffers
605 * would be in RAM, because the flash is not accessible.
606 * Use buffers on the stack to hold the test vectors data.
607 */
608 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
609 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200610 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000611 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200612
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200613 mbedtls_ccm_init( &ctx );
614
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500615 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
616 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200617 {
618 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200620
621 return( 1 );
622 }
623
624 for( i = 0; i < NB_TESTS; i++ )
625 {
626 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200628
Ron Eldor1b9b2172018-04-26 14:15:01 +0300629 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
630 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100631 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300632
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100633 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100634 iv_test_data, iv_len_test_data[i],
635 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300636 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500637 ciphertext + msg_len_test_data[i],
638 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200639
640 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500641 memcmp( ciphertext, res_test_data[i],
642 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200643 {
644 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200646
647 return( 1 );
648 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300649 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200650
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100651 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100652 iv_test_data, iv_len_test_data[i],
653 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300654 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500655 ciphertext + msg_len_test_data[i],
656 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200657
658 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100659 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200660 {
661 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200663
664 return( 1 );
665 }
666
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200667 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200669 }
670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200672
673 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200675
676 return( 0 );
677}
678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681#endif /* MBEDTLS_CCM_C */