Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / openssl / doc / apps / enc.pod
blob41791ad6713c4b9c65616856a4f4ac8c48d96204
1 =pod
3 =head1 NAME
5 enc - symmetric cipher routines
7 =head1 SYNOPSIS
9 B<openssl enc -ciphername>
10 [B<-in filename>]
11 [B<-out filename>]
12 [B<-pass arg>]
13 [B<-e>]
14 [B<-d>]
15 [B<-a/-base64>]
16 [B<-A>]
17 [B<-k password>]
18 [B<-kfile filename>]
19 [B<-K key>]
20 [B<-iv IV>]
21 [B<-S salt>]
22 [B<-salt>]
23 [B<-nosalt>]
24 [B<-z>]
25 [B<-md>]
26 [B<-p>]
27 [B<-P>]
28 [B<-bufsize number>]
29 [B<-nopad>]
30 [B<-debug>]
31 [B<-none>]
32 [B<-engine id>]
34 =head1 DESCRIPTION
36 The symmetric cipher commands allow data to be encrypted or decrypted
37 using various block and stream ciphers using keys based on passwords
38 or explicitly provided. Base64 encoding or decoding can also be performed
39 either by itself or in addition to the encryption or decryption.
41 =head1 OPTIONS
43 =over 4
45 =item B<-in filename>
47 the input filename, standard input by default.
49 =item B<-out filename>
51 the output filename, standard output by default.
53 =item B<-pass arg>
55 the password source. For more information about the format of B<arg>
56 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
58 =item B<-salt>
60 use a salt in the key derivation routines. This is the default.
62 =item B<-nosalt>
64 don't use a salt in the key derivation routines. This option B<SHOULD NOT> be
65 used except for test purposes or compatibility with ancient versions of OpenSSL
66 and SSLeay.
68 =item B<-e>
70 encrypt the input data: this is the default.
72 =item B<-d>
74 decrypt the input data.
76 =item B<-a>
78 base64 process the data. This means that if encryption is taking place
79 the data is base64 encoded after encryption. If decryption is set then
80 the input data is base64 decoded before being decrypted.
82 =item B<-base64>
84 same as B<-a>
86 =item B<-A>
88 if the B<-a> option is set then base64 process the data on one line.
90 =item B<-k password>
92 the password to derive the key from. This is for compatibility with previous
93 versions of OpenSSL. Superseded by the B<-pass> argument.
95 =item B<-kfile filename>
97 read the password to derive the key from the first line of B<filename>.
98 This is for compatibility with previous versions of OpenSSL. Superseded by
99 the B<-pass> argument.
101 =item B<-nosalt>
103 do not use a salt 
105 =item B<-salt>
107 use salt (randomly generated or provide with B<-S> option) when
108 encrypting (this is the default).
110 =item B<-S salt>
112 the actual salt to use: this must be represented as a string of hex digits.
114 =item B<-K key>
116 the actual key to use: this must be represented as a string comprised only
117 of hex digits. If only the key is specified, the IV must additionally specified
118 using the B<-iv> option. When both a key and a password are specified, the
119 key given with the B<-K> option will be used and the IV generated from the
120 password will be taken. It probably does not make much sense to specify
121 both key and password.
123 =item B<-iv IV>
125 the actual IV to use: this must be represented as a string comprised only
126 of hex digits. When only the key is specified using the B<-K> option, the
127 IV must explicitly be defined. When a password is being specified using
128 one of the other options, the IV is generated from this password.
130 =item B<-p>
132 print out the key and IV used.
134 =item B<-P>
136 print out the key and IV used then immediately exit: don't do any encryption
137 or decryption.
139 =item B<-bufsize number>
141 set the buffer size for I/O
143 =item B<-nopad>
145 disable standard block padding
147 =item B<-debug>
149 debug the BIOs used for I/O.
151 =item B<-z>
153 Compress or decompress clear text using zlib before encryption or after
154 decryption. This option exists only if OpenSSL with compiled with zlib
155 or zlib-dynamic option.
157 =item B<-none>
159 Use NULL cipher (no encryption or decryption of input).
161 =back
163 =head1 NOTES
165 The program can be called either as B<openssl ciphername> or
166 B<openssl enc -ciphername>. But the first form doesn't work with
167 engine-provided ciphers, because this form is processed before the
168 configuration file is read and any ENGINEs loaded.
170 Engines which provide entirely new encryption algorithms (such as ccgost
171 engine which provides gost89 algorithm) should be configured in the
172 configuration file. Engines, specified in the command line using -engine
173 options can only be used for hadrware-assisted implementations of
174 ciphers, which are supported by OpenSSL core or other engine, specified
175 in the configuration file.
177 When enc command lists supported ciphers, ciphers provided by engines,
178 specified in the configuration files are listed too.
180 A password will be prompted for to derive the key and IV if necessary.
182 The B<-salt> option should B<ALWAYS> be used if the key is being derived
183 from a password unless you want compatibility with previous versions of
184 OpenSSL and SSLeay.
186 Without the B<-salt> option it is possible to perform efficient dictionary
187 attacks on the password and to attack stream cipher encrypted data. The reason
188 for this is that without the salt the same password always generates the same
189 encryption key. When the salt is being used the first eight bytes of the
190 encrypted data are reserved for the salt: it is generated at random when
191 encrypting a file and read from the encrypted file when it is decrypted.
193 Some of the ciphers do not have large keys and others have security
194 implications if not used correctly. A beginner is advised to just use
195 a strong block cipher in CBC mode such as bf or des3.
197 All the block ciphers normally use PKCS#5 padding also known as standard block
198 padding: this allows a rudimentary integrity or password check to be
199 performed. However since the chance of random data passing the test is
200 better than 1 in 256 it isn't a very good test.
202 If padding is disabled then the input data must be a multiple of the cipher
203 block length.
205 All RC2 ciphers have the same key and effective key length.
207 Blowfish and RC5 algorithms use a 128 bit key.
209 =head1 SUPPORTED CIPHERS
211 Note that some of these ciphers can be disabled at compile time
212 and some are available only if an appropriate engine is configured
213 in the configuration file. The output of the B<enc> command run with
214 unsupported options (for example B<openssl enc -help>) includes a
215 list of ciphers, supported by your versesion of OpenSSL, including
216 ones provided by configured engines.
218 The B<enc> program does not support authenticated encryption modes
219 like CCM and GCM. The utility does not store or retrieve the
220 authentication tag.
223  base64             Base 64
225  bf-cbc             Blowfish in CBC mode
226  bf                 Alias for bf-cbc
227  bf-cfb             Blowfish in CFB mode
228  bf-ecb             Blowfish in ECB mode
229  bf-ofb             Blowfish in OFB mode
231  cast-cbc           CAST in CBC mode
232  cast               Alias for cast-cbc
233  cast5-cbc          CAST5 in CBC mode
234  cast5-cfb          CAST5 in CFB mode
235  cast5-ecb          CAST5 in ECB mode
236  cast5-ofb          CAST5 in OFB mode
238  des-cbc            DES in CBC mode
239  des                Alias for des-cbc
240  des-cfb            DES in CBC mode
241  des-ofb            DES in OFB mode
242  des-ecb            DES in ECB mode
244  des-ede-cbc        Two key triple DES EDE in CBC mode
245  des-ede            Two key triple DES EDE in ECB mode
246  des-ede-cfb        Two key triple DES EDE in CFB mode
247  des-ede-ofb        Two key triple DES EDE in OFB mode
249  des-ede3-cbc       Three key triple DES EDE in CBC mode
250  des-ede3           Three key triple DES EDE in ECB mode
251  des3               Alias for des-ede3-cbc
252  des-ede3-cfb       Three key triple DES EDE CFB mode
253  des-ede3-ofb       Three key triple DES EDE in OFB mode
255  desx               DESX algorithm.
257  gost89             GOST 28147-89 in CFB mode (provided by ccgost engine)
258  gost89-cnt        `GOST 28147-89 in CNT mode (provided by ccgost engine) 
260  idea-cbc           IDEA algorithm in CBC mode
261  idea               same as idea-cbc
262  idea-cfb           IDEA in CFB mode
263  idea-ecb           IDEA in ECB mode
264  idea-ofb           IDEA in OFB mode
266  rc2-cbc            128 bit RC2 in CBC mode
267  rc2                Alias for rc2-cbc
268  rc2-cfb            128 bit RC2 in CFB mode
269  rc2-ecb            128 bit RC2 in ECB mode
270  rc2-ofb            128 bit RC2 in OFB mode
271  rc2-64-cbc         64 bit RC2 in CBC mode
272  rc2-40-cbc         40 bit RC2 in CBC mode
274  rc4                128 bit RC4
275  rc4-64             64 bit RC4
276  rc4-40             40 bit RC4
278  rc5-cbc            RC5 cipher in CBC mode
279  rc5                Alias for rc5-cbc
280  rc5-cfb            RC5 cipher in CFB mode
281  rc5-ecb            RC5 cipher in ECB mode
282  rc5-ofb            RC5 cipher in OFB mode
284  aes-[128|192|256]-cbc  128/192/256 bit AES in CBC mode
285  aes-[128|192|256]      Alias for aes-[128|192|256]-cbc
286  aes-[128|192|256]-cfb  128/192/256 bit AES in 128 bit CFB mode
287  aes-[128|192|256]-cfb1 128/192/256 bit AES in 1 bit CFB mode
288  aes-[128|192|256]-cfb8 128/192/256 bit AES in 8 bit CFB mode
289  aes-[128|192|256]-ecb  128/192/256 bit AES in ECB mode
290  aes-[128|192|256]-ofb  128/192/256 bit AES in OFB mode
292 =head1 EXAMPLES
294 Just base64 encode a binary file:
296  openssl base64 -in file.bin -out file.b64
298 Decode the same file
300  openssl base64 -d -in file.b64 -out file.bin 
302 Encrypt a file using triple DES in CBC mode using a prompted password:
304  openssl des3 -salt -in file.txt -out file.des3 
306 Decrypt a file using a supplied password:
308  openssl des3 -d -salt -in file.des3 -out file.txt -k mypassword
310 Encrypt a file then base64 encode it (so it can be sent via mail for example)
311 using Blowfish in CBC mode:
313  openssl bf -a -salt -in file.txt -out file.bf
315 Base64 decode a file then decrypt it:
317  openssl bf -d -salt -a -in file.bf -out file.txt
319 Decrypt some data using a supplied 40 bit RC4 key:
321  openssl rc4-40 -in file.rc4 -out file.txt -K 0102030405
323 =head1 BUGS
325 The B<-A> option when used with large files doesn't work properly.
327 There should be an option to allow an iteration count to be included.
329 The B<enc> program only supports a fixed number of algorithms with
330 certain parameters. So if, for example, you want to use RC2 with a
331 76 bit key or RC4 with an 84 bit key you can't use this program.
333 =cut