blob: a2ca98600c709dee42f19d602bd357a14d57c93c [file] [log] [blame]
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001/*
2 * NIST SP800-38C compliant CCM implementation
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020018 */
19
20/*
21 * Definition of CCM:
22 * http://csrc.nist.gov/publications/nistpubs/800-38C/SP800-38C_updated-July20_2007.pdf
23 * RFC 3610 "Counter with CBC-MAC (CCM)"
24 *
25 * Related:
26 * RFC 5116 "An Interface and Algorithms for Authenticated Encryption"
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_CCM_C)
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020032
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/ccm.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050034#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000035#include "mbedtls/error.h"
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +020036
Rich Evans00ab4702015-02-06 13:43:58 +000037#include <string.h>
38
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
40#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/platform.h"
Rich Evans00ab4702015-02-06 13:43:58 +000042#else
43#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#define mbedtls_printf printf
45#endif /* MBEDTLS_PLATFORM_C */
46#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Rich Evans00ab4702015-02-06 13:43:58 +000047
Steven Cooreman222e2ff2017-04-04 11:37:15 +020048#if !defined(MBEDTLS_CCM_ALT)
49
k-stachowiak26d365e2018-12-11 12:22:16 +010050#define CCM_VALIDATE_RET( cond ) \
51 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_CCM_BAD_INPUT )
52#define CCM_VALIDATE( cond ) \
53 MBEDTLS_INTERNAL_VALIDATE( cond )
54
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +020055#define CCM_ENCRYPT 0
56#define CCM_DECRYPT 1
57
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020058/*
59 * Initialize context
60 */
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020061void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
62{
k-stachowiak26d365e2018-12-11 12:22:16 +010063 CCM_VALIDATE( ctx != NULL );
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +020064 memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
65}
66
67int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
68 mbedtls_cipher_id_t cipher,
69 const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020070 unsigned int keybits )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020071{
Janos Follath24eed8d2019-11-22 13:21:35 +000072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073 const mbedtls_cipher_info_t *cipher_info;
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020074
k-stachowiak26d365e2018-12-11 12:22:16 +010075 CCM_VALIDATE_RET( ctx != NULL );
76 CCM_VALIDATE_RET( key != NULL );
77
Andrzej Kurekee3c4352019-01-10 03:10:02 -050078 cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
79 MBEDTLS_MODE_ECB );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020080 if( cipher_info == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020082
83 if( cipher_info->block_size != 16 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020085
Manuel Pégourié-Gonnard43b08572015-05-27 17:23:30 +020086 mbedtls_cipher_free( &ctx->cipher_ctx );
87
Manuel Pégourié-Gonnard8473f872015-05-14 13:51:45 +020088 if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020089 return( ret );
90
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +020091 if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092 MBEDTLS_ENCRYPT ) ) != 0 )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +020093 {
94 return( ret );
95 }
96
97 return( 0 );
98}
99
100/*
101 * Free context
102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200104{
k-stachowiakfd42d532018-12-11 14:37:51 +0100105 if( ctx == NULL )
106 return;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107 mbedtls_cipher_free( &ctx->cipher_ctx );
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500108 mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
Manuel Pégourié-Gonnard9fe0d132014-05-06 12:12:45 +0200109}
110
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200111/*
112 * Macros for common operations.
113 * Results in smaller compiled code than static inline functions.
114 */
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200115
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200116/*
117 * Update the CBC-MAC state in y using a block in b
118 * (Always using b as the source helps the compiler optimise a bit better.)
119 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200120#define UPDATE_CBC_MAC \
121 for( i = 0; i < 16; i++ ) \
122 ctx->y[i] ^= ctx->b[i]; \
123 \
124 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->y, 16, ctx->y, &olen ) ) != 0 ) \
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200125 return( ret );
126
127/*
128 * Encrypt or decrypt a partial block with CTR
129 * Warning: using b for temporary storage! src and dst must not be b!
Manuel Pégourié-Gonnard0f6b66d2014-05-07 14:43:46 +0200130 * This avoids allocating one more 16 bytes buffer while allowing src == dst.
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200131 */
132#define CTR_CRYPT( dst, src, len ) \
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200133 do \
134 { \
135 if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctx->ctr, \
136 16, ctx->b, &olen ) ) != 0 ) \
137 { \
138 return( ret ); \
139 } \
140 \
141 for( i = 0; i < (len); i++ ) \
142 (dst)[i] = (src)[i] ^ ctx->b[i]; \
Hanno Becker1eeca412018-10-15 12:01:35 +0100143 } while( 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200144
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200145#define CCM_STATE__CLEAR 0
146#define CCM_STATE__STARTED 0x0001
147#define CCM_STATE__LENGHTS_SET 0x0002
148
149static void mbedtls_ccm_clear_state(mbedtls_ccm_context *ctx) {
150 ctx->state = CCM_STATE__CLEAR;
151 memset( ctx->b, 0, 16);
152 memset( ctx->y, 0, 16);
153 memset( ctx->ctr, 0, 16);
154}
155
156static int mbedtls_ccm_calculate_first_block(mbedtls_ccm_context *ctx)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200157{
Janos Follath24eed8d2019-11-22 13:21:35 +0000158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200159 unsigned char i;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200160 size_t len_left, olen;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200161
162 /* length calulcation can be done only after both
163 * mbedtls_ccm_starts() and mbedtls_ccm_set_lengths() have been executed
164 */
165 if( !(ctx->state & CCM_STATE__STARTED) || !(ctx->state & CCM_STATE__LENGHTS_SET) )
166 return 0;
167
168 /*
169 * First block B_0:
170 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
171 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
172 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
173 */
174 for( i = 0, len_left = ctx->plaintext_len; i < ctx->q; i++, len_left >>= 8 )
175 ctx->b[15-i] = (unsigned char)( len_left & 0xFF );
176
177 if( len_left > 0 )
178 return( MBEDTLS_ERR_CCM_BAD_INPUT );
179
180 /* Start CBC-MAC with first block*/
181 UPDATE_CBC_MAC;
182
183 return (0);
184}
185
186int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
187 int mode,
188 const unsigned char *iv,
189 size_t iv_len )
190{
191 int ret;
192
193 /* Also implies q is within bounds */
194 if( iv_len < 7 || iv_len > 13 )
195 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200196
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200197 ctx->mode = mode;
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200198 ctx->q = 16 - 1 - (unsigned char) iv_len;
199
200 /*
201 * Prepare counter block for encryption:
202 * 0 .. 0 flags
203 * 1 .. iv_len nonce (aka iv)
204 * iv_len+1 .. 15 counter (initially 1)
205 *
206 * With flags as (bits):
207 * 7 .. 3 0
208 * 2 .. 0 q - 1
209 */
210 memset( ctx->ctr, 0, 16);
211 ctx->ctr[0] = ctx->q - 1;
212 memcpy( ctx->ctr + 1, iv, iv_len );
213 memset( ctx->ctr + 1 + iv_len, 0, ctx->q );
214 ctx->ctr[15] = 1;
215
216 /*
217 * First block B_0:
218 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
219 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
220 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
221 *
222 * With flags as (bits):
223 * 7 0
224 * 6 add present? - set by: mbedtls_ccm_set_lengths()
225 * 5 .. 3 (t - 2) / 2 - set by: mbedtls_ccm_set_lengths()
226 * 2 .. 0 q - 1 - set by: mbedtls_ccm_starts()
227 */
228 ctx->b[0] |= ctx->q - 1;
229
230 memcpy( ctx->b + 1, iv, iv_len );
231
232 ctx->state |= CCM_STATE__STARTED;
233 ret = mbedtls_ccm_calculate_first_block(ctx);
234
235 return ret;
236}
237
238int mbedtls_ccm_set_lengths( mbedtls_ccm_context *ctx,
239 size_t total_ad_len,
240 size_t plaintext_len,
241 size_t tag_len )
242{
243 int ret;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200244
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200245 /*
246 * Check length requirements: SP800-38C A.1
247 * Additional requirement: a < 2^16 - 2^8 to simplify the code.
248 * 'length' checked later (when writing it to the first block)
Janos Follath997e85c2018-05-29 11:33:45 +0100249 *
250 * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200251 */
Janos Follath997e85c2018-05-29 11:33:45 +0100252 if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
Janos Follath997e85c2018-05-29 11:33:45 +0100253 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200254
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200255 if( total_ad_len >= 0xFF00 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256 return( MBEDTLS_ERR_CCM_BAD_INPUT );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200257
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200258 /*
259 * First block B_0:
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200260 * 0 .. 0 flags - set by: mbedtls_ccm_starts() and mbedtls_ccm_set_lenghts()
261 * 1 .. iv_len nonce (aka iv) - set by: mbedtls_ccm_starts()
262 * iv_len+1 .. 15 length - set by: mbedtls_ccm_calculate_first_block()
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200263 *
264 * With flags as (bits):
265 * 7 0
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200266 * 6 add present? - set by: mbedtls_ccm_set_lengths()
267 * 5 .. 3 (t - 2) / 2 - set by: mbedtls_ccm_set_lengths()
268 * 2 .. 0 q - 1 - set by: mbedtls_ccm_starts()
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200269 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200270 ctx->b[0] |= ( total_ad_len > 0 ) << 6;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200271 ctx->b[0] |= ( ( tag_len - 2 ) / 2 ) << 3;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200272
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200273 ctx->plaintext_len = plaintext_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200274
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200275 ctx->state |= CCM_STATE__LENGHTS_SET;
276 ret = mbedtls_ccm_calculate_first_block(ctx);
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200277
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200278 return ret;
279}
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200280
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200281int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
282 const unsigned char *add,
283 size_t add_len )
284{
285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
286 unsigned char i;
287 size_t len_left, olen;
288 const unsigned char *src;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200289
290 /*
291 * If there is additional data, update CBC-MAC with
292 * add_len, add, 0 (padding to a block boundary)
293 */
294 if( add_len > 0 )
295 {
296 size_t use_len;
297 len_left = add_len;
298 src = add;
299
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200300 memset( ctx->b, 0, 16 );
301 ctx->b[0] = (unsigned char)( ( add_len >> 8 ) & 0xFF );
302 ctx->b[1] = (unsigned char)( ( add_len ) & 0xFF );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200303
304 use_len = len_left < 16 - 2 ? len_left : 16 - 2;
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200305 memcpy( ctx->b + 2, src, use_len );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200306 len_left -= use_len;
307 src += use_len;
308
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200309 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200310
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200311 while( len_left > 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200312 {
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200313 use_len = len_left > 16 ? 16 : len_left;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200314
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200315 memset( ctx->b, 0, 16 );
316 memcpy( ctx->b, src, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200317 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200318
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200319 len_left -= use_len;
320 src += use_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200321 }
322 }
323
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200324 return (0);
325}
326
327int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
328 const unsigned char *input, size_t input_len,
329 unsigned char *output, size_t output_size,
330 size_t *output_len )
331{
332 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
333 unsigned char i;
334 size_t len_left, olen;
335 const unsigned char *src;
336 unsigned char *dst;
337
338 if( output_size < input_len )
339 return( MBEDTLS_ERR_CCM_BAD_INPUT );
340 CCM_VALIDATE_RET( output_length != NULL );
341 *output_len = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200342
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200343 /*
344 * Authenticate and {en,de}crypt the message.
345 *
346 * The only difference between encryption and decryption is
347 * the respective order of authentication and {en,de}cryption.
348 */
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200349 len_left = input_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200350 src = input;
351 dst = output;
352
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200353 while( len_left > 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200354 {
Manuel Pégourié-Gonnard9de64f52015-07-01 15:51:43 +0200355 size_t use_len = len_left > 16 ? 16 : len_left;
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200356
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200357 if( ctx->mode == CCM_ENCRYPT )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200358 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200359 memset( ctx->b, 0, 16 );
360 memcpy( ctx->b, src, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200361 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200362 }
363
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200364 CTR_CRYPT( dst, src, use_len );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200365
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200366 if( ctx->mode == CCM_DECRYPT )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200367 {
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200368 memset( ctx->b, 0, 16 );
369 memcpy( ctx->b, dst, use_len );
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200370 UPDATE_CBC_MAC;
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200371 }
372
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200373 dst += use_len;
374 src += use_len;
375 len_left -= use_len;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200376
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200377 /*
378 * Increment counter.
379 * No need to check for overflow thanks to the length check above.
380 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200381 for( i = 0; i < ctx->q; i++ )
382 if( ++(ctx->ctr)[15-i] != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200383 break;
384 }
385
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200386 return (0);
387}
388
389int mbedtls_ccm_finish( mbedtls_ccm_context *ctx,
390 unsigned char *tag, size_t tag_len )
391{
392 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
393 unsigned char i;
394 size_t olen;
395
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200396 /*
Manuel Pégourié-Gonnardaed60652014-05-07 13:14:42 +0200397 * Authentication: reset counter and crypt/mask internal tag
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200398 */
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200399 for( i = 0; i < ctx->q; i++ )
400 ctx->ctr[15-i] = 0;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200401
Mateusz Starzyk89d469c2021-06-22 16:24:28 +0200402 CTR_CRYPT( ctx->y, ctx->y, 16 );
403 memcpy( tag, ctx->y, tag_len );
Mateusz Starzyk793692c2021-06-22 20:34:20 +0200404 mbedtls_ccm_clear_state(ctx);
405
406 return( 0 );
407}
408
409/*
410 * Authenticated encryption or decryption
411 */
412static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
413 const unsigned char *iv, size_t iv_len,
414 const unsigned char *add, size_t add_len,
415 const unsigned char *input, unsigned char *output,
416 unsigned char *tag, size_t tag_len )
417{
418 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
419 size_t olen;
420
421 if( ( ret = mbedtls_ccm_starts( ctx, mode, iv, iv_len ) ) != 0 )
422 return( ret );
423
424 if( ( ret = mbedtls_ccm_set_lengths( ctx, add_len, length, tag_len ) ) != 0 )
425 return( ret );
426
427 if( ( ret = mbedtls_ccm_update_ad( ctx, add, add_len ) ) != 0 )
428 return( ret );
429
430 if( ( ret = mbedtls_ccm_update( ctx, input, length,
431 output, length, &olen ) ) != 0 )
432 return( ret );
433
434 if( ( ret = mbedtls_ccm_finish( ctx, tag, tag_len ) ) != 0 )
435 return( ret );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200436
437 return( 0 );
438}
439
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200440/*
441 * Authenticated encryption
442 */
Janos Follathb5734a22018-05-14 14:31:49 +0100443int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200444 const unsigned char *iv, size_t iv_len,
445 const unsigned char *add, size_t add_len,
446 const unsigned char *input, unsigned char *output,
447 unsigned char *tag, size_t tag_len )
448{
k-stachowiak26d365e2018-12-11 12:22:16 +0100449 CCM_VALIDATE_RET( ctx != NULL );
450 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100451 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
452 CCM_VALIDATE_RET( length == 0 || input != NULL );
453 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100454 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200455 return( ccm_auth_crypt( ctx, CCM_ENCRYPT, length, iv, iv_len,
456 add, add_len, input, output, tag, tag_len ) );
457}
458
Janos Follathb5734a22018-05-14 14:31:49 +0100459int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
460 const unsigned char *iv, size_t iv_len,
461 const unsigned char *add, size_t add_len,
462 const unsigned char *input, unsigned char *output,
463 unsigned char *tag, size_t tag_len )
464{
k-stachowiak26d365e2018-12-11 12:22:16 +0100465 CCM_VALIDATE_RET( ctx != NULL );
466 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100467 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
468 CCM_VALIDATE_RET( length == 0 || input != NULL );
469 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100470 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
Janos Follathb5734a22018-05-14 14:31:49 +0100471 if( tag_len == 0 )
472 return( MBEDTLS_ERR_CCM_BAD_INPUT );
473
474 return( mbedtls_ccm_star_encrypt_and_tag( ctx, length, iv, iv_len, add,
475 add_len, input, output, tag, tag_len ) );
476}
477
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200478/*
479 * Authenticated decryption
480 */
Janos Follathb5734a22018-05-14 14:31:49 +0100481int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200482 const unsigned char *iv, size_t iv_len,
483 const unsigned char *add, size_t add_len,
484 const unsigned char *input, unsigned char *output,
485 const unsigned char *tag, size_t tag_len )
486{
Janos Follath24eed8d2019-11-22 13:21:35 +0000487 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200488 unsigned char check_tag[16];
489 unsigned char i;
490 int diff;
491
k-stachowiak26d365e2018-12-11 12:22:16 +0100492 CCM_VALIDATE_RET( ctx != NULL );
493 CCM_VALIDATE_RET( iv != NULL );
k-stachowiakff8a0982018-12-11 15:56:55 +0100494 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
495 CCM_VALIDATE_RET( length == 0 || input != NULL );
496 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100497 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiak26d365e2018-12-11 12:22:16 +0100498
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200499 if( ( ret = ccm_auth_crypt( ctx, CCM_DECRYPT, length,
500 iv, iv_len, add, add_len,
501 input, output, check_tag, tag_len ) ) != 0 )
502 {
503 return( ret );
504 }
505
506 /* Check tag in "constant-time" */
507 for( diff = 0, i = 0; i < tag_len; i++ )
508 diff |= tag[i] ^ check_tag[i];
509
510 if( diff != 0 )
511 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500512 mbedtls_platform_zeroize( output, length );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 return( MBEDTLS_ERR_CCM_AUTH_FAILED );
Manuel Pégourié-Gonnard00232332014-05-06 15:56:07 +0200514 }
515
516 return( 0 );
517}
518
Janos Follathb5734a22018-05-14 14:31:49 +0100519int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
520 const unsigned char *iv, size_t iv_len,
521 const unsigned char *add, size_t add_len,
522 const unsigned char *input, unsigned char *output,
523 const unsigned char *tag, size_t tag_len )
524{
k-stachowiakf7125342018-12-11 15:57:19 +0100525 CCM_VALIDATE_RET( ctx != NULL );
526 CCM_VALIDATE_RET( iv != NULL );
527 CCM_VALIDATE_RET( add_len == 0 || add != NULL );
528 CCM_VALIDATE_RET( length == 0 || input != NULL );
529 CCM_VALIDATE_RET( length == 0 || output != NULL );
k-stachowiak6adb0572018-12-18 10:22:34 +0100530 CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
k-stachowiakf7125342018-12-11 15:57:19 +0100531
Janos Follathb5734a22018-05-14 14:31:49 +0100532 if( tag_len == 0 )
533 return( MBEDTLS_ERR_CCM_BAD_INPUT );
534
535 return( mbedtls_ccm_star_auth_decrypt( ctx, length, iv, iv_len, add,
536 add_len, input, output, tag, tag_len ) );
537}
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200538#endif /* !MBEDTLS_CCM_ALT */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200541/*
542 * Examples 1 to 3 from SP800-38C Appendix C
543 */
544
545#define NB_TESTS 3
Ron Eldor1b9b2172018-04-26 14:15:01 +0300546#define CCM_SELFTEST_PT_MAX_LEN 24
547#define CCM_SELFTEST_CT_MAX_LEN 32
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200548/*
549 * The data is the same for all tests, only the used length changes
550 */
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100551static const unsigned char key_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200552 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
553 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
554};
555
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100556static const unsigned char iv_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200557 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
558 0x18, 0x19, 0x1a, 0x1b
559};
560
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100561static const unsigned char ad_test_data[] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200562 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
563 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
564 0x10, 0x11, 0x12, 0x13
565};
566
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100567static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200568 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
569 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
570 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
571};
572
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100573static const size_t iv_len_test_data [NB_TESTS] = { 7, 8, 12 };
574static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
575static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
576static const size_t tag_len_test_data[NB_TESTS] = { 4, 6, 8 };
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200577
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100578static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200579 { 0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
580 { 0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
581 0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
582 0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
583 { 0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
584 0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
585 0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
586 0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
587};
588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589int mbedtls_ccm_self_test( int verbose )
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200590{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591 mbedtls_ccm_context ctx;
Ron Eldor1b9b2172018-04-26 14:15:01 +0300592 /*
593 * Some hardware accelerators require the input and output buffers
594 * would be in RAM, because the flash is not accessible.
595 * Use buffers on the stack to hold the test vectors data.
596 */
597 unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
598 unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200599 size_t i;
Janos Follath24eed8d2019-11-22 13:21:35 +0000600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200601
Manuel Pégourié-Gonnard6963ff02015-04-28 18:02:54 +0200602 mbedtls_ccm_init( &ctx );
603
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500604 if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
605 8 * sizeof key_test_data ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200606 {
607 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 mbedtls_printf( " CCM: setup failed" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200609
610 return( 1 );
611 }
612
613 for( i = 0; i < NB_TESTS; i++ )
614 {
615 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 mbedtls_printf( " CCM-AES #%u: ", (unsigned int) i + 1 );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200617
Ron Eldor1b9b2172018-04-26 14:15:01 +0300618 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
619 memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100620 memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
Ron Eldor1b9b2172018-04-26 14:15:01 +0300621
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100622 ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100623 iv_test_data, iv_len_test_data[i],
624 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300625 plaintext, ciphertext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500626 ciphertext + msg_len_test_data[i],
627 tag_len_test_data[i] );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200628
629 if( ret != 0 ||
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500630 memcmp( ciphertext, res_test_data[i],
631 msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200632 {
633 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200635
636 return( 1 );
637 }
Ron Eldor1b9b2172018-04-26 14:15:01 +0300638 memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200639
Michał Janiszewski9aeea932018-10-30 23:00:15 +0100640 ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100641 iv_test_data, iv_len_test_data[i],
642 ad_test_data, add_len_test_data[i],
Ron Eldor1b9b2172018-04-26 14:15:01 +0300643 ciphertext, plaintext,
Andrzej Kurekee3c4352019-01-10 03:10:02 -0500644 ciphertext + msg_len_test_data[i],
645 tag_len_test_data[i] );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200646
647 if( ret != 0 ||
Michał Janiszewskic79e92b2018-10-31 20:43:05 +0100648 memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200649 {
650 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnardce77d552014-05-06 18:06:52 +0200652
653 return( 1 );
654 }
655
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200656 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200657 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard637eb3d2014-05-06 12:13:09 +0200658 }
659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 mbedtls_ccm_free( &ctx );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200661
662 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200664
665 return( 0 );
666}
667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +0200669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670#endif /* MBEDTLS_CCM_C */