Blame doc/man3/EVP_chacha20.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
EVP_chacha20,
Packit Service 084de1
EVP_chacha20_poly1305
Packit Service 084de1
- EVP ChaCha20 stream cipher
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/evp.h>
Packit Service 084de1
Packit Service 084de1
 const EVP_CIPHER *EVP_chacha20(void)
Packit Service 084de1
 const EVP_CIPHER *EVP_chacha20_poly1305(void)
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
The ChaCha20 stream cipher for EVP.
Packit Service 084de1
Packit Service 084de1
=over 4
Packit Service 084de1
Packit Service 084de1
=item EVP_chacha20()
Packit Service 084de1
Packit Service 084de1
The ChaCha20 stream cipher. The key length is 256 bits, the IV is 128 bits long.
Packit Service 084de1
The first 32 bits consists of a counter in little-endian order followed by a 96
Packit Service 084de1
bit nonce. For example a nonce of:
Packit Service 084de1
Packit Service 084de1
000000000000000000000002
Packit Service 084de1
Packit Service 084de1
With an initial counter of 42 (2a in hex) would be expressed as:
Packit Service 084de1
Packit Service 084de1
2a000000000000000000000000000002
Packit Service 084de1
Packit Service 084de1
=item EVP_chacha20_poly1305()
Packit Service 084de1
Packit Service 084de1
Authenticated encryption with ChaCha20-Poly1305. Like EVP_chacha20(), the key
Packit Service 084de1
is 256 bits and the IV is 96 bits. This supports additional authenticated data
Packit Service 084de1
(AAD) and produces a 128-bit authentication tag. See the
Packit Service 084de1
L<EVP_EncryptInit(3)/AEAD Interface> section for more information.
Packit Service 084de1
Packit Service 084de1
=back
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
These functions return an B<EVP_CIPHER> structure that contains the
Packit Service 084de1
implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
Packit Service 084de1
details of the B<EVP_CIPHER> structure.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<evp(7)>,
Packit Service 084de1
L<EVP_EncryptInit(3)>,
Packit Service 084de1
L<EVP_CIPHER_meth_new(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut
Packit Service 084de1