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