Merge branch 'master' of git://chlamydia.fs.ei.tum.de/dragonfly
[dragonfly.git] / secure / usr.bin / openssl / man / enc.1
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
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.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
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
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
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'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
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
115 .    \" corrections for vroff
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'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
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
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "ENC 1"
135 .TH ENC 1 "2009-11-06" "0.9.8l" "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
140 .SH "NAME"
141 enc \- symmetric cipher routines
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 \&\fBopenssl enc \-ciphername\fR
145 [\fB\-in filename\fR]
146 [\fB\-out filename\fR]
147 [\fB\-pass arg\fR]
148 [\fB\-e\fR]
149 [\fB\-d\fR]
150 [\fB\-a\fR]
151 [\fB\-A\fR]
152 [\fB\-k password\fR]
153 [\fB\-kfile filename\fR]
154 [\fB\-K key\fR]
155 [\fB\-iv \s-1IV\s0\fR]
156 [\fB\-p\fR]
157 [\fB\-P\fR]
158 [\fB\-bufsize number\fR]
159 [\fB\-nopad\fR]
160 [\fB\-debug\fR]
161 .SH "DESCRIPTION"
162 .IX Header "DESCRIPTION"
163 The symmetric cipher commands allow data to be encrypted or decrypted
164 using various block and stream ciphers using keys based on passwords
165 or explicitly provided. Base64 encoding or decoding can also be performed
166 either by itself or in addition to the encryption or decryption.
167 .SH "OPTIONS"
168 .IX Header "OPTIONS"
169 .IP "\fB\-in filename\fR" 4
170 .IX Item "-in filename"
171 the input filename, standard input by default.
172 .IP "\fB\-out filename\fR" 4
173 .IX Item "-out filename"
174 the output filename, standard output by default.
175 .IP "\fB\-pass arg\fR" 4
176 .IX Item "-pass arg"
177 the password source. For more information about the format of \fBarg\fR
178 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
179 .IP "\fB\-salt\fR" 4
180 .IX Item "-salt"
181 use a salt in the key derivation routines. This option should \fB\s-1ALWAYS\s0\fR
182 be used unless compatibility with previous versions of OpenSSL or SSLeay
183 is required. This option is only present on OpenSSL versions 0.9.5 or
184 above.
185 .IP "\fB\-nosalt\fR" 4
186 .IX Item "-nosalt"
187 don't use a salt in the key derivation routines. This is the default for
188 compatibility with previous versions of OpenSSL and SSLeay.
189 .IP "\fB\-e\fR" 4
190 .IX Item "-e"
191 encrypt the input data: this is the default.
192 .IP "\fB\-d\fR" 4
193 .IX Item "-d"
194 decrypt the input data.
195 .IP "\fB\-a\fR" 4
196 .IX Item "-a"
197 base64 process the data. This means that if encryption is taking place
198 the data is base64 encoded after encryption. If decryption is set then
199 the input data is base64 decoded before being decrypted.
200 .IP "\fB\-A\fR" 4
201 .IX Item "-A"
202 if the \fB\-a\fR option is set then base64 process the data on one line.
203 .IP "\fB\-k password\fR" 4
204 .IX Item "-k password"
205 the password to derive the key from. This is for compatibility with previous
206 versions of OpenSSL. Superseded by the \fB\-pass\fR argument.
207 .IP "\fB\-kfile filename\fR" 4
208 .IX Item "-kfile filename"
209 read the password to derive the key from the first line of \fBfilename\fR.
210 This is for compatibility with previous versions of OpenSSL. Superseded by
211 the \fB\-pass\fR argument.
212 .IP "\fB\-S salt\fR" 4
213 .IX Item "-S salt"
214 the actual salt to use: this must be represented as a string comprised only
215 of hex digits.
216 .IP "\fB\-K key\fR" 4
217 .IX Item "-K key"
218 the actual key to use: this must be represented as a string comprised only
219 of hex digits. If only the key is specified, the \s-1IV\s0 must additionally specified
220 using the \fB\-iv\fR option. When both a key and a password are specified, the
221 key given with the \fB\-K\fR option will be used and the \s-1IV\s0 generated from the
222 password will be taken. It probably does not make much sense to specify
223 both key and password.
224 .IP "\fB\-iv \s-1IV\s0\fR" 4
225 .IX Item "-iv IV"
226 the actual \s-1IV\s0 to use: this must be represented as a string comprised only
227 of hex digits. When only the key is specified using the \fB\-K\fR option, the
228 \&\s-1IV\s0 must explicitly be defined. When a password is being specified using
229 one of the other options, the \s-1IV\s0 is generated from this password.
230 .IP "\fB\-p\fR" 4
231 .IX Item "-p"
232 print out the key and \s-1IV\s0 used.
233 .IP "\fB\-P\fR" 4
234 .IX Item "-P"
235 print out the key and \s-1IV\s0 used then immediately exit: don't do any encryption
236 or decryption.
237 .IP "\fB\-bufsize number\fR" 4
238 .IX Item "-bufsize number"
239 set the buffer size for I/O
240 .IP "\fB\-nopad\fR" 4
241 .IX Item "-nopad"
242 disable standard block padding
243 .IP "\fB\-debug\fR" 4
244 .IX Item "-debug"
245 debug the BIOs used for I/O.
246 .SH "NOTES"
247 .IX Header "NOTES"
248 The program can be called either as \fBopenssl ciphername\fR or
249 \&\fBopenssl enc \-ciphername\fR.
250 .PP
251 A password will be prompted for to derive the key and \s-1IV\s0 if necessary.
252 .PP
253 The \fB\-salt\fR option should \fB\s-1ALWAYS\s0\fR be used if the key is being derived
254 from a password unless you want compatibility with previous versions of
255 OpenSSL and SSLeay.
256 .PP
257 Without the \fB\-salt\fR option it is possible to perform efficient dictionary
258 attacks on the password and to attack stream cipher encrypted data. The reason
259 for this is that without the salt the same password always generates the same
260 encryption key. When the salt is being used the first eight bytes of the
261 encrypted data are reserved for the salt: it is generated at random when
262 encrypting a file and read from the encrypted file when it is decrypted.
263 .PP
264 Some of the ciphers do not have large keys and others have security
265 implications if not used correctly. A beginner is advised to just use
266 a strong block cipher in \s-1CBC\s0 mode such as bf or des3.
267 .PP
268 All the block ciphers normally use PKCS#5 padding also known as standard block
269 padding: this allows a rudimentary integrity or password check to be
270 performed. However since the chance of random data passing the test is
271 better than 1 in 256 it isn't a very good test.
272 .PP
273 If padding is disabled then the input data must be a multiple of the cipher
274 block length.
275 .PP
276 All \s-1RC2\s0 ciphers have the same key and effective key length.
277 .PP
278 Blowfish and \s-1RC5\s0 algorithms use a 128 bit key.
279 .SH "SUPPORTED CIPHERS"
280 .IX Header "SUPPORTED CIPHERS"
281 .Vb 1
282 \& base64             Base 64
283 \&
284 \& bf\-cbc             Blowfish in CBC mode
285 \& bf                 Alias for bf\-cbc
286 \& bf\-cfb             Blowfish in CFB mode
287 \& bf\-ecb             Blowfish in ECB mode
288 \& bf\-ofb             Blowfish in OFB mode
289 \&
290 \& cast\-cbc           CAST in CBC mode
291 \& cast               Alias for cast\-cbc
292 \& cast5\-cbc          CAST5 in CBC mode
293 \& cast5\-cfb          CAST5 in CFB mode
294 \& cast5\-ecb          CAST5 in ECB mode
295 \& cast5\-ofb          CAST5 in OFB mode
296 \&
297 \& des\-cbc            DES in CBC mode
298 \& des                Alias for des\-cbc
299 \& des\-cfb            DES in CBC mode
300 \& des\-ofb            DES in OFB mode
301 \& des\-ecb            DES in ECB mode
302 \&
303 \& des\-ede\-cbc        Two key triple DES EDE in CBC mode
304 \& des\-ede            Two key triple DES EDE in ECB mode
305 \& des\-ede\-cfb        Two key triple DES EDE in CFB mode
306 \& des\-ede\-ofb        Two key triple DES EDE in OFB mode
307 \&
308 \& des\-ede3\-cbc       Three key triple DES EDE in CBC mode
309 \& des\-ede3           Three key triple DES EDE in ECB mode
310 \& des3               Alias for des\-ede3\-cbc
311 \& des\-ede3\-cfb       Three key triple DES EDE CFB mode
312 \& des\-ede3\-ofb       Three key triple DES EDE in OFB mode
313 \&
314 \& desx               DESX algorithm.
315 \&
316 \& idea\-cbc           IDEA algorithm in CBC mode
317 \& idea               same as idea\-cbc
318 \& idea\-cfb           IDEA in CFB mode
319 \& idea\-ecb           IDEA in ECB mode
320 \& idea\-ofb           IDEA in OFB mode
321 \&
322 \& rc2\-cbc            128 bit RC2 in CBC mode
323 \& rc2                Alias for rc2\-cbc
324 \& rc2\-cfb            128 bit RC2 in CFB mode
325 \& rc2\-ecb            128 bit RC2 in ECB mode
326 \& rc2\-ofb            128 bit RC2 in OFB mode
327 \& rc2\-64\-cbc         64 bit RC2 in CBC mode
328 \& rc2\-40\-cbc         40 bit RC2 in CBC mode
329 \&
330 \& rc4                128 bit RC4
331 \& rc4\-64             64 bit RC4
332 \& rc4\-40             40 bit RC4
333 \&
334 \& rc5\-cbc            RC5 cipher in CBC mode
335 \& rc5                Alias for rc5\-cbc
336 \& rc5\-cfb            RC5 cipher in CFB mode
337 \& rc5\-ecb            RC5 cipher in ECB mode
338 \& rc5\-ofb            RC5 cipher in OFB mode
339 \&
340 \& aes\-[128|192|256]\-cbc  128/192/256 bit AES in CBC mode
341 \& aes\-[128|192|256]      Alias for aes\-[128|192|256]\-cbc
342 \& aes\-[128|192|256]\-cfb  128/192/256 bit AES in 128 bit CFB mode
343 \& aes\-[128|192|256]\-cfb1 128/192/256 bit AES in 1 bit CFB mode
344 \& aes\-[128|192|256]\-cfb8 128/192/256 bit AES in 8 bit CFB mode
345 \& aes\-[128|192|256]\-ecb  128/192/256 bit AES in ECB mode
346 \& aes\-[128|192|256]\-ofb  128/192/256 bit AES in OFB mode
347 .Ve
348 .SH "EXAMPLES"
349 .IX Header "EXAMPLES"
350 Just base64 encode a binary file:
351 .PP
352 .Vb 1
353 \& openssl base64 \-in file.bin \-out file.b64
354 .Ve
355 .PP
356 Decode the same file
357 .PP
358 .Vb 1
359 \& openssl base64 \-d \-in file.b64 \-out file.bin
360 .Ve
361 .PP
362 Encrypt a file using triple \s-1DES\s0 in \s-1CBC\s0 mode using a prompted password:
363 .PP
364 .Vb 1
365 \& openssl des3 \-salt \-in file.txt \-out file.des3
366 .Ve
367 .PP
368 Decrypt a file using a supplied password:
369 .PP
370 .Vb 1
371 \& openssl des3 \-d \-salt \-in file.des3 \-out file.txt \-k mypassword
372 .Ve
373 .PP
374 Encrypt a file then base64 encode it (so it can be sent via mail for example)
375 using Blowfish in \s-1CBC\s0 mode:
376 .PP
377 .Vb 1
378 \& openssl bf \-a \-salt \-in file.txt \-out file.bf
379 .Ve
380 .PP
381 Base64 decode a file then decrypt it:
382 .PP
383 .Vb 1
384 \& openssl bf \-d \-salt \-a \-in file.bf \-out file.txt
385 .Ve
386 .PP
387 Decrypt some data using a supplied 40 bit \s-1RC4\s0 key:
388 .PP
389 .Vb 1
390 \& openssl rc4\-40 \-in file.rc4 \-out file.txt \-K 0102030405
391 .Ve
392 .SH "BUGS"
393 .IX Header "BUGS"
394 The \fB\-A\fR option when used with large files doesn't work properly.
395 .PP
396 There should be an option to allow an iteration count to be included.
397 .PP
398 The \fBenc\fR program only supports a fixed number of algorithms with
399 certain parameters. So if, for example, you want to use \s-1RC2\s0 with a
400 76 bit key or \s-1RC4\s0 with an 84 bit key you can't use this program.