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 -}
  85 {- $OpenSSL::safe::opt_provider_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 If not specified triple DES is used. Only used with B<-encrypt> and
 312 B<-EncryptedData_create> commands.
 313
 314 =item B<-wrap> I<cipher>
 315
 316 Cipher algorithm to use for key wrap when encrypting the message using Key
 317 Agreement for key transport. The algorithm specified should be suitable for key
 318 wrap.
 319
 320 =item B<-nointern>
 321
 322 When verifying a message normally certificates (if any) included in
 323 the message are searched for the signing certificate. With this option
 324 only the certificates specified in the B<-certfile> option are used.
 325 The supplied certificates can still be used as untrusted CAs however.
 326
 327 =item B<-noverify>
 328
 329 Do not verify the signers certificate of a signed message.
 330
 331 =item B<-nocerts>
 332
 333 When signing a message the signer's certificate is normally included
 334 with this option it is excluded. This will reduce the size of the
 335 signed message but the verifier must have a copy of the signers certificate
 336 available locally (passed using the B<-certfile> option for example).
 337
 338 =item B<-noattr>
 339
 340 Normally when a message is signed a set of attributes are included which
 341 include the signing time and supported symmetric algorithms. With this
 342 option they are not included.
 343
 344 =item B<-nosmimecap>
 345
 346 Exclude the list of supported algorithms from signed attributes, other options
 347 such as signing time and content type are still included.
 348
 349 =item B<-binary>
 350
 351 Normally the input message is converted to "canonical" format which is
 352 effectively using CR and LF as end of line: as required by the S/MIME
 353 specification. When this option is present no translation occurs. This
 354 is useful when handling binary data which may not be in MIME format.
 355
 356 =item B<-crlfeol>
 357
 358 Normally the output file uses a single B<LF> as end of line. When this
 359 option is present B<CRLF> is used instead.
 360
 361 =item B<-asciicrlf>
 362
 363 When signing use ASCII CRLF format canonicalisation. This strips trailing
 364 whitespace from all lines, deletes trailing blank lines at EOF and sets
 365 the encapsulated content type. This option is normally used with detached
 366 content and an output signature format of DER. This option is not normally
 367 needed when verifying as it is enabled automatically if the encapsulated
 368 content format is detected.
 369
 370 =item B<-nodetach>
 371
 372 When signing a message use opaque signing: this form is more resistant
 373 to translation by mail relays but it cannot be read by mail agents that
 374 do not support S/MIME.  Without this option cleartext signing with
 375 the MIME type multipart/signed is used.
 376
 377 =item B<-certfile> I<file>
 378
 379 Allows additional certificates to be specified. When signing these will
 380 be included with the message. When verifying these will be searched for
 381 the signers certificates.
 382
 383 =item B<-certsout> I<file>
 384
 385 Any certificates contained in the message are written to I<file>.
 386
 387 =item B<-signer> I<file>
 388
 389 A signing certificate when signing or resigning a message, this option can be
 390 used multiple times if more than one signer is required. If a message is being
 391 verified then the signers certificates will be written to this file if the
 392 verification was successful.
 393
 394 =item B<-originator> I<file>
 395
 396 A certificate of the originator of the encrypted message. Necessary for
 397 decryption when Key Agreement is in use for a shared key.
 398
 399 =item B<-recip> I<file>
 400
 401 When decrypting a message this specifies the recipients certificate. The
 402 certificate must match one of the recipients of the message or an error
 403 occurs.
 404
 405 When encrypting a message this option may be used multiple times to specify
 406 each recipient. This form B<must> be used if customised parameters are
 407 required (for example to specify RSA-OAEP).
 408
 409 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
 410 option.
 411
 412 =item B<-keyid>
 413
 414 Use subject key identifier to identify certificates instead of issuer name and
 415 serial number. The supplied certificate B<must> include a subject key
 416 identifier extension. Supported by B<-sign> and B<-encrypt> options.
 417
 418 =item B<-receipt_request_all>, B<-receipt_request_first>
 419
 420 For B<-sign> option include a signed receipt request. Indicate requests should
 421 be provided by all recipient or first tier recipients (those mailed directly
 422 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
 423
 424 =item B<-receipt_request_from> I<emailaddress>
 425
 426 For B<-sign> option include a signed receipt request. Add an explicit email
 427 address where receipts should be supplied.
 428
 429 =item B<-receipt_request_to> I<emailaddress>
 430
 431 Add an explicit email address where signed receipts should be sent to. This
 432 option B<must> but supplied if a signed receipt it requested.
 433
 434 =item B<-receipt_request_print>
 435
 436 For the B<-verify> operation print out the contents of any signed receipt
 437 requests.
 438
 439 =item B<-pwri_password> I<password>
 440
 441 Specify password for recipient.
 442
 443 =item B<-secretkey> I<key>
 444
 445 Specify symmetric key to use. The key must be supplied in hex format and be
 446 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
 447 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
 448 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
 449 content encryption key using an AES key in the B<KEKRecipientInfo> type.
 450
 451 =item B<-secretkeyid> I<id>
 452
 453 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
 454 This option B<must> be present if the B<-secretkey> option is used with
 455 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
 456 relevant key if it is not supplied then an attempt is used to decrypt any
 457 B<KEKRecipientInfo> structures.
 458
 459 =item B<-econtent_type> I<type>
 460
 461 Set the encapsulated content type to I<type> if not supplied the B<Data> type
 462 is used. The I<type> argument can be any valid OID name in either text or
 463 numerical format.
 464
 465 =item B<-inkey> I<file>
 466
 467 The private key to use when signing or decrypting. This must match the
 468 corresponding certificate. If this option is not specified then the
 469 private key must be included in the certificate file specified with
 470 the B<-recip> or B<-signer> file. When signing this option can be used
 471 multiple times to specify successive keys.
 472
 473 =item B<-keyopt> I<name>:I<parameter>
 474
 475 For signing and encryption this option can be used multiple times to
 476 set customised parameters for the preceding key or certificate. It can
 477 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
 478 or to modify default parameters for ECDH.
 479
 480 =item B<-passin> I<arg>
 481
 482 The private key password source. For more information about the format of B<arg>
 483 see L<openssl(1)/Pass Phrase Options>.
 484
 485 =item B<-to>, B<-from>, B<-subject>
 486
 487 The relevant mail headers. These are included outside the signed
 488 portion of a message so they may be included manually. If signing
 489 then many S/MIME mail clients check the signers certificate's email
 490 address matches that specified in the From: address.
 491
 492 {- $OpenSSL::safe::opt_v_item -}
 493
 494 Any verification errors cause the command to exit.
 495
 496 {- $OpenSSL::safe::opt_trust_item -}
 497
 498 {- $OpenSSL::safe::opt_r_item -}
 499
 500 {- $OpenSSL::safe::opt_engine_item -}
 501
 502 {- $OpenSSL::safe::opt_provider_item -}
 503
 504 =item I<recipient-cert> ...
 505
 506 One or more certificates of message recipients: used when encrypting
 507 a message.
 508
 509 =back
 510
 511 =head1 NOTES
 512
 513 The MIME message must be sent without any blank lines between the
 514 headers and the output. Some mail programs will automatically add
 515 a blank line. Piping the mail directly to sendmail is one way to
 516 achieve the correct format.
 517
 518 The supplied message to be signed or encrypted must include the
 519 necessary MIME headers or many S/MIME clients won't display it
 520 properly (if at all). You can use the B<-text> option to automatically
 521 add plain text headers.
 522
 523 A "signed and encrypted" message is one where a signed message is
 524 then encrypted. This can be produced by encrypting an already signed
 525 message: see the examples section.
 526
 527 This version of the program only allows one signer per message but it
 528 will verify multiple signers on received messages. Some S/MIME clients
 529 choke if a message contains multiple signers. It is possible to sign
 530 messages "in parallel" by signing an already signed message.
 531
 532 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
 533 clients. Strictly speaking these process CMS enveloped data: CMS
 534 encrypted data is used for other purposes.
 535
 536 The B<-resign> option uses an existing message digest when adding a new
 537 signer. This means that attributes must be present in at least one existing
 538 signer using the same message digest or this operation will fail.
 539
 540 The B<-stream> and B<-indef> options enable streaming I/O support.
 541 As a result the encoding is BER using indefinite length constructed encoding
 542 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
 543 B<-sign> operation if the content is not detached.
 544
 545 Streaming is always used for the B<-sign> operation with detached data but
 546 since the content is no longer part of the CMS structure the encoding
 547 remains DER.
 548
 549 If the B<-decrypt> option is used without a recipient certificate then an
 550 attempt is made to locate the recipient by trying each potential recipient
 551 in turn using the supplied private key. To thwart the MMA attack
 552 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
 553 tried whether they succeed or not and if no recipients match the message
 554 is "decrypted" using a random key which will typically output garbage.
 555 The B<-debug_decrypt> option can be used to disable the MMA attack protection
 556 and return an error if no recipient can be found: this option should be used
 557 with caution. For a fuller description see L<CMS_decrypt(3)>).
 558
 559 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
 560
 561 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
 562
 563 =over 4
 564
 565 =item *
 566
 567 The signed user data as defined in CMS (RFC 3852);
 568
 569 =item *
 570
 571 Content-type of the EncapsulatedContentInfo value being signed;
 572
 573 =item *
 574
 575 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
 576
 577 =item *
 578
 579 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined
 580 in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
 581 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
 582 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
 583
 584 =item *
 585
 586 The digital signature value computed on the user data and, when present, on the signed attributes.
 587
 588 NOTE that the B<-cades> option applies to the B<-sign> or B<-verify> operations.
 589 With this option, the B<-verify> operation also checks that the signing-certificates
 590 attribute is present, and its value matches the verification trust chain built
 591 during the verification process.
 592
 593 =back
 594
 595 =head1 EXIT CODES
 596
 597 =over 4
 598
 599 =item Z<>0
 600
 601 The operation was completely successfully.
 602
 603 =item Z<>1
 604
 605 An error occurred parsing the command options.
 606
 607 =item Z<>2
 608
 609 One of the input files could not be read.
 610
 611 =item Z<>3
 612
 613 An error occurred creating the CMS file or when reading the MIME
 614 message.
 615
 616 =item Z<>4
 617
 618 An error occurred decrypting or verifying the message.
 619
 620 =item Z<>5
 621
 622 The message was verified correctly but an error occurred writing out
 623 the signers certificates.
 624
 625 =back
 626
 627 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
 628
 629 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
 630 B<openssl cms> supports Cryptographic Message Syntax format.
 631 Use of some features will result in messages which cannot be processed by
 632 applications which only support the older format. These are detailed below.
 633
 634 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
 635
 636 The B<-outform> I<PEM> option uses different headers.
 637
 638 The B<-compress> option.
 639
 640 The B<-secretkey> option when used with B<-encrypt>.
 641
 642 The use of PSS with B<-sign>.
 643
 644 The use of OAEP or non-RSA keys with B<-encrypt>.
 645
 646 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
 647 be processed by the older L<openssl-smime(1)> command.
 648
 649 =head1 EXAMPLES
 650
 651 Create a cleartext signed message:
 652
 653  openssl cms -sign -in message.txt -text -out mail.msg \
 654         -signer mycert.pem
 655
 656 Create an opaque signed message
 657
 658  openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
 659         -signer mycert.pem
 660
 661 Create a signed message, include some additional certificates and
 662 read the private key from another file:
 663
 664  openssl cms -sign -in in.txt -text -out mail.msg \
 665         -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
 666
 667 Create a signed message with two signers, use key identifier:
 668
 669  openssl cms -sign -in message.txt -text -out mail.msg \
 670         -signer mycert.pem -signer othercert.pem -keyid
 671
 672 Send a signed message under Unix directly to sendmail, including headers:
 673
 674  openssl cms -sign -in in.txt -text -signer mycert.pem \
 675         -from steve@openssl.org -to someone@somewhere \
 676         -subject "Signed message" | sendmail someone@somewhere
 677
 678 Verify a message and extract the signer's certificate if successful:
 679
 680  openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
 681
 682 Send encrypted mail using triple DES:
 683
 684  openssl cms -encrypt -in in.txt -from steve@openssl.org \
 685         -to someone@somewhere -subject "Encrypted message" \
 686         -des3 user.pem -out mail.msg
 687
 688 Sign and encrypt mail:
 689
 690  openssl cms -sign -in ml.txt -signer my.pem -text \
 691         | openssl cms -encrypt -out mail.msg \
 692         -from steve@openssl.org -to someone@somewhere \
 693         -subject "Signed and Encrypted message" -des3 user.pem
 694
 695 Note: the encryption command does not include the B<-text> option because the
 696 message being encrypted already has MIME headers.
 697
 698 Decrypt mail:
 699
 700  openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
 701
 702 The output from Netscape form signing is a PKCS#7 structure with the
 703 detached signature format. You can use this program to verify the
 704 signature by line wrapping the base64 encoded structure and surrounding
 705 it with:
 706
 707  -----BEGIN PKCS7-----
 708  -----END PKCS7-----
 709
 710 and using the command,
 711
 712  openssl cms -verify -inform PEM -in signature.pem -content content.txt
 713
 714 alternatively you can base64 decode the signature and use
 715
 716  openssl cms -verify -inform DER -in signature.der -content content.txt
 717
 718 Create an encrypted message using 128 bit Camellia:
 719
 720  openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
 721
 722 Add a signer to an existing message:
 723
 724  openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
 725
 726 Sign mail using RSA-PSS:
 727
 728  openssl cms -sign -in message.txt -text -out mail.msg \
 729         -signer mycert.pem -keyopt rsa_padding_mode:pss
 730
 731 Create encrypted mail using RSA-OAEP:
 732
 733  openssl cms -encrypt -in plain.txt -out mail.msg \
 734         -recip cert.pem -keyopt rsa_padding_mode:oaep
 735
 736 Use SHA256 KDF with an ECDH certificate:
 737
 738  openssl cms -encrypt -in plain.txt -out mail.msg \
 739         -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
 740
 741 =head1 BUGS
 742
 743 The MIME parser isn't very clever: it seems to handle most messages that I've
 744 thrown at it but it may choke on others.
 745
 746 The code currently will only write out the signer's certificate to a file: if
 747 the signer has a separate encryption certificate this must be manually
 748 extracted. There should be some heuristic that determines the correct
 749 encryption certificate.
 750
 751 Ideally a database should be maintained of a certificates for each email
 752 address.
 753
 754 The code doesn't currently take note of the permitted symmetric encryption
 755 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
 756 user has to manually include the correct encryption algorithm. It should store
 757 the list of permitted ciphers in a database and only use those.
 758
 759 No revocation checking is done on the signer's certificate.
 760
 761 =head1 SEE ALSO
 762
 763 L<ossl_store-file(7)>
 764
 765 =head1 HISTORY
 766
 767 The use of multiple B<-signer> options and the B<-resign> command were first
 768 added in OpenSSL 1.0.0.
 769
 770 The B<-keyopt> option was added in OpenSSL 1.0.2.
 771
 772 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
 773
 774 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
 775 was added in OpenSSL 1.0.2.
 776
 777 The -no_alt_chains option was added in OpenSSL 1.0.2b.
 778
 779 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 780 and have no effect.
 781
 782 The B<-nameopt> option was added in OpenSSL 3.0.0.
 783
 784 The B<-engine> option was deprecated in OpenSSL 3.0.
 785
 786 =head1 COPYRIGHT
 787
 788 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
 789
 790 Licensed under the Apache License 2.0 (the "License").  You may not use
 791 this file except in compliance with the License.  You can obtain a copy
 792 in the file LICENSE in the source distribution or at
 793 L<https://www.openssl.org/source/license.html>.
 794
 795 =cut