mbed TLS v3.4.0
chachapoly.h
Go to the documentation of this file.
1 
15 /*
16  * Copyright The Mbed TLS Contributors
17  * SPDX-License-Identifier: Apache-2.0
18  *
19  * Licensed under the Apache License, Version 2.0 (the "License"); you may
20  * not use this file except in compliance with the License.
21  * You may obtain a copy of the License at
22  *
23  * http://www.apache.org/licenses/LICENSE-2.0
24  *
25  * Unless required by applicable law or agreed to in writing, software
26  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
27  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28  * See the License for the specific language governing permissions and
29  * limitations under the License.
30  */
31 
32 #ifndef MBEDTLS_CHACHAPOLY_H
33 #define MBEDTLS_CHACHAPOLY_H
34 #include "mbedtls/private_access.h"
35 
36 #include "mbedtls/build_info.h"
37 
38 /* for shared error codes */
39 #include "mbedtls/poly1305.h"
40 
42 #define MBEDTLS_ERR_CHACHAPOLY_BAD_STATE -0x0054
43 
44 #define MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED -0x0056
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 typedef enum {
53 }
55 
56 #if !defined(MBEDTLS_CHACHAPOLY_ALT)
57 
58 #include "mbedtls/chacha20.h"
59 
63  uint64_t MBEDTLS_PRIVATE(aad_len);
64  uint64_t MBEDTLS_PRIVATE(ciphertext_len);
65  int MBEDTLS_PRIVATE(state);
67 }
69 
70 #else /* !MBEDTLS_CHACHAPOLY_ALT */
71 #include "chachapoly_alt.h"
72 #endif /* !MBEDTLS_CHACHAPOLY_ALT */
73 
117 
126 
139  const unsigned char key[32]);
140 
167  const unsigned char nonce[12],
169 
210  const unsigned char *aad,
211  size_t aad_len);
212 
245  size_t len,
246  const unsigned char *input,
247  unsigned char *output);
248 
266  unsigned char mac[16]);
267 
298  size_t length,
299  const unsigned char nonce[12],
300  const unsigned char *aad,
301  size_t aad_len,
302  const unsigned char *input,
303  unsigned char *output,
304  unsigned char tag[16]);
305 
332  size_t length,
333  const unsigned char nonce[12],
334  const unsigned char *aad,
335  size_t aad_len,
336  const unsigned char tag[16],
337  const unsigned char *input,
338  unsigned char *output);
339 
340 #if defined(MBEDTLS_SELF_TEST)
341 
347 int mbedtls_chachapoly_self_test(int verbose);
348 #endif /* MBEDTLS_SELF_TEST */
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 
354 #endif /* MBEDTLS_CHACHAPOLY_H */
void mbedtls_chachapoly_init(mbedtls_chachapoly_context *ctx)
This function initializes the specified ChaCha20-Poly1305 context.
int mbedtls_chachapoly_update_aad(mbedtls_chachapoly_context *ctx, const unsigned char *aad, size_t aad_len)
This function feeds additional data to be authenticated into an ongoing ChaCha20-Poly1305 operation...
mbedtls_chachapoly_mode_t
Definition: chachapoly.h:50
int mbedtls_chachapoly_finish(mbedtls_chachapoly_context *ctx, unsigned char mac[16])
This function finished the ChaCha20-Poly1305 operation and generates the MAC (authentication tag)...
struct mbedtls_chachapoly_context mbedtls_chachapoly_context
#define MBEDTLS_PRIVATE(member)
This file contains ChaCha20 definitions and functions.
int mbedtls_chachapoly_update(mbedtls_chachapoly_context *ctx, size_t len, const unsigned char *input, unsigned char *output)
Thus function feeds data to be encrypted or decrypted into an on-going ChaCha20-Poly1305 operation...
int mbedtls_chachapoly_encrypt_and_tag(mbedtls_chachapoly_context *ctx, size_t length, const unsigned char nonce[12], const unsigned char *aad, size_t aad_len, const unsigned char *input, unsigned char *output, unsigned char tag[16])
This function performs a complete ChaCha20-Poly1305 authenticated encryption with the previously-set ...
int mbedtls_chachapoly_setkey(mbedtls_chachapoly_context *ctx, const unsigned char key[32])
This function sets the ChaCha20-Poly1305 symmetric encryption key.
Macro wrapper for struct's members.
int mbedtls_chachapoly_self_test(int verbose)
The ChaCha20-Poly1305 checkup routine.
Build-time configuration info.
int mbedtls_chachapoly_auth_decrypt(mbedtls_chachapoly_context *ctx, size_t length, const unsigned char nonce[12], const unsigned char *aad, size_t aad_len, const unsigned char tag[16], const unsigned char *input, unsigned char *output)
This function performs a complete ChaCha20-Poly1305 authenticated decryption with the previously-set ...
int mbedtls_chachapoly_starts(mbedtls_chachapoly_context *ctx, const unsigned char nonce[12], mbedtls_chachapoly_mode_t mode)
This function starts a ChaCha20-Poly1305 encryption or decryption operation.
void mbedtls_chachapoly_free(mbedtls_chachapoly_context *ctx)
This function releases and clears the specified ChaCha20-Poly1305 context.
This file contains Poly1305 definitions and functions.