xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_chacha20.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_chacha20.3,v 1.8 2024/09/08 13:08:25 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_chacha20 3"
EVP_chacha20 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_chacha20, EVP_chacha20_poly1305 \- EVP ChaCha20 stream cipher
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& const EVP_CIPHER *EVP_chacha20(void); const EVP_CIPHER *EVP_chacha20_poly1305(void); .Ve
DESCRIPTION
Header "DESCRIPTION" The ChaCha20 stream cipher for EVP.
EVP_chacha20() 4
Item "EVP_chacha20()" The ChaCha20 stream cipher. The key length is 256 bits, the IV is 128 bits long. The first 64 bits consists of a counter in little-endian order followed by a 64 bit nonce. For example a nonce of: .Sp 0000000000000002 .Sp With an initial counter of 42 (2a in hex) would be expressed as: .Sp 2a000000000000000000000000000002
EVP_chacha20_poly1305() 4
Item "EVP_chacha20_poly1305()" Authenticated encryption with ChaCha20-Poly1305. Like EVP_chacha20(), the key is 256 bits and the IV is 96 bits. This supports additional authenticated data (AAD) and produces a 128-bit authentication tag. See the "AEAD Interface" in EVP_EncryptInit\|(3) section for more information.
NOTES
Header "NOTES" Developers should be aware of the negative performance implications of calling these functions multiple times and should consider using \fBEVP_CIPHER_fetch\|(3) with EVP_CIPHER-CHACHA\|(7) instead. See "Performance" in crypto\|(7) for further information.

RFC 7539 <https://www.rfc-editor.org/rfc/rfc7539.html#section-2.4> uses a 32 bit counter and a 96 bit nonce for the IV.

"RETURN VALUES"
Header "RETURN VALUES" These functions return an EVP_CIPHER structure that contains the implementation of the symmetric cipher. See EVP_CIPHER_meth_new\|(3) for details of the EVP_CIPHER structure.
"SEE ALSO"
Header "SEE ALSO" \fBevp\|(7), \fBEVP_EncryptInit\|(3), \fBEVP_CIPHER_meth_new\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.