Debian Codegraph @

upstream/debian-unstable/man3/EVP_chacha20.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_CHACHA20 3SSL"
58 .TH EVP_CHACHA20 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_chacha20,
65 EVP_chacha20_poly1305
66 \&\- EVP ChaCha20 stream cipher
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/evp.h>
71 \&
72 \& const EVP_CIPHER *EVP_chacha20(void);
73 \& const EVP_CIPHER *EVP_chacha20_poly1305(void);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 The ChaCha20 stream cipher for EVP.
78 .IP \fBEVP_chacha20()\fR 4
79 .IX Item "EVP_chacha20()"
80 The ChaCha20 stream cipher. The key length is 256 bits, the IV is 128 bits long.
81 The first 64 bits consists of a counter in little-endian order followed by a 64
82 bit nonce. For example a nonce of:
83 .Sp
84 0000000000000002
85 .Sp
86 With an initial counter of 42 (2a in hex) would be expressed as:
87 .Sp
88 2a000000000000000000000000000002
89 .IP \fBEVP_chacha20_poly1305()\fR 4
90 .IX Item "EVP_chacha20_poly1305()"
91 Authenticated encryption with ChaCha20\-Poly1305. Like \fBEVP_chacha20()\fR, the key
92 is 256 bits and the IV is 96 bits. This supports additional authenticated data
93 (AAD) and produces a 128\-bit authentication tag. See the
94 "AEAD INTERFACE" in \fBEVP_EncryptInit\fR\|(3) section for more information.
95 .SH NOTES
96 .IX Header "NOTES"
97 Developers should be aware of the negative performance implications of
98 calling these functions multiple times and should consider using
99 \&\fBEVP_CIPHER_fetch\fR\|(3) with \fBEVP_CIPHER\-CHACHA\fR\|(7) instead.
100 See "Performance" in \fBcrypto\fR\|(7) for further information.
101 .PP
102 RFC 7539 <https://www.rfc-editor.org/rfc/rfc7539.html#section-2.4>
103 uses a 32 bit counter and a 96 bit nonce for the IV.
104 .SH "RETURN VALUES"
105 .IX Header "RETURN VALUES"
106 These functions return an \fBEVP_CIPHER\fR structure that contains the
107 implementation of the symmetric cipher. See \fBEVP_CIPHER_meth_new\fR\|(3) for
108 details of the \fBEVP_CIPHER\fR structure.
109 .SH "SEE ALSO"
110 .IX Header "SEE ALSO"
111 \&\fBevp\fR\|(7),
112 \&\fBEVP_EncryptInit\fR\|(3),
113 \&\fBEVP_CIPHER_meth_new\fR\|(3)
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2017\-2025 The OpenSSL Project Authors. All Rights Reserved.
117 .PP
118 Licensed under the Apache License 2.0 (the "License"). You may not use
119 this file except in compliance with the License. You can obtain a copy
120 in the file LICENSE in the source distribution or at
121 <https://www.openssl.org/source/license.html>.