third_party/mbedtls/repo/library/ccm.c

   1 /*
   2  *  NIST SP800-38C compliant CCM implementation
   3  *
   4  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   5  *  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.
  18  *
  19  *  This file is part of mbed TLS (https://tls.mbed.org)
  20  */
  21
  22 /*
  23  * Definition of CCM:
  24  * http://csrc.nist.gov/publications/nistpubs/800-38C/SP800-38C_updated-July20_2007.pdf
  25  * RFC 3610 "Counter with CBC-MAC (CCM)"
  26  *
  27  * Related:
  28  * RFC 5116 "An Interface and Algorithms for Authenticated Encryption"
  29  */
  30
  31 #if !defined(MBEDTLS_CONFIG_FILE)
  32 #include "mbedtls/config.h"
  33 #else
  34 #include MBEDTLS_CONFIG_FILE
  35 #endif
  36
  37 #if defined(MBEDTLS_CCM_C)
  38
  39 #include "mbedtls/ccm.h"
  40 #include "mbedtls/platform_util.h"
  41
  42 #include <string.h>
  43
  44 #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
  45 #if defined(MBEDTLS_PLATFORM_C)
  46 #include "mbedtls/platform.h"
  47 #else
  48 #include <stdio.h>
  49 #define mbedtls_printf printf
  50 #endif /* MBEDTLS_PLATFORM_C */
  51 #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
  52
  53 #if !defined(MBEDTLS_CCM_ALT)
  54
  55 #define CCM_VALIDATE_RET( cond ) \
  56     MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_CCM_BAD_INPUT )
  57 #define CCM_VALIDATE( cond ) \
  58     MBEDTLS_INTERNAL_VALIDATE( cond )
  59
  60 #define CCM_ENCRYPT 0
  61 #define CCM_DECRYPT 1
  62
  63 /*
  64  * Initialize context
  65  */
  66 void mbedtls_ccm_init( mbedtls_ccm_context *ctx )
  67 {
  68     CCM_VALIDATE( ctx != NULL );
  69     memset( ctx, 0, sizeof( mbedtls_ccm_context ) );
  70 }
  71
  72 int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
  73                         mbedtls_cipher_id_t cipher,
  74                         const unsigned char *key,
  75                         unsigned int keybits )
  76 {
  77     int ret;
  78     const mbedtls_cipher_info_t *cipher_info;
  79
  80     CCM_VALIDATE_RET( ctx != NULL );
  81     CCM_VALIDATE_RET( key != NULL );
  82
  83     cipher_info = mbedtls_cipher_info_from_values( cipher, keybits,
  84                                                    MBEDTLS_MODE_ECB );
  85     if( cipher_info == NULL )
  86         return( MBEDTLS_ERR_CCM_BAD_INPUT );
  87
  88     if( cipher_info->block_size != 16 )
  89         return( MBEDTLS_ERR_CCM_BAD_INPUT );
  90
  91     mbedtls_cipher_free( &ctx->cipher_ctx );
  92
  93     if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )
  94         return( ret );
  95
  96     if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,
  97                                MBEDTLS_ENCRYPT ) ) != 0 )
  98     {
  99         return( ret );
 100     }
 101
 102     return( 0 );
 103 }
 104
 105 /*
 106  * Free context
 107  */
 108 void mbedtls_ccm_free( mbedtls_ccm_context *ctx )
 109 {
 110     if( ctx == NULL )
 111         return;
 112     mbedtls_cipher_free( &ctx->cipher_ctx );
 113     mbedtls_platform_zeroize( ctx, sizeof( mbedtls_ccm_context ) );
 114 }
 115
 116 /*
 117  * Macros for common operations.
 118  * Results in smaller compiled code than static inline functions.
 119  */
 120
 121 /*
 122  * Update the CBC-MAC state in y using a block in b
 123  * (Always using b as the source helps the compiler optimise a bit better.)
 124  */
 125 #define UPDATE_CBC_MAC                                                      \
 126     for( i = 0; i < 16; i++ )                                               \
 127         y[i] ^= b[i];                                                       \
 128                                                                             \
 129     if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, y, 16, y, &olen ) ) != 0 ) \
 130         return( ret );
 131
 132 /*
 133  * Encrypt or decrypt a partial block with CTR
 134  * Warning: using b for temporary storage! src and dst must not be b!
 135  * This avoids allocating one more 16 bytes buffer while allowing src == dst.
 136  */
 137 #define CTR_CRYPT( dst, src, len  )                                            \
 138     do                                                                  \
 139     {                                                                   \
 140         if( ( ret = mbedtls_cipher_update( &ctx->cipher_ctx, ctr,       \
 141                                            16, b, &olen ) ) != 0 )      \
 142         {                                                               \
 143             return( ret );                                              \
 144         }                                                               \
 145                                                                         \
 146         for( i = 0; i < (len); i++ )                                    \
 147             (dst)[i] = (src)[i] ^ b[i];                                 \
 148     } while( 0 )
 149
 150 /*
 151  * Authenticated encryption or decryption
 152  */
 153 static int ccm_auth_crypt( mbedtls_ccm_context *ctx, int mode, size_t length,
 154                            const unsigned char *iv, size_t iv_len,
 155                            const unsigned char *add, size_t add_len,
 156                            const unsigned char *input, unsigned char *output,
 157                            unsigned char *tag, size_t tag_len )
 158 {
 159     int ret;
 160     unsigned char i;
 161     unsigned char q;
 162     size_t len_left, olen;
 163     unsigned char b[16];
 164     unsigned char y[16];
 165     unsigned char ctr[16];
 166     const unsigned char *src;
 167     unsigned char *dst;
 168
 169     /*
 170      * Check length requirements: SP800-38C A.1
 171      * Additional requirement: a < 2^16 - 2^8 to simplify the code.
 172      * 'length' checked later (when writing it to the first block)
 173      *
 174      * Also, loosen the requirements to enable support for CCM* (IEEE 802.15.4).
 175      */
 176     if( tag_len == 2 || tag_len > 16 || tag_len % 2 != 0 )
 177         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 178
 179     /* Also implies q is within bounds */
 180     if( iv_len < 7 || iv_len > 13 )
 181         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 182
 183     if( add_len > 0xFF00 )
 184         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 185
 186     q = 16 - 1 - (unsigned char) iv_len;
 187
 188     /*
 189      * First block B_0:
 190      * 0        .. 0        flags
 191      * 1        .. iv_len   nonce (aka iv)
 192      * iv_len+1 .. 15       length
 193      *
 194      * With flags as (bits):
 195      * 7        0
 196      * 6        add present?
 197      * 5 .. 3   (t - 2) / 2
 198      * 2 .. 0   q - 1
 199      */
 200     b[0] = 0;
 201     b[0] |= ( add_len > 0 ) << 6;
 202     b[0] |= ( ( tag_len - 2 ) / 2 ) << 3;
 203     b[0] |= q - 1;
 204
 205     memcpy( b + 1, iv, iv_len );
 206
 207     for( i = 0, len_left = length; i < q; i++, len_left >>= 8 )
 208         b[15-i] = (unsigned char)( len_left & 0xFF );
 209
 210     if( len_left > 0 )
 211         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 212
 213
 214     /* Start CBC-MAC with first block */
 215     memset( y, 0, 16 );
 216     UPDATE_CBC_MAC;
 217
 218     /*
 219      * If there is additional data, update CBC-MAC with
 220      * add_len, add, 0 (padding to a block boundary)
 221      */
 222     if( add_len > 0 )
 223     {
 224         size_t use_len;
 225         len_left = add_len;
 226         src = add;
 227
 228         memset( b, 0, 16 );
 229         b[0] = (unsigned char)( ( add_len >> 8 ) & 0xFF );
 230         b[1] = (unsigned char)( ( add_len      ) & 0xFF );
 231
 232         use_len = len_left < 16 - 2 ? len_left : 16 - 2;
 233         memcpy( b + 2, src, use_len );
 234         len_left -= use_len;
 235         src += use_len;
 236
 237         UPDATE_CBC_MAC;
 238
 239         while( len_left > 0 )
 240         {
 241             use_len = len_left > 16 ? 16 : len_left;
 242
 243             memset( b, 0, 16 );
 244             memcpy( b, src, use_len );
 245             UPDATE_CBC_MAC;
 246
 247             len_left -= use_len;
 248             src += use_len;
 249         }
 250     }
 251
 252     /*
 253      * Prepare counter block for encryption:
 254      * 0        .. 0        flags
 255      * 1        .. iv_len   nonce (aka iv)
 256      * iv_len+1 .. 15       counter (initially 1)
 257      *
 258      * With flags as (bits):
 259      * 7 .. 3   0
 260      * 2 .. 0   q - 1
 261      */
 262     ctr[0] = q - 1;
 263     memcpy( ctr + 1, iv, iv_len );
 264     memset( ctr + 1 + iv_len, 0, q );
 265     ctr[15] = 1;
 266
 267     /*
 268      * Authenticate and {en,de}crypt the message.
 269      *
 270      * The only difference between encryption and decryption is
 271      * the respective order of authentication and {en,de}cryption.
 272      */
 273     len_left = length;
 274     src = input;
 275     dst = output;
 276
 277     while( len_left > 0 )
 278     {
 279         size_t use_len = len_left > 16 ? 16 : len_left;
 280
 281         if( mode == CCM_ENCRYPT )
 282         {
 283             memset( b, 0, 16 );
 284             memcpy( b, src, use_len );
 285             UPDATE_CBC_MAC;
 286         }
 287
 288         CTR_CRYPT( dst, src, use_len );
 289
 290         if( mode == CCM_DECRYPT )
 291         {
 292             memset( b, 0, 16 );
 293             memcpy( b, dst, use_len );
 294             UPDATE_CBC_MAC;
 295         }
 296
 297         dst += use_len;
 298         src += use_len;
 299         len_left -= use_len;
 300
 301         /*
 302          * Increment counter.
 303          * No need to check for overflow thanks to the length check above.
 304          */
 305         for( i = 0; i < q; i++ )
 306             if( ++ctr[15-i] != 0 )
 307                 break;
 308     }
 309
 310     /*
 311      * Authentication: reset counter and crypt/mask internal tag
 312      */
 313     for( i = 0; i < q; i++ )
 314         ctr[15-i] = 0;
 315
 316     CTR_CRYPT( y, y, 16 );
 317     memcpy( tag, y, tag_len );
 318
 319     return( 0 );
 320 }
 321
 322 /*
 323  * Authenticated encryption
 324  */
 325 int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
 326                          const unsigned char *iv, size_t iv_len,
 327                          const unsigned char *add, size_t add_len,
 328                          const unsigned char *input, unsigned char *output,
 329                          unsigned char *tag, size_t tag_len )
 330 {
 331     CCM_VALIDATE_RET( ctx != NULL );
 332     CCM_VALIDATE_RET( iv != NULL );
 333     CCM_VALIDATE_RET( add_len == 0 || add != NULL );
 334     CCM_VALIDATE_RET( length == 0 || input != NULL );
 335     CCM_VALIDATE_RET( length == 0 || output != NULL );
 336     CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
 337     return( ccm_auth_crypt( ctx, CCM_ENCRYPT, length, iv, iv_len,
 338                             add, add_len, input, output, tag, tag_len ) );
 339 }
 340
 341 int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
 342                          const unsigned char *iv, size_t iv_len,
 343                          const unsigned char *add, size_t add_len,
 344                          const unsigned char *input, unsigned char *output,
 345                          unsigned char *tag, size_t tag_len )
 346 {
 347     CCM_VALIDATE_RET( ctx != NULL );
 348     CCM_VALIDATE_RET( iv != NULL );
 349     CCM_VALIDATE_RET( add_len == 0 || add != NULL );
 350     CCM_VALIDATE_RET( length == 0 || input != NULL );
 351     CCM_VALIDATE_RET( length == 0 || output != NULL );
 352     CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
 353     if( tag_len == 0 )
 354         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 355
 356     return( mbedtls_ccm_star_encrypt_and_tag( ctx, length, iv, iv_len, add,
 357                 add_len, input, output, tag, tag_len ) );
 358 }
 359
 360 /*
 361  * Authenticated decryption
 362  */
 363 int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
 364                       const unsigned char *iv, size_t iv_len,
 365                       const unsigned char *add, size_t add_len,
 366                       const unsigned char *input, unsigned char *output,
 367                       const unsigned char *tag, size_t tag_len )
 368 {
 369     int ret;
 370     unsigned char check_tag[16];
 371     unsigned char i;
 372     int diff;
 373
 374     CCM_VALIDATE_RET( ctx != NULL );
 375     CCM_VALIDATE_RET( iv != NULL );
 376     CCM_VALIDATE_RET( add_len == 0 || add != NULL );
 377     CCM_VALIDATE_RET( length == 0 || input != NULL );
 378     CCM_VALIDATE_RET( length == 0 || output != NULL );
 379     CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
 380
 381     if( ( ret = ccm_auth_crypt( ctx, CCM_DECRYPT, length,
 382                                 iv, iv_len, add, add_len,
 383                                 input, output, check_tag, tag_len ) ) != 0 )
 384     {
 385         return( ret );
 386     }
 387
 388     /* Check tag in "constant-time" */
 389     for( diff = 0, i = 0; i < tag_len; i++ )
 390         diff |= tag[i] ^ check_tag[i];
 391
 392     if( diff != 0 )
 393     {
 394         mbedtls_platform_zeroize( output, length );
 395         return( MBEDTLS_ERR_CCM_AUTH_FAILED );
 396     }
 397
 398     return( 0 );
 399 }
 400
 401 int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
 402                       const unsigned char *iv, size_t iv_len,
 403                       const unsigned char *add, size_t add_len,
 404                       const unsigned char *input, unsigned char *output,
 405                       const unsigned char *tag, size_t tag_len )
 406 {
 407     CCM_VALIDATE_RET( ctx != NULL );
 408     CCM_VALIDATE_RET( iv != NULL );
 409     CCM_VALIDATE_RET( add_len == 0 || add != NULL );
 410     CCM_VALIDATE_RET( length == 0 || input != NULL );
 411     CCM_VALIDATE_RET( length == 0 || output != NULL );
 412     CCM_VALIDATE_RET( tag_len == 0 || tag != NULL );
 413
 414     if( tag_len == 0 )
 415         return( MBEDTLS_ERR_CCM_BAD_INPUT );
 416
 417     return( mbedtls_ccm_star_auth_decrypt( ctx, length, iv, iv_len, add,
 418                 add_len, input, output, tag, tag_len ) );
 419 }
 420 #endif /* !MBEDTLS_CCM_ALT */
 421
 422 #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
 423 /*
 424  * Examples 1 to 3 from SP800-38C Appendix C
 425  */
 426
 427 #define NB_TESTS 3
 428 #define CCM_SELFTEST_PT_MAX_LEN 24
 429 #define CCM_SELFTEST_CT_MAX_LEN 32
 430 /*
 431  * The data is the same for all tests, only the used length changes
 432  */
 433 static const unsigned char key_test_data[] = {
 434     0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
 435     0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f
 436 };
 437
 438 static const unsigned char iv_test_data[] = {
 439     0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
 440     0x18, 0x19, 0x1a, 0x1b
 441 };
 442
 443 static const unsigned char ad_test_data[] = {
 444     0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
 445     0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
 446     0x10, 0x11, 0x12, 0x13
 447 };
 448
 449 static const unsigned char msg_test_data[CCM_SELFTEST_PT_MAX_LEN] = {
 450     0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
 451     0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
 452     0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
 453 };
 454
 455 static const size_t iv_len_test_data [NB_TESTS] = { 7, 8,  12 };
 456 static const size_t add_len_test_data[NB_TESTS] = { 8, 16, 20 };
 457 static const size_t msg_len_test_data[NB_TESTS] = { 4, 16, 24 };
 458 static const size_t tag_len_test_data[NB_TESTS] = { 4, 6,  8  };
 459
 460 static const unsigned char res_test_data[NB_TESTS][CCM_SELFTEST_CT_MAX_LEN] = {
 461     {   0x71, 0x62, 0x01, 0x5b, 0x4d, 0xac, 0x25, 0x5d },
 462     {   0xd2, 0xa1, 0xf0, 0xe0, 0x51, 0xea, 0x5f, 0x62,
 463         0x08, 0x1a, 0x77, 0x92, 0x07, 0x3d, 0x59, 0x3d,
 464         0x1f, 0xc6, 0x4f, 0xbf, 0xac, 0xcd },
 465     {   0xe3, 0xb2, 0x01, 0xa9, 0xf5, 0xb7, 0x1a, 0x7a,
 466         0x9b, 0x1c, 0xea, 0xec, 0xcd, 0x97, 0xe7, 0x0b,
 467         0x61, 0x76, 0xaa, 0xd9, 0xa4, 0x42, 0x8a, 0xa5,
 468         0x48, 0x43, 0x92, 0xfb, 0xc1, 0xb0, 0x99, 0x51 }
 469 };
 470
 471 int mbedtls_ccm_self_test( int verbose )
 472 {
 473     mbedtls_ccm_context ctx;
 474     /*
 475      * Some hardware accelerators require the input and output buffers
 476      * would be in RAM, because the flash is not accessible.
 477      * Use buffers on the stack to hold the test vectors data.
 478      */
 479     unsigned char plaintext[CCM_SELFTEST_PT_MAX_LEN];
 480     unsigned char ciphertext[CCM_SELFTEST_CT_MAX_LEN];
 481     size_t i;
 482     int ret;
 483
 484     mbedtls_ccm_init( &ctx );
 485
 486     if( mbedtls_ccm_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, key_test_data,
 487                             8 * sizeof key_test_data ) != 0 )
 488     {
 489         if( verbose != 0 )
 490             mbedtls_printf( "  CCM: setup failed" );
 491
 492         return( 1 );
 493     }
 494
 495     for( i = 0; i < NB_TESTS; i++ )
 496     {
 497         if( verbose != 0 )
 498             mbedtls_printf( "  CCM-AES #%u: ", (unsigned int) i + 1 );
 499
 500         memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
 501         memset( ciphertext, 0, CCM_SELFTEST_CT_MAX_LEN );
 502         memcpy( plaintext, msg_test_data, msg_len_test_data[i] );
 503
 504         ret = mbedtls_ccm_encrypt_and_tag( &ctx, msg_len_test_data[i],
 505                                            iv_test_data, iv_len_test_data[i],
 506                                            ad_test_data, add_len_test_data[i],
 507                                            plaintext, ciphertext,
 508                                            ciphertext + msg_len_test_data[i],
 509                                            tag_len_test_data[i] );
 510
 511         if( ret != 0 ||
 512             memcmp( ciphertext, res_test_data[i],
 513                     msg_len_test_data[i] + tag_len_test_data[i] ) != 0 )
 514         {
 515             if( verbose != 0 )
 516                 mbedtls_printf( "failed\n" );
 517
 518             return( 1 );
 519         }
 520         memset( plaintext, 0, CCM_SELFTEST_PT_MAX_LEN );
 521
 522         ret = mbedtls_ccm_auth_decrypt( &ctx, msg_len_test_data[i],
 523                                         iv_test_data, iv_len_test_data[i],
 524                                         ad_test_data, add_len_test_data[i],
 525                                         ciphertext, plaintext,
 526                                         ciphertext + msg_len_test_data[i],
 527                                         tag_len_test_data[i] );
 528
 529         if( ret != 0 ||
 530             memcmp( plaintext, msg_test_data, msg_len_test_data[i] ) != 0 )
 531         {
 532             if( verbose != 0 )
 533                 mbedtls_printf( "failed\n" );
 534
 535             return( 1 );
 536         }
 537
 538         if( verbose != 0 )
 539             mbedtls_printf( "passed\n" );
 540     }
 541
 542     mbedtls_ccm_free( &ctx );
 543
 544     if( verbose != 0 )
 545         mbedtls_printf( "\n" );
 546
 547     return( 0 );
 548 }
 549
 550 #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
 551
 552 #endif /* MBEDTLS_CCM_C */