Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / blowfish.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "blowfish 3"
127 .TH blowfish 3 "2012-01-04" "1.0.0f" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
134 BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options \- Blowfish encryption
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 1
138 \& #include <openssl/blowfish.h>
139 \&
140 \& void BF_set_key(BF_KEY *key, int len, const unsigned char *data);
141 \&
142 \& void BF_ecb_encrypt(const unsigned char *in, unsigned char *out,
143 \&         BF_KEY *key, int enc);
144 \& void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
145 \&         long length, BF_KEY *schedule, unsigned char *ivec, int enc);
146 \& void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
147 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num,
148 \&         int enc);
149 \& void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
150 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num);
151 \& const char *BF_options(void);
152 \&
153 \& void BF_encrypt(BF_LONG *data,const BF_KEY *key);
154 \& void BF_decrypt(BF_LONG *data,const BF_KEY *key);
155 .Ve
156 .SH "DESCRIPTION"
157 .IX Header "DESCRIPTION"
158 This library implements the Blowfish cipher, which was invented and described
159 by Counterpane (see http://www.counterpane.com/blowfish.html ).
160 .PP
161 Blowfish is a block cipher that operates on 64 bit (8 byte) blocks of data.
162 It uses a variable size key, but typically, 128 bit (16 byte) keys are
163 considered good for strong encryption.  Blowfish can be used in the same
164 modes as \s-1DES\s0 (see \fIdes_modes\fR\|(7)).  Blowfish is currently one
165 of the faster block ciphers.  It is quite a bit faster than \s-1DES\s0, and much
166 faster than \s-1IDEA\s0 or \s-1RC2\s0.
167 .PP
168 Blowfish consists of a key setup phase and the actual encryption or decryption
169 phase.
170 .PP
171 \&\fIBF_set_key()\fR sets up the \fB\s-1BF_KEY\s0\fR \fBkey\fR using the \fBlen\fR bytes long key
172 at \fBdata\fR.
173 .PP
174 \&\fIBF_ecb_encrypt()\fR is the basic Blowfish encryption and decryption function.
175 It encrypts or decrypts the first 64 bits of \fBin\fR using the key \fBkey\fR,
176 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
177 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  The vector pointed at by
178 \&\fBin\fR and \fBout\fR must be 64 bits in length, no less.  If they are larger,
179 everything after the first 64 bits is ignored.
180 .PP
181 The mode functions \fIBF_cbc_encrypt()\fR, \fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR
182 all operate on variable length data.  They all take an initialization vector
183 \&\fBivec\fR which needs to be passed along into the next call of the same function 
184 for the same message.  \fBivec\fR may be initialized with anything, but the
185 recipient needs to know what it was initialized with, or it won't be able
186 to decrypt.  Some programs and protocols simplify this, like \s-1SSH\s0, where
187 \&\fBivec\fR is simply initialized to zero.
188 \&\fIBF_cbc_encrypt()\fR operates on data that is a multiple of 8 bytes long, while
189 \&\fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR are used to encrypt an variable
190 number of bytes (the amount does not have to be an exact multiple of 8).  The
191 purpose of the latter two is to simulate stream ciphers, and therefore, they
192 need the parameter \fBnum\fR, which is a pointer to an integer where the current
193 offset in \fBivec\fR is stored between calls.  This integer must be initialized
194 to zero when \fBivec\fR is initialized.
195 .PP
196 \&\fIBF_cbc_encrypt()\fR is the Cipher Block Chaining function for Blowfish.  It
197 encrypts or decrypts the 64 bits chunks of \fBin\fR using the key \fBschedule\fR,
198 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\s-1BF_ENCRYPT\s0) or
199 decryption (\s-1BF_DECRYPT\s0) shall be performed.  \fBivec\fR must point at an 8 byte
200 long initialization vector.
201 .PP
202 \&\fIBF_cfb64_encrypt()\fR is the \s-1CFB\s0 mode for Blowfish with 64 bit feedback.
203 It encrypts or decrypts the bytes in \fBin\fR using the key \fBschedule\fR,
204 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
205 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  \fBivec\fR must point at an
206 8 byte long initialization vector. \fBnum\fR must point at an integer which must
207 be initially zero.
208 .PP
209 \&\fIBF_ofb64_encrypt()\fR is the \s-1OFB\s0 mode for Blowfish with 64 bit feedback.
210 It uses the same parameters as \fIBF_cfb64_encrypt()\fR, which must be initialized
211 the same way.
212 .PP
213 \&\fIBF_encrypt()\fR and \fIBF_decrypt()\fR are the lowest level functions for Blowfish
214 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
215 \&\fBdata\fR, using the key \fBkey\fR.  These functions should not be used unless you
216 implement 'modes' of Blowfish.  The alternative is to use \fIBF_ecb_encrypt()\fR.
217 If you still want to use these functions, you should be aware that they take
218 each 32\-bit chunk in host-byte order, which is little-endian on little-endian
219 platforms and big-endian on big-endian ones.
220 .SH "RETURN VALUES"
221 .IX Header "RETURN VALUES"
222 None of the functions presented here return any value.
223 .SH "NOTE"
224 .IX Header "NOTE"
225 Applications should use the higher level functions
226 \&\fIEVP_EncryptInit\fR\|(3) etc. instead of calling the
227 blowfish functions directly.
228 .SH "SEE ALSO"
229 .IX Header "SEE ALSO"
230 \&\fIdes_modes\fR\|(7)
231 .SH "HISTORY"
232 .IX Header "HISTORY"
233 The Blowfish functions are available in all versions of SSLeay and OpenSSL.