doc/man/enc.pod

   1 =pod
   2 =head1 NAME
   3
   4 enc - symmetric cipher routines
   5
   6 =head1 SYNOPSIS
   7
   8 B<openssl enc -ciphername>
   9 [B<-in filename>]
  10 [B<-out filename>]
  11 [B<-e>]
  12 [B<-d>]
  13 [B<-a>]
  14 [B<-A>]
  15 [B<-k password>]
  16 [B<-kfile filename>]
  17 [B<-K key>]
  18 [B<-iv IV>]
  19 [B<-p>]
  20 [B<-P>]
  21 [B<-bufsize number>]
  22 [B<-debug>]
  23
  24 =head1 DESCRIPTION
  25
  26 The symmetric cipher commands allow data to be encrytped or decrypted
  27 using various block and stream ciphers using keys based on passwords
  28 or explicitly provided. Base64 encoding or decoding can also be performed
  29 either by itself or in addition to the encryption or decryption.
  30
  31 =head1 OPTIONS
  32
  33 =over 4
  34
  35 =item B<-in filename>
  36
  37 the input filename, standard input by default.
  38
  39 =item B<-out filename>
  40
  41 the output filename, standard output by default.
  42
  43 =item B<-salt>
  44
  45 use a salt in the key derivation routines. This option should B<ALWAYS>
  46 be used unless compatability with previous versions of OpenSSL or SSLeay
  47 is required. This option is only present on OpenSSL versions 0.9.5 or
  48 above.
  49
  50 =item B<-nosalt>
  51
  52 don't use a salt in the key derivation routines. This is the default for
  53 compatability with previous versions of OpenSSL and SSLeay.
  54
  55 =item B<-e>
  56
  57 encrypt the input data: this is the default.
  58
  59 =item B<-d>
  60
  61 decrypt the input data.
  62
  63 =item B<-a>
  64
  65 base64 process the data. This means that if encryption is taking place
  66 the data is base64 encoded after encryption. If decryption is set then
  67 the input data is base64 decoded before being decrypted.
  68
  69 =item B<-A>
  70
  71 if the B<-a> option is set then base64 process the data on one line.
  72
  73 =item B<-k password>
  74
  75 the password to derive the key from.
  76
  77 =item B<-kfile filename>
  78
  79 read the password to derive the key from the first line of B<filename>
  80
  81 =item B<-S salt>
  82
  83 the actual salt to use: this must be represented as a string comprised only
  84 of hex digits.
  85
  86 =item B<-K key>
  87
  88 the actual key to use: this must be represented as a string comprised only
  89 of hex digits.
  90
  91 =item B<-iv IV>
  92
  93 the actual IV to use: this must be represented as a string comprised only
  94 of hex digits.
  95
  96 =item B<-p>
  97
  98 print out the key and IV used.
  99
 100 =item B<-P>
 101
 102 print out the key and IV used then immediately exit: don't do any encryption
 103 or decryption.
 104
 105 =item B<-bufsize number>
 106
 107 set the buffer size for I/O
 108
 109 =item B<-debug>
 110
 111 debug the BIOs used for I/O.
 112
 113 =back
 114
 115 =head1 NOTES
 116
 117 The program can be called either as B<openssl ciphername> or
 118 B<openssl enc -ciphername>.
 119
 120 A password will be prompted for to derive the key and IV if necessary.
 121
 122 The B<-salt> option should B<ALWAYS> be used if the key is being derived
 123 from a password unless you want compatability with previous versions of
 124 OpenSSL and SSLeay.
 125
 126 Without the B<-salt> option it is possible to perform efficient dictionary
 127 attacks on the password and to attack stream cipher encrypted data. The reason
 128 for this is that without the salt the same password always generates the same
 129 encryption key. When the salt is being used the first eight bytes of the
 130 encrypted data are reserved for the salt: it is generated at random when
 131 encrypting a file and read from the encrypted file when it is decrypted.
 132
 133 Some of the ciphers do not have large keys and others have security
 134 implications if not used correctly. A beginner is advised to just use
 135 a strong block cipher in CBC mode such as bf or des3.
 136
 137 All the block ciphers use PKCS#5 padding also known as standard block
 138 padding: this allows a rudimentary integrity or password check to be
 139 performed. However since the chance of random data passing the test is
 140 better than 1 in 256 it isn't a very good test.
 141
 142 All RC2 ciphers have the same key and effective key length.
 143
 144 Blowfish and RC5 algorithms use a 128 bit key.
 145
 146 =head1 SUPPORTED CIPHERS
 147
 148  base64             Base 64
 149
 150  bf-cbc             Blowfish in CBC mode
 151  bf                 Alias for bf-cbc
 152  bf-cfb             Blowish in CFB mode
 153  bf-ecb             Blowfish in ECB mode
 154  bf-ofb             Blowfish in OFB mode
 155
 156  cast-cbc           CAST in CBC mode
 157  cast               Alias for cast-cbc
 158  cast5-cbc          CAST5 in CBC mode
 159  cast5-cfb          CAST5 in CFB mode
 160  cast5-ecb          CAST5 in ECB mode
 161  cast5-ofb          CAST5 in OFB mode
 162
 163  des-cbc            DES in CBC mode
 164  des                Alias for des-cbc
 165  des-cfb            DES in CBC mode
 166  des-ofb            DES in OFB mode
 167  des-ecb            DES in ECB mode
 168
 169  des-ede-cbc        Two key triple DES EDE in CBC mode
 170  des-ede            Alias for des-ede
 171  des-ede-cfb        Two key triple DES EDE in CFB mode
 172  des-ede-ofb        Two key triple DES EDE in OFB mode
 173
 174  des-ede3-cbc       Three key triple DES EDE in CBC mode
 175  des-ede3           Alias for des-ede3-cbc
 176  des3               Alias for des-ede3-cbc
 177  des-ede3-cfb       Three key triple DES EDE CFB mode
 178  des-ede3-ofb       Three key triple DES EDE in OFB mode
 179
 180  desx               DESX algorithm.
 181
 182  idea-cbc           IDEA algorithm in CBC mode
 183  idea               same as idea-cbc
 184  idea-cfb           IDEA in CFB mode
 185  idea-ecb           IDEA in ECB mode
 186  idea-ofb           IDEA in OFB mode
 187
 188  rc2-cbc            128 bit RC2 in CBC mode
 189  rc2                Alias for rc2-cbc
 190  rc2-cfb            128 bit RC2 in CBC mode
 191  rc2-ecb            128 bit RC2 in CBC mode
 192  rc2-ofb            128 bit RC2 in CBC mode
 193  rc2-64-cbc         64 bit RC2 in CBC mode
 194  rc2-40-cbc         40 bit RC2 in CBC mode
 195
 196  rc4                128 bit RC4
 197  rc4-64             64 bit RC4
 198  rc4-40             40 bit RC4
 199
 200  rc5-cbc            RC5 cipher in CBC mode
 201  rc5                Alias for rc5-cbc
 202  rc5-cfb            RC5 cipher in CBC mode
 203  rc5-ecb            RC5 cipher in CBC mode
 204  rc5-ofb            RC5 cipher in CBC mode
 205
 206 =head1 EXAMPLES
 207
 208 Just base64 encode a binary file:
 209
 210  openssl base64 -in file.bin -out file.b64
 211
 212 Decode the same file
 213
 214  openssl base64 -d -in file.b64 -out file.bin
 215
 216 Encrypt a file using triple DES in CBC mode using a prompted password:
 217
 218  openssl des3 -salt -in file.txt -out file.des3
 219
 220 Decrypt a file using a supplied password:
 221
 222  openssl des3 -d -salt -in file.des3 -out file.txt -k mypassword
 223
 224 Encrypt a file then base64 encode it (so it can be sent via mail for example)
 225 using Blowfish in CBC mode:
 226
 227  openssl bf -a -salt -in file.txt -out file.bf
 228
 229 Base64 decode a file then decrypt it:
 230
 231  openssl bf -d -salt -a -in file.bf -out file.txt
 232
 233 Decrypt some data using a supplied 40 bit RC4 key:
 234
 235  openssl rc4-40 -in file.rc4 -out file.txt -K 0102030405
 236
 237 =head1 BUGS
 238
 239 The B<-A> option when used with large files doesn't work properly.
 240
 241 There should be an option to allow an iteration count to be included.
 242
 243 Like the EVP library the B<enc> program only supports a fixed number of
 244 algorithms with certain parameters. So if, for example, you want to use RC2
 245 with a 76 bit key or RC4 with an 84 bit key you can't use this program.
 246
 247 =cut