doc/man1/enc.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 enc - symmetric cipher routines
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl enc -ciphername>
  10 [B<-help>]
  11 [B<-ciphers>]
  12 [B<-in filename>]
  13 [B<-out filename>]
  14 [B<-pass arg>]
  15 [B<-e>]
  16 [B<-d>]
  17 [B<-a/-base64>]
  18 [B<-A>]
  19 [B<-k password>]
  20 [B<-kfile filename>]
  21 [B<-K key>]
  22 [B<-iv IV>]
  23 [B<-S salt>]
  24 [B<-salt>]
  25 [B<-nosalt>]
  26 [B<-z>]
  27 [B<-md digest>]
  28 [B<-p>]
  29 [B<-P>]
  30 [B<-bufsize number>]
  31 [B<-nopad>]
  32 [B<-debug>]
  33 [B<-none>]
  34 [B<-engine id>]
  35
  36 =head1 DESCRIPTION
  37
  38 The symmetric cipher commands allow data to be encrypted or decrypted
  39 using various block and stream ciphers using keys based on passwords
  40 or explicitly provided. Base64 encoding or decoding can also be performed
  41 either by itself or in addition to the encryption or decryption.
  42
  43 =head1 OPTIONS
  44
  45 =over 4
  46
  47 =item B<-help>
  48
  49 Print out a usage message.
  50
  51 =item B<-ciphers>
  52
  53 List all supported ciphers.
  54
  55 =item B<-in filename>
  56
  57 The input filename, standard input by default.
  58
  59 =item B<-out filename>
  60
  61 The output filename, standard output by default.
  62
  63 =item B<-pass arg>
  64
  65 The password source. For more information about the format of B<arg>
  66 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  67
  68 =item B<-e>
  69
  70 Encrypt the input data: this is the default.
  71
  72 =item B<-d>
  73
  74 Decrypt the input data.
  75
  76 =item B<-a>
  77
  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.
  81
  82 =item B<-base64>
  83
  84 Same as B<-a>
  85
  86 =item B<-A>
  87
  88 If the B<-a> option is set then base64 process the data on one line.
  89
  90 =item B<-k password>
  91
  92 The password to derive the key from. This is for compatibility with previous
  93 versions of OpenSSL. Superseded by the B<-pass> argument.
  94
  95 =item B<-kfile filename>
  96
  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.
 100
 101 =item B<-md digest>
 102
 103 Use the specified digest to create the key from the passphrase.
 104 The default algorithm is sha-256.
 105
 106 =item B<-nosalt>
 107
 108 Don't use a salt in the key derivation routines. This option B<SHOULD NOT> be
 109 used except for test purposes or compatibility with ancient versions of
 110 OpenSSL.
 111
 112 =item B<-salt>
 113
 114 Use salt (randomly generated or provide with B<-S> option) when
 115 encrypting, this is the default.
 116
 117 =item B<-S salt>
 118
 119 The actual salt to use: this must be represented as a string of hex digits.
 120
 121 =item B<-K key>
 122
 123 The actual key to use: this must be represented as a string comprised only
 124 of hex digits. If only the key is specified, the IV must additionally specified
 125 using the B<-iv> option. When both a key and a password are specified, the
 126 key given with the B<-K> option will be used and the IV generated from the
 127 password will be taken. It does not make much sense to specify both key
 128 and password.
 129
 130 =item B<-iv IV>
 131
 132 The actual IV to use: this must be represented as a string comprised only
 133 of hex digits. When only the key is specified using the B<-K> option, the
 134 IV must explicitly be defined. When a password is being specified using
 135 one of the other options, the IV is generated from this password.
 136
 137 =item B<-p>
 138
 139 Print out the key and IV used.
 140
 141 =item B<-P>
 142
 143 Print out the key and IV used then immediately exit: don't do any encryption
 144 or decryption.
 145
 146 =item B<-bufsize number>
 147
 148 Set the buffer size for I/O.
 149
 150 =item B<-nopad>
 151
 152 Disable standard block padding.
 153
 154 =item B<-debug>
 155
 156 Debug the BIOs used for I/O.
 157
 158 =item B<-z>
 159
 160 Compress or decompress clear text using zlib before encryption or after
 161 decryption. This option exists only if OpenSSL with compiled with zlib
 162 or zlib-dynamic option.
 163
 164 =item B<-none>
 165
 166 Use NULL cipher (no encryption or decryption of input).
 167
 168 =back
 169
 170 =head1 NOTES
 171
 172 The program can be called either as B<openssl ciphername> or
 173 B<openssl enc -ciphername>. The first form doesn't work with
 174 engine-provided ciphers, because this form is processed before the
 175 configuration file is read and any ENGINEs loaded.
 176
 177 Engines which provide entirely new encryption algorithms (such as the ccgost
 178 engine which provides gost89 algorithm) should be configured in the
 179 configuration file. Engines specified on the command line using -engine
 180 options can only be used for hardware-assisted implementations of
 181 ciphers which are supported by the OpenSSL core or another engine specified
 182 in the configuration file.
 183
 184 When the enc command lists supported ciphers, ciphers provided by engines,
 185 specified in the configuration files are listed too.
 186
 187 A password will be prompted for to derive the key and IV if necessary.
 188
 189 The B<-salt> option should B<ALWAYS> be used if the key is being derived
 190 from a password unless you want compatibility with previous versions of
 191 OpenSSL.
 192
 193 Without the B<-salt> option it is possible to perform efficient dictionary
 194 attacks on the password and to attack stream cipher encrypted data. The reason
 195 for this is that without the salt the same password always generates the same
 196 encryption key. When the salt is being used the first eight bytes of the
 197 encrypted data are reserved for the salt: it is generated at random when
 198 encrypting a file and read from the encrypted file when it is decrypted.
 199
 200 Some of the ciphers do not have large keys and others have security
 201 implications if not used correctly. A beginner is advised to just use
 202 a strong block cipher, such as AES, in CBC mode.
 203
 204 All the block ciphers normally use PKCS#5 padding, also known as standard
 205 block padding. This allows a rudimentary integrity or password check to
 206 be performed. However since the chance of random data passing the test
 207 is better than 1 in 256 it isn't a very good test.
 208
 209 If padding is disabled then the input data must be a multiple of the cipher
 210 block length.
 211
 212 All RC2 ciphers have the same key and effective key length.
 213
 214 Blowfish and RC5 algorithms use a 128 bit key.
 215
 216 =head1 SUPPORTED CIPHERS
 217
 218 Note that some of these ciphers can be disabled at compile time
 219 and some are available only if an appropriate engine is configured
 220 in the configuration file. The output of the B<enc> command run with
 221 the B<-ciphers> option (that is B<openssl enc -ciphers>) produces a
 222 list of ciphers, supported by your version of OpenSSL, including
 223 ones provided by configured engines.
 224
 225 The B<enc> program does not support authenticated encryption modes
 226 like CCM and GCM. The utility does not store or retrieve the
 227 authentication tag.
 228
 229
 230  base64             Base 64
 231
 232  bf-cbc             Blowfish in CBC mode
 233  bf                 Alias for bf-cbc
 234  bf-cfb             Blowfish in CFB mode
 235  bf-ecb             Blowfish in ECB mode
 236  bf-ofb             Blowfish in OFB mode
 237
 238  cast-cbc           CAST in CBC mode
 239  cast               Alias for cast-cbc
 240  cast5-cbc          CAST5 in CBC mode
 241  cast5-cfb          CAST5 in CFB mode
 242  cast5-ecb          CAST5 in ECB mode
 243  cast5-ofb          CAST5 in OFB mode
 244
 245  des-cbc            DES in CBC mode
 246  des                Alias for des-cbc
 247  des-cfb            DES in CBC mode
 248  des-ofb            DES in OFB mode
 249  des-ecb            DES in ECB mode
 250
 251  des-ede-cbc        Two key triple DES EDE in CBC mode
 252  des-ede            Two key triple DES EDE in ECB mode
 253  des-ede-cfb        Two key triple DES EDE in CFB mode
 254  des-ede-ofb        Two key triple DES EDE in OFB mode
 255
 256  des-ede3-cbc       Three key triple DES EDE in CBC mode
 257  des-ede3           Three key triple DES EDE in ECB mode
 258  des3               Alias for des-ede3-cbc
 259  des-ede3-cfb       Three key triple DES EDE CFB mode
 260  des-ede3-ofb       Three key triple DES EDE in OFB mode
 261
 262  desx               DESX algorithm.
 263
 264  gost89             GOST 28147-89 in CFB mode (provided by ccgost engine)
 265  gost89-cnt        `GOST 28147-89 in CNT mode (provided by ccgost engine)
 266
 267  idea-cbc           IDEA algorithm in CBC mode
 268  idea               same as idea-cbc
 269  idea-cfb           IDEA in CFB mode
 270  idea-ecb           IDEA in ECB mode
 271  idea-ofb           IDEA in OFB mode
 272
 273  rc2-cbc            128 bit RC2 in CBC mode
 274  rc2                Alias for rc2-cbc
 275  rc2-cfb            128 bit RC2 in CFB mode
 276  rc2-ecb            128 bit RC2 in ECB mode
 277  rc2-ofb            128 bit RC2 in OFB mode
 278  rc2-64-cbc         64 bit RC2 in CBC mode
 279  rc2-40-cbc         40 bit RC2 in CBC mode
 280
 281  rc4                128 bit RC4
 282  rc4-64             64 bit RC4
 283  rc4-40             40 bit RC4
 284
 285  rc5-cbc            RC5 cipher in CBC mode
 286  rc5                Alias for rc5-cbc
 287  rc5-cfb            RC5 cipher in CFB mode
 288  rc5-ecb            RC5 cipher in ECB mode
 289  rc5-ofb            RC5 cipher in OFB mode
 290
 291  aes-[128|192|256]-cbc  128/192/256 bit AES in CBC mode
 292  aes[128|192|256]       Alias for aes-[128|192|256]-cbc
 293  aes-[128|192|256]-cfb  128/192/256 bit AES in 128 bit CFB mode
 294  aes-[128|192|256]-cfb1 128/192/256 bit AES in 1 bit CFB mode
 295  aes-[128|192|256]-cfb8 128/192/256 bit AES in 8 bit CFB mode
 296  aes-[128|192|256]-ctr  128/192/256 bit AES in CTR mode
 297  aes-[128|192|256]-ecb  128/192/256 bit AES in ECB mode
 298  aes-[128|192|256]-ofb  128/192/256 bit AES in OFB mode
 299
 300  camellia-[128|192|256]-cbc  128/192/256 bit Camellia in CBC mode
 301  camellia[128|192|256]       Alias for camellia-[128|192|256]-cbc
 302  camellia-[128|192|256]-cfb  128/192/256 bit Camellia in 128 bit CFB mode
 303  camellia-[128|192|256]-cfb1 128/192/256 bit Camellia in 1 bit CFB mode
 304  camellia-[128|192|256]-cfb8 128/192/256 bit Camellia in 8 bit CFB mode
 305  camellia-[128|192|256]-ctr  128/192/256 bit Camellia in CTR mode
 306  camellia-[128|192|256]-ecb  128/192/256 bit Camellia in ECB mode
 307  camellia-[128|192|256]-ofb  128/192/256 bit Camellia in OFB mode
 308
 309 =head1 EXAMPLES
 310
 311 Just base64 encode a binary file:
 312
 313  openssl base64 -in file.bin -out file.b64
 314
 315 Decode the same file
 316
 317  openssl base64 -d -in file.b64 -out file.bin
 318
 319 Encrypt a file using triple DES in CBC mode using a prompted password:
 320
 321  openssl des3 -salt -in file.txt -out file.des3
 322
 323 Decrypt a file using a supplied password:
 324
 325  openssl des3 -d -salt -in file.des3 -out file.txt -k mypassword
 326
 327 Encrypt a file then base64 encode it (so it can be sent via mail for example)
 328 using Blowfish in CBC mode:
 329
 330  openssl bf -a -salt -in file.txt -out file.bf
 331
 332 Base64 decode a file then decrypt it:
 333
 334  openssl bf -d -salt -a -in file.bf -out file.txt
 335
 336 Decrypt some data using a supplied 40 bit RC4 key:
 337
 338  openssl rc4-40 -in file.rc4 -out file.txt -K 0102030405
 339
 340 =head1 BUGS
 341
 342 The B<-A> option when used with large files doesn't work properly.
 343
 344 There should be an option to allow an iteration count to be included.
 345
 346 The B<enc> program only supports a fixed number of algorithms with
 347 certain parameters. So if, for example, you want to use RC2 with a
 348 76 bit key or RC4 with an 84 bit key you can't use this program.
 349
 350 =head1 HISTORY
 351
 352 The default digest was changed from MD5 to SHA256 in Openssl 1.1.
 353
 354 =head1 COPYRIGHT
 355
 356 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 357
 358 Licensed under the OpenSSL license (the "License").  You may not use
 359 this file except in compliance with the License.  You can obtain a copy
 360 in the file LICENSE in the source distribution or at
 361 L<https://www.openssl.org/source/license.html>.
 362
 363 =cut