xref: /freebsd/crypto/openssl/doc/man3/EVP_chacha20.pod (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1=pod
2
3=head1 NAME
4
5EVP_chacha20,
6EVP_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
18The ChaCha20 stream cipher for EVP.
19
20=over 4
21
22=item EVP_chacha20()
23
24The ChaCha20 stream cipher. The key length is 256 bits, the IV is 128 bits long.
25The first 32 bits consists of a counter in little-endian order followed by a 96
26bit nonce. For example a nonce of:
27
28000000000000000000000002
29
30With an initial counter of 42 (2a in hex) would be expressed as:
31
322a000000000000000000000000000002
33
34=item EVP_chacha20_poly1305()
35
36Authenticated encryption with ChaCha20-Poly1305. Like EVP_chacha20(), the key
37is 256 bits and the IV is 96 bits. This supports additional authenticated data
38(AAD) and produces a 128-bit authentication tag. See the
39L<EVP_EncryptInit(3)/AEAD Interface> section for more information.
40
41=back
42
43=head1 NOTES
44
45Developers should be aware of the negative performance implications of
46calling these functions multiple times and should consider using
47L<EVP_CIPHER_fetch(3)> instead.
48See L<crypto(7)/Performance> for further information.
49
50=head1 RETURN VALUES
51
52These functions return an B<EVP_CIPHER> structure that contains the
53implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
54details of the B<EVP_CIPHER> structure.
55
56=head1 SEE ALSO
57
58L<evp(7)>,
59L<EVP_EncryptInit(3)>,
60L<EVP_CIPHER_meth_new(3)>
61
62=head1 COPYRIGHT
63
64Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
65
66Licensed under the Apache License 2.0 (the "License").  You may not use
67this file except in compliance with the License.  You can obtain a copy
68in the file LICENSE in the source distribution or at
69L<https://www.openssl.org/source/license.html>.
70
71=cut
72
73