secure/usr.bin/openssl/man/enc.1

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "ENC 1"
 127 .TH ENC 1 "2013-02-05" "0.9.8y" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 enc \- symmetric cipher routines
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fBopenssl enc \-ciphername\fR
 137 [\fB\-in filename\fR]
 138 [\fB\-out filename\fR]
 139 [\fB\-pass arg\fR]
 140 [\fB\-e\fR]
 141 [\fB\-d\fR]
 142 [\fB\-a\fR]
 143 [\fB\-A\fR]
 144 [\fB\-k password\fR]
 145 [\fB\-kfile filename\fR]
 146 [\fB\-K key\fR]
 147 [\fB\-iv \s-1IV\s0\fR]
 148 [\fB\-p\fR]
 149 [\fB\-P\fR]
 150 [\fB\-bufsize number\fR]
 151 [\fB\-nopad\fR]
 152 [\fB\-debug\fR]
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 The symmetric cipher commands allow data to be encrypted or decrypted
 156 using various block and stream ciphers using keys based on passwords
 157 or explicitly provided. Base64 encoding or decoding can also be performed
 158 either by itself or in addition to the encryption or decryption.
 159 .SH "OPTIONS"
 160 .IX Header "OPTIONS"
 161 .IP "\fB\-in filename\fR" 4
 162 .IX Item "-in filename"
 163 the input filename, standard input by default.
 164 .IP "\fB\-out filename\fR" 4
 165 .IX Item "-out filename"
 166 the output filename, standard output by default.
 167 .IP "\fB\-pass arg\fR" 4
 168 .IX Item "-pass arg"
 169 the password source. For more information about the format of \fBarg\fR
 170 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 171 .IP "\fB\-salt\fR" 4
 172 .IX Item "-salt"
 173 use a salt in the key derivation routines. This is the default.
 174 .IP "\fB\-nosalt\fR" 4
 175 .IX Item "-nosalt"
 176 don't use a salt in the key derivation routines. This option \fB\s-1SHOULD\s0 \s-1NOT\s0\fR be
 177 used except for test purposes or compatibility with ancient versions of OpenSSL
 178 and SSLeay.
 179 .IP "\fB\-e\fR" 4
 180 .IX Item "-e"
 181 encrypt the input data: this is the default.
 182 .IP "\fB\-d\fR" 4
 183 .IX Item "-d"
 184 decrypt the input data.
 185 .IP "\fB\-a\fR" 4
 186 .IX Item "-a"
 187 base64 process the data. This means that if encryption is taking place
 188 the data is base64 encoded after encryption. If decryption is set then
 189 the input data is base64 decoded before being decrypted.
 190 .IP "\fB\-A\fR" 4
 191 .IX Item "-A"
 192 if the \fB\-a\fR option is set then base64 process the data on one line.
 193 .IP "\fB\-k password\fR" 4
 194 .IX Item "-k password"
 195 the password to derive the key from. This is for compatibility with previous
 196 versions of OpenSSL. Superseded by the \fB\-pass\fR argument.
 197 .IP "\fB\-kfile filename\fR" 4
 198 .IX Item "-kfile filename"
 199 read the password to derive the key from the first line of \fBfilename\fR.
 200 This is for compatibility with previous versions of OpenSSL. Superseded by
 201 the \fB\-pass\fR argument.
 202 .IP "\fB\-S salt\fR" 4
 203 .IX Item "-S salt"
 204 the actual salt to use: this must be represented as a string comprised only
 205 of hex digits.
 206 .IP "\fB\-K key\fR" 4
 207 .IX Item "-K key"
 208 the actual key to use: this must be represented as a string comprised only
 209 of hex digits. If only the key is specified, the \s-1IV\s0 must additionally specified
 210 using the \fB\-iv\fR option. When both a key and a password are specified, the
 211 key given with the \fB\-K\fR option will be used and the \s-1IV\s0 generated from the
 212 password will be taken. It probably does not make much sense to specify
 213 both key and password.
 214 .IP "\fB\-iv \s-1IV\s0\fR" 4
 215 .IX Item "-iv IV"
 216 the actual \s-1IV\s0 to use: this must be represented as a string comprised only
 217 of hex digits. When only the key is specified using the \fB\-K\fR option, the
 218 \&\s-1IV\s0 must explicitly be defined. When a password is being specified using
 219 one of the other options, the \s-1IV\s0 is generated from this password.
 220 .IP "\fB\-p\fR" 4
 221 .IX Item "-p"
 222 print out the key and \s-1IV\s0 used.
 223 .IP "\fB\-P\fR" 4
 224 .IX Item "-P"
 225 print out the key and \s-1IV\s0 used then immediately exit: don't do any encryption
 226 or decryption.
 227 .IP "\fB\-bufsize number\fR" 4
 228 .IX Item "-bufsize number"
 229 set the buffer size for I/O
 230 .IP "\fB\-nopad\fR" 4
 231 .IX Item "-nopad"
 232 disable standard block padding
 233 .IP "\fB\-debug\fR" 4
 234 .IX Item "-debug"
 235 debug the BIOs used for I/O.
 236 .SH "NOTES"
 237 .IX Header "NOTES"
 238 The program can be called either as \fBopenssl ciphername\fR or
 239 \&\fBopenssl enc \-ciphername\fR.
 240 .PP
 241 A password will be prompted for to derive the key and \s-1IV\s0 if necessary.
 242 .PP
 243 The \fB\-salt\fR option should \fB\s-1ALWAYS\s0\fR be used if the key is being derived
 244 from a password unless you want compatibility with previous versions of
 245 OpenSSL and SSLeay.
 246 .PP
 247 Without the \fB\-salt\fR option it is possible to perform efficient dictionary
 248 attacks on the password and to attack stream cipher encrypted data. The reason
 249 for this is that without the salt the same password always generates the same
 250 encryption key. When the salt is being used the first eight bytes of the
 251 encrypted data are reserved for the salt: it is generated at random when
 252 encrypting a file and read from the encrypted file when it is decrypted.
 253 .PP
 254 Some of the ciphers do not have large keys and others have security
 255 implications if not used correctly. A beginner is advised to just use
 256 a strong block cipher in \s-1CBC\s0 mode such as bf or des3.
 257 .PP
 258 All the block ciphers normally use PKCS#5 padding also known as standard block
 259 padding: this allows a rudimentary integrity or password check to be
 260 performed. However since the chance of random data passing the test is
 261 better than 1 in 256 it isn't a very good test.
 262 .PP
 263 If padding is disabled then the input data must be a multiple of the cipher
 264 block length.
 265 .PP
 266 All \s-1RC2\s0 ciphers have the same key and effective key length.
 267 .PP
 268 Blowfish and \s-1RC5\s0 algorithms use a 128 bit key.
 269 .SH "SUPPORTED CIPHERS"
 270 .IX Header "SUPPORTED CIPHERS"
 271 .Vb 1
 272 \& base64             Base 64
 273 \&
 274 \& bf\-cbc             Blowfish in CBC mode
 275 \& bf                 Alias for bf\-cbc
 276 \& bf\-cfb             Blowfish in CFB mode
 277 \& bf\-ecb             Blowfish in ECB mode
 278 \& bf\-ofb             Blowfish in OFB mode
 279 \&
 280 \& cast\-cbc           CAST in CBC mode
 281 \& cast               Alias for cast\-cbc
 282 \& cast5\-cbc          CAST5 in CBC mode
 283 \& cast5\-cfb          CAST5 in CFB mode
 284 \& cast5\-ecb          CAST5 in ECB mode
 285 \& cast5\-ofb          CAST5 in OFB mode
 286 \&
 287 \& des\-cbc            DES in CBC mode
 288 \& des                Alias for des\-cbc
 289 \& des\-cfb            DES in CBC mode
 290 \& des\-ofb            DES in OFB mode
 291 \& des\-ecb            DES in ECB mode
 292 \&
 293 \& des\-ede\-cbc        Two key triple DES EDE in CBC mode
 294 \& des\-ede            Two key triple DES EDE in ECB mode
 295 \& des\-ede\-cfb        Two key triple DES EDE in CFB mode
 296 \& des\-ede\-ofb        Two key triple DES EDE in OFB mode
 297 \&
 298 \& des\-ede3\-cbc       Three key triple DES EDE in CBC mode
 299 \& des\-ede3           Three key triple DES EDE in ECB mode
 300 \& des3               Alias for des\-ede3\-cbc
 301 \& des\-ede3\-cfb       Three key triple DES EDE CFB mode
 302 \& des\-ede3\-ofb       Three key triple DES EDE in OFB mode
 303 \&
 304 \& desx               DESX algorithm.
 305 \&
 306 \& idea\-cbc           IDEA algorithm in CBC mode
 307 \& idea               same as idea\-cbc
 308 \& idea\-cfb           IDEA in CFB mode
 309 \& idea\-ecb           IDEA in ECB mode
 310 \& idea\-ofb           IDEA in OFB mode
 311 \&
 312 \& rc2\-cbc            128 bit RC2 in CBC mode
 313 \& rc2                Alias for rc2\-cbc
 314 \& rc2\-cfb            128 bit RC2 in CFB mode
 315 \& rc2\-ecb            128 bit RC2 in ECB mode
 316 \& rc2\-ofb            128 bit RC2 in OFB mode
 317 \& rc2\-64\-cbc         64 bit RC2 in CBC mode
 318 \& rc2\-40\-cbc         40 bit RC2 in CBC mode
 319 \&
 320 \& rc4                128 bit RC4
 321 \& rc4\-64             64 bit RC4
 322 \& rc4\-40             40 bit RC4
 323 \&
 324 \& rc5\-cbc            RC5 cipher in CBC mode
 325 \& rc5                Alias for rc5\-cbc
 326 \& rc5\-cfb            RC5 cipher in CFB mode
 327 \& rc5\-ecb            RC5 cipher in ECB mode
 328 \& rc5\-ofb            RC5 cipher in OFB mode
 329 \&
 330 \& aes\-[128|192|256]\-cbc  128/192/256 bit AES in CBC mode
 331 \& aes\-[128|192|256]      Alias for aes\-[128|192|256]\-cbc
 332 \& aes\-[128|192|256]\-cfb  128/192/256 bit AES in 128 bit CFB mode
 333 \& aes\-[128|192|256]\-cfb1 128/192/256 bit AES in 1 bit CFB mode
 334 \& aes\-[128|192|256]\-cfb8 128/192/256 bit AES in 8 bit CFB mode
 335 \& aes\-[128|192|256]\-ecb  128/192/256 bit AES in ECB mode
 336 \& aes\-[128|192|256]\-ofb  128/192/256 bit AES in OFB mode
 337 .Ve
 338 .SH "EXAMPLES"
 339 .IX Header "EXAMPLES"
 340 Just base64 encode a binary file:
 341 .PP
 342 .Vb 1
 343 \& openssl base64 \-in file.bin \-out file.b64
 344 .Ve
 345 .PP
 346 Decode the same file
 347 .PP
 348 .Vb 1
 349 \& openssl base64 \-d \-in file.b64 \-out file.bin
 350 .Ve
 351 .PP
 352 Encrypt a file using triple \s-1DES\s0 in \s-1CBC\s0 mode using a prompted password:
 353 .PP
 354 .Vb 1
 355 \& openssl des3 \-salt \-in file.txt \-out file.des3
 356 .Ve
 357 .PP
 358 Decrypt a file using a supplied password:
 359 .PP
 360 .Vb 1
 361 \& openssl des3 \-d \-salt \-in file.des3 \-out file.txt \-k mypassword
 362 .Ve
 363 .PP
 364 Encrypt a file then base64 encode it (so it can be sent via mail for example)
 365 using Blowfish in \s-1CBC\s0 mode:
 366 .PP
 367 .Vb 1
 368 \& openssl bf \-a \-salt \-in file.txt \-out file.bf
 369 .Ve
 370 .PP
 371 Base64 decode a file then decrypt it:
 372 .PP
 373 .Vb 1
 374 \& openssl bf \-d \-salt \-a \-in file.bf \-out file.txt
 375 .Ve
 376 .PP
 377 Decrypt some data using a supplied 40 bit \s-1RC4\s0 key:
 378 .PP
 379 .Vb 1
 380 \& openssl rc4\-40 \-in file.rc4 \-out file.txt \-K 0102030405
 381 .Ve
 382 .SH "BUGS"
 383 .IX Header "BUGS"
 384 The \fB\-A\fR option when used with large files doesn't work properly.
 385 .PP
 386 There should be an option to allow an iteration count to be included.
 387 .PP
 388 The \fBenc\fR program only supports a fixed number of algorithms with
 389 certain parameters. So if, for example, you want to use \s-1RC2\s0 with a
 390 76 bit key or \s-1RC4\s0 with an 84 bit key you can't use this program.