blob: be1671c04c89d165f174520e8d513c3ea784311f [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 {
130 ctx->state |= CCM_STATE__ERROR; \
131 return ret;
132 }
133
134 for( i = 0; i < use_len; i++ )
135 output[i] = input[i] ^ tmp_buf[offset + i];
136
137 return ret;
138}
139
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200140static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
141 ctx->state = CCM_STATE__CLEAR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200142 memset( ctx->y, 0, 16);
143 memset( ctx->ctr, 0, 16);
144}
145
146static int mbedtls_ccm_calculate_first_block(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200147{
Janos Follath24eed8d2019-11-22 13:21:35 +0000148 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200149 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200150 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200151
152 /* length calulcation can be done only after both
153 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
154 */
155 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
156 return 0;
157
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200158 if( ctx->tag_len == 0 && \
159 ( ctx->mode == MBEDTLS_CCM_ENCRYPT || ctx->mode == MBEDTLS_CCM_DECRYPT ) )
160 return( MBEDTLS_ERR_CCM_BAD_INPUT );
161
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200162 /*
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200163 * First block:
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200164 * 0 .. 0 flags
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200165 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200166 * iv_len+1 .. 15 length
167 *
168 * With flags as (bits):
169 * 7 0
170 * 6 add present?
171 * 5 .. 3 (t - 2) / 2
172 * 2 .. 0 q - 1
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200173 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200174 ctx->y[0] |= ( ctx->add_len > 0 ) << 6;
175 ctx->y[0] |= ( ( ctx->tag_len - 2 ) / 2 ) << 3;
176 ctx->y[0] |= ctx->q - 1;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200177
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200178 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200179 ctx->y[15-i] = (unsigned char)( len_left & 0xFF );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200180
181 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200182 {
183 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200184 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200185 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200186
187 /* Start CBC-MAC with first block*/
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200188 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
189 {
190 ctx->state |= CCM_STATE__ERROR;
191 return( ret );
192 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200193
194 return (0);
195}
196
197int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
198 int mode,
199 const unsigned char *iv,
200 size_t iv_len )
201{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200202 CCM_VALIDATE_RET( ctx != NULL );
203 CCM_VALIDATE_RET( iv != NULL );
204 CCM_VALIDATE_RET( mode == MBEDTLS_CCM_DECRYPT || \
205 mode == MBEDTLS_CCM_STAR_DECRYPT || \
206 mode == MBEDTLS_CCM_ENCRYPT || \
207 mode == MBEDTLS_CCM_STAR_ENCRYPT );
208
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200209 /* Also implies q is within bounds */
210 if( iv_len < 7 || iv_len > 13 )
211 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200212
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200213 if( ctx->state & CCM_STATE__ERROR )
214 {
215 mbedtls_ccm_clear_state(ctx);
216 }
217
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200218 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200219 ctx->q = 16 - 1 - (unsigned char) iv_len;
220
221 /*
222 * Prepare counter block for encryption:
223 * 0 .. 0 flags
224 * 1 .. iv_len nonce (aka iv)
225 * iv_len+1 .. 15 counter (initially 1)
226 *
227 * With flags as (bits):
228 * 7 .. 3 0
229 * 2 .. 0 q - 1
230 */
231 memset( ctx->ctr, 0, 16);
232 ctx->ctr[0] = ctx->q - 1;
233 memcpy( ctx->ctr + 1, iv, iv_len );
234 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
235 ctx->ctr[15] = 1;
236
237 /*
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200238 * See mbedtls_ccm_calculate_first_block() for block layout description
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200239 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200240 memcpy( ctx->y + 1, iv, iv_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200241
242 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200243 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200244}
245
246int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
247 size_t total_ad_len,
248 size_t plaintext_len,
249 size_t tag_len )
250{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200251 CCM_VALIDATE_RET( ctx != NULL );
252
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200253 /*
254 * Check length requirements: SP800-38C A.1
255 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
256 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100257 *
258 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200259 */
Janos Follath997e85c2018-05-29 11:33:45 +0100260 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100261 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200262
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200263 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200265
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200266 if( ctx->state & CCM_STATE__ERROR )
267 {
268 mbedtls_ccm_clear_state(ctx);
269 }
270
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200271 ctx->plaintext_len = plaintext_len;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200272 ctx->add_len = total_ad_len;
273 ctx->tag_len = tag_len;
274 ctx->processed = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200275
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200276 ctx->state |= CCM_STATE__LENGHTS_SET;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200277 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200278}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200279
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200280int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
281 const unsigned char *add,
282 size_t add_len )
283{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200284 CCM_VALIDATE_RET( ctx->add_len == 0 || add != NULL );
285
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200286 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 Starzyk663055f2021-07-12 19:13:52 +0200294 ctx->y[0] ^= (unsigned char)( ( ctx->add_len >> 8 ) & 0xFF );
295 ctx->y[1] ^= (unsigned char)( ( ctx->add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200296
Mateusz Starzyk33392452021-07-06 15:38:35 +0200297 ctx->processed += 2;
298 }
299
300 while( add_len > 0 )
301 {
302 offset = ctx->processed % 16;
303
304 use_len = 16 - offset;
305
306 if( use_len > add_len )
307 use_len = add_len;
308
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200309 for( i = 0; i < use_len; i++ )
310 ctx->y[i + offset] ^= add[i];
311
Mateusz Starzyk33392452021-07-06 15:38:35 +0200312 ctx->processed += use_len;
313 add_len -= use_len;
314 add += use_len;
315
316 if( use_len + offset == 16 || ctx->processed - 2 == ctx->add_len )
317 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200318 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
319 {
320 ctx->state |= CCM_STATE__ERROR;
321 return( ret );
322 }
Mateusz Starzyk33392452021-07-06 15:38:35 +0200323 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200324 }
325 }
326
Mateusz Starzyk33392452021-07-06 15:38:35 +0200327 if( ctx->processed - 2 == ctx->add_len )
328 ctx->processed = 0; // prepare for mbedtls_ccm_update()
329
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200330 return (0);
331}
332
333int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
334 const unsigned char *input, size_t input_len,
335 unsigned char *output, size_t output_size,
336 size_t *output_len )
337{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200338 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || input != NULL );
339 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || output != NULL );
340
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200341 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
342 unsigned char i;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200343 size_t use_len, offset, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200344
345 if( output_size < input_len )
346 return( MBEDTLS_ERR_CCM_BAD_INPUT );
347 CCM_VALIDATE_RET( output_length != NULL );
348 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200349
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200350 while ( input_len > 0 )
351 {
352 offset = ctx->processed % 16;
353
354 use_len = 16 - offset;
355
356 if( use_len > input_len )
357 use_len = input_len;
358
359 ctx->processed += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200360
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200361 if( ctx->mode == MBEDTLS_CCM_ENCRYPT || \
362 ctx->mode == MBEDTLS_CCM_STAR_ENCRYPT )
363 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200364 for( i = 0; i < use_len; i++ )
365 ctx->y[i + offset] ^= input[i];
366
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200367 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
368 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200369 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
370 {
371 ctx->state |= CCM_STATE__ERROR;
372 return( ret );
373 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200374 }
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200375
376 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200377 if( ret != 0 )
378 return ret;
379 }
380
381 if( ctx->mode == MBEDTLS_CCM_DECRYPT || \
382 ctx->mode == MBEDTLS_CCM_STAR_DECRYPT )
383 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200384 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200385 if( ret != 0 )
386 return ret;
387
388 for( i = 0; i < use_len; i++ )
389 ctx->y[i + offset] ^= output[i];
390
391 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
392 {
393 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
394 {
395 ctx->state |= CCM_STATE__ERROR;
396 return( ret );
397 }
398 }
399 }
400
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200401 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
402 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200403 for( i = 0; i < ctx->q; i++ )
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200404 if( ++(ctx->ctr)[15-i] != 0 )
405 break;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200406 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200407
408 input_len -= use_len;
409 input += use_len;
410 output += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200411 }
412
413 return 0;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200414}
415
416int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
417 unsigned char *tag, size_t tag_len )
418{
419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
420 unsigned char i;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200421
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200422 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200423 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200424 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200425 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200426 for( i = 0; i < ctx->q; i++ )
427 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200428
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200429 ret = mbedtls_ccm_crypt( ctx, 0, 16, ctx->y, ctx->y );
430 if( ret != 0 )
431 return ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200432 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200433 mbedtls_ccm_clear_state(ctx);
434
435 return( 0 );
436}
437
438/*
439 * Authenticated encryption or decryption
440 */
441static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
442 const unsigned char *iv, size_t iv_len,
443 const unsigned char *add, size_t add_len,
444 const unsigned char *input, unsigned char *output,
445 unsigned char *tag, size_t tag_len )
446{
447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
448 size_t olen;
449
450 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
451 return( ret );
452
453 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
454 return( ret );
455
456 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
457 return( ret );
458
459 if( ( ret = mbedtls_ccm_update( ctx, input, length,
460 output, length, &olen ) ) != 0 )
461 return( ret );
462
463 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
464 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200465
466 return( 0 );
467}
468
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200469/*
470 * Authenticated encryption
471 */
Janos Follathb5734a22018-05-14 14:31:49 +0100472int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200473 const unsigned char *iv, size_t iv_len,
474 const unsigned char *add, size_t add_len,
475 const unsigned char *input, unsigned char *output,
476 unsigned char *tag, size_t tag_len )
477{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200478 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_ENCRYPT, length, iv, iv_len,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200479 add, add_len, input, output, tag, tag_len ) );
480}
481
Janos Follathb5734a22018-05-14 14:31:49 +0100482int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
483 const unsigned char *iv, size_t iv_len,
484 const unsigned char *add, size_t add_len,
485 const unsigned char *input, unsigned char *output,
486 unsigned char *tag, size_t tag_len )
487{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200488 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_ENCRYPT, length, iv, iv_len,
489 add, add_len, input, output, tag, tag_len ) );
490}
Janos Follathb5734a22018-05-14 14:31:49 +0100491
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200492static int mbedtls_ccm_compare_tags(const unsigned char *tag1, const unsigned char *tag2, size_t tag_len)
493{
494 unsigned char i;
495 int diff;
496
497 /* Check tag in "constant-time" */
498 for( diff = 0, i = 0; i < tag_len; i++ )
499 diff |= tag1[i] ^ tag2[i];
500
501 if( diff != 0 )
502 {
503 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
504 }
505
506 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100507}
508
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200509/*
510 * Authenticated decryption
511 */
Janos Follathb5734a22018-05-14 14:31:49 +0100512int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200513 const unsigned char *iv, size_t iv_len,
514 const unsigned char *add, size_t add_len,
515 const unsigned char *input, unsigned char *output,
516 const unsigned char *tag, size_t tag_len )
517{
Janos Follath24eed8d2019-11-22 13:21:35 +0000518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200519 unsigned char check_tag[16];
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200520
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200521 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_DECRYPT, length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200522 iv, iv_len, add, add_len,
523 input, output, check_tag, tag_len ) ) != 0 )
524 {
525 return( ret );
526 }
527
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200528 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200529 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500530 mbedtls_platform_zeroize( output, length );
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200531 return( ret );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200532 }
533
534 return( 0 );
535}
536
Janos Follathb5734a22018-05-14 14:31:49 +0100537int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
538 const unsigned char *iv, size_t iv_len,
539 const unsigned char *add, size_t add_len,
540 const unsigned char *input, unsigned char *output,
541 const unsigned char *tag, size_t tag_len )
542{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
544 unsigned char check_tag[16];
k-stachowiakf7125342018-12-11 15:57:19 +0100545
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200546 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_DECRYPT, length,
547 iv, iv_len, add, add_len,
548 input, output, check_tag, tag_len ) ) != 0 )
549 {
550 return( ret );
551 }
Janos Follathb5734a22018-05-14 14:31:49 +0100552
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200553 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
554 {
555 mbedtls_platform_zeroize( output, length );
556 return( ret );
557 }
558
559 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100560}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200561#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200564/*
565 * Examples 1 to 3 from SP800-38C Appendix C
566 */
567
568#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300569#define CCM_SELFTEST_PT_MAX_LEN 24
570#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200571/*
572 * The data is the same for all tests, only the used length changes
573 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100574static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200575 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
576 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
577};
578
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100579static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200580 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
581 0x18, 0x19, 0x1a, 0x1b
582};
583
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100584static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200585 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
586 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
587 0x10, 0x11, 0x12, 0x13
588};
589
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100590static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200591 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
592 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
593 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
594};
595
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100596static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
597static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
598static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
599static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200600
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100601static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200602 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
603 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
604 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
605 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
606 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
607 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
608 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
609 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
610};
611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200613{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300615 /*
616 * Some hardware accelerators require the input and output buffers
617 * would be in RAM, because the flash is not accessible.
618 * Use buffers on the stack to hold the test vectors data.
619 */
620 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
621 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200622 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000623 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200624
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200625 mbedtls_ccm_init( &ctx );
626
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500627 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
628 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200629 {
630 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200632
633 return( 1 );
634 }
635
636 for( i = 0; i < NB_TESTS; i++ )
637 {
638 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200639 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200640
Ron Eldor1b9b2172018-04-26 14:15:01 +0300641 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
642 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100643 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300644
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100645 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100646 iv_test_data, iv_len_test_data[i],
647 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300648 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500649 ciphertext + msg_len_test_data[i],
650 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200651
652 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500653 memcmp( ciphertext, res_test_data[i],
654 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200655 {
656 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200657 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200658
659 return( 1 );
660 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300661 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200662
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100663 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100664 iv_test_data, iv_len_test_data[i],
665 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300666 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500667 ciphertext + msg_len_test_data[i],
668 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200669
670 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100671 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200672 {
673 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200675
676 return( 1 );
677 }
678
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200679 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200681 }
682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200684
685 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200687
688 return( 0 );
689}
690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693#endif /* MBEDTLS_CCM_C */