doc/man1/openssl-cms.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-cms - CMS command
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<cms>
  11 [B<-help>]
  12 [B<-encrypt>]
  13 [B<-decrypt>]
  14 [B<-debug_decrypt>]
  15 [B<-sign>]
  16 [B<-verify>]
  17 [B<-verify_retcode>]
  18 [B<-no_attr_verify>]
  19 [B<-nosigs>]
  20 [B<-no_content_verify>]
  21 [B<-cmsout>]
  22 [B<-resign>]
  23 [B<-cades>]
  24 [B<-data_create>]
  25 [B<-data_out>]
  26 [B<-digest_create>]
  27 [B<-digest_verify>]
  28 [B<-compress>]
  29 [B<-uncompress>]
  30 [B<-EncryptedData_decrypt>]
  31 [B<-EncryptedData_encrypt>]
  32 [B<-sign_receipt>]
  33 [B<-verify_receipt> I<receipt>]
  34 [B<-in> I<filename>]
  35 [B<-out> I<filename>]
  36 [B<-inform> B<DER>|B<PEM>|B<SMIME>]
  37 [B<-outform> B<DER>|B<PEM>|B<SMIME>]
  38 [B<-rctform> B<DER>|B<PEM>|B<SMIME>]
  39 [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  40 [B<-stream>]
  41 [B<-indef>]
  42 [B<-noindef>]
  43 [B<-content> I<filename>]
  44 [B<-text>]
  45 [B<-noout>]
  46 [B<-print>]
  47 [B<-nameopt> I<option>]
  48 [B<-md> I<digest>]
  49 [B<-I<cipher>>]
  50 [B<-wrap> I<cipher>]
  51 [B<-nointern>]
  52 [B<-noverify>]
  53 [B<-nocerts>]
  54 [B<-noattr>]
  55 [B<-nosmimecap>]
  56 [B<-binary>]
  57 [B<-crlfeol>]
  58 [B<-asciicrlf>]
  59 [B<-nodetach>]
  60 [B<-certfile> I<file>]
  61 [B<-certsout> I<file>]
  62 [B<-signer> I<file>]
  63 [B<-originator> I<file>]
  64 [B<-recip> I<file>]
  65 [B<-keyid>]
  66 [B<-receipt_request_all>]
  67 [B<-receipt_request_first>]
  68 [B<-receipt_request_from> I<emailaddress>]
  69 [B<-receipt_request_to> I<emailaddress>]
  70 [B<-receipt_request_print>]
  71 [B<-pwri_password> I<password>]
  72 [B<-secretkey> I<key>]
  73 [B<-secretkeyid> I<id>]
  74 [B<-econtent_type> I<type>]
  75 [B<-inkey> I<file>]
  76 [B<-keyopt> I<name>:I<parameter>]
  77 [B<-passin> I<arg>]
  78 [B<-to> I<addr>]
  79 [B<-from> I<addr>]
  80 [B<-subject> I<subj>]
  81 {- $OpenSSL::safe::opt_v_synopsis -}
  82 {- $OpenSSL::safe::opt_trust_synopsis -}
  83 {- $OpenSSL::safe::opt_r_synopsis -}
  84 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  85 {- $OpenSSL::safe::opt_config_synopsis -}
  86 [I<recipient-cert> ...]
  87
  88 =for openssl ifdef des-wrap engine
  89
  90 =head1 DESCRIPTION
  91
  92 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
  93 sign and verify, compress and uncompress S/MIME messages.
  94
  95 =head1 OPTIONS
  96
  97 There are fourteen operation options that set the type of operation to be
  98 performed. The meaning of the other options varies according to the operation
  99 type.
 100
 101 =over 4
 102
 103 =item B<-help>
 104
 105 Print out a usage message.
 106
 107 =item B<-encrypt>
 108
 109 Encrypt mail for the given recipient certificates. Input file is the message
 110 to be encrypted. The output file is the encrypted mail in MIME format. The
 111 actual CMS type is B<EnvelopedData>.
 112
 113 Note that no revocation check is done for the recipient cert, so if that
 114 key has been compromised, others may be able to decrypt the text.
 115
 116 =item B<-decrypt>
 117
 118 Decrypt mail using the supplied certificate and private key. Expects an
 119 encrypted mail message in MIME format for the input file. The decrypted mail
 120 is written to the output file.
 121
 122 =item B<-debug_decrypt>
 123
 124 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
 125 with caution: see the notes section below.
 126
 127 =item B<-sign>
 128
 129 Sign mail using the supplied certificate and private key. Input file is
 130 the message to be signed. The signed message in MIME format is written
 131 to the output file.
 132
 133 =item B<-verify>
 134
 135 Verify signed mail. Expects a signed mail message on input and outputs
 136 the signed data. Both clear text and opaque signing is supported.
 137
 138 =item B<-verify_retcode>
 139
 140 Exit nonzero on verification failure.
 141
 142 =item B<-no_attr_verify>
 143
 144 Do not verify signed attribute signatures.
 145
 146 =item B<-no_content_verify>
 147
 148 Do not verify signed content signatures.
 149
 150 =item B<-nosigs>
 151
 152 Don't verify message signature.
 153
 154 =item B<-cmsout>
 155
 156 Takes an input message and writes out a PEM encoded CMS structure.
 157
 158 =item B<-resign>
 159
 160 Resign a message: take an existing message and one or more new signers.
 161
 162 =item B<-cades>
 163
 164 Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make
 165 the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES
 166 section for more details.
 167
 168 =item B<-data_create>
 169
 170 Create a CMS B<Data> type.
 171
 172 =item B<-data_out>
 173
 174 B<Data> type and output the content.
 175
 176 =item B<-digest_create>
 177
 178 Create a CMS B<DigestedData> type.
 179
 180 =item B<-digest_verify>
 181
 182 Verify a CMS B<DigestedData> type and output the content.
 183
 184 =item B<-compress>
 185
 186 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
 187 support for this option to work, otherwise it will output an error.
 188
 189 =item B<-uncompress>
 190
 191 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
 192 compiled with B<zlib> support for this option to work, otherwise it will
 193 output an error.
 194
 195 =item B<-EncryptedData_decrypt>
 196
 197 Decrypt content using supplied symmetric key and algorithm using a CMS
 198 B<EncryptedData> type and output the content.
 199
 200 =item B<-EncryptedData_encrypt>
 201
 202 Encrypt content using supplied symmetric key and algorithm using a CMS
 203 B<EncryptedData> type and output the content.
 204
 205 =item B<-sign_receipt>
 206
 207 Generate and output a signed receipt for the supplied message. The input
 208 message B<must> contain a signed receipt request. Functionality is otherwise
 209 similar to the B<-sign> operation.
 210
 211 =item B<-verify_receipt> I<receipt>
 212
 213 Verify a signed receipt in filename B<receipt>. The input message B<must>
 214 contain the original receipt request. Functionality is otherwise similar
 215 to the B<-verify> operation.
 216
 217 =item B<-in> I<filename>
 218
 219 The input message to be encrypted or signed or the message to be decrypted
 220 or verified.
 221
 222 =item B<-out> I<filename>
 223
 224 The message text that has been decrypted or verified or the output MIME
 225 format message that has been signed or verified.
 226
 227 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
 228
 229 The input format of the CMS structure (if one is being read);
 230 the default is B<SMIME>.
 231 See L<openssl(1)/Format Options> for details.
 232
 233 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
 234
 235 The output format of the CMS structure (if one is being written);
 236 the default is B<SMIME>.
 237 See L<openssl(1)/Format Options> for details.
 238
 239 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
 240
 241 The format of the private key file; the default is B<PEM>.
 242 The only value with effect is B<ENGINE>; all others have become obsolete.
 243 See L<openssl(1)/Format Options> for details.
 244
 245 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
 246
 247 The signed receipt format for use with the B<-receipt_verify>; the default
 248 is B<SMIME>.
 249 See L<openssl(1)/Format Options> for details.
 250
 251 =item B<-stream>, B<-indef>
 252
 253 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
 254 for encoding operations. This permits single pass processing of data without
 255 the need to hold the entire contents in memory, potentially supporting very
 256 large files. Streaming is automatically set for S/MIME signing with detached
 257 data if the output format is B<SMIME> it is currently off by default for all
 258 other operations.
 259
 260 =item B<-noindef>
 261
 262 Disable streaming I/O where it would produce and indefinite length constructed
 263 encoding. This option currently has no effect. In future streaming will be
 264 enabled by default on all relevant operations and this option will disable it.
 265
 266 =item B<-content> I<filename>
 267
 268 This specifies a file containing the detached content, this is only
 269 useful with the B<-verify> command. This is only usable if the CMS
 270 structure is using the detached signature form where the content is
 271 not included. This option will override any content if the input format
 272 is S/MIME and it uses the multipart/signed MIME content type.
 273
 274 =item B<-text>
 275
 276 This option adds plain text (text/plain) MIME headers to the supplied
 277 message if encrypting or signing. If decrypting or verifying it strips
 278 off text headers: if the decrypted or verified message is not of MIME
 279 type text/plain then an error occurs.
 280
 281 =item B<-noout>
 282
 283 For the B<-cmsout> operation do not output the parsed CMS structure. This
 284 is useful when combined with the B<-print> option or if the syntax of the CMS
 285 structure is being checked.
 286
 287 =item B<-print>
 288
 289 For the B<-cmsout> operation print out all fields of the CMS structure. This
 290 is mainly useful for testing purposes.
 291
 292 =item B<-nameopt> I<option>
 293
 294 For the B<-cmsout> operation when B<-print> option is in use, specifies
 295 printing options for string fields. For most cases B<utf8> is reasonable value.
 296 See L<openssl(1)/Name Format Options> for details.
 297
 298 =item B<-md> I<digest>
 299
 300 Digest algorithm to use when signing or resigning. If not present then the
 301 default digest algorithm for the signing key will be used (usually SHA1).
 302
 303 =item B<-I<cipher>>
 304
 305 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
 306 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
 307 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
 308 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
 309 supported by your version of OpenSSL.
 310
 311 Currently the AES variants with GCM mode are the only supported AEAD
 312 algorithms.
 313
 314 If not specified triple DES is used. Only used with B<-encrypt> and
 315 B<-EncryptedData_create> commands.
 316
 317 =item B<-wrap> I<cipher>
 318
 319 Cipher algorithm to use for key wrap when encrypting the message using Key
 320 Agreement for key transport. The algorithm specified should be suitable for key
 321 wrap.
 322
 323 =item B<-nointern>
 324
 325 When verifying a message normally certificates (if any) included in
 326 the message are searched for the signing certificate. With this option
 327 only the certificates specified in the B<-certfile> option are used.
 328 The supplied certificates can still be used as untrusted CAs however.
 329
 330 =item B<-noverify>
 331
 332 Do not verify the signers certificate of a signed message.
 333
 334 =item B<-nocerts>
 335
 336 When signing a message the signer's certificate is normally included
 337 with this option it is excluded. This will reduce the size of the
 338 signed message but the verifier must have a copy of the signers certificate
 339 available locally (passed using the B<-certfile> option for example).
 340
 341 =item B<-noattr>
 342
 343 Normally when a message is signed a set of attributes are included which
 344 include the signing time and supported symmetric algorithms. With this
 345 option they are not included.
 346
 347 =item B<-nosmimecap>
 348
 349 Exclude the list of supported algorithms from signed attributes, other options
 350 such as signing time and content type are still included.
 351
 352 =item B<-binary>
 353
 354 Normally the input message is converted to "canonical" format which is
 355 effectively using CR and LF as end of line: as required by the S/MIME
 356 specification. When this option is present no translation occurs. This
 357 is useful when handling binary data which may not be in MIME format.
 358
 359 =item B<-crlfeol>
 360
 361 Normally the output file uses a single B<LF> as end of line. When this
 362 option is present B<CRLF> is used instead.
 363
 364 =item B<-asciicrlf>
 365
 366 When signing use ASCII CRLF format canonicalisation. This strips trailing
 367 whitespace from all lines, deletes trailing blank lines at EOF and sets
 368 the encapsulated content type. This option is normally used with detached
 369 content and an output signature format of DER. This option is not normally
 370 needed when verifying as it is enabled automatically if the encapsulated
 371 content format is detected.
 372
 373 =item B<-nodetach>
 374
 375 When signing a message use opaque signing: this form is more resistant
 376 to translation by mail relays but it cannot be read by mail agents that
 377 do not support S/MIME.  Without this option cleartext signing with
 378 the MIME type multipart/signed is used.
 379
 380 =item B<-certfile> I<file>
 381
 382 Allows additional certificates to be specified. When signing these will
 383 be included with the message. When verifying these will be searched for
 384 the signers certificates.
 385 The input can be in PEM, DER, or PKCS#12 format.
 386
 387 =item B<-certsout> I<file>
 388
 389 Any certificates contained in the message are written to I<file>.
 390
 391 =item B<-signer> I<file>
 392
 393 A signing certificate when signing or resigning a message, this option can be
 394 used multiple times if more than one signer is required. If a message is being
 395 verified then the signers certificates will be written to this file if the
 396 verification was successful.
 397
 398 =item B<-originator> I<file>
 399
 400 A certificate of the originator of the encrypted message. Necessary for
 401 decryption when Key Agreement is in use for a shared key.
 402
 403 =item B<-recip> I<file>
 404
 405 When decrypting a message this specifies the recipients certificate. The
 406 certificate must match one of the recipients of the message or an error
 407 occurs.
 408
 409 When encrypting a message this option may be used multiple times to specify
 410 each recipient. This form B<must> be used if customised parameters are
 411 required (for example to specify RSA-OAEP).
 412
 413 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
 414 option.
 415
 416 =item B<-keyid>
 417
 418 Use subject key identifier to identify certificates instead of issuer name and
 419 serial number. The supplied certificate B<must> include a subject key
 420 identifier extension. Supported by B<-sign> and B<-encrypt> options.
 421
 422 =item B<-receipt_request_all>, B<-receipt_request_first>
 423
 424 For B<-sign> option include a signed receipt request. Indicate requests should
 425 be provided by all recipient or first tier recipients (those mailed directly
 426 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
 427
 428 =item B<-receipt_request_from> I<emailaddress>
 429
 430 For B<-sign> option include a signed receipt request. Add an explicit email
 431 address where receipts should be supplied.
 432
 433 =item B<-receipt_request_to> I<emailaddress>
 434
 435 Add an explicit email address where signed receipts should be sent to. This
 436 option B<must> but supplied if a signed receipt it requested.
 437
 438 =item B<-receipt_request_print>
 439
 440 For the B<-verify> operation print out the contents of any signed receipt
 441 requests.
 442
 443 =item B<-pwri_password> I<password>
 444
 445 Specify password for recipient.
 446
 447 =item B<-secretkey> I<key>
 448
 449 Specify symmetric key to use. The key must be supplied in hex format and be
 450 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
 451 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
 452 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
 453 content encryption key using an AES key in the B<KEKRecipientInfo> type.
 454
 455 =item B<-secretkeyid> I<id>
 456
 457 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
 458 This option B<must> be present if the B<-secretkey> option is used with
 459 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
 460 relevant key if it is not supplied then an attempt is used to decrypt any
 461 B<KEKRecipientInfo> structures.
 462
 463 =item B<-econtent_type> I<type>
 464
 465 Set the encapsulated content type to I<type> if not supplied the B<Data> type
 466 is used. The I<type> argument can be any valid OID name in either text or
 467 numerical format.
 468
 469 =item B<-inkey> I<file>
 470
 471 The private key to use when signing or decrypting. This must match the
 472 corresponding certificate. If this option is not specified then the
 473 private key must be included in the certificate file specified with
 474 the B<-recip> or B<-signer> file. When signing this option can be used
 475 multiple times to specify successive keys.
 476
 477 =item B<-keyopt> I<name>:I<parameter>
 478
 479 For signing and encryption this option can be used multiple times to
 480 set customised parameters for the preceding key or certificate. It can
 481 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
 482 or to modify default parameters for ECDH.
 483
 484 =item B<-passin> I<arg>
 485
 486 The private key password source. For more information about the format of B<arg>
 487 see L<openssl(1)/Pass Phrase Options>.
 488
 489 =item B<-to>, B<-from>, B<-subject>
 490
 491 The relevant mail headers. These are included outside the signed
 492 portion of a message so they may be included manually. If signing
 493 then many S/MIME mail clients check the signers certificate's email
 494 address matches that specified in the From: address.
 495
 496 {- $OpenSSL::safe::opt_v_item -}
 497
 498 Any verification errors cause the command to exit.
 499
 500 {- $OpenSSL::safe::opt_trust_item -}
 501
 502 {- $OpenSSL::safe::opt_r_item -}
 503
 504 {- $OpenSSL::safe::opt_engine_item -}
 505
 506 {- $OpenSSL::safe::opt_provider_item -}
 507
 508 {- $OpenSSL::safe::opt_config_item -}
 509
 510 =item I<recipient-cert> ...
 511
 512 One or more certificates of message recipients: used when encrypting
 513 a message.
 514
 515 =back
 516
 517 =head1 NOTES
 518
 519 The MIME message must be sent without any blank lines between the
 520 headers and the output. Some mail programs will automatically add
 521 a blank line. Piping the mail directly to sendmail is one way to
 522 achieve the correct format.
 523
 524 The supplied message to be signed or encrypted must include the
 525 necessary MIME headers or many S/MIME clients won't display it
 526 properly (if at all). You can use the B<-text> option to automatically
 527 add plain text headers.
 528
 529 A "signed and encrypted" message is one where a signed message is
 530 then encrypted. This can be produced by encrypting an already signed
 531 message: see the examples section.
 532
 533 This version of the program only allows one signer per message but it
 534 will verify multiple signers on received messages. Some S/MIME clients
 535 choke if a message contains multiple signers. It is possible to sign
 536 messages "in parallel" by signing an already signed message.
 537
 538 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
 539 clients. Strictly speaking these process CMS enveloped data: CMS
 540 encrypted data is used for other purposes.
 541
 542 The B<-resign> option uses an existing message digest when adding a new
 543 signer. This means that attributes must be present in at least one existing
 544 signer using the same message digest or this operation will fail.
 545
 546 The B<-stream> and B<-indef> options enable streaming I/O support.
 547 As a result the encoding is BER using indefinite length constructed encoding
 548 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
 549 B<-sign> operation if the content is not detached.
 550
 551 Streaming is always used for the B<-sign> operation with detached data but
 552 since the content is no longer part of the CMS structure the encoding
 553 remains DER.
 554
 555 If the B<-decrypt> option is used without a recipient certificate then an
 556 attempt is made to locate the recipient by trying each potential recipient
 557 in turn using the supplied private key. To thwart the MMA attack
 558 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
 559 tried whether they succeed or not and if no recipients match the message
 560 is "decrypted" using a random key which will typically output garbage.
 561 The B<-debug_decrypt> option can be used to disable the MMA attack protection
 562 and return an error if no recipient can be found: this option should be used
 563 with caution. For a fuller description see L<CMS_decrypt(3)>).
 564
 565 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
 566
 567 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
 568
 569 =over 4
 570
 571 =item *
 572
 573 The signed user data as defined in CMS (RFC 3852);
 574
 575 =item *
 576
 577 Content-type of the EncapsulatedContentInfo value being signed;
 578
 579 =item *
 580
 581 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
 582
 583 =item *
 584
 585 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined
 586 in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
 587 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
 588 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
 589
 590 =item *
 591
 592 The digital signature value computed on the user data and, when present, on the signed attributes.
 593
 594 NOTE that the B<-cades> option applies to the B<-sign> or B<-verify> operations.
 595 With this option, the B<-verify> operation also checks that the signing-certificates
 596 attribute is present, and its value matches the verification trust chain built
 597 during the verification process.
 598
 599 =back
 600
 601 =head1 EXIT CODES
 602
 603 =over 4
 604
 605 =item Z<>0
 606
 607 The operation was completely successfully.
 608
 609 =item Z<>1
 610
 611 An error occurred parsing the command options.
 612
 613 =item Z<>2
 614
 615 One of the input files could not be read.
 616
 617 =item Z<>3
 618
 619 An error occurred creating the CMS file or when reading the MIME
 620 message.
 621
 622 =item Z<>4
 623
 624 An error occurred decrypting or verifying the message.
 625
 626 =item Z<>5
 627
 628 The message was verified correctly but an error occurred writing out
 629 the signers certificates.
 630
 631 =back
 632
 633 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
 634
 635 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
 636 B<openssl cms> supports Cryptographic Message Syntax format.
 637 Use of some features will result in messages which cannot be processed by
 638 applications which only support the older format. These are detailed below.
 639
 640 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
 641
 642 The B<-outform> I<PEM> option uses different headers.
 643
 644 The B<-compress> option.
 645
 646 The B<-secretkey> option when used with B<-encrypt>.
 647
 648 The use of PSS with B<-sign>.
 649
 650 The use of OAEP or non-RSA keys with B<-encrypt>.
 651
 652 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
 653 be processed by the older L<openssl-smime(1)> command.
 654
 655 =head1 EXAMPLES
 656
 657 Create a cleartext signed message:
 658
 659  openssl cms -sign -in message.txt -text -out mail.msg \
 660         -signer mycert.pem
 661
 662 Create an opaque signed message
 663
 664  openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
 665         -signer mycert.pem
 666
 667 Create a signed message, include some additional certificates and
 668 read the private key from another file:
 669
 670  openssl cms -sign -in in.txt -text -out mail.msg \
 671         -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
 672
 673 Create a signed message with two signers, use key identifier:
 674
 675  openssl cms -sign -in message.txt -text -out mail.msg \
 676         -signer mycert.pem -signer othercert.pem -keyid
 677
 678 Send a signed message under Unix directly to sendmail, including headers:
 679
 680  openssl cms -sign -in in.txt -text -signer mycert.pem \
 681         -from steve@openssl.org -to someone@somewhere \
 682         -subject "Signed message" | sendmail someone@somewhere
 683
 684 Verify a message and extract the signer's certificate if successful:
 685
 686  openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
 687
 688 Send encrypted mail using triple DES:
 689
 690  openssl cms -encrypt -in in.txt -from steve@openssl.org \
 691         -to someone@somewhere -subject "Encrypted message" \
 692         -des3 user.pem -out mail.msg
 693
 694 Sign and encrypt mail:
 695
 696  openssl cms -sign -in ml.txt -signer my.pem -text \
 697         | openssl cms -encrypt -out mail.msg \
 698         -from steve@openssl.org -to someone@somewhere \
 699         -subject "Signed and Encrypted message" -des3 user.pem
 700
 701 Note: the encryption command does not include the B<-text> option because the
 702 message being encrypted already has MIME headers.
 703
 704 Decrypt mail:
 705
 706  openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
 707
 708 The output from Netscape form signing is a PKCS#7 structure with the
 709 detached signature format. You can use this program to verify the
 710 signature by line wrapping the base64 encoded structure and surrounding
 711 it with:
 712
 713  -----BEGIN PKCS7-----
 714  -----END PKCS7-----
 715
 716 and using the command,
 717
 718  openssl cms -verify -inform PEM -in signature.pem -content content.txt
 719
 720 alternatively you can base64 decode the signature and use
 721
 722  openssl cms -verify -inform DER -in signature.der -content content.txt
 723
 724 Create an encrypted message using 128 bit Camellia:
 725
 726  openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
 727
 728 Add a signer to an existing message:
 729
 730  openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
 731
 732 Sign mail using RSA-PSS:
 733
 734  openssl cms -sign -in message.txt -text -out mail.msg \
 735         -signer mycert.pem -keyopt rsa_padding_mode:pss
 736
 737 Create encrypted mail using RSA-OAEP:
 738
 739  openssl cms -encrypt -in plain.txt -out mail.msg \
 740         -recip cert.pem -keyopt rsa_padding_mode:oaep
 741
 742 Use SHA256 KDF with an ECDH certificate:
 743
 744  openssl cms -encrypt -in plain.txt -out mail.msg \
 745         -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
 746
 747 =head1 BUGS
 748
 749 The MIME parser isn't very clever: it seems to handle most messages that I've
 750 thrown at it but it may choke on others.
 751
 752 The code currently will only write out the signer's certificate to a file: if
 753 the signer has a separate encryption certificate this must be manually
 754 extracted. There should be some heuristic that determines the correct
 755 encryption certificate.
 756
 757 Ideally a database should be maintained of a certificates for each email
 758 address.
 759
 760 The code doesn't currently take note of the permitted symmetric encryption
 761 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
 762 user has to manually include the correct encryption algorithm. It should store
 763 the list of permitted ciphers in a database and only use those.
 764
 765 No revocation checking is done on the signer's certificate.
 766
 767 =head1 SEE ALSO
 768
 769 L<ossl_store-file(7)>
 770
 771 =head1 HISTORY
 772
 773 The use of multiple B<-signer> options and the B<-resign> command were first
 774 added in OpenSSL 1.0.0.
 775
 776 The B<-keyopt> option was added in OpenSSL 1.0.2.
 777
 778 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
 779
 780 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
 781 was added in OpenSSL 1.0.2.
 782
 783 The -no_alt_chains option was added in OpenSSL 1.0.2b.
 784
 785 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 786 and have no effect.
 787
 788 The B<-nameopt> option was added in OpenSSL 3.0.0.
 789
 790 The B<-engine> option was deprecated in OpenSSL 3.0.
 791
 792 =head1 COPYRIGHT
 793
 794 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
 795
 796 Licensed under the Apache License 2.0 (the "License").  You may not use
 797 this file except in compliance with the License.  You can obtain a copy
 798 in the file LICENSE in the source distribution or at
 799 L<https://www.openssl.org/source/license.html>.
 800
 801 =cut