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