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