96da825cded4b1de62ecaf5b51925d0abfbb7888
[openssl.git] / doc / man3 / EVP_chacha20.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_chacha20,
6 EVP_chacha20_poly1305
7 - EVP ChaCha20 stream cipher
8
9 =head1 SYNOPSIS
10
11  #include <openssl/evp.h>
12
13  const EVP_CIPHER *EVP_chacha20(void)
14  const EVP_CIPHER *EVP_chacha20_poly1305(void)
15
16 =head1 DESCRIPTION
17
18 The ChaCha20 stream cipher for EVP.
19
20 =over 4
21
22 =item EVP_chacha20()
23
24 The ChaCha20 stream cipher. The key length is 256 bits, the IV is 96 bits long.
25
26 =item EVP_chacha20_poly1305()
27
28 Authenticated encryption with ChaCha20-Poly1305. Like EVP_chacha20(), the key
29 is 256 bits and the IV is 96 bits. This supports additional authenticated data
30 (AAD) and produces a 128-bit authentication tag. See the
31 L<EVP_EncryptInit(3)/AEAD Interface> section for more information.
32
33 =back
34
35 =head1 RETURN VALUES
36
37 These functions return an B<EVP_CIPHER> structure that contains the
38 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
39 details of the B<EVP_CIPHER> structure.
40
41 =head1 SEE ALSO
42
43 L<evp(7)>,
44 L<EVP_EncryptInit(3)>,
45 L<EVP_CIPHER_meth_new(3)>
46
47 =head1 COPYRIGHT
48
49 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
50
51 Licensed under the OpenSSL license (the "License").  You may not use
52 this file except in compliance with the License.  You can obtain a copy
53 in the file LICENSE in the source distribution or at
54 L<https://www.openssl.org/source/license.html>.
55
56 =cut
57