Mbed TLS v2.28.5
cmac.h
Go to the documentation of this file.
1 
9 /*
10  * Copyright The Mbed TLS Contributors
11  * SPDX-License-Identifier: Apache-2.0
12  *
13  * Licensed under the Apache License, Version 2.0 (the "License"); you may
14  * not use this file except in compliance with the License.
15  * You may obtain a copy of the License at
16  *
17  * http://www.apache.org/licenses/LICENSE-2.0
18  *
19  * Unless required by applicable law or agreed to in writing, software
20  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22  * See the License for the specific language governing permissions and
23  * limitations under the License.
24  */
25 
26 #ifndef MBEDTLS_CMAC_H
27 #define MBEDTLS_CMAC_H
28 
29 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include "mbedtls/config.h"
31 #else
32 #include MBEDTLS_CONFIG_FILE
33 #endif
34 
35 #include "mbedtls/cipher.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 /* MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED is deprecated and should not be used. */
43 #define MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED -0x007A
44 
45 #define MBEDTLS_AES_BLOCK_SIZE 16
46 #define MBEDTLS_DES3_BLOCK_SIZE 8
47 
48 
49 /* Although the CMAC module does not support ARIA or CAMELLIA, we adjust the value of
50  * MBEDTLS_CIPHER_BLKSIZE_MAX to reflect these ciphers.
51  * This is done to avoid confusion, given the general-purpose name of the macro. */
52 #if defined(MBEDTLS_AES_C) || defined(MBEDTLS_ARIA_C) || defined(MBEDTLS_CAMELLIA_C)
53 #define MBEDTLS_CIPHER_BLKSIZE_MAX 16
54 #else
55 #define MBEDTLS_CIPHER_BLKSIZE_MAX 8
56 #endif
57 
58 #if !defined(MBEDTLS_CMAC_ALT)
59 
66 
70 
73 };
74 
75 #else /* !MBEDTLS_CMAC_ALT */
76 #include "cmac_alt.h"
77 #endif /* !MBEDTLS_CMAC_ALT */
78 
110  const unsigned char *key, size_t keybits);
111 
135  const unsigned char *input, size_t ilen);
136 
154  unsigned char *output);
155 
173 
201 int mbedtls_cipher_cmac(const mbedtls_cipher_info_t *cipher_info,
202  const unsigned char *key, size_t keylen,
203  const unsigned char *input, size_t ilen,
204  unsigned char *output);
205 
206 #if defined(MBEDTLS_AES_C)
207 
224 int mbedtls_aes_cmac_prf_128(const unsigned char *key, size_t key_len,
225  const unsigned char *input, size_t in_len,
226  unsigned char output[16]);
227 #endif /* MBEDTLS_AES_C */
228 
229 #if defined(MBEDTLS_SELF_TEST) && (defined(MBEDTLS_AES_C) || defined(MBEDTLS_DES_C))
230 
243 int mbedtls_cmac_self_test(int verbose);
244 #endif /* MBEDTLS_SELF_TEST && ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
245 
246 #ifdef __cplusplus
247 }
248 #endif
249 
250 #endif /* MBEDTLS_CMAC_H */
#define MBEDTLS_CIPHER_BLKSIZE_MAX
Definition: cmac.h:53
int mbedtls_cipher_cmac_reset(mbedtls_cipher_context_t *ctx)
This function starts a new CMAC operation with the same key as the previous one.
int mbedtls_cipher_cmac_starts(mbedtls_cipher_context_t *ctx, const unsigned char *key, size_t keybits)
This function starts a new CMAC computation by setting the CMAC key, and preparing to authenticate th...
Configuration options (set of defines)
int mbedtls_aes_cmac_prf_128(const unsigned char *key, size_t key_len, const unsigned char *input, size_t in_len, unsigned char output[16])
This function implements the AES-CMAC-PRF-128 pseudorandom function, as defined in RFC-4615: The Adva...
unsigned char state[MBEDTLS_CIPHER_BLKSIZE_MAX]
Definition: cmac.h:65
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
unsigned char unprocessed_block[MBEDTLS_CIPHER_BLKSIZE_MAX]
Definition: cmac.h:69
int mbedtls_cipher_cmac(const mbedtls_cipher_info_t *cipher_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output)
This function calculates the full generic CMAC on the input buffer with the provided key...
size_t unprocessed_len
Definition: cmac.h:72
int mbedtls_cipher_cmac_finish(mbedtls_cipher_context_t *ctx, unsigned char *output)
This function finishes an ongoing CMAC operation, and writes the result to the output buffer...
int mbedtls_cmac_self_test(int verbose)
The CMAC checkup routine.
int mbedtls_cipher_cmac_update(mbedtls_cipher_context_t *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing CMAC computation.