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

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