mbed TLS v2.16.7
ccm.h
Go to the documentation of this file.
1 
30 /*
31  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
32  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
33  *
34  * This file is provided under the Apache License 2.0, or the
35  * GNU General Public License v2.0 or later.
36  *
37  * **********
38  * Apache License 2.0:
39  *
40  * Licensed under the Apache License, Version 2.0 (the "License"); you may
41  * not use this file except in compliance with the License.
42  * You may obtain a copy of the License at
43  *
44  * http://www.apache.org/licenses/LICENSE-2.0
45  *
46  * Unless required by applicable law or agreed to in writing, software
47  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
48  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
49  * See the License for the specific language governing permissions and
50  * limitations under the License.
51  *
52  * **********
53  *
54  * **********
55  * GNU General Public License v2.0 or later:
56  *
57  * This program is free software; you can redistribute it and/or modify
58  * it under the terms of the GNU General Public License as published by
59  * the Free Software Foundation; either version 2 of the License, or
60  * (at your option) any later version.
61  *
62  * This program is distributed in the hope that it will be useful,
63  * but WITHOUT ANY WARRANTY; without even the implied warranty of
64  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
65  * GNU General Public License for more details.
66  *
67  * You should have received a copy of the GNU General Public License along
68  * with this program; if not, write to the Free Software Foundation, Inc.,
69  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
70  *
71  * **********
72  *
73  * This file is part of Mbed TLS (https://tls.mbed.org)
74  */
75 
76 #ifndef MBEDTLS_CCM_H
77 #define MBEDTLS_CCM_H
78 
79 #if !defined(MBEDTLS_CONFIG_FILE)
80 #include "config.h"
81 #else
82 #include MBEDTLS_CONFIG_FILE
83 #endif
84 
85 #include "cipher.h"
86 
87 #define MBEDTLS_ERR_CCM_BAD_INPUT -0x000D
88 #define MBEDTLS_ERR_CCM_AUTH_FAILED -0x000F
90 /* MBEDTLS_ERR_CCM_HW_ACCEL_FAILED is deprecated and should not be used. */
91 #define MBEDTLS_ERR_CCM_HW_ACCEL_FAILED -0x0011
93 #ifdef __cplusplus
94 extern "C" {
95 #endif
96 
97 #if !defined(MBEDTLS_CCM_ALT)
98 // Regular implementation
99 //
100 
105 typedef struct mbedtls_ccm_context
106 {
108 }
110 
111 #else /* MBEDTLS_CCM_ALT */
112 #include "ccm_alt.h"
113 #endif /* MBEDTLS_CCM_ALT */
114 
123 
138  mbedtls_cipher_id_t cipher,
139  const unsigned char *key,
140  unsigned int keybits );
141 
150 
187 int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
188  const unsigned char *iv, size_t iv_len,
189  const unsigned char *add, size_t add_len,
190  const unsigned char *input, unsigned char *output,
191  unsigned char *tag, size_t tag_len );
192 
236  const unsigned char *iv, size_t iv_len,
237  const unsigned char *add, size_t add_len,
238  const unsigned char *input, unsigned char *output,
239  unsigned char *tag, size_t tag_len );
240 
272 int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
273  const unsigned char *iv, size_t iv_len,
274  const unsigned char *add, size_t add_len,
275  const unsigned char *input, unsigned char *output,
276  const unsigned char *tag, size_t tag_len );
277 
317 int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
318  const unsigned char *iv, size_t iv_len,
319  const unsigned char *add, size_t add_len,
320  const unsigned char *input, unsigned char *output,
321  const unsigned char *tag, size_t tag_len );
322 
323 #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
324 
330 int mbedtls_ccm_self_test( int verbose );
331 #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
332 
333 #ifdef __cplusplus
334 }
335 #endif
336 
337 #endif /* MBEDTLS_CCM_H */
void mbedtls_ccm_free(mbedtls_ccm_context *ctx)
This function releases and clears the specified CCM context and underlying cipher sub-context...
The CCM context-type definition. The CCM context is passed to the APIs called.
Definition: ccm.h:105
Configuration options (set of defines)
struct mbedtls_ccm_context mbedtls_ccm_context
The CCM context-type definition. The CCM context is passed to the APIs called.
int mbedtls_ccm_star_encrypt_and_tag(mbedtls_ccm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, unsigned char *tag, size_t tag_len)
This function encrypts a buffer using CCM*.
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:111
int mbedtls_ccm_encrypt_and_tag(mbedtls_ccm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, unsigned char *tag, size_t tag_len)
This function encrypts a buffer using CCM.
int mbedtls_ccm_star_auth_decrypt(mbedtls_ccm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, const unsigned char *tag, size_t tag_len)
This function performs a CCM* authenticated decryption of a buffer.
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
int mbedtls_ccm_setkey(mbedtls_ccm_context *ctx, mbedtls_cipher_id_t cipher, const unsigned char *key, unsigned int keybits)
This function initializes the CCM context set in the ctx parameter and sets the encryption key...
int mbedtls_ccm_auth_decrypt(mbedtls_ccm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, const unsigned char *tag, size_t tag_len)
This function performs a CCM authenticated decryption of a buffer.
int mbedtls_ccm_self_test(int verbose)
The CCM checkup routine.
mbedtls_cipher_context_t cipher_ctx
Definition: ccm.h:107
void mbedtls_ccm_init(mbedtls_ccm_context *ctx)
This function initializes the specified CCM context, to make references valid, and prepare the contex...