blob: a6ba77435c5034d6ea9ae808c20d637e4a49c1a9 [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
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +020050
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020051/*
52 * Initialize context
53 */
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020054void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
55{
56 memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
57}
58
59int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
60 mbedtls_cipher_id_t cipher,
61 const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020062 unsigned int keybits )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020063{
Janos Follath24eed8d2019-11-22 13:21:35 +000064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065 const mbedtls_cipher_info_t *cipher_info;
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020066
Andrzej Kurekee3c4352019-01-10 03:10:02 -050067 cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
68 MBEDTLS_MODE_ECB );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020069 if( cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020071
72 if( cipher_info->block_size != 16 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020074
Manuel Pégourié-Gonnard43b08572015-05-27 17:23:30 +020075 mbedtls_cipher_free( &ctx->cipher_ctx );
76
Manuel Pégourié-Gonnard8473f872015-05-14 13:51:45 +020077 if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020078 return( ret );
79
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020080 if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081 MBEDTLS_ENCRYPT ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020082 {
83 return( ret );
84 }
85
86 return( 0 );
87}
88
89/*
90 * Free context
91 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020093{
k-stachowiakfd42d532018-12-11 14:37:51 +010094 if( ctx == NULL )
95 return;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020096 mbedtls_cipher_free( &ctx->cipher_ctx );
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050097 mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020098}
99
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200100#define CCM_STATE__CLEAR 0
Mateusz Starzyka9cbdfb2021-07-27 13:49:54 +0200101#define CCM_STATE__STARTED (1 << 0)
102#define CCM_STATE__LENGHTS_SET (1 << 1)
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200103#define CCM_STATE__AUTH_DATA_FINISHED (1 << 2)
104#define CCM_STATE__ERROR (1 << 4)
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200105
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200106/*
107 * Encrypt or decrypt a partial block with CTR
108 */
109static int mbedtls_ccm_crypt( mbedtls_ccm_context *ctx,
110 size_t offset, size_t use_len,
111 const unsigned char *input,
112 unsigned char *output )
113{
114 size_t i;
115 size_t olen = 0;
116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
117 unsigned char tmp_buf[16] = {0};
118
119 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, 16, tmp_buf,
120 &olen ) ) != 0 )
121 {
Mateusz Starzyk2d5652a2021-07-27 16:07:54 +0200122 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzykc52220d2021-07-27 13:54:55 +0200123 mbedtls_platform_zeroize(tmp_buf, sizeof(tmp_buf));
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200124 return ret;
125 }
126
127 for( i = 0; i < use_len; i++ )
128 output[i] = input[i] ^ tmp_buf[offset + i];
129
Mateusz Starzykc52220d2021-07-27 13:54:55 +0200130 mbedtls_platform_zeroize(tmp_buf, sizeof(tmp_buf));
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200131 return ret;
132}
133
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200134static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
135 ctx->state = CCM_STATE__CLEAR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200136 memset( ctx->y, 0, 16);
137 memset( ctx->ctr, 0, 16);
138}
139
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200140static int ccm_calculate_first_block_if_ready(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200141{
Janos Follath24eed8d2019-11-22 13:21:35 +0000142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200143 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200144 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200145
146 /* length calulcation can be done only after both
147 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
148 */
149 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
150 return 0;
151
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200152 if( ctx->tag_len == 0 && \
153 ( ctx->mode == MBEDTLS_CCM_ENCRYPT || ctx->mode == MBEDTLS_CCM_DECRYPT ) )
154 return( MBEDTLS_ERR_CCM_BAD_INPUT );
155
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200156 /*
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200157 * First block:
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200158 * 0 .. 0 flags
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200159 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200160 * iv_len+1 .. 15 length
161 *
162 * With flags as (bits):
163 * 7 0
164 * 6 add present?
165 * 5 .. 3 (t - 2) / 2
166 * 2 .. 0 q - 1
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200167 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200168 ctx->y[0] |= ( ctx->add_len > 0 ) << 6;
169 ctx->y[0] |= ( ( ctx->tag_len - 2 ) / 2 ) << 3;
170 ctx->y[0] |= ctx->q - 1;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200171
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200172 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200173 ctx->y[15-i] = (unsigned char)( len_left & 0xFF );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200174
175 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200176 {
177 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200178 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200179 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200180
181 /* Start CBC-MAC with first block*/
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200182 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
183 {
184 ctx->state |= CCM_STATE__ERROR;
185 return( ret );
186 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200187
188 return (0);
189}
190
191int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
192 int mode,
193 const unsigned char *iv,
194 size_t iv_len )
195{
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200196 /* Also implies q is within bounds */
197 if( iv_len < 7 || iv_len > 13 )
198 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200199
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200200 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200201 ctx->q = 16 - 1 - (unsigned char) iv_len;
202
203 /*
204 * Prepare counter block for encryption:
205 * 0 .. 0 flags
206 * 1 .. iv_len nonce (aka iv)
207 * iv_len+1 .. 15 counter (initially 1)
208 *
209 * With flags as (bits):
210 * 7 .. 3 0
211 * 2 .. 0 q - 1
212 */
213 memset( ctx->ctr, 0, 16);
214 ctx->ctr[0] = ctx->q - 1;
215 memcpy( ctx->ctr + 1, iv, iv_len );
216 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
217 ctx->ctr[15] = 1;
218
219 /*
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200220 * See ccm_calculate_first_block_if_ready() for block layout description
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200221 */
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200222 memcpy( ctx->y + 1, iv, iv_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200223
224 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200225 return ccm_calculate_first_block_if_ready(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200226}
227
228int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
229 size_t total_ad_len,
230 size_t plaintext_len,
231 size_t tag_len )
232{
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200233 /*
234 * Check length requirements: SP800-38C A.1
235 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
236 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100237 *
238 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200239 */
Janos Follath997e85c2018-05-29 11:33:45 +0100240 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100241 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200242
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200243 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200245
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200246 ctx->plaintext_len = plaintext_len;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200247 ctx->add_len = total_ad_len;
248 ctx->tag_len = tag_len;
249 ctx->processed = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200250
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200251 ctx->state |= CCM_STATE__LENGHTS_SET;
Mateusz Starzykca9dc8d2021-07-27 14:03:53 +0200252 return ccm_calculate_first_block_if_ready(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200253}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200254
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200255int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
256 const unsigned char *add,
257 size_t add_len )
258{
259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
260 unsigned char i;
Mateusz Starzyk33392452021-07-06 15:38:35 +0200261 size_t olen, use_len, offset;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200262
Mateusz Starzyk2d5652a2021-07-27 16:07:54 +0200263 if( ctx->state & CCM_STATE__ERROR )
264 {
265 return ret;
266 }
267
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200268 if( ctx->add_len > 0 && add_len > 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200269 {
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200270 if( ctx->state & CCM_STATE__AUTH_DATA_FINISHED )
271 {
272 return ret;
273 }
274
Mateusz Starzyk33392452021-07-06 15:38:35 +0200275 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200276 {
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200277 if ( add_len > ctx->add_len )
278 {
279 return MBEDTLS_ERR_CCM_BAD_INPUT;
280 }
281
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200282 ctx->y[0] ^= (unsigned char)( ( ctx->add_len >> 8 ) & 0xFF );
283 ctx->y[1] ^= (unsigned char)( ( ctx->add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200284
Mateusz Starzyk33392452021-07-06 15:38:35 +0200285 ctx->processed += 2;
286 }
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200287 else if ( ctx->processed - 2 + add_len > ctx->add_len )
288 {
289 return MBEDTLS_ERR_CCM_BAD_INPUT;
290 }
Mateusz Starzyk33392452021-07-06 15:38:35 +0200291
292 while( add_len > 0 )
293 {
294 offset = ctx->processed % 16;
295
296 use_len = 16 - offset;
297
298 if( use_len > add_len )
299 use_len = add_len;
300
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200301 for( i = 0; i < use_len; i++ )
302 ctx->y[i + offset] ^= add[i];
303
Mateusz Starzyk33392452021-07-06 15:38:35 +0200304 ctx->processed += use_len;
305 add_len -= use_len;
306 add += use_len;
307
308 if( use_len + offset == 16 || ctx->processed - 2 == ctx->add_len )
309 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200310 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
311 {
312 ctx->state |= CCM_STATE__ERROR;
313 return( ret );
314 }
Mateusz Starzyk33392452021-07-06 15:38:35 +0200315 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200316 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200317
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200318 if( ctx->processed - 2 == ctx->add_len )
319 {
320 ctx->state |= CCM_STATE__AUTH_DATA_FINISHED;
321 ctx->processed = 0; // prepare for mbedtls_ccm_update()
322 }
323 }
Mateusz Starzyk33392452021-07-06 15:38:35 +0200324
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200325 return (0);
326}
327
328int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
329 const unsigned char *input, size_t input_len,
330 unsigned char *output, size_t output_size,
331 size_t *output_len )
332{
333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
334 unsigned char i;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200335 size_t use_len, offset, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200336
Mateusz Starzyk2d5652a2021-07-27 16:07:54 +0200337 if( ctx->state & CCM_STATE__ERROR )
338 {
339 return ret;
340 }
341
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200342 if( ctx->processed + input_len > ctx->plaintext_len )
343 {
344 return MBEDTLS_ERR_CCM_BAD_INPUT;
345 }
346
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200347 if( output_size < input_len )
348 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200349 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200350
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200351 while ( input_len > 0 )
352 {
353 offset = ctx->processed % 16;
354
355 use_len = 16 - offset;
356
357 if( use_len > input_len )
358 use_len = input_len;
359
360 ctx->processed += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200361
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200362 if( ctx->mode == MBEDTLS_CCM_ENCRYPT || \
363 ctx->mode == MBEDTLS_CCM_STAR_ENCRYPT )
364 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200365 for( i = 0; i < use_len; i++ )
366 ctx->y[i + offset] ^= input[i];
367
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200368 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
369 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200370 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
371 {
372 ctx->state |= CCM_STATE__ERROR;
373 return( ret );
374 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200375 }
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200376
377 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200378 if( ret != 0 )
379 return ret;
380 }
381
382 if( ctx->mode == MBEDTLS_CCM_DECRYPT || \
383 ctx->mode == MBEDTLS_CCM_STAR_DECRYPT )
384 {
Mateusz Starzyk663055f2021-07-12 19:13:52 +0200385 ret = mbedtls_ccm_crypt( ctx, offset, use_len, input, output );
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200386 if( ret != 0 )
387 return ret;
388
389 for( i = 0; i < use_len; i++ )
390 ctx->y[i + offset] ^= output[i];
391
392 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
393 {
394 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
395 {
396 ctx->state |= CCM_STATE__ERROR;
397 return( ret );
398 }
399 }
400 }
401
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200402 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
403 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200404 for( i = 0; i < ctx->q; i++ )
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200405 if( ++(ctx->ctr)[15-i] != 0 )
406 break;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200407 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200408
409 input_len -= use_len;
410 input += use_len;
411 output += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200412 }
413
414 return 0;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200415}
416
417int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
418 unsigned char *tag, size_t tag_len )
419{
420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
421 unsigned char i;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200422
Mateusz Starzyk2d5652a2021-07-27 16:07:54 +0200423 if( ctx->state & CCM_STATE__ERROR )
424 {
425 return ret;
426 }
427
Mateusz Starzyk36d3b892021-07-28 14:14:58 +0200428 if( ctx->add_len > 0 && !( ctx->state & CCM_STATE__AUTH_DATA_FINISHED ) )
429 {
430 return ret;
431 }
432
433 if( ctx->plaintext_len > 0 && ctx->processed != ctx->plaintext_len )
434 {
435 return ret;
436 }
437
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200438 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200439 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200440 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200441 for( i = 0; i < ctx->q; i++ )
442 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200443
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200444 ret = mbedtls_ccm_crypt( ctx, 0, 16, ctx->y, ctx->y );
445 if( ret != 0 )
446 return ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200447 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200448 mbedtls_ccm_clear_state(ctx);
449
450 return( 0 );
451}
452
453/*
454 * Authenticated encryption or decryption
455 */
456static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
457 const unsigned char *iv, size_t iv_len,
458 const unsigned char *add, size_t add_len,
459 const unsigned char *input, unsigned char *output,
460 unsigned char *tag, size_t tag_len )
461{
462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
463 size_t olen;
464
465 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
466 return( ret );
467
468 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
469 return( ret );
470
471 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
472 return( ret );
473
474 if( ( ret = mbedtls_ccm_update( ctx, input, length,
475 output, length, &olen ) ) != 0 )
476 return( ret );
477
478 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
479 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200480
481 return( 0 );
482}
483
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200484/*
485 * Authenticated encryption
486 */
Janos Follathb5734a22018-05-14 14:31:49 +0100487int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200488 const unsigned char *iv, size_t iv_len,
489 const unsigned char *add, size_t add_len,
490 const unsigned char *input, unsigned char *output,
491 unsigned char *tag, size_t tag_len )
492{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200493 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_ENCRYPT, length, iv, iv_len,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200494 add, add_len, input, output, tag, tag_len ) );
495}
496
Janos Follathb5734a22018-05-14 14:31:49 +0100497int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
498 const unsigned char *iv, size_t iv_len,
499 const unsigned char *add, size_t add_len,
500 const unsigned char *input, unsigned char *output,
501 unsigned char *tag, size_t tag_len )
502{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200503 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_ENCRYPT, length, iv, iv_len,
504 add, add_len, input, output, tag, tag_len ) );
505}
Janos Follathb5734a22018-05-14 14:31:49 +0100506
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200507static int mbedtls_ccm_compare_tags(const unsigned char *tag1, const unsigned char *tag2, size_t tag_len)
508{
509 unsigned char i;
510 int diff;
511
512 /* Check tag in "constant-time" */
513 for( diff = 0, i = 0; i < tag_len; i++ )
514 diff |= tag1[i] ^ tag2[i];
515
516 if( diff != 0 )
517 {
518 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
519 }
520
521 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100522}
523
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200524/*
525 * Authenticated decryption
526 */
Janos Follathb5734a22018-05-14 14:31:49 +0100527int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200528 const unsigned char *iv, size_t iv_len,
529 const unsigned char *add, size_t add_len,
530 const unsigned char *input, unsigned char *output,
531 const unsigned char *tag, size_t tag_len )
532{
Janos Follath24eed8d2019-11-22 13:21:35 +0000533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200534 unsigned char check_tag[16];
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200535
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200536 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_DECRYPT, length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200537 iv, iv_len, add, add_len,
538 input, output, check_tag, tag_len ) ) != 0 )
539 {
540 return( ret );
541 }
542
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200543 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200544 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500545 mbedtls_platform_zeroize( output, length );
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200546 return( ret );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200547 }
548
549 return( 0 );
550}
551
Janos Follathb5734a22018-05-14 14:31:49 +0100552int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
553 const unsigned char *iv, size_t iv_len,
554 const unsigned char *add, size_t add_len,
555 const unsigned char *input, unsigned char *output,
556 const unsigned char *tag, size_t tag_len )
557{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200558 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
559 unsigned char check_tag[16];
k-stachowiakf7125342018-12-11 15:57:19 +0100560
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200561 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_DECRYPT, length,
562 iv, iv_len, add, add_len,
563 input, output, check_tag, tag_len ) ) != 0 )
564 {
565 return( ret );
566 }
Janos Follathb5734a22018-05-14 14:31:49 +0100567
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200568 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
569 {
570 mbedtls_platform_zeroize( output, length );
571 return( ret );
572 }
573
574 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100575}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200576#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200579/*
580 * Examples 1 to 3 from SP800-38C Appendix C
581 */
582
583#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300584#define CCM_SELFTEST_PT_MAX_LEN 24
585#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200586/*
587 * The data is the same for all tests, only the used length changes
588 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100589static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200590 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
591 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
592};
593
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100594static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200595 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
596 0x18, 0x19, 0x1a, 0x1b
597};
598
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100599static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200600 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
601 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
602 0x10, 0x11, 0x12, 0x13
603};
604
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100605static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200606 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
607 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
608 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
609};
610
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100611static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
612static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
613static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
614static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200615
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100616static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200617 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
618 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
619 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
620 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
621 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
622 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
623 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
624 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
625};
626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200628{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300630 /*
631 * Some hardware accelerators require the input and output buffers
632 * would be in RAM, because the flash is not accessible.
633 * Use buffers on the stack to hold the test vectors data.
634 */
635 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
636 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200637 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200639
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200640 mbedtls_ccm_init( &ctx );
641
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500642 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
643 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200644 {
645 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200646 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200647
648 return( 1 );
649 }
650
651 for( i = 0; i < NB_TESTS; i++ )
652 {
653 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200655
Ron Eldor1b9b2172018-04-26 14:15:01 +0300656 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
657 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100658 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300659
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100660 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100661 iv_test_data, iv_len_test_data[i],
662 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300663 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500664 ciphertext + msg_len_test_data[i],
665 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200666
667 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500668 memcmp( ciphertext, res_test_data[i],
669 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200670 {
671 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200673
674 return( 1 );
675 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300676 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200677
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100678 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100679 iv_test_data, iv_len_test_data[i],
680 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300681 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500682 ciphertext + msg_len_test_data[i],
683 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200684
685 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100686 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200687 {
688 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200690
691 return( 1 );
692 }
693
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200694 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200696 }
697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200699
700 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200702
703 return( 0 );
704}
705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708#endif /* MBEDTLS_CCM_C */