diff options
author | cvs2svn <admin@example.com> | 2025-04-14 17:32:06 +0000 |
---|---|---|
committer | cvs2svn <admin@example.com> | 2025-04-14 17:32:06 +0000 |
commit | eb8dd9dca1228af0cd132f515509051ecfabf6f6 (patch) | |
tree | edb6da6af7e865d488dc1a29309f1e1ec226e603 /src/lib/libcrypto/man/EVP_BytesToKey.3 | |
parent | 247f0352e0ed72a4f476db9dc91f4d982bc83eb2 (diff) | |
download | openbsd-tb_20250414.tar.gz openbsd-tb_20250414.tar.bz2 openbsd-tb_20250414.zip |
This commit was manufactured by cvs2git to create tag 'tb_20250414'.tb_20250414
Diffstat (limited to 'src/lib/libcrypto/man/EVP_BytesToKey.3')
-rw-r--r-- | src/lib/libcrypto/man/EVP_BytesToKey.3 | 145 |
1 files changed, 0 insertions, 145 deletions
diff --git a/src/lib/libcrypto/man/EVP_BytesToKey.3 b/src/lib/libcrypto/man/EVP_BytesToKey.3 deleted file mode 100644 index 1f78b4de06..0000000000 --- a/src/lib/libcrypto/man/EVP_BytesToKey.3 +++ /dev/null | |||
@@ -1,145 +0,0 @@ | |||
1 | .\" $OpenBSD: EVP_BytesToKey.3,v 1.9 2024/12/05 15:12:37 schwarze Exp $ | ||
2 | .\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | ||
3 | .\" | ||
4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
5 | .\" Copyright (c) 2001, 2011, 2013, 2014, 2015 The OpenSSL Project. | ||
6 | .\" 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: December 5 2024 $ | ||
53 | .Dt EVP_BYTESTOKEY 3 | ||
54 | .Os | ||
55 | .Sh NAME | ||
56 | .Nm EVP_BytesToKey | ||
57 | .Nd password based encryption routine | ||
58 | .Sh SYNOPSIS | ||
59 | .In openssl/evp.h | ||
60 | .Ft int | ||
61 | .Fo EVP_BytesToKey | ||
62 | .Fa "const EVP_CIPHER *type" | ||
63 | .Fa "const EVP_MD *md" | ||
64 | .Fa "const unsigned char *salt" | ||
65 | .Fa "const unsigned char *data" | ||
66 | .Fa "int datal" | ||
67 | .Fa "int count" | ||
68 | .Fa "unsigned char *key" | ||
69 | .Fa "unsigned char *iv" | ||
70 | .Fc | ||
71 | .Sh DESCRIPTION | ||
72 | .Fn EVP_BytesToKey | ||
73 | derives a key and IV from various parameters. | ||
74 | .Fa type | ||
75 | is the cipher to derive the key and IV for. | ||
76 | .Fa md | ||
77 | is the message digest to use. | ||
78 | The | ||
79 | .Fa salt | ||
80 | parameter is used as a salt in the derivation: | ||
81 | it should point to a buffer containing | ||
82 | .Dv PKCS5_SALT_LEN No = 8 | ||
83 | bytes or | ||
84 | .Dv NULL | ||
85 | if no salt is used. | ||
86 | .Fa data | ||
87 | is a buffer containing | ||
88 | .Fa datal | ||
89 | bytes which is used to derive the keying data. | ||
90 | .Fa count | ||
91 | is the iteration count to use. | ||
92 | The derived key and IV will be written to | ||
93 | .Fa key | ||
94 | and | ||
95 | .Fa iv , | ||
96 | respectively. | ||
97 | .Pp | ||
98 | A typical application of this function is to derive keying material for | ||
99 | an encryption algorithm from a password in the | ||
100 | .Fa data | ||
101 | parameter. | ||
102 | .Pp | ||
103 | Increasing the | ||
104 | .Fa count | ||
105 | parameter slows down the algorithm, which makes it harder for an attacker | ||
106 | to perform a brute force attack using a large number of candidate | ||
107 | passwords. | ||
108 | .Pp | ||
109 | If the total key and IV length is less than the digest length and MD5 | ||
110 | is used, then the derivation algorithm is compatible with PKCS#5 v1.5. | ||
111 | Otherwise, a non-standard extension is used to derive the extra data. | ||
112 | .Pp | ||
113 | Newer applications should use more standard algorithms such as PBKDF2 as | ||
114 | defined in PKCS#5v2.1 for key derivation. | ||
115 | .Sh KEY DERIVATION ALGORITHM | ||
116 | The key and IV is derived by concatenating D_1, D_2, etc. until enough | ||
117 | data is available for the key and IV. | ||
118 | D_i is defined recursively as: | ||
119 | .Pp | ||
120 | .Dl D_i = HASH^count(D_(i-1) || data || salt) | ||
121 | .Pp | ||
122 | where || denotes concatenation, D_0 is empty, HASH is the digest | ||
123 | algorithm in use, HASH^1(data) is simply HASH(data), HASH^2(data) is | ||
124 | HASH(HASH(data)) and so on. | ||
125 | .Pp | ||
126 | The initial bytes are used for the key and the subsequent bytes for the | ||
127 | IV. | ||
128 | .Sh RETURN VALUES | ||
129 | If | ||
130 | .Fa data | ||
131 | is | ||
132 | .Dv NULL , | ||
133 | .Fn EVP_BytesToKey | ||
134 | returns the number of bytes needed to store the derived key. | ||
135 | Otherwise, | ||
136 | .Fn EVP_BytesToKey | ||
137 | returns the size of the derived key in bytes or 0 on error. | ||
138 | .Sh SEE ALSO | ||
139 | .Xr evp 3 , | ||
140 | .Xr EVP_EncryptInit 3 , | ||
141 | .Xr PKCS5_PBKDF2_HMAC 3 | ||
142 | .Sh HISTORY | ||
143 | .Fn EVP_BytesToKey | ||
144 | first appeared in SSLeay 0.5.1 and has been available since | ||
145 | .Ox 2.4 . | ||