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<-e>
  44
  45 encrypt the input data: this is the default.
  46
  47 =item B<-d>
  48
  49 decrypt the input data.
  50
  51 =item B<-a>
  52
  53 base64 process the data. This means that if encryption is taking place
  54 the data is base64 encoded after encryption. If decryption is set then
  55 the input data is base64 decoded before being decrypted.
  56
  57 =item B<-A>
  58
  59 if the B<-a> option is set then base64 process the data on one line.
  60
  61 =item B<-k password>
  62
  63 the password to derive the key from.
  64
  65 =item B<-kfile filename>
  66
  67 read the password to derive the key from the first line of B<filename>
  68
  69 =item B<-K key>
  70
  71 the actual key to use: this must be represented as a string comprised only
  72 of hex digits.
  73
  74 =item B<-iv IV>
  75
  76 the actual IV to use: this must be represented as a string comprised only
  77 of hex digits.
  78
  79 =item B<-p>
  80
  81 print out the key and IV used.
  82
  83 =item B<-P>
  84
  85 print out the key and IV used then immediately exit: don't do any encryption
  86 or decryption.
  87
  88 =item B<-bufsize number>
  89
  90 set the buffer size for I/O
  91
  92 =item B<-debug>
  93
  94 debug the BIOs used for I/O.
  95
  96 =back
  97
  98 =head1 NOTES
  99
 100 The program can be called either as B<openssl ciphername> or
 101 B<openssl enc -ciphername>.
 102
 103 A password will be prompted for to derive the key and IV if necessary.
 104
 105 Some of the ciphers do not have large keys and others have security
 106 implications if not used correctly. A beginner is advised to just use
 107 a strong block cipher in CBC mode such as bf or des3.
 108
 109 All the block ciphers use PKCS#5 padding also known as standard block
 110 padding: this allows a rudimentary integrity or password check to be
 111 performed. However since the chance of random data passing the test is
 112 better than 1 in 256 it isn't a very good test.
 113
 114 All RC2 ciphers have the same key and effective key length.
 115
 116 Blowfish and RC5 algorithms use a 128 bit key.
 117
 118 =head1 SUPPORTED CIPHERS
 119
 120  base64             Base 64
 121
 122  bf-cbc             Blowfish in CBC mode
 123  bf                 Alias for bf-cbc
 124  bf-cfb             Blowish in CFB mode
 125  bf-ecb             Blowfish in ECB mode
 126  bf-ofb             Blowfish in OFB mode
 127
 128  cast-cbc           CAST in CBC mode
 129  cast               Alias for cast-cbc
 130  cast5-cbc          CAST5 in CBC mode
 131  cast5-cfb          CAST5 in CFB mode
 132  cast5-ecb          CAST5 in ECB mode
 133  cast5-ofb          CAST5 in OFB mode
 134
 135  des-cbc            DES in CBC mode
 136  des                Alias for des-cbc
 137  des-cfb            DES in CBC mode
 138  des-ofb            DES in OFB mode
 139  des-ecb            DES in ECB mode
 140
 141  des-ede-cbc        Two key triple DES EDE in CBC mode
 142  des-ede            Alias for des-ede
 143  des-ede-cfb        Two key triple DES EDE in CFB mode
 144  des-ede-ofb        Two key triple DES EDE in OFB mode
 145
 146  des-ede3-cbc       Three key triple DES EDE in CBC mode
 147  des-ede3           Alias for des-ede3-cbc
 148  des3               Alias for des-ede3-cbc
 149  des-ede3-cfb       Three key triple DES EDE CFB mode
 150  des-ede3-ofb       Three key triple DES EDE in OFB mode
 151
 152  desx               DESX algorithm.
 153
 154  idea-cbc           IDEA algorithm in CBC mode
 155  idea               same as idea-cbc
 156  idea-cfb           IDEA in CFB mode
 157  idea-ecb           IDEA in ECB mode
 158  idea-ofb           IDEA in OFB mode
 159
 160  rc2-cbc            128 bit RC2 in CBC mode
 161  rc2                Alias for rc2-cbc
 162  rc2-cfb            128 bit RC2 in CBC mode
 163  rc2-ecb            128 bit RC2 in CBC mode
 164  rc2-ofb            128 bit RC2 in CBC mode
 165  rc2-64-cbc         64 bit RC2 in CBC mode
 166  rc2-40-cbc         40 bit RC2 in CBC mode
 167
 168  rc4                128 bit RC4
 169  rc4-64             64 bit RC4
 170  rc4-40             40 bit RC4
 171
 172  rc5-cbc            RC5 cipher in CBC mode
 173  rc5                Alias for rc5-cbc
 174  rc5-cfb            RC5 cipher in CBC mode
 175  rc5-ecb            RC5 cipher in CBC mode
 176  rc5-ofb            RC5 cipher in CBC mode
 177
 178 =head1 EXAMPLES
 179
 180 Just base64 encode a binary file:
 181
 182  openssl base64 -in file.bin -out file.b64
 183
 184 Decode the same file
 185
 186  openssl base64 -d -in file.b64 -out file.bin
 187
 188 Encrypt a file using triple DES in CBC mode using a prompted password:
 189
 190  openssl des3 -in file.txt -out file.des3
 191
 192 Decrypt a file using a supplied password:
 193
 194  openssl des3 -d -in file.des3 -out file.txt -k mypassword
 195
 196 Encrypt a file then base64 encode it (so it can be sent via mail for example)
 197 using Blowfish in CBC mode:
 198
 199  openssl bf -a -in file.txt -out file.bf
 200
 201 Base64 decode a file then decrypt it:
 202
 203  openssl bf -d -a -in file.bf -out file.txt
 204
 205 Decrypt some data using a supplied 40 bit RC4 key:
 206
 207  openssl rc4-40 -in file.rc4 -out file.txt -K 0102030405
 208
 209 =head1 BUGS
 210
 211 The B<-A> option when used with large files doesn't work properly.
 212
 213 The key derivation algorithm used is compatible with the SSLeay algorithm. It
 214 is not very good: it uses unsalted MD5.
 215
 216 There should be an option to allow a salt or iteration count to be included.
 217
 218 Like the EVP library the B<enc> program only supports a fixed number of
 219 algorithms with certain parameters. So if, for example, you want to use RC2
 220 with a 76 bit key or RC4 with an 84 bit key you can't use this program.
 221
 222 =cut