2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-cms - CMS command
20 [B<-no_content_verify>]
30 [B<-EncryptedData_decrypt>]
31 [B<-EncryptedData_encrypt>]
33 [B<-verify_receipt> I<receipt>]
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>]
43 [B<-content> I<filename>]
47 [B<-nameopt> I<option>]
60 [B<-certfile> I<file>]
61 [B<-certsout> I<file>]
63 [B<-originator> I<file>]
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>]
76 [B<-keyopt> I<name>:I<parameter>]
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 {- $OpenSSL::safe::opt_config_synopsis -}
87 [I<recipient-cert> ...]
89 =for openssl ifdef des-wrap engine
93 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
94 sign and verify, compress and uncompress S/MIME messages.
98 There are fourteen operation options that set the type of operation to be
99 performed. The meaning of the other options varies according to the operation
106 Print out a usage message.
110 Encrypt mail for the given recipient certificates. Input file is the message
111 to be encrypted. The output file is the encrypted mail in MIME format. The
112 actual CMS type is B<EnvelopedData>.
114 Note that no revocation check is done for the recipient cert, so if that
115 key has been compromised, others may be able to decrypt the text.
119 Decrypt mail using the supplied certificate and private key. Expects an
120 encrypted mail message in MIME format for the input file. The decrypted mail
121 is written to the output file.
123 =item B<-debug_decrypt>
125 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
126 with caution: see the notes section below.
130 Sign mail using the supplied certificate and private key. Input file is
131 the message to be signed. The signed message in MIME format is written
136 Verify signed mail. Expects a signed mail message on input and outputs
137 the signed data. Both clear text and opaque signing is supported.
139 =item B<-verify_retcode>
141 Exit nonzero on verification failure.
143 =item B<-no_attr_verify>
145 Do not verify signed attribute signatures.
147 =item B<-no_content_verify>
149 Do not verify signed content signatures.
153 Don't verify message signature.
157 Takes an input message and writes out a PEM encoded CMS structure.
161 Resign a message: take an existing message and one or more new signers.
165 Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make
166 the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES
167 section for more details.
169 =item B<-data_create>
171 Create a CMS B<Data> type.
175 B<Data> type and output the content.
177 =item B<-digest_create>
179 Create a CMS B<DigestedData> type.
181 =item B<-digest_verify>
183 Verify a CMS B<DigestedData> type and output the content.
187 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
188 support for this option to work, otherwise it will output an error.
192 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
193 compiled with B<zlib> support for this option to work, otherwise it will
196 =item B<-EncryptedData_decrypt>
198 Decrypt content using supplied symmetric key and algorithm using a CMS
199 B<EncryptedData> type and output the content.
201 =item B<-EncryptedData_encrypt>
203 Encrypt content using supplied symmetric key and algorithm using a CMS
204 B<EncryptedData> type and output the content.
206 =item B<-sign_receipt>
208 Generate and output a signed receipt for the supplied message. The input
209 message B<must> contain a signed receipt request. Functionality is otherwise
210 similar to the B<-sign> operation.
212 =item B<-verify_receipt> I<receipt>
214 Verify a signed receipt in filename B<receipt>. The input message B<must>
215 contain the original receipt request. Functionality is otherwise similar
216 to the B<-verify> operation.
218 =item B<-in> I<filename>
220 The input message to be encrypted or signed or the message to be decrypted
223 =item B<-out> I<filename>
225 The message text that has been decrypted or verified or the output MIME
226 format message that has been signed or verified.
228 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
230 The input format of the CMS structure (if one is being read);
231 the default is B<SMIME>.
232 See L<openssl(1)/Format Options> for details.
234 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
236 The output format of the CMS structure (if one is being written);
237 the default is B<SMIME>.
238 See L<openssl(1)/Format Options> for details.
240 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
242 The format of the private key file; the default is B<PEM>.
243 The only value with effect is B<ENGINE>; all others have become obsolete.
244 See L<openssl(1)/Format Options> for details.
246 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
248 The signed receipt format for use with the B<-receipt_verify>; the default
250 See L<openssl(1)/Format Options> for details.
252 =item B<-stream>, B<-indef>
254 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
255 for encoding operations. This permits single pass processing of data without
256 the need to hold the entire contents in memory, potentially supporting very
257 large files. Streaming is automatically set for S/MIME signing with detached
258 data if the output format is B<SMIME> it is currently off by default for all
263 Disable streaming I/O where it would produce and indefinite length constructed
264 encoding. This option currently has no effect. In future streaming will be
265 enabled by default on all relevant operations and this option will disable it.
267 =item B<-content> I<filename>
269 This specifies a file containing the detached content, this is only
270 useful with the B<-verify> command. This is only usable if the CMS
271 structure is using the detached signature form where the content is
272 not included. This option will override any content if the input format
273 is S/MIME and it uses the multipart/signed MIME content type.
277 This option adds plain text (text/plain) MIME headers to the supplied
278 message if encrypting or signing. If decrypting or verifying it strips
279 off text headers: if the decrypted or verified message is not of MIME
280 type text/plain then an error occurs.
284 For the B<-cmsout> operation do not output the parsed CMS structure. This
285 is useful when combined with the B<-print> option or if the syntax of the CMS
286 structure is being checked.
290 For the B<-cmsout> operation print out all fields of the CMS structure. This
291 is mainly useful for testing purposes.
293 =item B<-nameopt> I<option>
295 For the B<-cmsout> operation when B<-print> option is in use, specifies
296 printing options for string fields. For most cases B<utf8> is reasonable value.
297 See L<openssl(1)/Name Format Options> for details.
299 =item B<-md> I<digest>
301 Digest algorithm to use when signing or resigning. If not present then the
302 default digest algorithm for the signing key will be used (usually SHA1).
306 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
307 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
308 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
309 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
310 supported by your version of OpenSSL.
312 If not specified triple DES is used. Only used with B<-encrypt> and
313 B<-EncryptedData_create> commands.
315 =item B<-wrap> I<cipher>
317 Cipher algorithm to use for key wrap when encrypting the message using Key
318 Agreement for key transport. The algorithm specified should be suitable for key
323 When verifying a message normally certificates (if any) included in
324 the message are searched for the signing certificate. With this option
325 only the certificates specified in the B<-certfile> option are used.
326 The supplied certificates can still be used as untrusted CAs however.
330 Do not verify the signers certificate of a signed message.
334 When signing a message the signer's certificate is normally included
335 with this option it is excluded. This will reduce the size of the
336 signed message but the verifier must have a copy of the signers certificate
337 available locally (passed using the B<-certfile> option for example).
341 Normally when a message is signed a set of attributes are included which
342 include the signing time and supported symmetric algorithms. With this
343 option they are not included.
347 Exclude the list of supported algorithms from signed attributes, other options
348 such as signing time and content type are still included.
352 Normally the input message is converted to "canonical" format which is
353 effectively using CR and LF as end of line: as required by the S/MIME
354 specification. When this option is present no translation occurs. This
355 is useful when handling binary data which may not be in MIME format.
359 Normally the output file uses a single B<LF> as end of line. When this
360 option is present B<CRLF> is used instead.
364 When signing use ASCII CRLF format canonicalisation. This strips trailing
365 whitespace from all lines, deletes trailing blank lines at EOF and sets
366 the encapsulated content type. This option is normally used with detached
367 content and an output signature format of DER. This option is not normally
368 needed when verifying as it is enabled automatically if the encapsulated
369 content format is detected.
373 When signing a message use opaque signing: this form is more resistant
374 to translation by mail relays but it cannot be read by mail agents that
375 do not support S/MIME. Without this option cleartext signing with
376 the MIME type multipart/signed is used.
378 =item B<-certfile> I<file>
380 Allows additional certificates to be specified. When signing these will
381 be included with the message. When verifying these will be searched for
382 the signers certificates.
384 =item B<-certsout> I<file>
386 Any certificates contained in the message are written to I<file>.
388 =item B<-signer> I<file>
390 A signing certificate when signing or resigning a message, this option can be
391 used multiple times if more than one signer is required. If a message is being
392 verified then the signers certificates will be written to this file if the
393 verification was successful.
395 =item B<-originator> I<file>
397 A certificate of the originator of the encrypted message. Necessary for
398 decryption when Key Agreement is in use for a shared key.
400 =item B<-recip> I<file>
402 When decrypting a message this specifies the recipients certificate. The
403 certificate must match one of the recipients of the message or an error
406 When encrypting a message this option may be used multiple times to specify
407 each recipient. This form B<must> be used if customised parameters are
408 required (for example to specify RSA-OAEP).
410 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
415 Use subject key identifier to identify certificates instead of issuer name and
416 serial number. The supplied certificate B<must> include a subject key
417 identifier extension. Supported by B<-sign> and B<-encrypt> options.
419 =item B<-receipt_request_all>, B<-receipt_request_first>
421 For B<-sign> option include a signed receipt request. Indicate requests should
422 be provided by all recipient or first tier recipients (those mailed directly
423 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
425 =item B<-receipt_request_from> I<emailaddress>
427 For B<-sign> option include a signed receipt request. Add an explicit email
428 address where receipts should be supplied.
430 =item B<-receipt_request_to> I<emailaddress>
432 Add an explicit email address where signed receipts should be sent to. This
433 option B<must> but supplied if a signed receipt it requested.
435 =item B<-receipt_request_print>
437 For the B<-verify> operation print out the contents of any signed receipt
440 =item B<-pwri_password> I<password>
442 Specify password for recipient.
444 =item B<-secretkey> I<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 B<-EncryptedData_encrypt>
448 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
449 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
450 content encryption key using an AES key in the B<KEKRecipientInfo> type.
452 =item B<-secretkeyid> I<id>
454 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
455 This option B<must> be present if the B<-secretkey> option is used with
456 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
457 relevant key if it is not supplied then an attempt is used to decrypt any
458 B<KEKRecipientInfo> structures.
460 =item B<-econtent_type> I<type>
462 Set the encapsulated content type to I<type> if not supplied the B<Data> type
463 is used. The I<type> argument can be any valid OID name in either text or
466 =item B<-inkey> I<file>
468 The private key to use when signing or decrypting. This must match the
469 corresponding certificate. If this option is not specified then the
470 private key must be included in the certificate file specified with
471 the B<-recip> or B<-signer> file. When signing this option can be used
472 multiple times to specify successive keys.
474 =item B<-keyopt> I<name>:I<parameter>
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 ECDH.
481 =item B<-passin> I<arg>
483 The private key password source. For more information about the format of B<arg>
484 see L<openssl(1)/Pass Phrase Options>.
486 =item B<-to>, B<-from>, B<-subject>
488 The relevant mail headers. These are included outside the signed
489 portion of a message so they may be included manually. If signing
490 then many S/MIME mail clients check the signers certificate's email
491 address matches that specified in the From: address.
493 {- $OpenSSL::safe::opt_v_item -}
495 Any verification errors cause the command to exit.
497 {- $OpenSSL::safe::opt_trust_item -}
499 {- $OpenSSL::safe::opt_r_item -}
501 {- $OpenSSL::safe::opt_engine_item -}
503 {- $OpenSSL::safe::opt_provider_item -}
505 {- $OpenSSL::safe::opt_config_item -}
507 =item I<recipient-cert> ...
509 One or more certificates of message recipients: used when encrypting
516 The MIME message must be sent without any blank lines between the
517 headers and the output. Some mail programs will automatically add
518 a blank line. Piping the mail directly to sendmail is one way to
519 achieve the correct format.
521 The supplied message to be signed or encrypted must include the
522 necessary MIME headers or many S/MIME clients won't display it
523 properly (if at all). You can use the B<-text> option to automatically
524 add plain text headers.
526 A "signed and encrypted" message is one where a signed message is
527 then encrypted. This can be produced by encrypting an already signed
528 message: see the examples section.
530 This version of the program only allows one signer per message but it
531 will verify multiple signers on received messages. Some S/MIME clients
532 choke if a message contains multiple signers. It is possible to sign
533 messages "in parallel" by signing an already signed message.
535 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
536 clients. Strictly speaking these process CMS enveloped data: CMS
537 encrypted data is used for other purposes.
539 The B<-resign> option uses an existing message digest when adding a new
540 signer. This means that attributes must be present in at least one existing
541 signer using the same message digest or this operation will fail.
543 The B<-stream> and B<-indef> options enable streaming I/O support.
544 As a result the encoding is BER using indefinite length constructed encoding
545 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
546 B<-sign> operation if the content is not detached.
548 Streaming is always used for the B<-sign> operation with detached data but
549 since the content is no longer part of the CMS structure the encoding
552 If the B<-decrypt> option is used without a recipient certificate then an
553 attempt is made to locate the recipient by trying each potential recipient
554 in turn using the supplied private key. To thwart the MMA attack
555 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
556 tried whether they succeed or not and if no recipients match the message
557 is "decrypted" using a random key which will typically output garbage.
558 The B<-debug_decrypt> option can be used to disable the MMA attack protection
559 and return an error if no recipient can be found: this option should be used
560 with caution. For a fuller description see L<CMS_decrypt(3)>).
562 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
564 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
570 The signed user data as defined in CMS (RFC 3852);
574 Content-type of the EncapsulatedContentInfo value being signed;
578 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
582 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined
583 in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
584 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
585 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
589 The digital signature value computed on the user data and, when present, on the signed attributes.
591 NOTE that the B<-cades> option applies to the B<-sign> or B<-verify> operations.
592 With this option, the B<-verify> operation also checks that the signing-certificates
593 attribute is present, and its value matches the verification trust chain built
594 during the verification process.
604 The operation was completely successfully.
608 An error occurred parsing the command options.
612 One of the input files could not be read.
616 An error occurred creating the CMS file or when reading the MIME
621 An error occurred decrypting or verifying the message.
625 The message was verified correctly but an error occurred writing out
626 the signers certificates.
630 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
632 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
633 B<openssl cms> supports Cryptographic Message Syntax format.
634 Use of some features will result in messages which cannot be processed by
635 applications which only support the older format. These are detailed below.
637 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
639 The B<-outform> I<PEM> option uses different headers.
641 The B<-compress> option.
643 The B<-secretkey> option when used with B<-encrypt>.
645 The use of PSS with B<-sign>.
647 The use of OAEP or non-RSA keys with B<-encrypt>.
649 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
650 be processed by the older L<openssl-smime(1)> command.
654 Create a cleartext signed message:
656 openssl cms -sign -in message.txt -text -out mail.msg \
659 Create an opaque signed message
661 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
664 Create a signed message, include some additional certificates and
665 read the private key from another file:
667 openssl cms -sign -in in.txt -text -out mail.msg \
668 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
670 Create a signed message with two signers, use key identifier:
672 openssl cms -sign -in message.txt -text -out mail.msg \
673 -signer mycert.pem -signer othercert.pem -keyid
675 Send a signed message under Unix directly to sendmail, including headers:
677 openssl cms -sign -in in.txt -text -signer mycert.pem \
678 -from steve@openssl.org -to someone@somewhere \
679 -subject "Signed message" | sendmail someone@somewhere
681 Verify a message and extract the signer's certificate if successful:
683 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
685 Send encrypted mail using triple DES:
687 openssl cms -encrypt -in in.txt -from steve@openssl.org \
688 -to someone@somewhere -subject "Encrypted message" \
689 -des3 user.pem -out mail.msg
691 Sign and encrypt mail:
693 openssl cms -sign -in ml.txt -signer my.pem -text \
694 | openssl cms -encrypt -out mail.msg \
695 -from steve@openssl.org -to someone@somewhere \
696 -subject "Signed and Encrypted message" -des3 user.pem
698 Note: the encryption command does not include the B<-text> option because the
699 message being encrypted already has MIME headers.
703 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
705 The output from Netscape form signing is a PKCS#7 structure with the
706 detached signature format. You can use this program to verify the
707 signature by line wrapping the base64 encoded structure and surrounding
710 -----BEGIN PKCS7-----
713 and using the command,
715 openssl cms -verify -inform PEM -in signature.pem -content content.txt
717 alternatively you can base64 decode the signature and use
719 openssl cms -verify -inform DER -in signature.der -content content.txt
721 Create an encrypted message using 128 bit Camellia:
723 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
725 Add a signer to an existing message:
727 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
729 Sign mail using RSA-PSS:
731 openssl cms -sign -in message.txt -text -out mail.msg \
732 -signer mycert.pem -keyopt rsa_padding_mode:pss
734 Create encrypted mail using RSA-OAEP:
736 openssl cms -encrypt -in plain.txt -out mail.msg \
737 -recip cert.pem -keyopt rsa_padding_mode:oaep
739 Use SHA256 KDF with an ECDH certificate:
741 openssl cms -encrypt -in plain.txt -out mail.msg \
742 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
746 The MIME parser isn't very clever: it seems to handle most messages that I've
747 thrown at it but it may choke on others.
749 The code currently will only write out the signer's certificate to a file: if
750 the signer has a separate encryption certificate this must be manually
751 extracted. There should be some heuristic that determines the correct
752 encryption certificate.
754 Ideally a database should be maintained of a certificates for each email
757 The code doesn't currently take note of the permitted symmetric encryption
758 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
759 user has to manually include the correct encryption algorithm. It should store
760 the list of permitted ciphers in a database and only use those.
762 No revocation checking is done on the signer's certificate.
766 L<ossl_store-file(7)>
770 The use of multiple B<-signer> options and the B<-resign> command were first
771 added in OpenSSL 1.0.0.
773 The B<-keyopt> option was added in OpenSSL 1.0.2.
775 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
777 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
778 was added in OpenSSL 1.0.2.
780 The -no_alt_chains option was added in OpenSSL 1.0.2b.
782 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
785 The B<-nameopt> option was added in OpenSSL 3.0.0.
787 The B<-engine> option was deprecated in OpenSSL 3.0.
791 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
793 Licensed under the Apache License 2.0 (the "License"). You may not use
794 this file except in compliance with the License. You can obtain a copy
795 in the file LICENSE in the source distribution or at
796 L<https://www.openssl.org/source/license.html>.