diff options
Diffstat (limited to 'src/lib/libcrypto/man/EVP_chacha20.3')
| -rw-r--r-- | src/lib/libcrypto/man/EVP_chacha20.3 | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/EVP_chacha20.3 b/src/lib/libcrypto/man/EVP_chacha20.3 new file mode 100644 index 0000000000..000ac88290 --- /dev/null +++ b/src/lib/libcrypto/man/EVP_chacha20.3 | |||
| @@ -0,0 +1,93 @@ | |||
| 1 | .\" $OpenBSD: EVP_chacha20.3,v 1.1 2023/08/15 11:26:49 schwarze Exp $ | ||
| 2 | .\" full merge up to: OpenSSL 35fd9953 May 28 14:49:38 2019 +0200 | ||
| 3 | .\" | ||
| 4 | .\" This file was written by Ronald Tse <ronald.tse@ribose.com> | ||
| 5 | .\" and Matt Caswell <matt@openssl.org>. | ||
| 6 | .\" Copyright (c) 2017, 2019 The OpenSSL Project. All rights reserved. | ||
| 7 | .\" | ||
| 8 | .\" Redistribution and use in source and binary forms, with or without | ||
| 9 | .\" modification, are permitted provided that the following conditions | ||
| 10 | .\" are met: | ||
| 11 | .\" | ||
| 12 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 13 | .\" notice, this list of conditions and the following disclaimer. | ||
| 14 | .\" | ||
| 15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 16 | .\" notice, this list of conditions and the following disclaimer in | ||
| 17 | .\" the documentation and/or other materials provided with the | ||
| 18 | .\" distribution. | ||
| 19 | .\" | ||
| 20 | .\" 3. All advertising materials mentioning features or use of this | ||
| 21 | .\" software must display the following acknowledgment: | ||
| 22 | .\" "This product includes software developed by the OpenSSL Project | ||
| 23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 24 | .\" | ||
| 25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 26 | .\" endorse or promote products derived from this software without | ||
| 27 | .\" prior written permission. For written permission, please contact | ||
| 28 | .\" openssl-core@openssl.org. | ||
| 29 | .\" | ||
| 30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 32 | .\" permission of the OpenSSL Project. | ||
| 33 | .\" | ||
| 34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 35 | .\" acknowledgment: | ||
| 36 | .\" "This product includes software developed by the OpenSSL Project | ||
| 37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 38 | .\" | ||
| 39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 51 | .\" | ||
| 52 | .Dd $Mdocdate: August 15 2023 $ | ||
| 53 | .Dt EVP_CHACHA20 3 | ||
| 54 | .Os | ||
| 55 | .Sh NAME | ||
| 56 | .Nm EVP_chacha20 , | ||
| 57 | .Nm EVP_chacha20_poly1305 | ||
| 58 | .Nd ChaCha20 stream cipher for EVP | ||
| 59 | .Sh SYNOPSIS | ||
| 60 | .In openssl/evp.h | ||
| 61 | .Ft const EVP_CIPHER * | ||
| 62 | .Fn EVP_chacha20 void | ||
| 63 | .Ft const EVP_CIPHER * | ||
| 64 | .Fn EVP_chacha20_poly1305 void | ||
| 65 | .Sh DESCRIPTION | ||
| 66 | .Fn EVP_chacha20 | ||
| 67 | provides the ChaCha20 stream cipher in the EVP framework. | ||
| 68 | The key length is 256 bits, the IV is 128 bits long. | ||
| 69 | The first 32 bits consists of a counter in little-endian order followed | ||
| 70 | by a 96 bit nonce. | ||
| 71 | For example a nonce of: | ||
| 72 | .Pp | ||
| 73 | 000000000000000000000002 | ||
| 74 | .Pp | ||
| 75 | With an initial counter of 42 (2a in hex) would be expressed as: | ||
| 76 | .Pp | ||
| 77 | 2a000000000000000000000000000002 | ||
| 78 | .Pp | ||
| 79 | .Fn EVP_chacha20_poly1305 | ||
| 80 | provides authenticated encryption with ChaCha20-Poly1305. | ||
| 81 | Like | ||
| 82 | .Fn EVP_chacha20 , | ||
| 83 | the key is 256 bits and the IV is 96 bits. | ||
| 84 | This supports additional authenticated data (AAD) and produces a 128-bit | ||
| 85 | authentication tag. | ||
| 86 | .Sh RETURN VALUES | ||
| 87 | These functions return return pointers to static | ||
| 88 | .Vt EVP_CIPHER | ||
| 89 | objects that contain the implementations of the symmetric cipher. | ||
| 90 | .Sh SEE ALSO | ||
| 91 | .Xr evp 3 , | ||
| 92 | .Xr EVP_CIPHER_meth_new 3 , | ||
| 93 | .Xr EVP_EncryptInit 3 | ||