blob: 5450e408c1062193007358a60704bfb2382d41d2 [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
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200109/*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200110 * Update the CBC-MAC state in y using a block in b
111 * (Always using b as the source helps the compiler optimise a bit better.)
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200112 *
113 * Macro results in smaller compiled code than static inline functions.
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200114 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200115#define UPDATE_CBC_MAC \
116 for( i = 0; i < 16; i++ ) \
117 ctx->y[i] ^= ctx->b[i]; \
118 \
119 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 ) \
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200120 { \
121 ctx->state |= CCM_STATE__ERROR; \
122 return( ret ); \
123 } \
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200124
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200125#define CCM_STATE__CLEAR 0
126#define CCM_STATE__STARTED 0x0001
127#define CCM_STATE__LENGHTS_SET 0x0002
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200128#define CCM_STATE__ERROR 0x0004
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200129
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200130/*
131 * Encrypt or decrypt a partial block with CTR
132 */
133static int mbedtls_ccm_crypt( mbedtls_ccm_context *ctx,
134 size_t offset, size_t use_len,
135 const unsigned char *input,
136 unsigned char *output )
137{
138 size_t i;
139 size_t olen = 0;
140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
141 unsigned char tmp_buf[16] = {0};
142
143 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, 16, tmp_buf,
144 &olen ) ) != 0 )
145 {
146 ctx->state |= CCM_STATE__ERROR; \
147 return ret;
148 }
149
150 for( i = 0; i < use_len; i++ )
151 output[i] = input[i] ^ tmp_buf[offset + i];
152
153 return ret;
154}
155
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200156static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
157 ctx->state = CCM_STATE__CLEAR;
158 memset( ctx->b, 0, 16);
159 memset( ctx->y, 0, 16);
160 memset( ctx->ctr, 0, 16);
161}
162
163static int mbedtls_ccm_calculate_first_block(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200164{
Janos Follath24eed8d2019-11-22 13:21:35 +0000165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200166 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200167 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200168
169 /* length calulcation can be done only after both
170 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
171 */
172 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
173 return 0;
174
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200175 if( ctx->tag_len == 0 && \
176 ( ctx->mode == MBEDTLS_CCM_ENCRYPT || ctx->mode == MBEDTLS_CCM_DECRYPT ) )
177 return( MBEDTLS_ERR_CCM_BAD_INPUT );
178
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200179 /*
180 * First block B_0:
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200181 * 0 .. 0 flags
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200182 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200183 * iv_len+1 .. 15 length
184 *
185 * With flags as (bits):
186 * 7 0
187 * 6 add present?
188 * 5 .. 3 (t - 2) / 2
189 * 2 .. 0 q - 1
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200190 */
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200191 ctx->b[0] |= ( ctx->add_len > 0 ) << 6;
192 ctx->b[0] |= ( ( ctx->tag_len - 2 ) / 2 ) << 3;
193 ctx->b[0] |= ctx->q - 1;
194
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200195 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
196 ctx->b[15-i] = (unsigned char)( len_left & 0xFF );
197
198 if( len_left > 0 )
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200199 {
200 ctx->state |= CCM_STATE__ERROR;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200201 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200202 }
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200203
204 /* Start CBC-MAC with first block*/
205 UPDATE_CBC_MAC;
206
207 return (0);
208}
209
210int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
211 int mode,
212 const unsigned char *iv,
213 size_t iv_len )
214{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200215 CCM_VALIDATE_RET( ctx != NULL );
216 CCM_VALIDATE_RET( iv != NULL );
217 CCM_VALIDATE_RET( mode == MBEDTLS_CCM_DECRYPT || \
218 mode == MBEDTLS_CCM_STAR_DECRYPT || \
219 mode == MBEDTLS_CCM_ENCRYPT || \
220 mode == MBEDTLS_CCM_STAR_ENCRYPT );
221
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200222 /* Also implies q is within bounds */
223 if( iv_len < 7 || iv_len > 13 )
224 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200225
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200226 if( ctx->state & CCM_STATE__ERROR )
227 {
228 mbedtls_ccm_clear_state(ctx);
229 }
230
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200231 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200232 ctx->q = 16 - 1 - (unsigned char) iv_len;
233
234 /*
235 * Prepare counter block for encryption:
236 * 0 .. 0 flags
237 * 1 .. iv_len nonce (aka iv)
238 * iv_len+1 .. 15 counter (initially 1)
239 *
240 * With flags as (bits):
241 * 7 .. 3 0
242 * 2 .. 0 q - 1
243 */
244 memset( ctx->ctr, 0, 16);
245 ctx->ctr[0] = ctx->q - 1;
246 memcpy( ctx->ctr + 1, iv, iv_len );
247 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
248 ctx->ctr[15] = 1;
249
250 /*
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200251 * See mbedtls_ccm_calculate_first_block() for B block layout description
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200252 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200253 memcpy( ctx->b + 1, iv, iv_len );
254
255 ctx->state |= CCM_STATE__STARTED;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200256 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200257}
258
259int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
260 size_t total_ad_len,
261 size_t plaintext_len,
262 size_t tag_len )
263{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200264 CCM_VALIDATE_RET( ctx != NULL );
265
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200266 /*
267 * Check length requirements: SP800-38C A.1
268 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
269 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100270 *
271 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200272 */
Janos Follath997e85c2018-05-29 11:33:45 +0100273 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100274 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200275
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200276 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200278
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200279 if( ctx->state & CCM_STATE__ERROR )
280 {
281 mbedtls_ccm_clear_state(ctx);
282 }
283
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200284 ctx->plaintext_len = plaintext_len;
Mateusz Starzykeb2ca962021-07-06 12:45:11 +0200285 ctx->add_len = total_ad_len;
286 ctx->tag_len = tag_len;
287 ctx->processed = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200288
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200289 ctx->state |= CCM_STATE__LENGHTS_SET;
Mateusz Starzyk88c4d622021-07-05 17:09:16 +0200290 return mbedtls_ccm_calculate_first_block(ctx);
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200291}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200292
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200293int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
294 const unsigned char *add,
295 size_t add_len )
296{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200297 CCM_VALIDATE_RET( ctx->add_len == 0 || add != NULL );
298
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
300 unsigned char i;
Mateusz Starzyk33392452021-07-06 15:38:35 +0200301 size_t olen, use_len, offset;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200302
Mateusz Starzyk33392452021-07-06 15:38:35 +0200303 if( ctx->add_len > 0 && add_len > 0)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200304 {
Mateusz Starzyk33392452021-07-06 15:38:35 +0200305 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200306 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200307 memset( ctx->b, 0, 16 );
Mateusz Starzyk33392452021-07-06 15:38:35 +0200308 ctx->b[0] = (unsigned char)( ( ctx->add_len >> 8 ) & 0xFF );
309 ctx->b[1] = (unsigned char)( ( ctx->add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200310
Mateusz Starzyk33392452021-07-06 15:38:35 +0200311 ctx->processed += 2;
312 }
313
314 while( add_len > 0 )
315 {
316 offset = ctx->processed % 16;
317
318 use_len = 16 - offset;
319
320 if( use_len > add_len )
321 use_len = add_len;
322
323 memcpy( ctx->b + offset, add, use_len );
324 ctx->processed += use_len;
325 add_len -= use_len;
326 add += use_len;
327
328 if( use_len + offset == 16 || ctx->processed - 2 == ctx->add_len )
329 {
330 UPDATE_CBC_MAC;
331 memset( ctx->b, 0, 16 );
332 }
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200333 }
334 }
335
Mateusz Starzyk33392452021-07-06 15:38:35 +0200336 if( ctx->processed - 2 == ctx->add_len )
337 ctx->processed = 0; // prepare for mbedtls_ccm_update()
338
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200339 return (0);
340}
341
342int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
343 const unsigned char *input, size_t input_len,
344 unsigned char *output, size_t output_size,
345 size_t *output_len )
346{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200347 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || input != NULL );
348 CCM_VALIDATE_RET( ctx->plaintext_len == 0 || output != NULL );
349
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
351 unsigned char i;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200352 size_t use_len, offset, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200353
354 if( output_size < input_len )
355 return( MBEDTLS_ERR_CCM_BAD_INPUT );
356 CCM_VALIDATE_RET( output_length != NULL );
357 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200358
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200359 if( ctx->processed == 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200360 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200361 memset( ctx->b, 0, 16 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200362 }
363
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200364 while ( input_len > 0 )
365 {
366 offset = ctx->processed % 16;
367
368 use_len = 16 - offset;
369
370 if( use_len > input_len )
371 use_len = input_len;
372
373 ctx->processed += use_len;
374 memcpy( ctx->b + offset, input, use_len );
375
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200376 if( ctx->mode == MBEDTLS_CCM_ENCRYPT || \
377 ctx->mode == MBEDTLS_CCM_STAR_ENCRYPT )
378 {
379 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
380 {
381 UPDATE_CBC_MAC;
382 }
383 ret = mbedtls_ccm_crypt( ctx, offset, use_len, ctx->b + offset, output );
384 if( ret != 0 )
385 return ret;
386 }
387
388 if( ctx->mode == MBEDTLS_CCM_DECRYPT || \
389 ctx->mode == MBEDTLS_CCM_STAR_DECRYPT )
390 {
391 ret = mbedtls_ccm_crypt( ctx, offset, use_len, ctx->b + offset, output );
392 if( ret != 0 )
393 return ret;
394
395 for( i = 0; i < use_len; i++ )
396 ctx->y[i + offset] ^= output[i];
397
398 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
399 {
400 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 )
401 {
402 ctx->state |= CCM_STATE__ERROR;
403 return( ret );
404 }
405 }
406 }
407
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200408 if( use_len + offset == 16 || ctx->processed == ctx->plaintext_len )
409 {
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200410 for( i = 0; i < ctx->q; i++ )
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200411 if( ++(ctx->ctr)[15-i] != 0 )
412 break;
413 memset( ctx->b, 0, 16 );
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200414 }
Mateusz Starzyk20bac2f2021-07-12 14:52:44 +0200415
416 input_len -= use_len;
417 input += use_len;
418 output += use_len;
Mateusz Starzyk6a15bcf2021-07-07 13:41:30 +0200419 }
420
421 return 0;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200422}
423
424int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
425 unsigned char *tag, size_t tag_len )
426{
427 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
428 unsigned char i;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200429
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200430 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200431 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200432 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200433 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200434 for( i = 0; i < ctx->q; i++ )
435 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200436
Mateusz Starzyk2ad7d8e2021-07-07 11:05:45 +0200437 ret = mbedtls_ccm_crypt( ctx, 0, 16, ctx->y, ctx->y );
438 if( ret != 0 )
439 return ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200440 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200441 mbedtls_ccm_clear_state(ctx);
442
443 return( 0 );
444}
445
446/*
447 * Authenticated encryption or decryption
448 */
449static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
450 const unsigned char *iv, size_t iv_len,
451 const unsigned char *add, size_t add_len,
452 const unsigned char *input, unsigned char *output,
453 unsigned char *tag, size_t tag_len )
454{
455 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
456 size_t olen;
457
458 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
459 return( ret );
460
461 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
462 return( ret );
463
464 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
465 return( ret );
466
467 if( ( ret = mbedtls_ccm_update( ctx, input, length,
468 output, length, &olen ) ) != 0 )
469 return( ret );
470
471 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
472 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200473
474 return( 0 );
475}
476
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200477/*
478 * Authenticated encryption
479 */
Janos Follathb5734a22018-05-14 14:31:49 +0100480int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200481 const unsigned char *iv, size_t iv_len,
482 const unsigned char *add, size_t add_len,
483 const unsigned char *input, unsigned char *output,
484 unsigned char *tag, size_t tag_len )
485{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200486 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_ENCRYPT, length, iv, iv_len,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200487 add, add_len, input, output, tag, tag_len ) );
488}
489
Janos Follathb5734a22018-05-14 14:31:49 +0100490int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
491 const unsigned char *iv, size_t iv_len,
492 const unsigned char *add, size_t add_len,
493 const unsigned char *input, unsigned char *output,
494 unsigned char *tag, size_t tag_len )
495{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200496 return( ccm_auth_crypt( ctx, MBEDTLS_CCM_ENCRYPT, length, iv, iv_len,
497 add, add_len, input, output, tag, tag_len ) );
498}
Janos Follathb5734a22018-05-14 14:31:49 +0100499
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200500static int mbedtls_ccm_compare_tags(const unsigned char *tag1, const unsigned char *tag2, size_t tag_len)
501{
502 unsigned char i;
503 int diff;
504
505 /* Check tag in "constant-time" */
506 for( diff = 0, i = 0; i < tag_len; i++ )
507 diff |= tag1[i] ^ tag2[i];
508
509 if( diff != 0 )
510 {
511 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
512 }
513
514 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100515}
516
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200517/*
518 * Authenticated decryption
519 */
Janos Follathb5734a22018-05-14 14:31:49 +0100520int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200521 const unsigned char *iv, size_t iv_len,
522 const unsigned char *add, size_t add_len,
523 const unsigned char *input, unsigned char *output,
524 const unsigned char *tag, size_t tag_len )
525{
Janos Follath24eed8d2019-11-22 13:21:35 +0000526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200527 unsigned char check_tag[16];
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200528
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200529 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_STAR_DECRYPT, length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200530 iv, iv_len, add, add_len,
531 input, output, check_tag, tag_len ) ) != 0 )
532 {
533 return( ret );
534 }
535
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200536 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200537 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500538 mbedtls_platform_zeroize( output, length );
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200539 return( ret );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200540 }
541
542 return( 0 );
543}
544
Janos Follathb5734a22018-05-14 14:31:49 +0100545int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
546 const unsigned char *iv, size_t iv_len,
547 const unsigned char *add, size_t add_len,
548 const unsigned char *input, unsigned char *output,
549 const unsigned char *tag, size_t tag_len )
550{
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
552 unsigned char check_tag[16];
k-stachowiakf7125342018-12-11 15:57:19 +0100553
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200554 if( ( ret = ccm_auth_crypt( ctx, MBEDTLS_CCM_DECRYPT, length,
555 iv, iv_len, add, add_len,
556 input, output, check_tag, tag_len ) ) != 0 )
557 {
558 return( ret );
559 }
Janos Follathb5734a22018-05-14 14:31:49 +0100560
Mateusz Starzyk05e92d62021-07-09 12:44:07 +0200561 if( ( ret = mbedtls_ccm_compare_tags( tag, check_tag, tag_len ) ) != 0 )
562 {
563 mbedtls_platform_zeroize( output, length );
564 return( ret );
565 }
566
567 return( 0 );
Janos Follathb5734a22018-05-14 14:31:49 +0100568}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200569#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200572/*
573 * Examples 1 to 3 from SP800-38C Appendix C
574 */
575
576#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300577#define CCM_SELFTEST_PT_MAX_LEN 24
578#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200579/*
580 * The data is the same for all tests, only the used length changes
581 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100582static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200583 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
584 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
585};
586
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100587static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200588 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
589 0x18, 0x19, 0x1a, 0x1b
590};
591
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100592static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200593 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
594 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
595 0x10, 0x11, 0x12, 0x13
596};
597
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100598static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200599 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
600 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
601 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
602};
603
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100604static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
605static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
606static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
607static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200608
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100609static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200610 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
611 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
612 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
613 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
614 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
615 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
616 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
617 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
618};
619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200621{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300623 /*
624 * Some hardware accelerators require the input and output buffers
625 * would be in RAM, because the flash is not accessible.
626 * Use buffers on the stack to hold the test vectors data.
627 */
628 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
629 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200630 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000631 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200632
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200633 mbedtls_ccm_init( &ctx );
634
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500635 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
636 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200637 {
638 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200639 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200640
641 return( 1 );
642 }
643
644 for( i = 0; i < NB_TESTS; i++ )
645 {
646 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200648
Ron Eldor1b9b2172018-04-26 14:15:01 +0300649 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
650 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100651 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300652
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100653 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100654 iv_test_data, iv_len_test_data[i],
655 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300656 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500657 ciphertext + msg_len_test_data[i],
658 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200659
660 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500661 memcmp( ciphertext, res_test_data[i],
662 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200663 {
664 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200666
667 return( 1 );
668 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300669 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200670
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100671 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100672 iv_test_data, iv_len_test_data[i],
673 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300674 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500675 ciphertext + msg_len_test_data[i],
676 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200677
678 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100679 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200680 {
681 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200683
684 return( 1 );
685 }
686
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200687 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200689 }
690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200692
693 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200695
696 return( 0 );
697}
698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701#endif /* MBEDTLS_CCM_C */