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/BF_set_key.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/BF_set_key.3')
-rw-r--r-- | src/lib/libcrypto/man/BF_set_key.3 | 269 |
1 files changed, 0 insertions, 269 deletions
diff --git a/src/lib/libcrypto/man/BF_set_key.3 b/src/lib/libcrypto/man/BF_set_key.3 deleted file mode 100644 index 5f4c7a689b..0000000000 --- a/src/lib/libcrypto/man/BF_set_key.3 +++ /dev/null | |||
@@ -1,269 +0,0 @@ | |||
1 | .\" $OpenBSD: BF_set_key.3,v 1.12 2023/08/05 18:27:55 jmc Exp $ | ||
2 | .\" OpenSSL 99d63d46 Jul 19 09:27:53 2016 -0400 | ||
3 | .\" | ||
4 | .\" This file was written by Richard Levitte <levitte@openssl.org>. | ||
5 | .\" Copyright (c) 2000, 2002, 2005, 2014, 2016 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: August 5 2023 $ | ||
53 | .Dt BF_SET_KEY 3 | ||
54 | .Os | ||
55 | .Sh NAME | ||
56 | .Nm BF_set_key , | ||
57 | .Nm BF_encrypt , | ||
58 | .Nm BF_decrypt , | ||
59 | .Nm BF_ecb_encrypt , | ||
60 | .Nm BF_cbc_encrypt , | ||
61 | .Nm BF_cfb64_encrypt , | ||
62 | .Nm BF_ofb64_encrypt | ||
63 | .Nd Blowfish encryption | ||
64 | .Sh SYNOPSIS | ||
65 | .In openssl/blowfish.h | ||
66 | .Ft void | ||
67 | .Fo BF_set_key | ||
68 | .Fa "BF_KEY *key" | ||
69 | .Fa "int len" | ||
70 | .Fa "const unsigned char *data" | ||
71 | .Fc | ||
72 | .Ft void | ||
73 | .Fo BF_encrypt | ||
74 | .Fa "BF_LONG *data" | ||
75 | .Fa "const BF_KEY *key" | ||
76 | .Fc | ||
77 | .Ft void | ||
78 | .Fo BF_decrypt | ||
79 | .Fa "BF_LONG *data" | ||
80 | .Fa "const BF_KEY *key" | ||
81 | .Fc | ||
82 | .Ft void | ||
83 | .Fo BF_ecb_encrypt | ||
84 | .Fa "const unsigned char *in" | ||
85 | .Fa "unsigned char *out" | ||
86 | .Fa "BF_KEY *key" | ||
87 | .Fa "int enc" | ||
88 | .Fc | ||
89 | .Ft void | ||
90 | .Fo BF_cbc_encrypt | ||
91 | .Fa "const unsigned char *in" | ||
92 | .Fa "unsigned char *out" | ||
93 | .Fa "long length" | ||
94 | .Fa "BF_KEY *schedule" | ||
95 | .Fa "unsigned char *ivec" | ||
96 | .Fa "int enc" | ||
97 | .Fc | ||
98 | .Ft void | ||
99 | .Fo BF_cfb64_encrypt | ||
100 | .Fa "const unsigned char *in" | ||
101 | .Fa "unsigned char *out" | ||
102 | .Fa "long length" | ||
103 | .Fa "BF_KEY *schedule" | ||
104 | .Fa "unsigned char *ivec" | ||
105 | .Fa "int *num" | ||
106 | .Fa "int enc" | ||
107 | .Fc | ||
108 | .Ft void | ||
109 | .Fo BF_ofb64_encrypt | ||
110 | .Fa "const unsigned char *in" | ||
111 | .Fa "unsigned char *out" | ||
112 | .Fa "long length" | ||
113 | .Fa "BF_KEY *schedule" | ||
114 | .Fa "unsigned char *ivec" | ||
115 | .Fa "int *num" | ||
116 | .Fc | ||
117 | .Sh DESCRIPTION | ||
118 | This library implements the Blowfish cipher, | ||
119 | which was invented and defined by | ||
120 | .An Counterpane . | ||
121 | Note that applications should use higher level functions such as | ||
122 | .Xr EVP_EncryptInit 3 | ||
123 | instead of calling the Blowfish functions directly. | ||
124 | .Pp | ||
125 | Blowfish is a block cipher that operates on 64-bit (8 byte) blocks of data. | ||
126 | It uses a variable size key, but typically, 128-bit (16 byte) keys | ||
127 | are considered good for strong encryption. | ||
128 | Blowfish can be used in the same modes as DES | ||
129 | and is currently one of the faster block ciphers. | ||
130 | It is quite a bit faster than DES, and much faster than IDEA or RC2. | ||
131 | .Pp | ||
132 | Blowfish consists of a key setup phase | ||
133 | and the actual encryption or decryption phase. | ||
134 | .Pp | ||
135 | .Fn BF_set_key | ||
136 | sets up the | ||
137 | .Vt BF_KEY | ||
138 | .Fa key | ||
139 | using the | ||
140 | .Fa len | ||
141 | bytes long key at | ||
142 | .Fa data . | ||
143 | .Pp | ||
144 | .Fn BF_ecb_encrypt | ||
145 | is the basic Blowfish encryption and decryption function. | ||
146 | It encrypts or decrypts the first 64 bits of | ||
147 | .Fa in | ||
148 | using the key | ||
149 | .Fa key , | ||
150 | putting the result in | ||
151 | .Fa out . | ||
152 | .Fa enc | ||
153 | decides if encryption | ||
154 | .Pq Dv BF_ENCRYPT | ||
155 | or decryption | ||
156 | .Pq Dv BF_DECRYPT | ||
157 | shall be performed. | ||
158 | The vector pointed at by | ||
159 | .Fa in | ||
160 | and | ||
161 | .Fa out | ||
162 | must be 64 bits in length, no less. | ||
163 | If they are larger, everything after the first 64 bits is ignored. | ||
164 | .Pp | ||
165 | The mode functions | ||
166 | .Fn BF_cbc_encrypt , | ||
167 | .Fn BF_cfb64_encrypt , | ||
168 | and | ||
169 | .Fn BF_ofb64_encrypt | ||
170 | all operate on variable length data. | ||
171 | They all take an initialization vector | ||
172 | .Fa ivec | ||
173 | which needs to be passed along into the next call of the same function | ||
174 | for the same message. | ||
175 | .Fa ivec | ||
176 | may be initialized with anything, but the recipient needs to know what | ||
177 | it was initialized with, or it won't be able to decrypt. | ||
178 | Some programs and protocols simplify this, like SSH, where | ||
179 | .Fa ivec | ||
180 | is simply initialized to zero. | ||
181 | .Fn BF_cbc_encrypt | ||
182 | operates on data that is a multiple of 8 bytes long, while | ||
183 | .Fn BF_cfb64_encrypt | ||
184 | and | ||
185 | .Fn BF_ofb64_encrypt | ||
186 | are used to encrypt a variable number of bytes (the amount | ||
187 | does not have to be an exact multiple of 8). | ||
188 | The purpose of the latter two is to simulate stream ciphers and, | ||
189 | therefore, they need the parameter | ||
190 | .Fa num , | ||
191 | which is a pointer to an integer where the current offset in | ||
192 | .Fa ivec | ||
193 | is stored between calls. | ||
194 | This integer must be initialized to zero when | ||
195 | .Fa ivec | ||
196 | is initialized. | ||
197 | .Pp | ||
198 | .Fn BF_cbc_encrypt | ||
199 | is the Cipher Block Chaining function for Blowfish. | ||
200 | It encrypts or decrypts the 64-bit chunks of | ||
201 | .Fa in | ||
202 | using the key | ||
203 | .Fa schedule , | ||
204 | putting the result in | ||
205 | .Fa out . | ||
206 | .Fa enc | ||
207 | decides if encryption | ||
208 | .Pq Dv BF_ENCRYPT | ||
209 | or decryption | ||
210 | .Pq Dv BF_DECRYPT | ||
211 | shall be performed. | ||
212 | .Fa ivec | ||
213 | must point at an 8-byte long initialization vector. | ||
214 | .Pp | ||
215 | .Fn BF_cfb64_encrypt | ||
216 | is the CFB mode for Blowfish with 64-bit feedback. | ||
217 | It encrypts or decrypts the bytes in | ||
218 | .Fa in | ||
219 | using the key | ||
220 | .Fa schedule , | ||
221 | putting the result in | ||
222 | .Fa out . | ||
223 | .Fa enc | ||
224 | decides if encryption | ||
225 | .Pq Dv BF_ENCRYPT | ||
226 | or decryption | ||
227 | .Pq Dv BF_DECRYPT | ||
228 | shall be performed. | ||
229 | .Fa ivec | ||
230 | must point at an | ||
231 | 8-byte long initialization vector. | ||
232 | .Fa num | ||
233 | must point at an integer which must be initially zero. | ||
234 | .Pp | ||
235 | .Fn BF_ofb64_encrypt | ||
236 | is the OFB mode for Blowfish with 64-bit feedback. | ||
237 | It uses the same parameters as | ||
238 | .Fn BF_cfb64_encrypt , | ||
239 | which must be initialized the same way. | ||
240 | .Pp | ||
241 | .Fn BF_encrypt | ||
242 | and | ||
243 | .Fn BF_decrypt | ||
244 | are the lowest level functions for Blowfish encryption. | ||
245 | They encrypt/decrypt the first 64 bits of the vector pointed by | ||
246 | .Fa data , | ||
247 | using the key | ||
248 | .Fa key . | ||
249 | These functions should not be used unless implementing `modes' of Blowfish. | ||
250 | The alternative is to use | ||
251 | .Fn BF_ecb_encrypt . | ||
252 | Be aware that these functions take each 32-bit chunk in host-byte order, | ||
253 | which is little-endian on little-endian platforms | ||
254 | and big-endian on big-endian ones. | ||
255 | .Sh SEE ALSO | ||
256 | .Xr EVP_EncryptInit 3 | ||
257 | .Sh HISTORY | ||
258 | .Fn BF_set_key , | ||
259 | .Fn BF_encrypt , | ||
260 | .Fn BF_ecb_encrypt , | ||
261 | .Fn BF_cbc_encrypt , | ||
262 | .Fn BF_cfb64_encrypt , | ||
263 | and | ||
264 | .Fn BF_ofb64_encrypt | ||
265 | first appeared in SSLeay 0.6.6. | ||
266 | .Fn BF_decrypt | ||
267 | first appeared in SSLeay 0.9.0. | ||
268 | All these functions have been available since | ||
269 | .Ox 2.4 . | ||