mbed TLS v2.16.0: cmac.h Source File

mbed TLS v2.16.0

cmac.h
Go to the documentation of this file.
1
9 /*
10 * Copyright (C) 2015-2018, Arm Limited (or its affiliates), All Rights Reserved
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 * This file is part of Mbed TLS (https://tls.mbed.org)
26 */
27
28 #ifndef MBEDTLS_CMAC_H
29 #define MBEDTLS_CMAC_H
30
31 #include "cipher.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /* MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED is deprecated and should not be used. */
38 #define MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED -0x007A
40 #define MBEDTLS_AES_BLOCK_SIZE 16
41 #define MBEDTLS_DES3_BLOCK_SIZE 8
42
43 #if defined(MBEDTLS_AES_C)
44 #define MBEDTLS_CIPHER_BLKSIZE_MAX 16
45 #else
46 #define MBEDTLS_CIPHER_BLKSIZE_MAX 8
47 #endif
48
49 #if !defined(MBEDTLS_CMAC_ALT)
50
54 struct mbedtls_cmac_context_t
55 {
57 unsigned char state[MBEDTLS_CIPHER_BLKSIZE_MAX];
58
61 unsigned char unprocessed_block[MBEDTLS_CIPHER_BLKSIZE_MAX];
62
64 size_t unprocessed_len;
65 };
66
67 #else /* !MBEDTLS_CMAC_ALT */
68 #include "cmac_alt.h"
69 #endif /* !MBEDTLS_CMAC_ALT */
70
87 int mbedtls_cipher_cmac_starts( mbedtls_cipher_context_t *ctx,
88 const unsigned char *key, size_t keybits );
89
106 int mbedtls_cipher_cmac_update( mbedtls_cipher_context_t *ctx,
107 const unsigned char *input, size_t ilen );
108
124 int mbedtls_cipher_cmac_finish( mbedtls_cipher_context_t *ctx,
125 unsigned char *output );
126
141 int mbedtls_cipher_cmac_reset( mbedtls_cipher_context_t *ctx );
142
165 int mbedtls_cipher_cmac( const mbedtls_cipher_info_t *cipher_info,
166 const unsigned char *key, size_t keylen,
167 const unsigned char *input, size_t ilen,
168 unsigned char *output );
169
170 #if defined(MBEDTLS_AES_C)
171
188 int mbedtls_aes_cmac_prf_128( const unsigned char *key, size_t key_len,
189 const unsigned char *input, size_t in_len,
190 unsigned char output[16] );
191 #endif /* MBEDTLS_AES_C */
192
193 #if defined(MBEDTLS_SELF_TEST) && ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_DES_C) )
194
200 int mbedtls_cmac_self_test( int verbose );
201 #endif /* MBEDTLS_SELF_TEST && ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif /* MBEDTLS_CMAC_H */
MBEDTLS_CIPHER_BLKSIZE_MAX
#define MBEDTLS_CIPHER_BLKSIZE_MAX
Definition: cmac.h:44
mbedtls_cipher_cmac_reset
int mbedtls_cipher_cmac_reset(mbedtls_cipher_context_t *ctx)
This function prepares the authentication of another message with the same key as the previous CMAC o...
mbedtls_cipher_cmac_starts
int mbedtls_cipher_cmac_starts(mbedtls_cipher_context_t *ctx, const unsigned char *key, size_t keybits)
This function sets the CMAC key, and prepares to authenticate the input data. Must be called with an ...
mbedtls_cmac_context_t
Definition: cmac.h:54
mbedtls_cipher_context_t
Definition: cipher.h:284
mbedtls_cipher_info_t
Definition: cipher.h:242
mbedtls_aes_cmac_prf_128
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...
mbedtls_cmac_context_t::state
unsigned char state[MBEDTLS_CIPHER_BLKSIZE_MAX]
Definition: cmac.h:57
cipher.h
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
mbedtls_cmac_context_t::unprocessed_block
unsigned char unprocessed_block[MBEDTLS_CIPHER_BLKSIZE_MAX]
Definition: cmac.h:61
mbedtls_cipher_cmac
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.
mbedtls_cmac_context_t::unprocessed_len
size_t unprocessed_len
Definition: cmac.h:64
mbedtls_cipher_cmac_finish
int mbedtls_cipher_cmac_finish(mbedtls_cipher_context_t *ctx, unsigned char *output)
This function finishes the CMAC operation, and writes the result to the output buffer.
mbedtls_cmac_self_test
int mbedtls_cmac_self_test(int verbose)
The CMAC checkup routine.
mbedtls_cipher_cmac_update
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.