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>]
59 [B<-certfile> I<file>]
60 [B<-certsout> I<file>]
62 [B<-originator> I<file>]
65 [B<-receipt_request_all>]
66 [B<-receipt_request_first>]
67 [B<-receipt_request_from> I<emailaddress>]
68 [B<-receipt_request_to> I<emailaddress>]
69 [B<-receipt_request_print>]
70 [B<-pwri_password> I<password>]
71 [B<-secretkey> I<key>]
72 [B<-secretkeyid> I<id>]
73 [B<-econtent_type> I<type>]
75 [B<-keyopt> I<name>:I<parameter>]
80 {- $OpenSSL::safe::opt_v_synopsis -}
81 {- $OpenSSL::safe::opt_trust_synopsis -}
82 {- $OpenSSL::safe::opt_r_synopsis -}
83 {- $OpenSSL::safe::opt_engine_synopsis -}
84 {- $OpenSSL::safe::opt_provider_synopsis -}
85 [I<recipient-cert> ...]
87 =for openssl ifdef des-wrap engine
91 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
92 sign and verify, compress and uncompress S/MIME messages.
96 There are fourteen operation options that set the type of operation to be
97 performed. The meaning of the other options varies according to the operation
104 Print out a usage message.
108 Encrypt mail for the given recipient certificates. Input file is the message
109 to be encrypted. The output file is the encrypted mail in MIME format. The
110 actual CMS type is B<EnvelopedData>.
112 Note that no revocation check is done for the recipient cert, so if that
113 key has been compromised, others may be able to decrypt the text.
117 Decrypt mail using the supplied certificate and private key. Expects an
118 encrypted mail message in MIME format for the input file. The decrypted mail
119 is written to the output file.
121 =item B<-debug_decrypt>
123 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
124 with caution: see the notes section below.
128 Sign mail using the supplied certificate and private key. Input file is
129 the message to be signed. The signed message in MIME format is written
134 Verify signed mail. Expects a signed mail message on input and outputs
135 the signed data. Both clear text and opaque signing is supported.
137 =item B<-verify_retcode>
139 Exit nonzero on verification failure.
141 =item B<-no_attr_verify>
143 Do not verify signed attribute signatures.
145 =item B<-no_content_verify>
147 Do not verify signed content signatures.
151 Don't verify message signature.
155 Takes an input message and writes out a PEM encoded CMS structure.
159 Resign a message: take an existing message and one or more new signers.
163 Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make
164 the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES
165 section for more details.
167 =item B<-data_create>
169 Create a CMS B<Data> type.
173 B<Data> type and output the content.
175 =item B<-digest_create>
177 Create a CMS B<DigestedData> type.
179 =item B<-digest_verify>
181 Verify a CMS B<DigestedData> type and output the content.
185 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
186 support for this option to work, otherwise it will output an error.
190 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
191 compiled with B<zlib> support for this option to work, otherwise it will
194 =item B<-EncryptedData_decrypt>
196 Decrypt content using supplied symmetric key and algorithm using a CMS
197 B<EncryptedData> type and output the content.
199 =item B<-EncryptedData_encrypt>
201 Encrypt content using supplied symmetric key and algorithm using a CMS
202 B<EncryptedData> type and output the content.
204 =item B<-sign_receipt>
206 Generate and output a signed receipt for the supplied message. The input
207 message B<must> contain a signed receipt request. Functionality is otherwise
208 similar to the B<-sign> operation.
210 =item B<-verify_receipt> I<receipt>
212 Verify a signed receipt in filename B<receipt>. The input message B<must>
213 contain the original receipt request. Functionality is otherwise similar
214 to the B<-verify> operation.
216 =item B<-in> I<filename>
218 The input message to be encrypted or signed or the message to be decrypted
221 =item B<-out> I<filename>
223 The message text that has been decrypted or verified or the output MIME
224 format message that has been signed or verified.
226 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
228 The input format of the CMS structure (if one is being read);
229 the default is B<SMIME>.
230 See L<openssl(1)/Format Options> for details.
232 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
234 The output format of the CMS structure (if one is being written);
235 the default is B<SMIME>.
236 See L<openssl(1)/Format Options> for details.
238 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
240 The format of the private key file; the default is B<PEM>.
241 The only value with effect is B<ENGINE>; all others have become obsolete.
242 See L<openssl(1)/Format Options> for details.
244 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
246 The signed receipt format for use with the B<-receipt_verify>; the default
248 See L<openssl(1)/Format Options> for details.
250 =item B<-stream>, B<-indef>
252 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
253 for encoding operations. This permits single pass processing of data without
254 the need to hold the entire contents in memory, potentially supporting very
255 large files. Streaming is automatically set for S/MIME signing with detached
256 data if the output format is B<SMIME> it is currently off by default for all
261 Disable streaming I/O where it would produce and indefinite length constructed
262 encoding. This option currently has no effect. In future streaming will be
263 enabled by default on all relevant operations and this option will disable it.
265 =item B<-content> I<filename>
267 This specifies a file containing the detached content, this is only
268 useful with the B<-verify> command. This is only usable if the CMS
269 structure is using the detached signature form where the content is
270 not included. This option will override any content if the input format
271 is S/MIME and it uses the multipart/signed MIME content type.
275 This option adds plain text (text/plain) MIME headers to the supplied
276 message if encrypting or signing. If decrypting or verifying it strips
277 off text headers: if the decrypted or verified message is not of MIME
278 type text/plain then an error occurs.
282 For the B<-cmsout> operation do not output the parsed CMS structure. This
283 is useful when combined with the B<-print> option or if the syntax of the CMS
284 structure is being checked.
288 For the B<-cmsout> operation print out all fields of the CMS structure. This
289 is mainly useful for testing purposes.
291 =item B<-md> I<digest>
293 Digest algorithm to use when signing or resigning. If not present then the
294 default digest algorithm for the signing key will be used (usually SHA1).
298 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
299 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
300 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
301 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
302 supported by your version of OpenSSL.
304 If not specified triple DES is used. Only used with B<-encrypt> and
305 B<-EncryptedData_create> commands.
307 =item B<-wrap> I<cipher>
309 Cipher algorithm to use for key wrap when encrypting the message using Key
310 Agreement for key transport. The algorithm specified should be suitable for key
315 When verifying a message normally certificates (if any) included in
316 the message are searched for the signing certificate. With this option
317 only the certificates specified in the B<-certfile> option are used.
318 The supplied certificates can still be used as untrusted CAs however.
322 Do not verify the signers certificate of a signed message.
326 When signing a message the signer's certificate is normally included
327 with this option it is excluded. This will reduce the size of the
328 signed message but the verifier must have a copy of the signers certificate
329 available locally (passed using the B<-certfile> option for example).
333 Normally when a message is signed a set of attributes are included which
334 include the signing time and supported symmetric algorithms. With this
335 option they are not included.
339 Exclude the list of supported algorithms from signed attributes, other options
340 such as signing time and content type are still included.
344 Normally the input message is converted to "canonical" format which is
345 effectively using CR and LF as end of line: as required by the S/MIME
346 specification. When this option is present no translation occurs. This
347 is useful when handling binary data which may not be in MIME format.
351 Normally the output file uses a single B<LF> as end of line. When this
352 option is present B<CRLF> is used instead.
356 When signing use ASCII CRLF format canonicalisation. This strips trailing
357 whitespace from all lines, deletes trailing blank lines at EOF and sets
358 the encapsulated content type. This option is normally used with detached
359 content and an output signature format of DER. This option is not normally
360 needed when verifying as it is enabled automatically if the encapsulated
361 content format is detected.
365 When signing a message use opaque signing: this form is more resistant
366 to translation by mail relays but it cannot be read by mail agents that
367 do not support S/MIME. Without this option cleartext signing with
368 the MIME type multipart/signed is used.
370 =item B<-certfile> I<file>
372 Allows additional certificates to be specified. When signing these will
373 be included with the message. When verifying these will be searched for
374 the signers certificates.
376 =item B<-certsout> I<file>
378 Any certificates contained in the message are written to I<file>.
380 =item B<-signer> I<file>
382 A signing certificate when signing or resigning a message, this option can be
383 used multiple times if more than one signer is required. If a message is being
384 verified then the signers certificates will be written to this file if the
385 verification was successful.
387 =item B<-originator> I<file>
389 A certificate of the originator of the encrypted message. Necessary for
390 decryption when Key Agreement is in use for a shared key.
392 =item B<-recip> I<file>
394 When decrypting a message this specifies the recipients certificate. The
395 certificate must match one of the recipients of the message or an error
398 When encrypting a message this option may be used multiple times to specify
399 each recipient. This form B<must> be used if customised parameters are
400 required (for example to specify RSA-OAEP).
402 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
407 Use subject key identifier to identify certificates instead of issuer name and
408 serial number. The supplied certificate B<must> include a subject key
409 identifier extension. Supported by B<-sign> and B<-encrypt> options.
411 =item B<-receipt_request_all>, B<-receipt_request_first>
413 For B<-sign> option include a signed receipt request. Indicate requests should
414 be provided by all recipient or first tier recipients (those mailed directly
415 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
417 =item B<-receipt_request_from> I<emailaddress>
419 For B<-sign> option include a signed receipt request. Add an explicit email
420 address where receipts should be supplied.
422 =item B<-receipt_request_to> I<emailaddress>
424 Add an explicit email address where signed receipts should be sent to. This
425 option B<must> but supplied if a signed receipt it requested.
427 =item B<-receipt_request_print>
429 For the B<-verify> operation print out the contents of any signed receipt
432 =item B<-pwri_password> I<password>
434 Specify password for recipient.
436 =item B<-secretkey> I<key>
438 Specify symmetric key to use. The key must be supplied in hex format and be
439 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
440 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
441 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
442 content encryption key using an AES key in the B<KEKRecipientInfo> type.
444 =item B<-secretkeyid> I<id>
446 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
447 This option B<must> be present if the B<-secretkey> option is used with
448 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
449 relevant key if it is not supplied then an attempt is used to decrypt any
450 B<KEKRecipientInfo> structures.
452 =item B<-econtent_type> I<type>
454 Set the encapsulated content type to I<type> if not supplied the B<Data> type
455 is used. The I<type> argument can be any valid OID name in either text or
458 =item B<-inkey> I<file>
460 The private key to use when signing or decrypting. This must match the
461 corresponding certificate. If this option is not specified then the
462 private key must be included in the certificate file specified with
463 the B<-recip> or B<-signer> file. When signing this option can be used
464 multiple times to specify successive keys.
466 =item B<-keyopt> I<name>:I<parameter>
468 For signing and encryption this option can be used multiple times to
469 set customised parameters for the preceding key or certificate. It can
470 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
471 or to modify default parameters for ECDH.
473 =item B<-passin> I<arg>
475 The private key password source. For more information about the format of B<arg>
476 see L<openssl(1)/Pass Phrase Options>.
478 =item B<-to>, B<-from>, B<-subject>
480 The relevant mail headers. These are included outside the signed
481 portion of a message so they may be included manually. If signing
482 then many S/MIME mail clients check the signers certificate's email
483 address matches that specified in the From: address.
485 {- $OpenSSL::safe::opt_v_item -}
487 Any verification errors cause the command to exit.
489 {- $OpenSSL::safe::opt_trust_item -}
491 {- $OpenSSL::safe::opt_r_item -}
493 {- $OpenSSL::safe::opt_engine_item -}
495 {- $OpenSSL::safe::opt_provider_item -}
497 =item I<recipient-cert> ...
499 One or more certificates of message recipients: used when encrypting
506 The MIME message must be sent without any blank lines between the
507 headers and the output. Some mail programs will automatically add
508 a blank line. Piping the mail directly to sendmail is one way to
509 achieve the correct format.
511 The supplied message to be signed or encrypted must include the
512 necessary MIME headers or many S/MIME clients won't display it
513 properly (if at all). You can use the B<-text> option to automatically
514 add plain text headers.
516 A "signed and encrypted" message is one where a signed message is
517 then encrypted. This can be produced by encrypting an already signed
518 message: see the examples section.
520 This version of the program only allows one signer per message but it
521 will verify multiple signers on received messages. Some S/MIME clients
522 choke if a message contains multiple signers. It is possible to sign
523 messages "in parallel" by signing an already signed message.
525 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
526 clients. Strictly speaking these process CMS enveloped data: CMS
527 encrypted data is used for other purposes.
529 The B<-resign> option uses an existing message digest when adding a new
530 signer. This means that attributes must be present in at least one existing
531 signer using the same message digest or this operation will fail.
533 The B<-stream> and B<-indef> options enable streaming I/O support.
534 As a result the encoding is BER using indefinite length constructed encoding
535 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
536 B<-sign> operation if the content is not detached.
538 Streaming is always used for the B<-sign> operation with detached data but
539 since the content is no longer part of the CMS structure the encoding
542 If the B<-decrypt> option is used without a recipient certificate then an
543 attempt is made to locate the recipient by trying each potential recipient
544 in turn using the supplied private key. To thwart the MMA attack
545 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
546 tried whether they succeed or not and if no recipients match the message
547 is "decrypted" using a random key which will typically output garbage.
548 The B<-debug_decrypt> option can be used to disable the MMA attack protection
549 and return an error if no recipient can be found: this option should be used
550 with caution. For a fuller description see L<CMS_decrypt(3)>).
552 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
554 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
560 The signed user data as defined in CMS (RFC 3852);
564 Content-type of the EncapsulatedContentInfo value being signed;
568 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
572 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
573 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
574 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
578 The digital signature value computed on the user data and, when present, on the signed attributes.
580 Note that currently the B<-cades> option applies only to the B<-sign> operation and is ignored during
581 the B<-verify> operation, i.e. the signing certification is not checked during the verification process.
582 This feature might be added in a future version.
592 The operation was completely successfully.
596 An error occurred parsing the command options.
600 One of the input files could not be read.
604 An error occurred creating the CMS file or when reading the MIME
609 An error occurred decrypting or verifying the message.
613 The message was verified correctly but an error occurred writing out
614 the signers certificates.
618 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
620 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
621 B<openssl cms> supports Cryptographic Message Syntax format.
622 Use of some features will result in messages which cannot be processed by
623 applications which only support the older format. These are detailed below.
625 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
627 The B<-outform> I<PEM> option uses different headers.
629 The B<-compress> option.
631 The B<-secretkey> option when used with B<-encrypt>.
633 The use of PSS with B<-sign>.
635 The use of OAEP or non-RSA keys with B<-encrypt>.
637 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
638 be processed by the older L<openssl-smime(1)> command.
642 Create a cleartext signed message:
644 openssl cms -sign -in message.txt -text -out mail.msg \
647 Create an opaque signed message
649 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
652 Create a signed message, include some additional certificates and
653 read the private key from another file:
655 openssl cms -sign -in in.txt -text -out mail.msg \
656 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
658 Create a signed message with two signers, use key identifier:
660 openssl cms -sign -in message.txt -text -out mail.msg \
661 -signer mycert.pem -signer othercert.pem -keyid
663 Send a signed message under Unix directly to sendmail, including headers:
665 openssl cms -sign -in in.txt -text -signer mycert.pem \
666 -from steve@openssl.org -to someone@somewhere \
667 -subject "Signed message" | sendmail someone@somewhere
669 Verify a message and extract the signer's certificate if successful:
671 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
673 Send encrypted mail using triple DES:
675 openssl cms -encrypt -in in.txt -from steve@openssl.org \
676 -to someone@somewhere -subject "Encrypted message" \
677 -des3 user.pem -out mail.msg
679 Sign and encrypt mail:
681 openssl cms -sign -in ml.txt -signer my.pem -text \
682 | openssl cms -encrypt -out mail.msg \
683 -from steve@openssl.org -to someone@somewhere \
684 -subject "Signed and Encrypted message" -des3 user.pem
686 Note: the encryption command does not include the B<-text> option because the
687 message being encrypted already has MIME headers.
691 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
693 The output from Netscape form signing is a PKCS#7 structure with the
694 detached signature format. You can use this program to verify the
695 signature by line wrapping the base64 encoded structure and surrounding
698 -----BEGIN PKCS7-----
701 and using the command,
703 openssl cms -verify -inform PEM -in signature.pem -content content.txt
705 alternatively you can base64 decode the signature and use
707 openssl cms -verify -inform DER -in signature.der -content content.txt
709 Create an encrypted message using 128 bit Camellia:
711 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
713 Add a signer to an existing message:
715 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
717 Sign mail using RSA-PSS:
719 openssl cms -sign -in message.txt -text -out mail.msg \
720 -signer mycert.pem -keyopt rsa_padding_mode:pss
722 Create encrypted mail using RSA-OAEP:
724 openssl cms -encrypt -in plain.txt -out mail.msg \
725 -recip cert.pem -keyopt rsa_padding_mode:oaep
727 Use SHA256 KDF with an ECDH certificate:
729 openssl cms -encrypt -in plain.txt -out mail.msg \
730 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
734 The MIME parser isn't very clever: it seems to handle most messages that I've
735 thrown at it but it may choke on others.
737 The code currently will only write out the signer's certificate to a file: if
738 the signer has a separate encryption certificate this must be manually
739 extracted. There should be some heuristic that determines the correct
740 encryption certificate.
742 Ideally a database should be maintained of a certificates for each email
745 The code doesn't currently take note of the permitted symmetric encryption
746 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
747 user has to manually include the correct encryption algorithm. It should store
748 the list of permitted ciphers in a database and only use those.
750 No revocation checking is done on the signer's certificate.
754 L<ossl_store-file(7)>
758 The use of multiple B<-signer> options and the B<-resign> command were first
759 added in OpenSSL 1.0.0.
761 The B<-keyopt> option was added in OpenSSL 1.0.2.
763 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
765 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
766 was added in OpenSSL 1.0.2.
768 The -no_alt_chains option was added in OpenSSL 1.0.2b.
770 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
775 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
777 Licensed under the Apache License 2.0 (the "License"). You may not use
778 this file except in compliance with the License. You can obtain a copy
779 in the file LICENSE in the source distribution or at
780 L<https://www.openssl.org/source/license.html>.