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

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