git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/include/mbedtls/cmac.h

   1 /**\r
   2  * \file cmac.h\r
   3  *\r
   4  * \brief This file contains CMAC definitions and functions.\r
   5  *\r
   6  * The Cipher-based Message Authentication Code (CMAC) Mode for\r
   7  * Authentication is defined in <em>RFC-4493: The AES-CMAC Algorithm</em>.\r
   8  */\r
   9 /*\r
  10  *  Copyright (C) 2015-2018, Arm Limited (or its affiliates), All Rights Reserved\r
  11  *  SPDX-License-Identifier: Apache-2.0\r
  12  *\r
  13  *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
  14  *  not use this file except in compliance with the License.\r
  15  *  You may obtain a copy of the License at\r
  16  *\r
  17  *  http://www.apache.org/licenses/LICENSE-2.0\r
  18  *\r
  19  *  Unless required by applicable law or agreed to in writing, software\r
  20  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  21  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  22  *  See the License for the specific language governing permissions and\r
  23  *  limitations under the License.\r
  24  *\r
  25  *  This file is part of Mbed TLS (https://tls.mbed.org)\r
  26  */\r
  27 \r
  28 #ifndef MBEDTLS_CMAC_H\r
  29 #define MBEDTLS_CMAC_H\r
  30 \r
  31 #if !defined(MBEDTLS_CONFIG_FILE)\r
  32 #include "config.h"\r
  33 #else\r
  34 #include MBEDTLS_CONFIG_FILE\r
  35 #endif\r
  36 \r
  37 #include "cipher.h"\r
  38 \r
  39 #ifdef __cplusplus\r
  40 extern "C" {\r
  41 #endif\r
  42 \r
  43 /* MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED is deprecated and should not be used. */\r
  44 #define MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED -0x007A  /**< CMAC hardware accelerator failed. */\r
  45 \r
  46 #define MBEDTLS_AES_BLOCK_SIZE          16\r
  47 #define MBEDTLS_DES3_BLOCK_SIZE         8\r
  48 \r
  49 #if defined(MBEDTLS_AES_C)\r
  50 #define MBEDTLS_CIPHER_BLKSIZE_MAX      16  /**< The longest block used by CMAC is that of AES. */\r
  51 #else\r
  52 #define MBEDTLS_CIPHER_BLKSIZE_MAX      8   /**< The longest block used by CMAC is that of 3DES. */\r
  53 #endif\r
  54 \r
  55 #if !defined(MBEDTLS_CMAC_ALT)\r
  56 \r
  57 /**\r
  58  * The CMAC context structure.\r
  59  */\r
  60 struct mbedtls_cmac_context_t\r
  61 {\r
  62     /** The internal state of the CMAC algorithm.  */\r
  63     unsigned char       state[MBEDTLS_CIPHER_BLKSIZE_MAX];\r
  64 \r
  65     /** Unprocessed data - either data that was not block aligned and is still\r
  66      *  pending processing, or the final block. */\r
  67     unsigned char       unprocessed_block[MBEDTLS_CIPHER_BLKSIZE_MAX];\r
  68 \r
  69     /** The length of data pending processing. */\r
  70     size_t              unprocessed_len;\r
  71 };\r
  72 \r
  73 #else  /* !MBEDTLS_CMAC_ALT */\r
  74 #include "cmac_alt.h"\r
  75 #endif /* !MBEDTLS_CMAC_ALT */\r
  76 \r
  77 /**\r
  78  * \brief               This function sets the CMAC key, and prepares to authenticate\r
  79  *                      the input data.\r
  80  *                      Must be called with an initialized cipher context.\r
  81  *\r
  82  * \param ctx           The cipher context used for the CMAC operation, initialized\r
  83  *                      as one of the following types: MBEDTLS_CIPHER_AES_128_ECB,\r
  84  *                      MBEDTLS_CIPHER_AES_192_ECB, MBEDTLS_CIPHER_AES_256_ECB,\r
  85  *                      or MBEDTLS_CIPHER_DES_EDE3_ECB.\r
  86  * \param key           The CMAC key.\r
  87  * \param keybits       The length of the CMAC key in bits.\r
  88  *                      Must be supported by the cipher.\r
  89  *\r
  90  * \return              \c 0 on success.\r
  91  * \return              A cipher-specific error code on failure.\r
  92  */\r
  93 int mbedtls_cipher_cmac_starts( mbedtls_cipher_context_t *ctx,\r
  94                                 const unsigned char *key, size_t keybits );\r
  95 \r
  96 /**\r
  97  * \brief               This function feeds an input buffer into an ongoing CMAC\r
  98  *                      computation.\r
  99  *\r
 100  *                      It is called between mbedtls_cipher_cmac_starts() or\r
 101  *                      mbedtls_cipher_cmac_reset(), and mbedtls_cipher_cmac_finish().\r
 102  *                      Can be called repeatedly.\r
 103  *\r
 104  * \param ctx           The cipher context used for the CMAC operation.\r
 105  * \param input         The buffer holding the input data.\r
 106  * \param ilen          The length of the input data.\r
 107  *\r
 108  * \return             \c 0 on success.\r
 109  * \return             #MBEDTLS_ERR_MD_BAD_INPUT_DATA\r
 110  *                     if parameter verification fails.\r
 111  */\r
 112 int mbedtls_cipher_cmac_update( mbedtls_cipher_context_t *ctx,\r
 113                                 const unsigned char *input, size_t ilen );\r
 114 \r
 115 /**\r
 116  * \brief               This function finishes the CMAC operation, and writes\r
 117  *                      the result to the output buffer.\r
 118  *\r
 119  *                      It is called after mbedtls_cipher_cmac_update().\r
 120  *                      It can be followed by mbedtls_cipher_cmac_reset() and\r
 121  *                      mbedtls_cipher_cmac_update(), or mbedtls_cipher_free().\r
 122  *\r
 123  * \param ctx           The cipher context used for the CMAC operation.\r
 124  * \param output        The output buffer for the CMAC checksum result.\r
 125  *\r
 126  * \return              \c 0 on success.\r
 127  * \return              #MBEDTLS_ERR_MD_BAD_INPUT_DATA\r
 128  *                      if parameter verification fails.\r
 129  */\r
 130 int mbedtls_cipher_cmac_finish( mbedtls_cipher_context_t *ctx,\r
 131                                 unsigned char *output );\r
 132 \r
 133 /**\r
 134  * \brief               This function prepares the authentication of another\r
 135  *                      message with the same key as the previous CMAC\r
 136  *                      operation.\r
 137  *\r
 138  *                      It is called after mbedtls_cipher_cmac_finish()\r
 139  *                      and before mbedtls_cipher_cmac_update().\r
 140  *\r
 141  * \param ctx           The cipher context used for the CMAC operation.\r
 142  *\r
 143  * \return              \c 0 on success.\r
 144  * \return              #MBEDTLS_ERR_MD_BAD_INPUT_DATA\r
 145  *                      if parameter verification fails.\r
 146  */\r
 147 int mbedtls_cipher_cmac_reset( mbedtls_cipher_context_t *ctx );\r
 148 \r
 149 /**\r
 150  * \brief               This function calculates the full generic CMAC\r
 151  *                      on the input buffer with the provided key.\r
 152  *\r
 153  *                      The function allocates the context, performs the\r
 154  *                      calculation, and frees the context.\r
 155  *\r
 156  *                      The CMAC result is calculated as\r
 157  *                      output = generic CMAC(cmac key, input buffer).\r
 158  *\r
 159  *\r
 160  * \param cipher_info   The cipher information.\r
 161  * \param key           The CMAC key.\r
 162  * \param keylen        The length of the CMAC key in bits.\r
 163  * \param input         The buffer holding the input data.\r
 164  * \param ilen          The length of the input data.\r
 165  * \param output        The buffer for the generic CMAC result.\r
 166  *\r
 167  * \return              \c 0 on success.\r
 168  * \return              #MBEDTLS_ERR_MD_BAD_INPUT_DATA\r
 169  *                      if parameter verification fails.\r
 170  */\r
 171 int mbedtls_cipher_cmac( const mbedtls_cipher_info_t *cipher_info,\r
 172                          const unsigned char *key, size_t keylen,\r
 173                          const unsigned char *input, size_t ilen,\r
 174                          unsigned char *output );\r
 175 \r
 176 #if defined(MBEDTLS_AES_C)\r
 177 /**\r
 178  * \brief           This function implements the AES-CMAC-PRF-128 pseudorandom\r
 179  *                  function, as defined in\r
 180  *                  <em>RFC-4615: The Advanced Encryption Standard-Cipher-based\r
 181  *                  Message Authentication Code-Pseudo-Random Function-128\r
 182  *                  (AES-CMAC-PRF-128) Algorithm for the Internet Key\r
 183  *                  Exchange Protocol (IKE).</em>\r
 184  *\r
 185  * \param key       The key to use.\r
 186  * \param key_len   The key length in Bytes.\r
 187  * \param input     The buffer holding the input data.\r
 188  * \param in_len    The length of the input data in Bytes.\r
 189  * \param output    The buffer holding the generated 16 Bytes of\r
 190  *                  pseudorandom output.\r
 191  *\r
 192  * \return          \c 0 on success.\r
 193  */\r
 194 int mbedtls_aes_cmac_prf_128( const unsigned char *key, size_t key_len,\r
 195                               const unsigned char *input, size_t in_len,\r
 196                               unsigned char output[16] );\r
 197 #endif /* MBEDTLS_AES_C */\r
 198 \r
 199 #if defined(MBEDTLS_SELF_TEST) && ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_DES_C) )\r
 200 /**\r
 201  * \brief          The CMAC checkup routine.\r
 202  *\r
 203  * \return         \c 0 on success.\r
 204  * \return         \c 1 on failure.\r
 205  */\r
 206 int mbedtls_cmac_self_test( int verbose );\r
 207 #endif /* MBEDTLS_SELF_TEST && ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */\r
 208 \r
 209 #ifdef __cplusplus\r
 210 }\r
 211 #endif\r
 212 \r
 213 #endif /* MBEDTLS_CMAC_H */\r