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

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "CMS 1"
 136 .TH CMS 1 "2015-01-15" "1.0.1l" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 cms \- CMS utility
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBcms\fR
 146 [\fB\-encrypt\fR]
 147 [\fB\-decrypt\fR]
 148 [\fB\-sign\fR]
 149 [\fB\-verify\fR]
 150 [\fB\-cmsout\fR]
 151 [\fB\-resign\fR]
 152 [\fB\-data_create\fR]
 153 [\fB\-data_out\fR]
 154 [\fB\-digest_create\fR]
 155 [\fB\-digest_verify\fR]
 156 [\fB\-compress\fR]
 157 [\fB\-uncompress\fR]
 158 [\fB\-EncryptedData_encrypt\fR]
 159 [\fB\-sign_receipt\fR]
 160 [\fB\-verify_receipt receipt\fR]
 161 [\fB\-in filename\fR]
 162 [\fB\-inform SMIME|PEM|DER\fR]
 163 [\fB\-rctform SMIME|PEM|DER\fR]
 164 [\fB\-out filename\fR]
 165 [\fB\-outform SMIME|PEM|DER\fR]
 166 [\fB\-stream \-indef \-noindef\fR]
 167 [\fB\-noindef\fR]
 168 [\fB\-content filename\fR]
 169 [\fB\-text\fR]
 170 [\fB\-noout\fR]
 171 [\fB\-print\fR]
 172 [\fB\-CAfile file\fR]
 173 [\fB\-CApath dir\fR]
 174 [\fB\-md digest\fR]
 175 [\fB\-[cipher]\fR]
 176 [\fB\-nointern\fR]
 177 [\fB\-no_signer_cert_verify\fR]
 178 [\fB\-nocerts\fR]
 179 [\fB\-noattr\fR]
 180 [\fB\-nosmimecap\fR]
 181 [\fB\-binary\fR]
 182 [\fB\-nodetach\fR]
 183 [\fB\-certfile file\fR]
 184 [\fB\-certsout file\fR]
 185 [\fB\-signer file\fR]
 186 [\fB\-recip file\fR]
 187 [\fB\-keyid\fR]
 188 [\fB\-receipt_request_all \-receipt_request_first\fR]
 189 [\fB\-receipt_request_from emailaddress\fR]
 190 [\fB\-receipt_request_to emailaddress\fR]
 191 [\fB\-receipt_request_print\fR]
 192 [\fB\-secretkey key\fR]
 193 [\fB\-secretkeyid id\fR]
 194 [\fB\-econtent_type type\fR]
 195 [\fB\-inkey file\fR]
 196 [\fB\-passin arg\fR]
 197 [\fB\-rand file(s)\fR]
 198 [\fBcert.pem...\fR]
 199 [\fB\-to addr\fR]
 200 [\fB\-from addr\fR]
 201 [\fB\-subject subj\fR]
 202 [cert.pem]...
 203 .SH "DESCRIPTION"
 204 .IX Header "DESCRIPTION"
 205 The \fBcms\fR command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and
 206 verify, compress and uncompress S/MIME messages.
 207 .SH "COMMAND OPTIONS"
 208 .IX Header "COMMAND OPTIONS"
 209 There are fourteen operation options that set the type of operation to be
 210 performed. The meaning of the other options varies according to the operation
 211 type.
 212 .IP "\fB\-encrypt\fR" 4
 213 .IX Item "-encrypt"
 214 encrypt mail for the given recipient certificates. Input file is the message
 215 to be encrypted. The output file is the encrypted mail in \s-1MIME\s0 format. The
 216 actual \s-1CMS\s0 type is <B>EnvelopedData<B>.
 217 .IP "\fB\-decrypt\fR" 4
 218 .IX Item "-decrypt"
 219 decrypt mail using the supplied certificate and private key. Expects an
 220 encrypted mail message in \s-1MIME\s0 format for the input file. The decrypted mail
 221 is written to the output file.
 222 .IP "\fB\-debug_decrypt\fR" 4
 223 .IX Item "-debug_decrypt"
 224 this option sets the \fB\s-1CMS_DEBUG_DECRYPT\s0\fR flag. This option should be used
 225 with caution: see the notes section below.
 226 .IP "\fB\-sign\fR" 4
 227 .IX Item "-sign"
 228 sign mail using the supplied certificate and private key. Input file is
 229 the message to be signed. The signed message in \s-1MIME\s0 format is written
 230 to the output file.
 231 .IP "\fB\-verify\fR" 4
 232 .IX Item "-verify"
 233 verify signed mail. Expects a signed mail message on input and outputs
 234 the signed data. Both clear text and opaque signing is supported.
 235 .IP "\fB\-cmsout\fR" 4
 236 .IX Item "-cmsout"
 237 takes an input message and writes out a \s-1PEM\s0 encoded \s-1CMS\s0 structure.
 238 .IP "\fB\-resign\fR" 4
 239 .IX Item "-resign"
 240 resign a message: take an existing message and one or more new signers.
 241 .IP "\fB\-data_create\fR" 4
 242 .IX Item "-data_create"
 243 Create a \s-1CMS \s0\fBData\fR type.
 244 .IP "\fB\-data_out\fR" 4
 245 .IX Item "-data_out"
 246 \&\fBData\fR type and output the content.
 247 .IP "\fB\-digest_create\fR" 4
 248 .IX Item "-digest_create"
 249 Create a \s-1CMS \s0\fBDigestedData\fR type.
 250 .IP "\fB\-digest_verify\fR" 4
 251 .IX Item "-digest_verify"
 252 Verify a \s-1CMS \s0\fBDigestedData\fR type and output the content.
 253 .IP "\fB\-compress\fR" 4
 254 .IX Item "-compress"
 255 Create a \s-1CMS \s0\fBCompressedData\fR type. OpenSSL must be compiled with \fBzlib\fR
 256 support for this option to work, otherwise it will output an error.
 257 .IP "\fB\-uncompress\fR" 4
 258 .IX Item "-uncompress"
 259 Uncompress a \s-1CMS \s0\fBCompressedData\fR type and output the content. OpenSSL must be
 260 compiled with \fBzlib\fR support for this option to work, otherwise it will
 261 output an error.
 262 .IP "\fB\-EncryptedData_encrypt\fR" 4
 263 .IX Item "-EncryptedData_encrypt"
 264 Encrypt content using supplied symmetric key and algorithm using a \s-1CMS
 265 \&\s0\fBEncrytedData\fR type and output the content.
 266 .IP "\fB\-sign_receipt\fR" 4
 267 .IX Item "-sign_receipt"
 268 Generate and output a signed receipt for the supplied message. The input
 269 message \fBmust\fR contain a signed receipt request. Functionality is otherwise
 270 similar to the \fB\-sign\fR operation.
 271 .IP "\fB\-verify_receipt receipt\fR" 4
 272 .IX Item "-verify_receipt receipt"
 273 Verify a signed receipt in filename \fBreceipt\fR. The input message \fBmust\fR
 274 contain the original receipt request. Functionality is otherwise similar
 275 to the \fB\-verify\fR operation.
 276 .IP "\fB\-in filename\fR" 4
 277 .IX Item "-in filename"
 278 the input message to be encrypted or signed or the message to be decrypted
 279 or verified.
 280 .IP "\fB\-inform SMIME|PEM|DER\fR" 4
 281 .IX Item "-inform SMIME|PEM|DER"
 282 this specifies the input format for the \s-1CMS\s0 structure. The default
 283 is \fB\s-1SMIME\s0\fR which reads an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
 284 format change this to expect \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
 285 instead. This currently only affects the input format of the \s-1CMS\s0
 286 structure, if no \s-1CMS\s0 structure is being input (for example with
 287 \&\fB\-encrypt\fR or \fB\-sign\fR) this option has no effect.
 288 .IP "\fB\-rctform SMIME|PEM|DER\fR" 4
 289 .IX Item "-rctform SMIME|PEM|DER"
 290 specify the format for a signed receipt for use with the \fB\-receipt_verify\fR
 291 operation.
 292 .IP "\fB\-out filename\fR" 4
 293 .IX Item "-out filename"
 294 the message text that has been decrypted or verified or the output \s-1MIME\s0
 295 format message that has been signed or verified.
 296 .IP "\fB\-outform SMIME|PEM|DER\fR" 4
 297 .IX Item "-outform SMIME|PEM|DER"
 298 this specifies the output format for the \s-1CMS\s0 structure. The default
 299 is \fB\s-1SMIME\s0\fR which writes an S/MIME format message. \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR
 300 format change this to write \s-1PEM\s0 and \s-1DER\s0 format \s-1CMS\s0 structures
 301 instead. This currently only affects the output format of the \s-1CMS\s0
 302 structure, if no \s-1CMS\s0 structure is being output (for example with
 303 \&\fB\-verify\fR or \fB\-decrypt\fR) this option has no effect.
 304 .IP "\fB\-stream \-indef \-noindef\fR" 4
 305 .IX Item "-stream -indef -noindef"
 306 the \fB\-stream\fR and \fB\-indef\fR options are equivalent and enable streaming I/O
 307 for encoding operations. This permits single pass processing of data without
 308 the need to hold the entire contents in memory, potentially supporting very
 309 large files. Streaming is automatically set for S/MIME signing with detached
 310 data if the output format is \fB\s-1SMIME\s0\fR it is currently off by default for all
 311 other operations.
 312 .IP "\fB\-noindef\fR" 4
 313 .IX Item "-noindef"
 314 disable streaming I/O where it would produce and indefinite length constructed
 315 encoding. This option currently has no effect. In future streaming will be
 316 enabled by default on all relevant operations and this option will disable it.
 317 .IP "\fB\-content filename\fR" 4
 318 .IX Item "-content filename"
 319 This specifies a file containing the detached content, this is only
 320 useful with the \fB\-verify\fR command. This is only usable if the \s-1CMS\s0
 321 structure is using the detached signature form where the content is
 322 not included. This option will override any content if the input format
 323 is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type.
 324 .IP "\fB\-text\fR" 4
 325 .IX Item "-text"
 326 this option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied
 327 message if encrypting or signing. If decrypting or verifying it strips
 328 off text headers: if the decrypted or verified message is not of \s-1MIME \s0
 329 type text/plain then an error occurs.
 330 .IP "\fB\-noout\fR" 4
 331 .IX Item "-noout"
 332 for the \fB\-cmsout\fR operation do not output the parsed \s-1CMS\s0 structure. This
 333 is useful when combined with the \fB\-print\fR option or if the syntax of the \s-1CMS\s0
 334 structure is being checked.
 335 .IP "\fB\-print\fR" 4
 336 .IX Item "-print"
 337 for the \fB\-cmsout\fR operation print out all fields of the \s-1CMS\s0 structure. This
 338 is mainly useful for testing purposes.
 339 .IP "\fB\-CAfile file\fR" 4
 340 .IX Item "-CAfile file"
 341 a file containing trusted \s-1CA\s0 certificates, only used with \fB\-verify\fR.
 342 .IP "\fB\-CApath dir\fR" 4
 343 .IX Item "-CApath dir"
 344 a directory containing trusted \s-1CA\s0 certificates, only used with
 345 \&\fB\-verify\fR. This directory must be a standard certificate directory: that
 346 is a hash of each subject name (using \fBx509 \-hash\fR) should be linked
 347 to each certificate.
 348 .IP "\fB\-md digest\fR" 4
 349 .IX Item "-md digest"
 350 digest algorithm to use when signing or resigning. If not present then the
 351 default digest algorithm for the signing key will be used (usually \s-1SHA1\s0).
 352 .IP "\fB\-[cipher]\fR" 4
 353 .IX Item "-[cipher]"
 354 the encryption algorithm to use. For example triple \s-1DES \s0(168 bits) \- \fB\-des3\fR
 355 or 256 bit \s-1AES \- \s0\fB\-aes256\fR. Any standard algorithm name (as used by the
 356 \&\fIEVP_get_cipherbyname()\fR function) can also be used preceded by a dash, for
 357 example \fB\-aes_128_cbc\fR. See \fBenc\fR for a list of ciphers
 358 supported by your version of OpenSSL.
 359 .Sp
 360 If not specified triple \s-1DES\s0 is used. Only used with \fB\-encrypt\fR and
 361 \&\fB\-EncryptedData_create\fR commands.
 362 .IP "\fB\-nointern\fR" 4
 363 .IX Item "-nointern"
 364 when verifying a message normally certificates (if any) included in
 365 the message are searched for the signing certificate. With this option
 366 only the certificates specified in the \fB\-certfile\fR option are used.
 367 The supplied certificates can still be used as untrusted CAs however.
 368 .IP "\fB\-no_signer_cert_verify\fR" 4
 369 .IX Item "-no_signer_cert_verify"
 370 do not verify the signers certificate of a signed message.
 371 .IP "\fB\-nocerts\fR" 4
 372 .IX Item "-nocerts"
 373 when signing a message the signer's certificate is normally included
 374 with this option it is excluded. This will reduce the size of the
 375 signed message but the verifier must have a copy of the signers certificate
 376 available locally (passed using the \fB\-certfile\fR option for example).
 377 .IP "\fB\-noattr\fR" 4
 378 .IX Item "-noattr"
 379 normally when a message is signed a set of attributes are included which
 380 include the signing time and supported symmetric algorithms. With this
 381 option they are not included.
 382 .IP "\fB\-nosmimecap\fR" 4
 383 .IX Item "-nosmimecap"
 384 exclude the list of supported algorithms from signed attributes, other options
 385 such as signing time and content type are still included.
 386 .IP "\fB\-binary\fR" 4
 387 .IX Item "-binary"
 388 normally the input message is converted to \*(L"canonical\*(R" format which is
 389 effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME
 390 specification. When this option is present no translation occurs. This
 391 is useful when handling binary data which may not be in \s-1MIME\s0 format.
 392 .IP "\fB\-nodetach\fR" 4
 393 .IX Item "-nodetach"
 394 when signing a message use opaque signing: this form is more resistant
 395 to translation by mail relays but it cannot be read by mail agents that
 396 do not support S/MIME.  Without this option cleartext signing with
 397 the \s-1MIME\s0 type multipart/signed is used.
 398 .IP "\fB\-certfile file\fR" 4
 399 .IX Item "-certfile file"
 400 allows additional certificates to be specified. When signing these will
 401 be included with the message. When verifying these will be searched for
 402 the signers certificates. The certificates should be in \s-1PEM\s0 format.
 403 .IP "\fB\-certsout file\fR" 4
 404 .IX Item "-certsout file"
 405 any certificates contained in the message are written to \fBfile\fR.
 406 .IP "\fB\-signer file\fR" 4
 407 .IX Item "-signer file"
 408 a signing certificate when signing or resigning a message, this option can be
 409 used multiple times if more than one signer is required. If a message is being
 410 verified then the signers certificates will be written to this file if the
 411 verification was successful.
 412 .IP "\fB\-recip file\fR" 4
 413 .IX Item "-recip file"
 414 the recipients certificate when decrypting a message. This certificate
 415 must match one of the recipients of the message or an error occurs.
 416 .IP "\fB\-keyid\fR" 4
 417 .IX Item "-keyid"
 418 use subject key identifier to identify certificates instead of issuer name and
 419 serial number. The supplied certificate \fBmust\fR include a subject key
 420 identifier extension. Supported by \fB\-sign\fR and \fB\-encrypt\fR options.
 421 .IP "\fB\-receipt_request_all \-receipt_request_first\fR" 4
 422 .IX Item "-receipt_request_all -receipt_request_first"
 423 for \fB\-sign\fR option include a signed receipt request. Indicate requests should
 424 be provided by all receipient or first tier recipients (those mailed directly
 425 and not from a mailing list). Ignored it \fB\-receipt_request_from\fR is included.
 426 .IP "\fB\-receipt_request_from emailaddress\fR" 4
 427 .IX Item "-receipt_request_from emailaddress"
 428 for \fB\-sign\fR option include a signed receipt request. Add an explicit email
 429 address where receipts should be supplied.
 430 .IP "\fB\-receipt_request_to emailaddress\fR" 4
 431 .IX Item "-receipt_request_to emailaddress"
 432 Add an explicit email address where signed receipts should be sent to. This
 433 option \fBmust\fR but supplied if a signed receipt it requested.
 434 .IP "\fB\-receipt_request_print\fR" 4
 435 .IX Item "-receipt_request_print"
 436 For the \fB\-verify\fR operation print out the contents of any signed receipt
 437 requests.
 438 .IP "\fB\-secretkey key\fR" 4
 439 .IX Item "-secretkey key"
 440 specify symmetric key to use. The key must be supplied in hex format and be
 441 consistent with the algorithm used. Supported by the \fB\-EncryptedData_encrypt\fR
 442 \&\fB\-EncrryptedData_decrypt\fR, \fB\-encrypt\fR and \fB\-decrypt\fR options. When used
 443 with \fB\-encrypt\fR or \fB\-decrypt\fR the supplied key is used to wrap or unwrap the
 444 content encryption key using an \s-1AES\s0 key in the \fBKEKRecipientInfo\fR type.
 445 .IP "\fB\-secretkeyid id\fR" 4
 446 .IX Item "-secretkeyid id"
 447 the key identifier for the supplied symmetric key for \fBKEKRecipientInfo\fR type.
 448 This option \fBmust\fR be present if the \fB\-secretkey\fR option is used with
 449 \&\fB\-encrypt\fR. With \fB\-decrypt\fR operations the \fBid\fR is used to locate the
 450 relevant key if it is not supplied then an attempt is used to decrypt any
 451 \&\fBKEKRecipientInfo\fR structures.
 452 .IP "\fB\-econtent_type type\fR" 4
 453 .IX Item "-econtent_type type"
 454 set the encapsulated content type to \fBtype\fR if not supplied the \fBData\fR type
 455 is used. The \fBtype\fR argument can be any valid \s-1OID\s0 name in either text or
 456 numerical format.
 457 .IP "\fB\-inkey file\fR" 4
 458 .IX Item "-inkey file"
 459 the private key to use when signing or decrypting. This must match the
 460 corresponding certificate. If this option is not specified then the
 461 private key must be included in the certificate file specified with
 462 the \fB\-recip\fR or \fB\-signer\fR file. When signing this option can be used
 463 multiple times to specify successive keys.
 464 .IP "\fB\-passin arg\fR" 4
 465 .IX Item "-passin arg"
 466 the private key password source. For more information about the format of \fBarg\fR
 467 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 468 .IP "\fB\-rand file(s)\fR" 4
 469 .IX Item "-rand file(s)"
 470 a file or files containing random data used to seed the random number
 471 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 472 Multiple files can be specified separated by a OS-dependent character.
 473 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 474 all others.
 475 .IP "\fBcert.pem...\fR" 4
 476 .IX Item "cert.pem..."
 477 one or more certificates of message recipients: used when encrypting
 478 a message.
 479 .IP "\fB\-to, \-from, \-subject\fR" 4
 480 .IX Item "-to, -from, -subject"
 481 the relevant mail headers. These are included outside the signed
 482 portion of a message so they may be included manually. If signing
 483 then many S/MIME mail clients check the signers certificate's email
 484 address matches that specified in the From: address.
 485 .IP "\fB\-purpose, \-ignore_critical, \-issuer_checks, \-crl_check, \-crl_check_all, \-policy_check, \-extended_crl, \-x509_strict, \-policy \-check_ss_sig\fR" 4
 486 .IX Item "-purpose, -ignore_critical, -issuer_checks, -crl_check, -crl_check_all, -policy_check, -extended_crl, -x509_strict, -policy -check_ss_sig"
 487 Set various certificate chain valiadition option. See the
 488 \&\fBverify\fR manual page for details.
 489 .SH "NOTES"
 490 .IX Header "NOTES"
 491 The \s-1MIME\s0 message must be sent without any blank lines between the
 492 headers and the output. Some mail programs will automatically add
 493 a blank line. Piping the mail directly to sendmail is one way to
 494 achieve the correct format.
 495 .PP
 496 The supplied message to be signed or encrypted must include the
 497 necessary \s-1MIME\s0 headers or many S/MIME clients wont display it
 498 properly (if at all). You can use the \fB\-text\fR option to automatically
 499 add plain text headers.
 500 .PP
 501 A \*(L"signed and encrypted\*(R" message is one where a signed message is
 502 then encrypted. This can be produced by encrypting an already signed
 503 message: see the examples section.
 504 .PP
 505 This version of the program only allows one signer per message but it
 506 will verify multiple signers on received messages. Some S/MIME clients
 507 choke if a message contains multiple signers. It is possible to sign
 508 messages \*(L"in parallel\*(R" by signing an already signed message.
 509 .PP
 510 The options \fB\-encrypt\fR and \fB\-decrypt\fR reflect common usage in S/MIME
 511 clients. Strictly speaking these process \s-1CMS\s0 enveloped data: \s-1CMS\s0
 512 encrypted data is used for other purposes.
 513 .PP
 514 The \fB\-resign\fR option uses an existing message digest when adding a new
 515 signer. This means that attributes must be present in at least one existing
 516 signer using the same message digest or this operation will fail.
 517 .PP
 518 The \fB\-stream\fR and \fB\-indef\fR options enable experimental streaming I/O support.
 519 As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding
 520 and no longer \s-1DER.\s0 Streaming is supported for the \fB\-encrypt\fR operation and the
 521 \&\fB\-sign\fR operation if the content is not detached.
 522 .PP
 523 Streaming is always used for the \fB\-sign\fR operation with detached data but
 524 since the content is no longer part of the \s-1CMS\s0 structure the encoding
 525 remains \s-1DER.\s0
 526 .PP
 527 If the \fB\-decrypt\fR option is used without a recipient certificate then an
 528 attempt is made to locate the recipient by trying each potential recipient
 529 in turn using the supplied private key. To thwart the \s-1MMA\s0 attack
 530 (Bleichenbacher's attack on \s-1PKCS\s0 #1 v1.5 \s-1RSA\s0 padding) all recipients are
 531 tried whether they succeed or not and if no recipients match the message
 532 is \*(L"decrypted\*(R" using a random key which will typically output garbage.
 533 The \fB\-debug_decrypt\fR option can be used to disable the \s-1MMA\s0 attack protection
 534 and return an error if no recipient can be found: this option should be used
 535 with caution. For a fuller description see \fICMS_decrypt\fR\|(3)).
 536 .SH "EXIT CODES"
 537 .IX Header "EXIT CODES"
 538 .IP "0" 4
 539 the operation was completely successfully.
 540 .IP "1" 4
 541 .IX Item "1"
 542 an error occurred parsing the command options.
 543 .IP "2" 4
 544 .IX Item "2"
 545 one of the input files could not be read.
 546 .IP "3" 4
 547 .IX Item "3"
 548 an error occurred creating the \s-1CMS\s0 file or when reading the \s-1MIME\s0
 549 message.
 550 .IP "4" 4
 551 .IX Item "4"
 552 an error occurred decrypting or verifying the message.
 553 .IP "5" 4
 554 .IX Item "5"
 555 the message was verified correctly but an error occurred writing out
 556 the signers certificates.
 557 .SH "COMPATIBILITY WITH PKCS#7 format."
 558 .IX Header "COMPATIBILITY WITH PKCS#7 format."
 559 The \fBsmime\fR utility can only process the older \fBPKCS#7\fR format. The \fBcms\fR
 560 utility supports Cryptographic Message Syntax format. Use of some features
 561 will result in messages which cannot be processed by applications which only
 562 support the older format. These are detailed below.
 563 .PP
 564 The use of the \fB\-keyid\fR option with \fB\-sign\fR or \fB\-encrypt\fR.
 565 .PP
 566 The \fB\-outform \s-1PEM\s0\fR option uses different headers.
 567 .PP
 568 The \fB\-compress\fR option.
 569 .PP
 570 The \fB\-secretkey\fR option when used with \fB\-encrypt\fR.
 571 .PP
 572 Additionally the \fB\-EncryptedData_create\fR and \fB\-data_create\fR type cannot
 573 be processed by the older \fBsmime\fR command.
 574 .SH "EXAMPLES"
 575 .IX Header "EXAMPLES"
 576 Create a cleartext signed message:
 577 .PP
 578 .Vb 2
 579 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
 580 \&        \-signer mycert.pem
 581 .Ve
 582 .PP
 583 Create an opaque signed message
 584 .PP
 585 .Vb 2
 586 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \-nodetach \e
 587 \&        \-signer mycert.pem
 588 .Ve
 589 .PP
 590 Create a signed message, include some additional certificates and
 591 read the private key from another file:
 592 .PP
 593 .Vb 2
 594 \& openssl cms \-sign \-in in.txt \-text \-out mail.msg \e
 595 \&        \-signer mycert.pem \-inkey mykey.pem \-certfile mycerts.pem
 596 .Ve
 597 .PP
 598 Create a signed message with two signers, use key identifier:
 599 .PP
 600 .Vb 2
 601 \& openssl cms \-sign \-in message.txt \-text \-out mail.msg \e
 602 \&        \-signer mycert.pem \-signer othercert.pem \-keyid
 603 .Ve
 604 .PP
 605 Send a signed message under Unix directly to sendmail, including headers:
 606 .PP
 607 .Vb 3
 608 \& openssl cms \-sign \-in in.txt \-text \-signer mycert.pem \e
 609 \&        \-from steve@openssl.org \-to someone@somewhere \e
 610 \&        \-subject "Signed message" | sendmail someone@somewhere
 611 .Ve
 612 .PP
 613 Verify a message and extract the signer's certificate if successful:
 614 .PP
 615 .Vb 1
 616 \& openssl cms \-verify \-in mail.msg \-signer user.pem \-out signedtext.txt
 617 .Ve
 618 .PP
 619 Send encrypted mail using triple \s-1DES:\s0
 620 .PP
 621 .Vb 3
 622 \& openssl cms \-encrypt \-in in.txt \-from steve@openssl.org \e
 623 \&        \-to someone@somewhere \-subject "Encrypted message" \e
 624 \&        \-des3 user.pem \-out mail.msg
 625 .Ve
 626 .PP
 627 Sign and encrypt mail:
 628 .PP
 629 .Vb 4
 630 \& openssl cms \-sign \-in ml.txt \-signer my.pem \-text \e
 631 \&        | openssl cms \-encrypt \-out mail.msg \e
 632 \&        \-from steve@openssl.org \-to someone@somewhere \e
 633 \&        \-subject "Signed and Encrypted message" \-des3 user.pem
 634 .Ve
 635 .PP
 636 Note: the encryption command does not include the \fB\-text\fR option because the
 637 message being encrypted already has \s-1MIME\s0 headers.
 638 .PP
 639 Decrypt mail:
 640 .PP
 641 .Vb 1
 642 \& openssl cms \-decrypt \-in mail.msg \-recip mycert.pem \-inkey key.pem
 643 .Ve
 644 .PP
 645 The output from Netscape form signing is a PKCS#7 structure with the
 646 detached signature format. You can use this program to verify the
 647 signature by line wrapping the base64 encoded structure and surrounding
 648 it with:
 649 .PP
 650 .Vb 2
 651 \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
 652 \& \-\-\-\-\-END PKCS7\-\-\-\-\-
 653 .Ve
 654 .PP
 655 and using the command,
 656 .PP
 657 .Vb 1
 658 \& openssl cms \-verify \-inform PEM \-in signature.pem \-content content.txt
 659 .Ve
 660 .PP
 661 alternatively you can base64 decode the signature and use
 662 .PP
 663 .Vb 1
 664 \& openssl cms \-verify \-inform DER \-in signature.der \-content content.txt
 665 .Ve
 666 .PP
 667 Create an encrypted message using 128 bit Camellia:
 668 .PP
 669 .Vb 1
 670 \& openssl cms \-encrypt \-in plain.txt \-camellia128 \-out mail.msg cert.pem
 671 .Ve
 672 .PP
 673 Add a signer to an existing message:
 674 .PP
 675 .Vb 1
 676 \& openssl cms \-resign \-in mail.msg \-signer newsign.pem \-out mail2.msg
 677 .Ve
 678 .SH "BUGS"
 679 .IX Header "BUGS"
 680 The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've
 681 thrown at it but it may choke on others.
 682 .PP
 683 The code currently will only write out the signer's certificate to a file: if
 684 the signer has a separate encryption certificate this must be manually
 685 extracted. There should be some heuristic that determines the correct
 686 encryption certificate.
 687 .PP
 688 Ideally a database should be maintained of a certificates for each email
 689 address.
 690 .PP
 691 The code doesn't currently take note of the permitted symmetric encryption
 692 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
 693 user has to manually include the correct encryption algorithm. It should store
 694 the list of permitted ciphers in a database and only use those.
 695 .PP
 696 No revocation checking is done on the signer's certificate.
 697 .SH "HISTORY"
 698 .IX Header "HISTORY"
 699 The use of multiple \fB\-signer\fR options and the \fB\-resign\fR command were first
 700 added in OpenSSL 1.0.0