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>]
64 [B<-certfile> I<file>]
65 [B<-certsout> I<file>]
67 [B<-originator> I<file>]
70 [B<-receipt_request_all>]
71 [B<-receipt_request_first>]
72 [B<-receipt_request_from> I<emailaddress>]
73 [B<-receipt_request_to> I<emailaddress>]
74 [B<-receipt_request_print>]
75 [B<-pwri_password> I<password>]
76 [B<-secretkey> I<key>]
77 [B<-secretkeyid> I<id>]
78 [B<-econtent_type> I<type>]
79 [B<-inkey> I<filename>|I<uri>]
80 [B<-keyopt> I<name>:I<parameter>]
85 {- $OpenSSL::safe::opt_v_synopsis -}
86 {- $OpenSSL::safe::opt_trust_synopsis -}
87 {- $OpenSSL::safe::opt_r_synopsis -}
88 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
89 {- $OpenSSL::safe::opt_config_synopsis -}
90 [I<recipient-cert> ...]
92 =for openssl ifdef des-wrap engine
96 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
97 sign and verify, compress and uncompress S/MIME messages.
101 There are fourteen operation options that set the type of operation to be
102 performed. The meaning of the other options varies according to the operation
109 Print out a usage message.
113 Encrypt mail for the given recipient certificates. Input file is the message
114 to be encrypted. The output file is the encrypted mail in MIME format. The
115 actual CMS type is B<EnvelopedData>.
117 Note that no revocation check is done for the recipient cert, so if that
118 key has been compromised, others may be able to decrypt the text.
122 Decrypt mail using the supplied certificate and private key. Expects an
123 encrypted mail message in MIME format for the input file. The decrypted mail
124 is written to the output file.
126 =item B<-debug_decrypt>
128 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
129 with caution: see the notes section below.
133 Sign mail using the supplied certificate and private key. Input file is
134 the message to be signed. The signed message in MIME format is written
139 Verify signed mail. Expects a signed mail message on input and outputs
140 the signed data. Both clear text and opaque signing is supported.
142 =item B<-verify_retcode>
144 Exit nonzero on verification failure.
146 =item B<-no_attr_verify>
148 Do not verify signed attribute signatures.
150 =item B<-no_content_verify>
152 Do not verify signed content signatures.
156 Don't verify message signature.
160 Takes an input message and writes out a PEM encoded CMS structure.
164 Resign a message: take an existing message and one or more new signers.
168 When used with B<-sign>,
169 add an ESS signingCertificate or ESS signingCertificateV2 signed-attribute
170 to the SignerInfo, in order to make the signature comply with the requirements
171 for a CAdES Basic Electronic Signature (CAdES-BES).
172 When used with B<-verify>, require and check signer certificate digest.
173 See the NOTES section for more details.
175 =item B<-data_create>
177 Create a CMS B<Data> type.
181 B<Data> type and output the content.
183 =item B<-digest_create>
185 Create a CMS B<DigestedData> type.
187 =item B<-digest_verify>
189 Verify a CMS B<DigestedData> type and output the content.
193 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
194 support for this option to work, otherwise it will output an error.
198 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
199 compiled with B<zlib> support for this option to work, otherwise it will
202 =item B<-EncryptedData_decrypt>
204 Decrypt content using supplied symmetric key and algorithm using a CMS
205 B<EncryptedData> type and output the content.
207 =item B<-EncryptedData_encrypt>
209 Encrypt content using supplied symmetric key and algorithm using a CMS
210 B<EncryptedData> type and output the content.
212 =item B<-sign_receipt>
214 Generate and output a signed receipt for the supplied message. The input
215 message B<must> contain a signed receipt request. Functionality is otherwise
216 similar to the B<-sign> operation.
218 =item B<-verify_receipt> I<receipt>
220 Verify a signed receipt in filename B<receipt>. The input message B<must>
221 contain the original receipt request. Functionality is otherwise similar
222 to the B<-verify> operation.
224 =item B<-in> I<filename>
226 The input message to be encrypted or signed or the message to be decrypted
229 =item B<-out> I<filename>
231 The message text that has been decrypted or verified or the output MIME
232 format message that has been signed or verified.
234 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
236 The input format of the CMS structure (if one is being read);
237 the default is B<SMIME>.
238 See L<openssl-format-options(1)> for details.
240 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
242 The output format of the CMS structure (if one is being written);
243 the default is B<SMIME>.
244 See L<openssl-format-options(1)> for details.
246 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
248 The format of the private key file; unspecified by default.
249 See L<openssl-format-options(1)> for details.
251 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
253 The signed receipt format for use with the B<-receipt_verify>; the default
255 See L<openssl-format-options(1)> for details.
257 =item B<-stream>, B<-indef>
259 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
260 for encoding operations. This permits single pass processing of data without
261 the need to hold the entire contents in memory, potentially supporting very
262 large files. Streaming is automatically set for S/MIME signing with detached
263 data if the output format is B<SMIME> it is currently off by default for all
268 Disable streaming I/O where it would produce and indefinite length constructed
269 encoding. This option currently has no effect. In future streaming will be
270 enabled by default on all relevant operations and this option will disable it.
272 =item B<-content> I<filename>
274 This specifies a file containing the detached content, this is only
275 useful with the B<-verify> command. This is only usable if the CMS
276 structure is using the detached signature form where the content is
277 not included. This option will override any content if the input format
278 is S/MIME and it uses the multipart/signed MIME content type.
282 This option adds plain text (text/plain) MIME headers to the supplied
283 message if encrypting or signing. If decrypting or verifying it strips
284 off text headers: if the decrypted or verified message is not of MIME
285 type text/plain then an error occurs.
289 For the B<-cmsout> operation do not output the parsed CMS structure. This
290 is useful when combined with the B<-print> option or if the syntax of the CMS
291 structure is being checked.
295 For the B<-cmsout> operation print out all fields of the CMS structure. This
296 is mainly useful for testing purposes.
298 =item B<-nameopt> I<option>
300 For the B<-cmsout> operation when B<-print> option is in use, specifies
301 printing options for string fields. For most cases B<utf8> is reasonable value.
302 See L<openssl-namedisplay-options(1)> for details.
304 =item B<-md> I<digest>
306 Digest algorithm to use when signing or resigning. If not present then the
307 default digest algorithm for the signing key will be used (usually SHA1).
311 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
312 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
313 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
314 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
315 supported by your version of OpenSSL.
317 Currently the AES variants with GCM mode are the only supported AEAD
320 If not specified triple DES is used. Only used with B<-encrypt> and
321 B<-EncryptedData_create> commands.
323 =item B<-wrap> I<cipher>
325 Cipher algorithm to use for key wrap when encrypting the message using Key
326 Agreement for key transport. The algorithm specified should be suitable for key
329 =item B<-aes128-wrap>, B<-aes192-wrap>, B<-aes256-wrap>, B<-des3-wrap>
331 Use AES128, AES192, AES256, or 3DES-EDE, respectively, to wrap key.
335 When verifying a message normally certificates (if any) included in
336 the message are searched for the signing certificate. With this option
337 only the certificates specified in the B<-certfile> option are used.
338 The supplied certificates can still be used as untrusted CAs however.
342 Do not verify the signers certificate of a signed message.
346 When signing a message the signer's certificate is normally included
347 with this option it is excluded. This will reduce the size of the
348 signed message but the verifier must have a copy of the signers certificate
349 available locally (passed using the B<-certfile> option for example).
353 Normally when a message is signed a set of attributes are included which
354 include the signing time and supported symmetric algorithms. With this
355 option they are not included.
359 Exclude the list of supported algorithms from signed attributes, other options
360 such as signing time and content type are still included.
364 Normally the input message is converted to "canonical" format which is
365 effectively using CR and LF as end of line: as required by the S/MIME
366 specification. When this option is present no translation occurs. This
367 is useful when handling binary data which may not be in MIME format.
371 Normally the output file uses a single B<LF> as end of line. When this
372 option is present B<CRLF> is used instead.
376 When signing use ASCII CRLF format canonicalisation. This strips trailing
377 whitespace from all lines, deletes trailing blank lines at EOF and sets
378 the encapsulated content type. This option is normally used with detached
379 content and an output signature format of DER. This option is not normally
380 needed when verifying as it is enabled automatically if the encapsulated
381 content format is detected.
385 When signing a message use opaque signing: this form is more resistant
386 to translation by mail relays but it cannot be read by mail agents that
387 do not support S/MIME. Without this option cleartext signing with
388 the MIME type multipart/signed is used.
390 =item B<-certfile> I<file>
392 Allows additional certificates to be specified. When signing these will
393 be included with the message. When verifying these will be searched for
394 the signers certificates.
395 The input can be in PEM, DER, or PKCS#12 format.
397 =item B<-certsout> I<file>
399 Any certificates contained in the message are written to I<file>.
401 =item B<-signer> I<file>
403 A signing certificate when signing or resigning a message, this option can be
404 used multiple times if more than one signer is required. If a message is being
405 verified then the signers certificates will be written to this file if the
406 verification was successful.
408 =item B<-originator> I<file>
410 A certificate of the originator of the encrypted message. Necessary for
411 decryption when Key Agreement is in use for a shared key.
413 =item B<-recip> I<file>
415 When decrypting a message this specifies the recipients certificate. The
416 certificate must match one of the recipients of the message or an error
419 When encrypting a message this option may be used multiple times to specify
420 each recipient. This form B<must> be used if customised parameters are
421 required (for example to specify RSA-OAEP).
423 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
428 Use subject key identifier to identify certificates instead of issuer name and
429 serial number. The supplied certificate B<must> include a subject key
430 identifier extension. Supported by B<-sign> and B<-encrypt> options.
432 =item B<-receipt_request_all>, B<-receipt_request_first>
434 For B<-sign> option include a signed receipt request. Indicate requests should
435 be provided by all recipient or first tier recipients (those mailed directly
436 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
438 =item B<-receipt_request_from> I<emailaddress>
440 For B<-sign> option include a signed receipt request. Add an explicit email
441 address where receipts should be supplied.
443 =item B<-receipt_request_to> I<emailaddress>
445 Add an explicit email address where signed receipts should be sent to. This
446 option B<must> but supplied if a signed receipt it requested.
448 =item B<-receipt_request_print>
450 For the B<-verify> operation print out the contents of any signed receipt
453 =item B<-pwri_password> I<password>
455 Specify password for recipient.
457 =item B<-secretkey> I<key>
459 Specify symmetric key to use. The key must be supplied in hex format and be
460 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
461 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
462 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
463 content encryption key using an AES key in the B<KEKRecipientInfo> type.
465 =item B<-secretkeyid> I<id>
467 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
468 This option B<must> be present if the B<-secretkey> option is used with
469 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
470 relevant key if it is not supplied then an attempt is used to decrypt any
471 B<KEKRecipientInfo> structures.
473 =item B<-econtent_type> I<type>
475 Set the encapsulated content type to I<type> if not supplied the B<Data> type
476 is used. The I<type> argument can be any valid OID name in either text or
479 =item B<-inkey> I<filename>|I<uri>
481 The private key to use when signing or decrypting. This must match the
482 corresponding certificate. If this option is not specified then the
483 private key must be included in the certificate file specified with
484 the B<-recip> or B<-signer> file. When signing this option can be used
485 multiple times to specify successive keys.
487 =item B<-keyopt> I<name>:I<parameter>
489 For signing and encryption this option can be used multiple times to
490 set customised parameters for the preceding key or certificate. It can
491 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
492 or to modify default parameters for ECDH.
494 =item B<-passin> I<arg>
496 The private key password source. For more information about the format of B<arg>
497 see L<openssl-passphrase-options(1)>.
499 =item B<-to>, B<-from>, B<-subject>
501 The relevant mail headers. These are included outside the signed
502 portion of a message so they may be included manually. If signing
503 then many S/MIME mail clients check the signers certificate's email
504 address matches that specified in the From: address.
506 {- $OpenSSL::safe::opt_v_item -}
508 Any verification errors cause the command to exit.
510 {- $OpenSSL::safe::opt_trust_item -}
512 {- $OpenSSL::safe::opt_r_item -}
514 {- $OpenSSL::safe::opt_engine_item -}
516 {- $OpenSSL::safe::opt_provider_item -}
518 {- $OpenSSL::safe::opt_config_item -}
520 =item I<recipient-cert> ...
522 One or more certificates of message recipients: used when encrypting
529 The MIME message must be sent without any blank lines between the
530 headers and the output. Some mail programs will automatically add
531 a blank line. Piping the mail directly to sendmail is one way to
532 achieve the correct format.
534 The supplied message to be signed or encrypted must include the
535 necessary MIME headers or many S/MIME clients won't display it
536 properly (if at all). You can use the B<-text> option to automatically
537 add plain text headers.
539 A "signed and encrypted" message is one where a signed message is
540 then encrypted. This can be produced by encrypting an already signed
541 message: see the examples section.
543 This version of the program only allows one signer per message but it
544 will verify multiple signers on received messages. Some S/MIME clients
545 choke if a message contains multiple signers. It is possible to sign
546 messages "in parallel" by signing an already signed message.
548 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
549 clients. Strictly speaking these process CMS enveloped data: CMS
550 encrypted data is used for other purposes.
552 The B<-resign> option uses an existing message digest when adding a new
553 signer. This means that attributes must be present in at least one existing
554 signer using the same message digest or this operation will fail.
556 The B<-stream> and B<-indef> options enable streaming I/O support.
557 As a result the encoding is BER using indefinite length constructed encoding
558 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
559 B<-sign> operation if the content is not detached.
561 Streaming is always used for the B<-sign> operation with detached data but
562 since the content is no longer part of the CMS structure the encoding
565 If the B<-decrypt> option is used without a recipient certificate then an
566 attempt is made to locate the recipient by trying each potential recipient
567 in turn using the supplied private key. To thwart the MMA attack
568 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
569 tried whether they succeed or not and if no recipients match the message
570 is "decrypted" using a random key which will typically output garbage.
571 The B<-debug_decrypt> option can be used to disable the MMA attack protection
572 and return an error if no recipient can be found: this option should be used
573 with caution. For a fuller description see L<CMS_decrypt(3)>).
575 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
577 A CAdES Basic Electronic Signature (CAdES-BES),
578 as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
584 The signed user data as defined in CMS (RFC 3852);
588 Content-type of the EncapsulatedContentInfo value being signed;
592 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
596 An ESS signingCertificate or ESS signingCertificateV2 attribute,
597 as defined in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
598 An ESS signingCertificate attribute only allows for SHA-1 as digest algorithm.
599 An ESS signingCertificateV2 attribute allows for any digest algorithm.
603 The digital signature value computed on the user data and, when present, on the signed attributes.
605 NOTE that the B<-cades> option applies to the B<-sign> or B<-verify> operations.
606 With this option, the B<-verify> operation also requires that the
607 signingCertificate attribute is present and checks that the given identifiers
608 match the verification trust chain built during the verification process.
618 The operation was completely successfully.
622 An error occurred parsing the command options.
626 One of the input files could not be read.
630 An error occurred creating the CMS file or when reading the MIME
635 An error occurred decrypting or verifying the message.
639 The message was verified correctly but an error occurred writing out
640 the signers certificates.
644 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
646 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
647 B<openssl cms> supports Cryptographic Message Syntax format.
648 Use of some features will result in messages which cannot be processed by
649 applications which only support the older format. These are detailed below.
651 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
653 The B<-outform> I<PEM> option uses different headers.
655 The B<-compress> option.
657 The B<-secretkey> option when used with B<-encrypt>.
659 The use of PSS with B<-sign>.
661 The use of OAEP or non-RSA keys with B<-encrypt>.
663 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
664 be processed by the older L<openssl-smime(1)> command.
668 Create a cleartext signed message:
670 openssl cms -sign -in message.txt -text -out mail.msg \
673 Create an opaque signed message
675 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
678 Create a signed message, include some additional certificates and
679 read the private key from another file:
681 openssl cms -sign -in in.txt -text -out mail.msg \
682 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
684 Create a signed message with two signers, use key identifier:
686 openssl cms -sign -in message.txt -text -out mail.msg \
687 -signer mycert.pem -signer othercert.pem -keyid
689 Send a signed message under Unix directly to sendmail, including headers:
691 openssl cms -sign -in in.txt -text -signer mycert.pem \
692 -from steve@openssl.org -to someone@somewhere \
693 -subject "Signed message" | sendmail someone@somewhere
695 Verify a message and extract the signer's certificate if successful:
697 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
699 Send encrypted mail using triple DES:
701 openssl cms -encrypt -in in.txt -from steve@openssl.org \
702 -to someone@somewhere -subject "Encrypted message" \
703 -des3 user.pem -out mail.msg
705 Sign and encrypt mail:
707 openssl cms -sign -in ml.txt -signer my.pem -text \
708 | openssl cms -encrypt -out mail.msg \
709 -from steve@openssl.org -to someone@somewhere \
710 -subject "Signed and Encrypted message" -des3 user.pem
712 Note: the encryption command does not include the B<-text> option because the
713 message being encrypted already has MIME headers.
717 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
719 The output from Netscape form signing is a PKCS#7 structure with the
720 detached signature format. You can use this program to verify the
721 signature by line wrapping the base64 encoded structure and surrounding
724 -----BEGIN PKCS7-----
727 and using the command,
729 openssl cms -verify -inform PEM -in signature.pem -content content.txt
731 alternatively you can base64 decode the signature and use
733 openssl cms -verify -inform DER -in signature.der -content content.txt
735 Create an encrypted message using 128 bit Camellia:
737 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
739 Add a signer to an existing message:
741 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
743 Sign mail using RSA-PSS:
745 openssl cms -sign -in message.txt -text -out mail.msg \
746 -signer mycert.pem -keyopt rsa_padding_mode:pss
748 Create encrypted mail using RSA-OAEP:
750 openssl cms -encrypt -in plain.txt -out mail.msg \
751 -recip cert.pem -keyopt rsa_padding_mode:oaep
753 Use SHA256 KDF with an ECDH certificate:
755 openssl cms -encrypt -in plain.txt -out mail.msg \
756 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
760 The MIME parser isn't very clever: it seems to handle most messages that I've
761 thrown at it but it may choke on others.
763 The code currently will only write out the signer's certificate to a file: if
764 the signer has a separate encryption certificate this must be manually
765 extracted. There should be some heuristic that determines the correct
766 encryption certificate.
768 Ideally a database should be maintained of a certificates for each email
771 The code doesn't currently take note of the permitted symmetric encryption
772 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
773 user has to manually include the correct encryption algorithm. It should store
774 the list of permitted ciphers in a database and only use those.
776 No revocation checking is done on the signer's certificate.
780 L<ossl_store-file(7)>
784 The use of multiple B<-signer> options and the B<-resign> command were first
785 added in OpenSSL 1.0.0.
787 The B<-keyopt> option was added in OpenSSL 1.0.2.
789 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
791 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
792 was added in OpenSSL 1.0.2.
794 The -no_alt_chains option was added in OpenSSL 1.0.2b.
796 The B<-nameopt> option was added in OpenSSL 3.0.0.
798 The B<-engine> option was deprecated in OpenSSL 3.0.
802 Copyright 2008-2021 The OpenSSL Project Authors. All Rights Reserved.
804 Licensed under the Apache License 2.0 (the "License"). You may not use
805 this file except in compliance with the License. You can obtain a copy
806 in the file LICENSE in the source distribution or at
807 L<https://www.openssl.org/source/license.html>.