Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / blowfish.3
1 .rn '' }`
2 ''' $RCSfile$$Revision$$Date$
3 '''
4 ''' $Log$
5 '''
6 .de Sh
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve
30 .ft R
31
32 .fi
33 ..
34 '''
35 '''
36 '''     Set up \*(-- to give an unbreakable dash;
37 '''     string Tr holds user defined translation string.
38 '''     Bell System Logo is used as a dummy character.
39 '''
40 .tr \(*W-|\(bv\*(Tr
41 .ie n \{\
42 .ds -- \(*W-
43 .ds PI pi
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46 .ds L" ""
47 .ds R" ""
48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
50 '''   such as .IP and .SH, which do another additional levels of
51 '''   double-quote interpretation
52 .ds M" """
53 .ds S" """
54 .ds N" """""
55 .ds T" """""
56 .ds L' '
57 .ds R' '
58 .ds M' '
59 .ds S' '
60 .ds N' '
61 .ds T' '
62 'br\}
63 .el\{\
64 .ds -- \(em\|
65 .tr \*(Tr
66 .ds L" ``
67 .ds R" ''
68 .ds M" ``
69 .ds S" ''
70 .ds N" ``
71 .ds T" ''
72 .ds L' `
73 .ds R' '
74 .ds M' `
75 .ds S' '
76 .ds N' `
77 .ds T' '
78 .ds PI \(*p
79 'br\}
80 .\"     If the F register is turned on, we'll generate
81 .\"     index entries out stderr for the following things:
82 .\"             TH      Title 
83 .\"             SH      Header
84 .\"             Sh      Subsection 
85 .\"             Ip      Item
86 .\"             X<>     Xref  (embedded
87 .\"     Of course, you have to process the output yourself
88 .\"     in some meaninful fashion.
89 .if \nF \{
90 .de IX
91 .tm Index:\\$1\t\\n%\t"\\$2"
92 ..
93 .nr % 0
94 .rr F
95 .\}
96 .TH blowfish 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97 .UC
98 .if n .hy 0
99 .if n .na
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101 .de CQ          \" put $1 in typewriter font
102 .ft CW
103 'if n "\c
104 'if t \\&\\$1\c
105 'if n \\&\\$1\c
106 'if n \&"
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108 '.ft R
109 ..
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111 .       \" AM - accent mark definitions
112 .bd B 3
113 .       \" fudge factors for nroff and troff
114 .if n \{\
115 .       ds #H 0
116 .       ds #V .8m
117 .       ds #F .3m
118 .       ds #[ \f1
119 .       ds #] \fP
120 .\}
121 .if t \{\
122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123 .       ds #V .6m
124 .       ds #F 0
125 .       ds #[ \&
126 .       ds #] \&
127 .\}
128 .       \" simple accents for nroff and troff
129 .if n \{\
130 .       ds ' \&
131 .       ds ` \&
132 .       ds ^ \&
133 .       ds , \&
134 .       ds ~ ~
135 .       ds ? ?
136 .       ds ! !
137 .       ds /
138 .       ds q
139 .\}
140 .if t \{\
141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150 .\}
151 .       \" troff and (daisy-wheel) nroff accents
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163 .ds ae a\h'-(\w'a'u*4/10)'e
164 .ds Ae A\h'-(\w'A'u*4/10)'E
165 .ds oe o\h'-(\w'o'u*4/10)'e
166 .ds Oe O\h'-(\w'O'u*4/10)'E
167 .       \" corrections for vroff
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170 .       \" for low resolution devices (crt and lpr)
171 .if \n(.H>23 .if \n(.V>19 \
172 \{\
173 .       ds : e
174 .       ds 8 ss
175 .       ds v \h'-1'\o'\(aa\(ga'
176 .       ds _ \h'-1'^
177 .       ds . \h'-1'.
178 .       ds 3 3
179 .       ds o a
180 .       ds d- d\h'-1'\(ga
181 .       ds D- D\h'-1'\(hy
182 .       ds th \o'bp'
183 .       ds Th \o'LP'
184 .       ds ae ae
185 .       ds Ae AE
186 .       ds oe oe
187 .       ds Oe OE
188 .\}
189 .rm #[ #] #H #V #F C
190 .SH "NAME"
191 blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
192 BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options \- Blowfish encryption
193 .SH "SYNOPSIS"
194 .PP
195 .Vb 1
196 \& #include <openssl/blowfish.h>
197 .Ve
198 .Vb 1
199 \& void BF_set_key(BF_KEY *key, int len, const unsigned char *data);
200 .Ve
201 .Vb 10
202 \& void BF_ecb_encrypt(const unsigned char *in, unsigned char *out,
203 \&         BF_KEY *key, int enc);
204 \& void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
205 \&         long length, BF_KEY *schedule, unsigned char *ivec, int enc);
206 \& void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
207 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num,
208 \&         int enc);
209 \& void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
210 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num);
211 \& const char *BF_options(void);
212 .Ve
213 .Vb 2
214 \& void BF_encrypt(BF_LONG *data,const BF_KEY *key);
215 \& void BF_decrypt(BF_LONG *data,const BF_KEY *key);
216 .Ve
217 .SH "DESCRIPTION"
218 This library implements the Blowfish cipher, which was invented and described
219 by Counterpane (see http://www.counterpane.com/blowfish.html ).
220 .PP
221 Blowfish is a block cipher that operates on 64 bit (8 byte) blocks of data.
222 It uses a variable size key, but typically, 128 bit (16 byte) keys are
223 a considered good for strong encryption.  Blowfish can be used in the same
224 modes as DES (see des_modes(7)).  Blowfish is currently one
225 of the faster block ciphers.  It is quite a bit faster than DES, and much
226 faster than IDEA or RC2.
227 .PP
228 Blowfish consists of a key setup phase and the actual encryption or decryption
229 phase.
230 .PP
231 \fIBF_set_key()\fR sets up the \fBBF_KEY\fR \fBkey\fR using the \fBlen\fR bytes long key
232 at \fBdata\fR.
233 .PP
234 \fIBF_ecb_encrypt()\fR is the basic Blowfish encryption and decryption function.
235 It encrypts or decrypts the first 64 bits of \fBin\fR using the key \fBkey\fR,
236 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fBBF_ENCRYPT\fR)
237 or decryption (\fBBF_DECRYPT\fR) shall be performed.  The vector pointed at by
238 \fBin\fR and \fBout\fR must be 64 bits in length, no less.  If they are larger,
239 everything after the first 64 bits is ignored.
240 .PP
241 The mode functions \fIBF_cbc_encrypt()\fR, \fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR
242 all operate on variable length data.  They all take an initialization vector
243 \fBivec\fR which needs to be passed along into the next call of the same function 
244 for the same message.  \fBivec\fR may be initialized with anything, but the
245 recipient needs to know what it was initialized with, or it won't be able
246 to decrypt.  Some programs and protocols simplify this, like SSH, where
247 \fBivec\fR is simply initialized to zero.
248 \fIBF_cbc_encrypt()\fR operates on data that is a multiple of 8 bytes long, while
249 \fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR are used to encrypt an variable
250 number of bytes (the amount does not have to be an exact multiple of 8).  The
251 purpose of the latter two is to simulate stream ciphers, and therefore, they
252 need the parameter \fBnum\fR, which is a pointer to an integer where the current
253 offset in \fBivec\fR is stored between calls.  This integer must be initialized
254 to zero when \fBivec\fR is initialized.
255 .PP
256 \fIBF_cbc_encrypt()\fR is the Cipher Block Chaining function for Blowfish.  It
257 encrypts or decrypts the 64 bits chunks of \fBin\fR using the key \fBschedule\fR,
258 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (BF_ENCRYPT) or
259 decryption (BF_DECRYPT) shall be performed.  \fBivec\fR must point at an 8 byte
260 long initialization vector.
261 .PP
262 \fIBF_cfb64_encrypt()\fR is the CFB mode for Blowfish with 64 bit feedback.
263 It encrypts or decrypts the bytes in \fBin\fR using the key \fBschedule\fR,
264 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fBBF_ENCRYPT\fR)
265 or decryption (\fBBF_DECRYPT\fR) shall be performed.  \fBivec\fR must point at an
266 8 byte long initialization vector. \fBnum\fR must point at an integer which must
267 be initially zero.
268 .PP
269 \fIBF_ofb64_encrypt()\fR is the OFB mode for Blowfish with 64 bit feedback.
270 It uses the same parameters as \fIBF_cfb64_encrypt()\fR, which must be initialized
271 the same way.
272 .PP
273 \fIBF_encrypt()\fR and \fIBF_decrypt()\fR are the lowest level functions for Blowfish
274 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
275 \fBdata\fR, using the key \fBkey\fR.  These functions should not be used unless you
276 implement \*(L'modes\*(R' of Blowfish.  The alternative is to use \fIBF_ecb_encrypt()\fR.
277 If you still want to use these functions, you should be aware that they take
278 each 32-bit chunk in host-byte order, which is little-endian on little-endian
279 platforms and big-endian on big-endian ones.
280 .SH "RETURN VALUES"
281 None of the functions presented here return any value.
282 .SH "NOTE"
283 Applications should use the higher level functions
284 EVP_EncryptInit(3) etc. instead of calling the
285 blowfish functions directly.
286 .SH "SEE ALSO"
287 des_modes(7)
288 .SH "HISTORY"
289 The Blowfish functions are available in all versions of SSLeay and OpenSSL.
290
291 .rn }` ''
292 .IX Title "blowfish 3"
293 .IX Name "blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
294 BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options - Blowfish encryption"
295
296 .IX Header "NAME"
297
298 .IX Header "SYNOPSIS"
299
300 .IX Header "DESCRIPTION"
301
302 .IX Header "RETURN VALUES"
303
304 .IX Header "NOTE"
305
306 .IX Header "SEE ALSO"
307
308 .IX Header "HISTORY"
309