mbed TLS v2.23.0: chachapoly.h Source File

mbed TLS v2.23.0

chachapoly.h
Go to the documentation of this file.
1
15 /*
16 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved.
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 * This file is part of Mbed TLS (https://tls.mbed.org)
32 */
33
34 #ifndef MBEDTLS_CHACHAPOLY_H
35 #define MBEDTLS_CHACHAPOLY_H
36
37 #if !defined(MBEDTLS_CONFIG_FILE)
38 #include "mbedtls/config.h"
39 #else
40 #include MBEDTLS_CONFIG_FILE
41 #endif
42
43 /* for shared error codes */
44 #include "mbedtls/poly1305.h"
45
46 #define MBEDTLS_ERR_CHACHAPOLY_BAD_STATE -0x0054
47 #define MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED -0x0056
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 typedef enum
54 {
55 MBEDTLS_CHACHAPOLY_ENCRYPT,
56 MBEDTLS_CHACHAPOLY_DECRYPT
57 }
58 mbedtls_chachapoly_mode_t;
59
60 #if !defined(MBEDTLS_CHACHAPOLY_ALT)
61
62 #include "mbedtls/chacha20.h"
63
64 typedef struct mbedtls_chachapoly_context
65 {
66 mbedtls_chacha20_context chacha20_ctx;
67 mbedtls_poly1305_context poly1305_ctx;
68 uint64_t aad_len;
69 uint64_t ciphertext_len;
70 int state;
71 mbedtls_chachapoly_mode_t mode;
72 }
73 mbedtls_chachapoly_context;
74
75 #else /* !MBEDTLS_CHACHAPOLY_ALT */
76 #include "chachapoly_alt.h"
77 #endif /* !MBEDTLS_CHACHAPOLY_ALT */
78
121 void mbedtls_chachapoly_init( mbedtls_chachapoly_context *ctx );
122
130 void mbedtls_chachapoly_free( mbedtls_chachapoly_context *ctx );
131
143 int mbedtls_chachapoly_setkey( mbedtls_chachapoly_context *ctx,
144 const unsigned char key[32] );
145
171 int mbedtls_chachapoly_starts( mbedtls_chachapoly_context *ctx,
172 const unsigned char nonce[12],
173 mbedtls_chachapoly_mode_t mode );
174
214 int mbedtls_chachapoly_update_aad( mbedtls_chachapoly_context *ctx,
215 const unsigned char *aad,
216 size_t aad_len );
217
249 int mbedtls_chachapoly_update( mbedtls_chachapoly_context *ctx,
250 size_t len,
251 const unsigned char *input,
252 unsigned char *output );
253
270 int mbedtls_chachapoly_finish( mbedtls_chachapoly_context *ctx,
271 unsigned char mac[16] );
272
302 int mbedtls_chachapoly_encrypt_and_tag( mbedtls_chachapoly_context *ctx,
303 size_t length,
304 const unsigned char nonce[12],
305 const unsigned char *aad,
306 size_t aad_len,
307 const unsigned char *input,
308 unsigned char *output,
309 unsigned char tag[16] );
310
336 int mbedtls_chachapoly_auth_decrypt( mbedtls_chachapoly_context *ctx,
337 size_t length,
338 const unsigned char nonce[12],
339 const unsigned char *aad,
340 size_t aad_len,
341 const unsigned char tag[16],
342 const unsigned char *input,
343 unsigned char *output );
344
345 #if defined(MBEDTLS_SELF_TEST)
346
352 int mbedtls_chachapoly_self_test( int verbose );
353 #endif /* MBEDTLS_SELF_TEST */
354
355 #ifdef __cplusplus
356 }
357 #endif
358
359 #endif /* MBEDTLS_CHACHAPOLY_H */
mbedtls_chachapoly_context::mode
mbedtls_chachapoly_mode_t mode
Definition: chachapoly.h:71
mbedtls_chachapoly_context
Definition: chachapoly.h:65
MBEDTLS_CHACHAPOLY_DECRYPT
@ MBEDTLS_CHACHAPOLY_DECRYPT
Definition: chachapoly.h:56
mbedtls_chachapoly_setkey
int mbedtls_chachapoly_setkey(mbedtls_chachapoly_context *ctx, const unsigned char key[32])
This function sets the ChaCha20-Poly1305 symmetric encryption key.
chacha20.h
This file contains ChaCha20 definitions and functions.
mbedtls_chachapoly_context::chacha20_ctx
mbedtls_chacha20_context chacha20_ctx
Definition: chachapoly.h:66
poly1305.h
This file contains Poly1305 definitions and functions.
mbedtls_chachapoly_update
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.
mbedtls_chachapoly_context::poly1305_ctx
mbedtls_poly1305_context poly1305_ctx
Definition: chachapoly.h:67
mbedtls_chachapoly_mode_t
mbedtls_chachapoly_mode_t
Definition: chachapoly.h:54
mbedtls_chachapoly_context::state
int state
Definition: chachapoly.h:70
mbedtls_chachapoly_context::aad_len
uint64_t aad_len
Definition: chachapoly.h:68
mbedtls_chachapoly_context
struct mbedtls_chachapoly_context mbedtls_chachapoly_context
mbedtls_chachapoly_self_test
int mbedtls_chachapoly_self_test(int verbose)
The ChaCha20-Poly1305 checkup routine.
mbedtls_chachapoly_context::ciphertext_len
uint64_t ciphertext_len
Definition: chachapoly.h:69
mbedtls_chachapoly_free
void mbedtls_chachapoly_free(mbedtls_chachapoly_context *ctx)
This function releases and clears the specified ChaCha20-Poly1305 context.
mbedtls_chachapoly_encrypt_and_tag
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 ...
MBEDTLS_CHACHAPOLY_ENCRYPT
@ MBEDTLS_CHACHAPOLY_ENCRYPT
Definition: chachapoly.h:55
mbedtls_chacha20_context
Definition: chacha20.h:63
config.h
Configuration options (set of defines)
mbedtls_chachapoly_update_aad
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_auth_decrypt
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 ...
mbedtls_poly1305_context
Definition: poly1305.h:63
mbedtls_chachapoly_finish
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).
mbedtls_chachapoly_starts
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.
mbedtls_chachapoly_init
void mbedtls_chachapoly_init(mbedtls_chachapoly_context *ctx)
This function initializes the specified ChaCha20-Poly1305 context.