Mbed TLS v3.6.0
cmac.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  */
14 
15 #ifndef MBEDTLS_CMAC_H
16 #define MBEDTLS_CMAC_H
17 #include "mbedtls/private_access.h"
18 
19 #include "mbedtls/build_info.h"
20 
21 #include "mbedtls/cipher.h"
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 #define MBEDTLS_AES_BLOCK_SIZE 16
28 #define MBEDTLS_DES3_BLOCK_SIZE 8
29 
30 /* We don't support Camellia or ARIA in this module */
31 #if defined(MBEDTLS_AES_C)
32 #define MBEDTLS_CMAC_MAX_BLOCK_SIZE 16
33 #else
34 #define MBEDTLS_CMAC_MAX_BLOCK_SIZE 8
35 #endif
36 
37 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
46 /* Before Mbed TLS 3.5, this was the maximum block size supported by the CMAC
47  * module, so it didn't take Camellia or ARIA into account. Since the name
48  * of the macro doesn't even convey "CMAC", this was misleading. Now the size
49  * is sufficient for any cipher, but the name is defined in cmac.h for
50  * backward compatibility. */
51 #define MBEDTLS_CIPHER_BLKSIZE_MAX MBEDTLS_MAX_BLOCK_LENGTH
52 #endif /* MBEDTLS_DEPRECATED_REMOVED */
53 
54 #if !defined(MBEDTLS_CMAC_ALT)
55 
62 
65  unsigned char MBEDTLS_PRIVATE(unprocessed_block)[MBEDTLS_CMAC_MAX_BLOCK_SIZE];
66 
68  size_t MBEDTLS_PRIVATE(unprocessed_len);
69 };
70 
71 #else /* !MBEDTLS_CMAC_ALT */
72 #include "cmac_alt.h"
73 #endif /* !MBEDTLS_CMAC_ALT */
74 
106  const unsigned char *key, size_t keybits);
107 
131  const unsigned char *input, size_t ilen);
132 
150  unsigned char *output);
151 
169 
198  const unsigned char *key, size_t keylen,
199  const unsigned char *input, size_t ilen,
200  unsigned char *output);
201 
202 #if defined(MBEDTLS_AES_C)
220 int mbedtls_aes_cmac_prf_128(const unsigned char *key, size_t key_len,
221  const unsigned char *input, size_t in_len,
222  unsigned char output[16]);
223 #endif /* MBEDTLS_AES_C */
224 
225 #if defined(MBEDTLS_SELF_TEST) && (defined(MBEDTLS_AES_C) || defined(MBEDTLS_DES_C))
239 int mbedtls_cmac_self_test(int verbose);
240 #endif /* MBEDTLS_SELF_TEST && ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
241 
242 #ifdef __cplusplus
243 }
244 #endif
245 
246 #endif /* MBEDTLS_CMAC_H */
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
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.
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_cmac_self_test(int verbose)
The CMAC checkup routine.
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.
#define MBEDTLS_CMAC_MAX_BLOCK_SIZE
Definition: cmac.h:32
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...
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...
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.
Build-time configuration info.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)