2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-enc - symmetric cipher routines
10 B<openssl> B<enc>|I<cipher>
24 [B<-kfile> I<filename>]
36 [B<-bufsize> I<number>]
41 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
42 {- $OpenSSL::safe::opt_provider_synopsis -}
44 =for openssl ifdef z engine ciphers
46 B<openssl> I<cipher> [B<...>]
50 The symmetric cipher commands allow data to be encrypted or decrypted
51 using various block and stream ciphers using keys based on passwords
52 or explicitly provided. Base64 encoding or decoding can also be performed
53 either by itself or in addition to the encryption or decryption.
61 Print out a usage message.
65 List all supported ciphers.
69 Alias of -list to display all supported ciphers.
71 =item B<-in> I<filename>
73 The input filename, standard input by default.
75 =item B<-out> I<filename>
77 The output filename, standard output by default.
81 The password source. For more information about the format of I<arg>
82 see L<openssl-passphrase-options(1)>.
86 Encrypt the input data: this is the default.
90 Decrypt the input data.
94 Base64 process the data. This means that if encryption is taking place
95 the data is base64 encoded after encryption. If decryption is set then
96 the input data is base64 decoded before being decrypted.
104 If the B<-a> option is set then base64 process the data on one line.
106 =item B<-k> I<password>
108 The password to derive the key from. This is for compatibility with previous
109 versions of OpenSSL. Superseded by the B<-pass> argument.
111 =item B<-kfile> I<filename>
113 Read the password to derive the key from the first line of I<filename>.
114 This is for compatibility with previous versions of OpenSSL. Superseded by
115 the B<-pass> argument.
117 =item B<-md> I<digest>
119 Use the specified digest to create the key from the passphrase.
120 The default algorithm is sha-256.
122 =item B<-iter> I<count>
124 Use a given number of iterations on the password in deriving the encryption key.
125 High values increase the time required to brute-force the resulting file.
126 This option enables the use of PBKDF2 algorithm to derive the key.
130 Use PBKDF2 algorithm with default iteration count unless otherwise specified.
134 Don't use a salt in the key derivation routines. This option B<SHOULD NOT> be
135 used except for test purposes or compatibility with ancient versions of
140 Use salt (randomly generated or provide with B<-S> option) when
141 encrypting, this is the default.
145 The actual salt to use: this must be represented as a string of hex digits.
149 The actual key to use: this must be represented as a string comprised only
150 of hex digits. If only the key is specified, the IV must additionally specified
151 using the B<-iv> option. When both a key and a password are specified, the
152 key given with the B<-K> option will be used and the IV generated from the
153 password will be taken. It does not make much sense to specify both key
158 The actual IV to use: this must be represented as a string comprised only
159 of hex digits. When only the key is specified using the B<-K> option, the
160 IV must explicitly be defined. When a password is being specified using
161 one of the other options, the IV is generated from this password.
165 Print out the key and IV used.
169 Print out the key and IV used then immediately exit: don't do any encryption
172 =item B<-bufsize> I<number>
174 Set the buffer size for I/O.
178 Disable standard block padding.
182 Verbose print; display some statistics about I/O and buffer sizes.
186 Debug the BIOs used for I/O.
190 Compress or decompress encrypted data using zlib after encryption or before
191 decryption. This option exists only if OpenSSL was compiled with the zlib
192 or zlib-dynamic option.
196 Use NULL cipher (no encryption or decryption of input).
198 {- $OpenSSL::safe::opt_r_item -}
200 {- $OpenSSL::safe::opt_provider_item -}
202 {- $OpenSSL::safe::opt_engine_item -}
208 The program can be called either as C<openssl I<cipher>> or
209 C<openssl enc -I<cipher>>. The first form doesn't work with
210 engine-provided ciphers, because this form is processed before the
211 configuration file is read and any ENGINEs loaded.
212 Use the L<openssl-list(1)> command to get a list of supported ciphers.
214 Engines which provide entirely new encryption algorithms (such as the ccgost
215 engine which provides gost89 algorithm) should be configured in the
216 configuration file. Engines specified on the command line using B<-engine>
217 option can only be used for hardware-assisted implementations of
218 ciphers which are supported by the OpenSSL core or another engine specified
219 in the configuration file.
221 When the enc command lists supported ciphers, ciphers provided by engines,
222 specified in the configuration files are listed too.
224 A password will be prompted for to derive the key and IV if necessary.
226 The B<-salt> option should B<ALWAYS> be used if the key is being derived
227 from a password unless you want compatibility with previous versions of
230 Without the B<-salt> option it is possible to perform efficient dictionary
231 attacks on the password and to attack stream cipher encrypted data. The reason
232 for this is that without the salt the same password always generates the same
233 encryption key. When the salt is being used the first eight bytes of the
234 encrypted data are reserved for the salt: it is generated at random when
235 encrypting a file and read from the encrypted file when it is decrypted.
237 Some of the ciphers do not have large keys and others have security
238 implications if not used correctly. A beginner is advised to just use
239 a strong block cipher, such as AES, in CBC mode.
241 All the block ciphers normally use PKCS#5 padding, also known as standard
242 block padding. This allows a rudimentary integrity or password check to
243 be performed. However, since the chance of random data passing the test
244 is better than 1 in 256 it isn't a very good test.
246 If padding is disabled then the input data must be a multiple of the cipher
249 All RC2 ciphers have the same key and effective key length.
251 Blowfish and RC5 algorithms use a 128 bit key.
253 =head1 SUPPORTED CIPHERS
255 Note that some of these ciphers can be disabled at compile time
256 and some are available only if an appropriate engine is configured
257 in the configuration file. The output when invoking this command
258 with the B<-list> option (that is C<openssl enc -list>) is
259 a list of ciphers, supported by your version of OpenSSL, including
260 ones provided by configured engines.
262 This command does not support authenticated encryption modes
263 like CCM and GCM, and will not support such modes in the future.
264 This is due to having to begin streaming output (e.g., to standard output
265 when B<-out> is not used) before the authentication tag could be validated.
266 When this command is used in a pipeline, the receiving end will not be
267 able to roll back upon authentication failure. The AEAD modes currently in
268 common use also suffer from catastrophic failure of confidentiality and/or
269 integrity upon reuse of key/iv/nonce, and since B<openssl enc> places the
270 entire burden of key/iv/nonce management upon the user, the risk of
271 exposing AEAD modes is too great to allow. These key/iv/nonce
272 management issues also affect other modes currently exposed in this command,
273 but the failure modes are less extreme in these cases, and the
274 functionality cannot be removed with a stable release branch.
275 For bulk encryption of data, whether using authenticated encryption
276 modes or other modes, L<openssl-cms(1)> is recommended, as it provides a
277 standard data format and performs the needed key/iv/nonce management.
282 bf-cbc Blowfish in CBC mode
284 blowfish Alias for bf-cbc
285 bf-cfb Blowfish in CFB mode
286 bf-ecb Blowfish in ECB mode
287 bf-ofb Blowfish in OFB mode
289 cast-cbc CAST in CBC mode
290 cast Alias for cast-cbc
291 cast5-cbc CAST5 in CBC mode
292 cast5-cfb CAST5 in CFB mode
293 cast5-ecb CAST5 in ECB mode
294 cast5-ofb CAST5 in OFB mode
296 chacha20 ChaCha20 algorithm
298 des-cbc DES in CBC mode
299 des Alias for des-cbc
300 des-cfb DES in CFB mode
301 des-ofb DES in OFB mode
302 des-ecb DES in ECB mode
304 des-ede-cbc Two key triple DES EDE in CBC mode
305 des-ede Two key triple DES EDE in ECB mode
306 des-ede-cfb Two key triple DES EDE in CFB mode
307 des-ede-ofb Two key triple DES EDE in OFB mode
309 des-ede3-cbc Three key triple DES EDE in CBC mode
310 des-ede3 Three key triple DES EDE in ECB mode
311 des3 Alias for des-ede3-cbc
312 des-ede3-cfb Three key triple DES EDE CFB mode
313 des-ede3-ofb Three key triple DES EDE in OFB mode
317 gost89 GOST 28147-89 in CFB mode (provided by ccgost engine)
318 gost89-cnt GOST 28147-89 in CNT mode (provided by ccgost engine)
320 idea-cbc IDEA algorithm in CBC mode
321 idea same as idea-cbc
322 idea-cfb IDEA in CFB mode
323 idea-ecb IDEA in ECB mode
324 idea-ofb IDEA in OFB mode
326 rc2-cbc 128 bit RC2 in CBC mode
327 rc2 Alias for rc2-cbc
328 rc2-cfb 128 bit RC2 in CFB mode
329 rc2-ecb 128 bit RC2 in ECB mode
330 rc2-ofb 128 bit RC2 in OFB mode
331 rc2-64-cbc 64 bit RC2 in CBC mode
332 rc2-40-cbc 40 bit RC2 in CBC mode
338 rc5-cbc RC5 cipher in CBC mode
339 rc5 Alias for rc5-cbc
340 rc5-cfb RC5 cipher in CFB mode
341 rc5-ecb RC5 cipher in ECB mode
342 rc5-ofb RC5 cipher in OFB mode
344 seed-cbc SEED cipher in CBC mode
345 seed Alias for seed-cbc
346 seed-cfb SEED cipher in CFB mode
347 seed-ecb SEED cipher in ECB mode
348 seed-ofb SEED cipher in OFB mode
350 sm4-cbc SM4 cipher in CBC mode
351 sm4 Alias for sm4-cbc
352 sm4-cfb SM4 cipher in CFB mode
353 sm4-ctr SM4 cipher in CTR mode
354 sm4-ecb SM4 cipher in ECB mode
355 sm4-ofb SM4 cipher in OFB mode
357 aes-[128|192|256]-cbc 128/192/256 bit AES in CBC mode
358 aes[128|192|256] Alias for aes-[128|192|256]-cbc
359 aes-[128|192|256]-cfb 128/192/256 bit AES in 128 bit CFB mode
360 aes-[128|192|256]-cfb1 128/192/256 bit AES in 1 bit CFB mode
361 aes-[128|192|256]-cfb8 128/192/256 bit AES in 8 bit CFB mode
362 aes-[128|192|256]-ctr 128/192/256 bit AES in CTR mode
363 aes-[128|192|256]-ecb 128/192/256 bit AES in ECB mode
364 aes-[128|192|256]-ofb 128/192/256 bit AES in OFB mode
366 aria-[128|192|256]-cbc 128/192/256 bit ARIA in CBC mode
367 aria[128|192|256] Alias for aria-[128|192|256]-cbc
368 aria-[128|192|256]-cfb 128/192/256 bit ARIA in 128 bit CFB mode
369 aria-[128|192|256]-cfb1 128/192/256 bit ARIA in 1 bit CFB mode
370 aria-[128|192|256]-cfb8 128/192/256 bit ARIA in 8 bit CFB mode
371 aria-[128|192|256]-ctr 128/192/256 bit ARIA in CTR mode
372 aria-[128|192|256]-ecb 128/192/256 bit ARIA in ECB mode
373 aria-[128|192|256]-ofb 128/192/256 bit ARIA in OFB mode
375 camellia-[128|192|256]-cbc 128/192/256 bit Camellia in CBC mode
376 camellia[128|192|256] Alias for camellia-[128|192|256]-cbc
377 camellia-[128|192|256]-cfb 128/192/256 bit Camellia in 128 bit CFB mode
378 camellia-[128|192|256]-cfb1 128/192/256 bit Camellia in 1 bit CFB mode
379 camellia-[128|192|256]-cfb8 128/192/256 bit Camellia in 8 bit CFB mode
380 camellia-[128|192|256]-ctr 128/192/256 bit Camellia in CTR mode
381 camellia-[128|192|256]-ecb 128/192/256 bit Camellia in ECB mode
382 camellia-[128|192|256]-ofb 128/192/256 bit Camellia in OFB mode
386 Just base64 encode a binary file:
388 openssl base64 -in file.bin -out file.b64
392 openssl base64 -d -in file.b64 -out file.bin
394 Encrypt a file using AES-128 using a prompted password
395 and PBKDF2 key derivation:
397 openssl enc -aes128 -pbkdf2 -in file.txt -out file.aes128
399 Decrypt a file using a supplied password:
401 openssl enc -aes128 -pbkdf2 -d -in file.aes128 -out file.txt \
402 -pass pass:<password>
404 Encrypt a file then base64 encode it (so it can be sent via mail for example)
405 using AES-256 in CTR mode and PBKDF2 key derivation:
407 openssl enc -aes-256-ctr -pbkdf2 -a -in file.txt -out file.aes256
409 Base64 decode a file then decrypt it using a password supplied in a file:
411 openssl enc -aes-256-ctr -pbkdf2 -d -a -in file.aes256 -out file.txt \
412 -pass file:<passfile>
416 The B<-A> option when used with large files doesn't work properly.
418 The B<openssl enc> command only supports a fixed number of algorithms with
419 certain parameters. So if, for example, you want to use RC2 with a
420 76 bit key or RC4 with an 84 bit key you can't use this program.
424 The default digest was changed from MD5 to SHA256 in OpenSSL 1.1.0.
426 The B<-list> option was added in OpenSSL 1.1.1e.
428 The B<-ciphers> and B<-engine> options were deprecated in OpenSSL 3.0.
432 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
434 Licensed under the Apache License 2.0 (the "License"). You may not use
435 this file except in compliance with the License. You can obtain a copy
436 in the file LICENSE in the source distribution or at
437 L<https://www.openssl.org/source/license.html>.