1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, 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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
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
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
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'
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 \
133 .\" ========================================================================
136 .TH ENC 1 "2019-09-10" "1.1.1d" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 openssl\-enc, enc \- symmetric cipher routines
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl enc \-\f(BIcipher\fB\fR
148 [\fB\-in filename\fR]
149 [\fB\-out filename\fR]
157 [\fB\-kfile filename\fR]
159 [\fB\-iv \s-1IV\s0\fR]
169 [\fB\-bufsize number\fR]
173 [\fB\-rand file...\fR]
174 [\fB\-writerand file\fR]
177 \&\fBopenssl\fR \fI[cipher]\fR [\fB...\fR]
179 .IX Header "DESCRIPTION"
180 The symmetric cipher commands allow data to be encrypted or decrypted
181 using various block and stream ciphers using keys based on passwords
182 or explicitly provided. Base64 encoding or decoding can also be performed
183 either by itself or in addition to the encryption or decryption.
188 Print out a usage message.
189 .IP "\fB\-ciphers\fR" 4
191 List all supported ciphers.
192 .IP "\fB\-in filename\fR" 4
193 .IX Item "-in filename"
194 The input filename, standard input by default.
195 .IP "\fB\-out filename\fR" 4
196 .IX Item "-out filename"
197 The output filename, standard output by default.
198 .IP "\fB\-pass arg\fR" 4
200 The password source. For more information about the format of \fBarg\fR
201 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
204 Encrypt the input data: this is the default.
207 Decrypt the input data.
210 Base64 process the data. This means that if encryption is taking place
211 the data is base64 encoded after encryption. If decryption is set then
212 the input data is base64 decoded before being decrypted.
213 .IP "\fB\-base64\fR" 4
218 If the \fB\-a\fR option is set then base64 process the data on one line.
219 .IP "\fB\-k password\fR" 4
220 .IX Item "-k password"
221 The password to derive the key from. This is for compatibility with previous
222 versions of OpenSSL. Superseded by the \fB\-pass\fR argument.
223 .IP "\fB\-kfile filename\fR" 4
224 .IX Item "-kfile filename"
225 Read the password to derive the key from the first line of \fBfilename\fR.
226 This is for compatibility with previous versions of OpenSSL. Superseded by
227 the \fB\-pass\fR argument.
228 .IP "\fB\-md digest\fR" 4
229 .IX Item "-md digest"
230 Use the specified digest to create the key from the passphrase.
231 The default algorithm is sha\-256.
232 .IP "\fB\-iter count\fR" 4
233 .IX Item "-iter count"
234 Use a given number of iterations on the password in deriving the encryption key.
235 High values increase the time required to brute-force the resulting file.
236 This option enables the use of \s-1PBKDF2\s0 algorithm to derive the key.
237 .IP "\fB\-pbkdf2\fR" 4
239 Use \s-1PBKDF2\s0 algorithm with default iteration count unless otherwise specified.
240 .IP "\fB\-nosalt\fR" 4
242 Don't use a salt in the key derivation routines. This option \fB\s-1SHOULD NOT\s0\fR be
243 used except for test purposes or compatibility with ancient versions of
247 Use salt (randomly generated or provide with \fB\-S\fR option) when
248 encrypting, this is the default.
249 .IP "\fB\-S salt\fR" 4
251 The actual salt to use: this must be represented as a string of hex digits.
252 .IP "\fB\-K key\fR" 4
254 The actual key to use: this must be represented as a string comprised only
255 of hex digits. If only the key is specified, the \s-1IV\s0 must additionally specified
256 using the \fB\-iv\fR option. When both a key and a password are specified, the
257 key given with the \fB\-K\fR option will be used and the \s-1IV\s0 generated from the
258 password will be taken. It does not make much sense to specify both key
260 .IP "\fB\-iv \s-1IV\s0\fR" 4
262 The actual \s-1IV\s0 to use: this must be represented as a string comprised only
263 of hex digits. When only the key is specified using the \fB\-K\fR option, the
264 \&\s-1IV\s0 must explicitly be defined. When a password is being specified using
265 one of the other options, the \s-1IV\s0 is generated from this password.
268 Print out the key and \s-1IV\s0 used.
271 Print out the key and \s-1IV\s0 used then immediately exit: don't do any encryption
273 .IP "\fB\-bufsize number\fR" 4
274 .IX Item "-bufsize number"
275 Set the buffer size for I/O.
276 .IP "\fB\-nopad\fR" 4
278 Disable standard block padding.
279 .IP "\fB\-debug\fR" 4
281 Debug the BIOs used for I/O.
284 Compress or decompress clear text using zlib before encryption or after
285 decryption. This option exists only if OpenSSL with compiled with zlib
286 or zlib-dynamic option.
289 Use \s-1NULL\s0 cipher (no encryption or decryption of input).
290 .IP "\fB\-rand file...\fR" 4
291 .IX Item "-rand file..."
292 A file or files containing random data used to seed the random number
294 Multiple files can be specified separated by an OS-dependent character.
295 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
297 .IP "[\fB\-writerand file\fR]" 4
298 .IX Item "[-writerand file]"
299 Writes random data to the specified \fIfile\fR upon exit.
300 This can be used with a subsequent \fB\-rand\fR flag.
303 The program can be called either as \fBopenssl cipher\fR or
304 \&\fBopenssl enc \-cipher\fR. The first form doesn't work with
305 engine-provided ciphers, because this form is processed before the
306 configuration file is read and any ENGINEs loaded.
307 Use the \fBlist\fR command to get a list of supported ciphers.
309 Engines which provide entirely new encryption algorithms (such as the ccgost
310 engine which provides gost89 algorithm) should be configured in the
311 configuration file. Engines specified on the command line using \-engine
312 options can only be used for hardware-assisted implementations of
313 ciphers which are supported by the OpenSSL core or another engine specified
314 in the configuration file.
316 When the enc command lists supported ciphers, ciphers provided by engines,
317 specified in the configuration files are listed too.
319 A password will be prompted for to derive the key and \s-1IV\s0 if necessary.
321 The \fB\-salt\fR option should \fB\s-1ALWAYS\s0\fR be used if the key is being derived
322 from a password unless you want compatibility with previous versions of
325 Without the \fB\-salt\fR option it is possible to perform efficient dictionary
326 attacks on the password and to attack stream cipher encrypted data. The reason
327 for this is that without the salt the same password always generates the same
328 encryption key. When the salt is being used the first eight bytes of the
329 encrypted data are reserved for the salt: it is generated at random when
330 encrypting a file and read from the encrypted file when it is decrypted.
332 Some of the ciphers do not have large keys and others have security
333 implications if not used correctly. A beginner is advised to just use
334 a strong block cipher, such as \s-1AES,\s0 in \s-1CBC\s0 mode.
336 All the block ciphers normally use PKCS#5 padding, also known as standard
337 block padding. This allows a rudimentary integrity or password check to
338 be performed. However since the chance of random data passing the test
339 is better than 1 in 256 it isn't a very good test.
341 If padding is disabled then the input data must be a multiple of the cipher
344 All \s-1RC2\s0 ciphers have the same key and effective key length.
346 Blowfish and \s-1RC5\s0 algorithms use a 128 bit key.
347 .SH "SUPPORTED CIPHERS"
348 .IX Header "SUPPORTED CIPHERS"
349 Note that some of these ciphers can be disabled at compile time
350 and some are available only if an appropriate engine is configured
351 in the configuration file. The output of the \fBenc\fR command run with
352 the \fB\-ciphers\fR option (that is \fBopenssl enc \-ciphers\fR) produces a
353 list of ciphers, supported by your version of OpenSSL, including
354 ones provided by configured engines.
356 The \fBenc\fR program does not support authenticated encryption modes
357 like \s-1CCM\s0 and \s-1GCM,\s0 and will not support such modes in the future.
358 The \fBenc\fR interface by necessity must begin streaming output (e.g.,
359 to standard output when \fB\-out\fR is not used) before the authentication
360 tag could be validated, leading to the usage of \fBenc\fR in pipelines
361 that begin processing untrusted data and are not capable of rolling
362 back upon authentication failure. The \s-1AEAD\s0 modes currently in common
363 use also suffer from catastrophic failure of confidentiality and/or
364 integrity upon reuse of key/iv/nonce, and since \fBenc\fR places the
365 entire burden of key/iv/nonce management upon the user, the risk of
366 exposing \s-1AEAD\s0 modes is too great to allow. These key/iv/nonce
367 management issues also affect other modes currently exposed in \fBenc\fR,
368 but the failure modes are less extreme in these cases, and the
369 functionality cannot be removed with a stable release branch.
370 For bulk encryption of data, whether using authenticated encryption
371 modes or other modes, \fBcms\fR\|(1) is recommended, as it provides a
372 standard data format and performs the needed key/iv/nonce management.
377 \& bf\-cbc Blowfish in CBC mode
378 \& bf Alias for bf\-cbc
379 \& blowfish Alias for bf\-cbc
380 \& bf\-cfb Blowfish in CFB mode
381 \& bf\-ecb Blowfish in ECB mode
382 \& bf\-ofb Blowfish in OFB mode
384 \& cast\-cbc CAST in CBC mode
385 \& cast Alias for cast\-cbc
386 \& cast5\-cbc CAST5 in CBC mode
387 \& cast5\-cfb CAST5 in CFB mode
388 \& cast5\-ecb CAST5 in ECB mode
389 \& cast5\-ofb CAST5 in OFB mode
391 \& chacha20 ChaCha20 algorithm
393 \& des\-cbc DES in CBC mode
394 \& des Alias for des\-cbc
395 \& des\-cfb DES in CFB mode
396 \& des\-ofb DES in OFB mode
397 \& des\-ecb DES in ECB mode
399 \& des\-ede\-cbc Two key triple DES EDE in CBC mode
400 \& des\-ede Two key triple DES EDE in ECB mode
401 \& des\-ede\-cfb Two key triple DES EDE in CFB mode
402 \& des\-ede\-ofb Two key triple DES EDE in OFB mode
404 \& des\-ede3\-cbc Three key triple DES EDE in CBC mode
405 \& des\-ede3 Three key triple DES EDE in ECB mode
406 \& des3 Alias for des\-ede3\-cbc
407 \& des\-ede3\-cfb Three key triple DES EDE CFB mode
408 \& des\-ede3\-ofb Three key triple DES EDE in OFB mode
410 \& desx DESX algorithm.
412 \& gost89 GOST 28147\-89 in CFB mode (provided by ccgost engine)
413 \& gost89\-cnt \`GOST 28147\-89 in CNT mode (provided by ccgost engine)
415 \& idea\-cbc IDEA algorithm in CBC mode
416 \& idea same as idea\-cbc
417 \& idea\-cfb IDEA in CFB mode
418 \& idea\-ecb IDEA in ECB mode
419 \& idea\-ofb IDEA in OFB mode
421 \& rc2\-cbc 128 bit RC2 in CBC mode
422 \& rc2 Alias for rc2\-cbc
423 \& rc2\-cfb 128 bit RC2 in CFB mode
424 \& rc2\-ecb 128 bit RC2 in ECB mode
425 \& rc2\-ofb 128 bit RC2 in OFB mode
426 \& rc2\-64\-cbc 64 bit RC2 in CBC mode
427 \& rc2\-40\-cbc 40 bit RC2 in CBC mode
430 \& rc4\-64 64 bit RC4
431 \& rc4\-40 40 bit RC4
433 \& rc5\-cbc RC5 cipher in CBC mode
434 \& rc5 Alias for rc5\-cbc
435 \& rc5\-cfb RC5 cipher in CFB mode
436 \& rc5\-ecb RC5 cipher in ECB mode
437 \& rc5\-ofb RC5 cipher in OFB mode
439 \& seed\-cbc SEED cipher in CBC mode
440 \& seed Alias for seed\-cbc
441 \& seed\-cfb SEED cipher in CFB mode
442 \& seed\-ecb SEED cipher in ECB mode
443 \& seed\-ofb SEED cipher in OFB mode
445 \& sm4\-cbc SM4 cipher in CBC mode
446 \& sm4 Alias for sm4\-cbc
447 \& sm4\-cfb SM4 cipher in CFB mode
448 \& sm4\-ctr SM4 cipher in CTR mode
449 \& sm4\-ecb SM4 cipher in ECB mode
450 \& sm4\-ofb SM4 cipher in OFB mode
452 \& aes\-[128|192|256]\-cbc 128/192/256 bit AES in CBC mode
453 \& aes[128|192|256] Alias for aes\-[128|192|256]\-cbc
454 \& aes\-[128|192|256]\-cfb 128/192/256 bit AES in 128 bit CFB mode
455 \& aes\-[128|192|256]\-cfb1 128/192/256 bit AES in 1 bit CFB mode
456 \& aes\-[128|192|256]\-cfb8 128/192/256 bit AES in 8 bit CFB mode
457 \& aes\-[128|192|256]\-ctr 128/192/256 bit AES in CTR mode
458 \& aes\-[128|192|256]\-ecb 128/192/256 bit AES in ECB mode
459 \& aes\-[128|192|256]\-ofb 128/192/256 bit AES in OFB mode
461 \& aria\-[128|192|256]\-cbc 128/192/256 bit ARIA in CBC mode
462 \& aria[128|192|256] Alias for aria\-[128|192|256]\-cbc
463 \& aria\-[128|192|256]\-cfb 128/192/256 bit ARIA in 128 bit CFB mode
464 \& aria\-[128|192|256]\-cfb1 128/192/256 bit ARIA in 1 bit CFB mode
465 \& aria\-[128|192|256]\-cfb8 128/192/256 bit ARIA in 8 bit CFB mode
466 \& aria\-[128|192|256]\-ctr 128/192/256 bit ARIA in CTR mode
467 \& aria\-[128|192|256]\-ecb 128/192/256 bit ARIA in ECB mode
468 \& aria\-[128|192|256]\-ofb 128/192/256 bit ARIA in OFB mode
470 \& camellia\-[128|192|256]\-cbc 128/192/256 bit Camellia in CBC mode
471 \& camellia[128|192|256] Alias for camellia\-[128|192|256]\-cbc
472 \& camellia\-[128|192|256]\-cfb 128/192/256 bit Camellia in 128 bit CFB mode
473 \& camellia\-[128|192|256]\-cfb1 128/192/256 bit Camellia in 1 bit CFB mode
474 \& camellia\-[128|192|256]\-cfb8 128/192/256 bit Camellia in 8 bit CFB mode
475 \& camellia\-[128|192|256]\-ctr 128/192/256 bit Camellia in CTR mode
476 \& camellia\-[128|192|256]\-ecb 128/192/256 bit Camellia in ECB mode
477 \& camellia\-[128|192|256]\-ofb 128/192/256 bit Camellia in OFB mode
480 .IX Header "EXAMPLES"
481 Just base64 encode a binary file:
484 \& openssl base64 \-in file.bin \-out file.b64
490 \& openssl base64 \-d \-in file.b64 \-out file.bin
493 Encrypt a file using \s-1AES\-128\s0 using a prompted password
494 and \s-1PBKDF2\s0 key derivation:
497 \& openssl enc \-aes128 \-pbkdf2 \-in file.txt \-out file.aes128
500 Decrypt a file using a supplied password:
503 \& openssl enc \-aes128 \-pbkdf2 \-d \-in file.aes128 \-out file.txt \e
504 \& \-pass pass:<password>
507 Encrypt a file then base64 encode it (so it can be sent via mail for example)
508 using \s-1AES\-256\s0 in \s-1CTR\s0 mode and \s-1PBKDF2\s0 key derivation:
511 \& openssl enc \-aes\-256\-ctr \-pbkdf2 \-a \-in file.txt \-out file.aes256
514 Base64 decode a file then decrypt it using a password supplied in a file:
517 \& openssl enc \-aes\-256\-ctr \-pbkdf2 \-d \-a \-in file.aes256 \-out file.txt \e
518 \& \-pass file:<passfile>
522 The \fB\-A\fR option when used with large files doesn't work properly.
524 The \fBenc\fR program only supports a fixed number of algorithms with
525 certain parameters. So if, for example, you want to use \s-1RC2\s0 with a
526 76 bit key or \s-1RC4\s0 with an 84 bit key you can't use this program.
529 The default digest was changed from \s-1MD5\s0 to \s-1SHA256\s0 in OpenSSL 1.1.0.
531 .IX Header "COPYRIGHT"
532 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
534 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
535 this file except in compliance with the License. You can obtain a copy
536 in the file \s-1LICENSE\s0 in the source distribution or at
537 <https://www.openssl.org/source/license.html>.