blob: d8c65b552e18c8de4abed6884cb6de0b37310ec8 [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
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020056/*
57 * Initialize context
58 */
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020059void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
60{
k-stachowiak26d365e2018-12-11 12:22:16 +010061 CCM_VALIDATE( ctx != NULL );
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020062 memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
63}
64
65int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
66 mbedtls_cipher_id_t cipher,
67 const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020068 unsigned int keybits )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020069{
Janos Follath24eed8d2019-11-22 13:21:35 +000070 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071 const mbedtls_cipher_info_t *cipher_info;
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020072
k-stachowiak26d365e2018-12-11 12:22:16 +010073 CCM_VALIDATE_RET( ctx != NULL );
74 CCM_VALIDATE_RET( key != NULL );
75
Andrzej Kurekee3c4352019-01-10 03:10:02 -050076 cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
77 MBEDTLS_MODE_ECB );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020078 if( cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020079 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020080
81 if( cipher_info->block_size != 16 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020083
Manuel Pégourié-Gonnard43b08572015-05-27 17:23:30 +020084 mbedtls_cipher_free( &ctx->cipher_ctx );
85
Manuel Pégourié-Gonnard8473f872015-05-14 13:51:45 +020086 if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020087 return( ret );
88
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020089 if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020090 MBEDTLS_ENCRYPT ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020091 {
92 return( ret );
93 }
94
95 return( 0 );
96}
97
98/*
99 * Free context
100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200102{
k-stachowiakfd42d532018-12-11 14:37:51 +0100103 if( ctx == NULL )
104 return;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105 mbedtls_cipher_free( &ctx->cipher_ctx );
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500106 mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200107}
108
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200109#define CCM_STATE__CLEAR 0
Mateusz Starzyka9cbdfb2021-07-27 13:49:54 +0200110#define CCM_STATE__STARTED (1 << 0)
111#define CCM_STATE__LENGHTS_SET (1 << 1)
112#define CCM_STATE__ERROR (1 << 2)
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200113
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200114/*
115 * Encrypt or decrypt a partial block with CTR
116 */
117static int mbedtls_ccm_crypt( mbedtls_ccm_context *ctx,
118 size_t offset, size_t use_len,
119 const unsigned char *input,
120 unsigned char *output )
121{
122 size_t i;
123 size_t olen = 0;
124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
125 unsigned char tmp_buf[16] = {0};
126
127 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, 16, tmp_buf,
128 &olen ) ) != 0 )
129 {
Mateusz Starzykc52220d2021-07-27 13:54:55 +0200130 ctx->state |= CCM_STATE__ERROR;
131 mbedtls_platform_zeroize(tmp_buf, sizeof(tmp_buf));
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200132 return ret;
133 }
134
135 for( i = 0; i < use_len; i++ )
136 output[i] = input[i] ^ tmp_buf[offset + i];
137
Mateusz Starzykc52220d2021-07-27 13:54:55 +0200138 mbedtls_platform_zeroize(tmp_buf, sizeof(tmp_buf));
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200139 return ret;
140}
141
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200142static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
143 ctx->state = CCM_STATE__CLEAR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200144 memset( ctx->y, 0, 16);
145 memset( ctx->ctr, 0, 16);
146}
147
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200148static int ccm_calculate_first_block_if_ready(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200149{
Janos Follath24eed8d2019-11-22 13:21:35 +0000150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200151 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200152 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200153
154 /* length calulcation can be done only after both
155 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
156 */
157 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
158 return 0;
159
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200160 if( ctx->tag_len == 0 && \
161 ( ctx->mode == MBEDTLS_CCM_ENCRYPT || ctx->mode == MBEDTLS_CCM_DECRYPT ) )
162 return( MBEDTLS_ERR_CCM_BAD_INPUT );
163
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200164 /*
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200165 * First block:
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200166 * 0 .. 0 flags
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200167 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200168 * iv_len+1 .. 15 length
169 *
170 * With flags as (bits):
171 * 7 0
172 * 6 add present?
173 * 5 .. 3 (t - 2) / 2
174 * 2 .. 0 q - 1
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200175 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200176 ctx->y[0] |= ( ctx->add_len > 0 ) << 6;
177 ctx->y[0] |= ( ( ctx->tag_len - 2 ) / 2 ) << 3;
178 ctx->y[0] |= ctx->q - 1;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200179
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200180 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200181 ctx->y[15-i] = (unsigned char)( len_left & 0xFF );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200182
183 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200184 {
185 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200186 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200187 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200188
189 /* Start CBC-MAC with first block*/
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200190 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
191 {
192 ctx->state |= CCM_STATE__ERROR;
193 return( ret );
194 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200195
196 return (0);
197}
198
199int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
200 int mode,
201 const unsigned char *iv,
202 size_t iv_len )
203{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200204 CCM_VALIDATE_RET( ctx != NULL );
205 CCM_VALIDATE_RET( iv != NULL );
206 CCM_VALIDATE_RET( mode == MBEDTLS_CCM_DECRYPT || \
207 mode == MBEDTLS_CCM_STAR_DECRYPT || \
208 mode == MBEDTLS_CCM_ENCRYPT || \
209 mode == MBEDTLS_CCM_STAR_ENCRYPT );
210
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200211 /* Also implies q is within bounds */
212 if( iv_len < 7 || iv_len > 13 )
213 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200214
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200215 if( ctx->state & CCM_STATE__ERROR )
216 {
217 mbedtls_ccm_clear_state(ctx);
218 }
219
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200220 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200221 ctx->q = 16 - 1 - (unsigned char) iv_len;
222
223 /*
224 * Prepare counter block for encryption:
225 * 0 .. 0 flags
226 * 1 .. iv_len nonce (aka iv)
227 * iv_len+1 .. 15 counter (initially 1)
228 *
229 * With flags as (bits):
230 * 7 .. 3 0
231 * 2 .. 0 q - 1
232 */
233 memset( ctx->ctr, 0, 16);
234 ctx->ctr[0] = ctx->q - 1;
235 memcpy( ctx->ctr + 1, iv, iv_len );
236 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
237 ctx->ctr[15] = 1;
238
239 /*
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200240 * See ccm_calculate_first_block_if_ready() for block layout description
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200241 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200242 memcpy( ctx->y + 1, iv, iv_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200243
244 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200245 return ccm_calculate_first_block_if_ready(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200246}
247
248int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
249 size_t total_ad_len,
250 size_t plaintext_len,
251 size_t tag_len )
252{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200253 CCM_VALIDATE_RET( ctx != NULL );
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 Starzykca9dc8d2021-07-27 14:03:53 +0200279 return ccm_calculate_first_block_if_ready(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{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200286 CCM_VALIDATE_RET( ctx->add_len == 0 || add != NULL );
287
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200288 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
289 unsigned char i;
Mateusz Starzyk33392452021-07-06 15:38:35 +0200290 size_t olen, use_len, offset;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200291
Mateusz Starzyk33392452021-07-06 15:38:35 +0200292 if( ctx->add_len > 0 && add_len > 0)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200293 {
Mateusz Starzyk33392452021-07-06 15:38:35 +0200294 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200295 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200296 ctx->y[0] ^= (unsigned char)( ( ctx->add_len >> 8 ) & 0xFF );
297 ctx->y[1] ^= (unsigned char)( ( ctx->add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200298
Mateusz Starzyk33392452021-07-06 15:38:35 +0200299 ctx->processed += 2;
300 }
301
302 while( add_len > 0 )
303 {
304 offset = ctx->processed % 16;
305
306 use_len = 16 - offset;
307
308 if( use_len > add_len )
309 use_len = add_len;
310
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200311 for( i = 0; i < use_len; i++ )
312 ctx->y[i + offset] ^= add[i];
313
Mateusz Starzyk33392452021-07-06 15:38:35 +0200314 ctx->processed += use_len;
315 add_len -= use_len;
316 add += use_len;
317
318 if( use_len + offset == 16 || ctx->processed - 2 == ctx->add_len )
319 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200320 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
321 {
322 ctx->state |= CCM_STATE__ERROR;
323 return( ret );
324 }
Mateusz Starzyk33392452021-07-06 15:38:35 +0200325 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200326 }
327 }
328
Mateusz Starzyk33392452021-07-06 15:38:35 +0200329 if( ctx->processed - 2 == ctx->add_len )
330 ctx->processed = 0; // prepare for mbedtls_ccm_update()
331
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200332 return (0);
333}
334
335int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
336 const unsigned char *input, size_t input_len,
337 unsigned char *output, size_t output_size,
338 size_t *output_len )
339{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200340 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || input != NULL );
341 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || output != NULL );
342
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
344 unsigned char i;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200345 size_t use_len, offset, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200346
347 if( output_size < input_len )
348 return( MBEDTLS_ERR_CCM_BAD_INPUT );
349 CCM_VALIDATE_RET( output_length != NULL );
350 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200351
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200352 while ( input_len > 0 )
353 {
354 offset = ctx->processed % 16;
355
356 use_len = 16 - offset;
357
358 if( use_len > input_len )
359 use_len = input_len;
360
361 ctx->processed += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200362
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200363 if( ctx->mode == MBEDTLS_CCM_ENCRYPT || \
364 ctx->mode == MBEDTLS_CCM_STAR_ENCRYPT )
365 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200366 for( i = 0; i < use_len; i++ )
367 ctx->y[i + offset] ^= input[i];
368
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200369 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
370 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200371 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
372 {
373 ctx->state |= CCM_STATE__ERROR;
374 return( ret );
375 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200376 }
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200377
378 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200379 if( ret != 0 )
380 return ret;
381 }
382
383 if( ctx->mode == MBEDTLS_CCM_DECRYPT || \
384 ctx->mode == MBEDTLS_CCM_STAR_DECRYPT )
385 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200386 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200387 if( ret != 0 )
388 return ret;
389
390 for( i = 0; i < use_len; i++ )
391 ctx->y[i + offset] ^= output[i];
392
393 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
394 {
395 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
396 {
397 ctx->state |= CCM_STATE__ERROR;
398 return( ret );
399 }
400 }
401 }
402
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200403 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
404 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200405 for( i = 0; i < ctx->q; i++ )
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200406 if( ++(ctx->ctr)[15-i] != 0 )
407 break;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200408 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200409
410 input_len -= use_len;
411 input += use_len;
412 output += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200413 }
414
415 return 0;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200416}
417
418int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
419 unsigned char *tag, size_t tag_len )
420{
421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
422 unsigned char i;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200423
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200424 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200425 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200426 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200427 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200428 for( i = 0; i < ctx->q; i++ )
429 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200430
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200431 ret = mbedtls_ccm_crypt( ctx, 0, 16, ctx->y, ctx->y );
432 if( ret != 0 )
433 return ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200434 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200435 mbedtls_ccm_clear_state(ctx);
436
437 return( 0 );
438}
439
440/*
441 * Authenticated encryption or decryption
442 */
443static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
444 const unsigned char *iv, size_t iv_len,
445 const unsigned char *add, size_t add_len,
446 const unsigned char *input, unsigned char *output,
447 unsigned char *tag, size_t tag_len )
448{
449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
450 size_t olen;
451
452 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
453 return( ret );
454
455 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
456 return( ret );
457
458 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
459 return( ret );
460
461 if( ( ret = mbedtls_ccm_update( ctx, input, length,
462 output, length, &olen ) ) != 0 )
463 return( ret );
464
465 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
466 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200467
468 return( 0 );
469}
470
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200471/*
472 * Authenticated encryption
473 */
Janos Follathb5734a22018-05-14 14:31:49 +0100474int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200475 const unsigned char *iv, size_t iv_len,
476 const unsigned char *add, size_t add_len,
477 const unsigned char *input, unsigned char *output,
478 unsigned char *tag, size_t tag_len )
479{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200480 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_ENCRYPT, length, iv, iv_len,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200481 add, add_len, input, output, tag, tag_len ) );
482}
483
Janos Follathb5734a22018-05-14 14:31:49 +0100484int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
485 const unsigned char *iv, size_t iv_len,
486 const unsigned char *add, size_t add_len,
487 const unsigned char *input, unsigned char *output,
488 unsigned char *tag, size_t tag_len )
489{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200490 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_ENCRYPT, length, iv, iv_len,
491 add, add_len, input, output, tag, tag_len ) );
492}
Janos Follathb5734a22018-05-14 14:31:49 +0100493
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200494static int mbedtls_ccm_compare_tags(const unsigned char *tag1, const unsigned char *tag2, size_t tag_len)
495{
496 unsigned char i;
497 int diff;
498
499 /* Check tag in "constant-time" */
500 for( diff = 0, i = 0; i < tag_len; i++ )
501 diff |= tag1[i] ^ tag2[i];
502
503 if( diff != 0 )
504 {
505 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
506 }
507
508 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100509}
510
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200511/*
512 * Authenticated decryption
513 */
Janos Follathb5734a22018-05-14 14:31:49 +0100514int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200515 const unsigned char *iv, size_t iv_len,
516 const unsigned char *add, size_t add_len,
517 const unsigned char *input, unsigned char *output,
518 const unsigned char *tag, size_t tag_len )
519{
Janos Follath24eed8d2019-11-22 13:21:35 +0000520 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200521 unsigned char check_tag[16];
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200522
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200523 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_DECRYPT, length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200524 iv, iv_len, add, add_len,
525 input, output, check_tag, tag_len ) ) != 0 )
526 {
527 return( ret );
528 }
529
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200530 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200531 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500532 mbedtls_platform_zeroize( output, length );
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200533 return( ret );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200534 }
535
536 return( 0 );
537}
538
Janos Follathb5734a22018-05-14 14:31:49 +0100539int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
540 const unsigned char *iv, size_t iv_len,
541 const unsigned char *add, size_t add_len,
542 const unsigned char *input, unsigned char *output,
543 const unsigned char *tag, size_t tag_len )
544{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
546 unsigned char check_tag[16];
k-stachowiakf7125342018-12-11 15:57:19 +0100547
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200548 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_DECRYPT, length,
549 iv, iv_len, add, add_len,
550 input, output, check_tag, tag_len ) ) != 0 )
551 {
552 return( ret );
553 }
Janos Follathb5734a22018-05-14 14:31:49 +0100554
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200555 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
556 {
557 mbedtls_platform_zeroize( output, length );
558 return( ret );
559 }
560
561 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100562}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200563#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200566/*
567 * Examples 1 to 3 from SP800-38C Appendix C
568 */
569
570#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300571#define CCM_SELFTEST_PT_MAX_LEN 24
572#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200573/*
574 * The data is the same for all tests, only the used length changes
575 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100576static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200577 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
578 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
579};
580
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100581static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200582 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
583 0x18, 0x19, 0x1a, 0x1b
584};
585
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100586static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200587 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
588 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
589 0x10, 0x11, 0x12, 0x13
590};
591
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100592static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200593 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
594 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
595 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
596};
597
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100598static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
599static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
600static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
601static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200602
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100603static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200604 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
605 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
606 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
607 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
608 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
609 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
610 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
611 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
612};
613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200615{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300617 /*
618 * Some hardware accelerators require the input and output buffers
619 * would be in RAM, because the flash is not accessible.
620 * Use buffers on the stack to hold the test vectors data.
621 */
622 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
623 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200624 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200626
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200627 mbedtls_ccm_init( &ctx );
628
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500629 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
630 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200631 {
632 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200634
635 return( 1 );
636 }
637
638 for( i = 0; i < NB_TESTS; i++ )
639 {
640 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200642
Ron Eldor1b9b2172018-04-26 14:15:01 +0300643 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
644 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100645 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300646
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100647 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100648 iv_test_data, iv_len_test_data[i],
649 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300650 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500651 ciphertext + msg_len_test_data[i],
652 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200653
654 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500655 memcmp( ciphertext, res_test_data[i],
656 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200657 {
658 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200660
661 return( 1 );
662 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300663 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200664
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100665 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100666 iv_test_data, iv_len_test_data[i],
667 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300668 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500669 ciphertext + msg_len_test_data[i],
670 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200671
672 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100673 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200674 {
675 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200677
678 return( 1 );
679 }
680
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200681 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200683 }
684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200686
687 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200689
690 return( 0 );
691}
692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695#endif /* MBEDTLS_CCM_C */