2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-cms - CMS utility
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<ENGINE>]
43 [B<-content> I<filename>]
58 [B<-certsout> I<file>]
62 [B<-receipt_request_all>]
63 [B<-receipt_request_first>]
64 [B<-receipt_request_from> I<emailaddress>]
65 [B<-receipt_request_to> I<emailaddress>]
66 [B<-receipt_request_print>]
67 [B<-pwri_password> I<password>]
68 [B<-secretkey> I<key>]
69 [B<-secretkeyid> I<id>]
70 [B<-econtent_type> I<type>]
72 [B<-keyopt> I<name>:I<parameter>]
77 {- $OpenSSL::safe::opt_v_synopsis -}
78 {- $OpenSSL::safe::opt_trust_synopsis -}
79 {- $OpenSSL::safe::opt_r_synopsis -}
80 {- $OpenSSL::safe::opt_engine_synopsis -}
83 =for openssl ifdef des-wrap engine
87 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
88 sign and verify, compress and uncompress S/MIME messages.
92 There are fourteen operation options that set the type of operation to be
93 performed. The meaning of the other options varies according to the operation
100 Print out a usage message.
104 Encrypt mail for the given recipient certificates. Input file is the message
105 to be encrypted. The output file is the encrypted mail in MIME format. The
106 actual CMS type is <B>EnvelopedData<B>.
108 Note that no revocation check is done for the recipient cert, so if that
109 key has been compromised, others may be able to decrypt the text.
113 Decrypt mail using the supplied certificate and private key. Expects an
114 encrypted mail message in MIME format for the input file. The decrypted mail
115 is written to the output file.
117 =item B<-debug_decrypt>
119 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
120 with caution: see the notes section below.
124 Sign mail using the supplied certificate and private key. Input file is
125 the message to be signed. The signed message in MIME format is written
130 Verify signed mail. Expects a signed mail message on input and outputs
131 the signed data. Both clear text and opaque signing is supported.
133 =item B<-verify_retcode>
135 Exit nonzero on verification failure.
137 =item B<-no_attr_verify>
139 Do not verify signed attribute signatures.
141 =item B<-no_content_verify>
143 Do not verify signed content signatures.
147 Don't verify message signature.
151 Takes an input message and writes out a PEM encoded CMS structure.
155 Resign a message: take an existing message and one or more new signers.
159 Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make
160 the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES
161 section for more details.
163 =item B<-data_create>
165 Create a CMS B<Data> type.
169 B<Data> type and output the content.
171 =item B<-digest_create>
173 Create a CMS B<DigestedData> type.
175 =item B<-digest_verify>
177 Verify a CMS B<DigestedData> type and output the content.
181 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
182 support for this option to work, otherwise it will output an error.
186 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
187 compiled with B<zlib> support for this option to work, otherwise it will
190 =item B<-EncryptedData_decrypt>
192 Decrypt content using supplied symmetric key and algorithm using a CMS
193 B<EncryptedData> type and output the content.
195 =item B<-EncryptedData_encrypt>
197 Encrypt content using supplied symmetric key and algorithm using a CMS
198 B<EncryptedData> type and output the content.
200 =item B<-sign_receipt>
202 Generate and output a signed receipt for the supplied message. The input
203 message B<must> contain a signed receipt request. Functionality is otherwise
204 similar to the B<-sign> operation.
206 =item B<-verify_receipt> I<receipt>
208 Verify a signed receipt in filename B<receipt>. The input message B<must>
209 contain the original receipt request. Functionality is otherwise similar
210 to the B<-verify> operation.
212 =item B<-in> I<filename>
214 The input message to be encrypted or signed or the message to be decrypted
217 =item B<-out> I<filename>
219 The message text that has been decrypted or verified or the output MIME
220 format message that has been signed or verified.
222 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
224 The input format of the CMS structure (if one is being read);
225 the default is B<SMIME>.
226 See L<openssl(1)/Format Options> for details.
228 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
230 The output format of the CMS structure (if one is being written);
231 the default is B<SMIME>.
232 See L<openssl(1)/Format Options> for details.
234 =item B<-keyform> B<DER>|B<PEM>|B<ENGINE>
236 The format of the private key file; the default is B<PEM>.
237 See L<openssl(1)/Format Options> for details.
239 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
241 The signed receipt format for use with the B<-receipt_verify>; the default
243 See L<openssl(1)/Format Options> for details.
245 =item B<-stream>, B<-indef>
247 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
248 for encoding operations. This permits single pass processing of data without
249 the need to hold the entire contents in memory, potentially supporting very
250 large files. Streaming is automatically set for S/MIME signing with detached
251 data if the output format is B<SMIME> it is currently off by default for all
256 Disable streaming I/O where it would produce and indefinite length constructed
257 encoding. This option currently has no effect. In future streaming will be
258 enabled by default on all relevant operations and this option will disable it.
260 =item B<-content> I<filename>
262 This specifies a file containing the detached content, this is only
263 useful with the B<-verify> command. This is only usable if the CMS
264 structure is using the detached signature form where the content is
265 not included. This option will override any content if the input format
266 is S/MIME and it uses the multipart/signed MIME content type.
270 This option adds plain text (text/plain) MIME headers to the supplied
271 message if encrypting or signing. If decrypting or verifying it strips
272 off text headers: if the decrypted or verified message is not of MIME
273 type text/plain then an error occurs.
277 For the B<-cmsout> operation do not output the parsed CMS structure. This
278 is useful when combined with the B<-print> option or if the syntax of the CMS
279 structure is being checked.
283 For the B<-cmsout> operation print out all fields of the CMS structure. This
284 is mainly useful for testing purposes.
286 =item B<-md> I<digest>
288 Digest algorithm to use when signing or resigning. If not present then the
289 default digest algorithm for the signing key will be used (usually SHA1).
293 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
294 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
295 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
296 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
297 supported by your version of OpenSSL.
299 If not specified triple DES is used. Only used with B<-encrypt> and
300 B<-EncryptedData_create> commands.
304 When verifying a message normally certificates (if any) included in
305 the message are searched for the signing certificate. With this option
306 only the certificates specified in the B<-certfile> option are used.
307 The supplied certificates can still be used as untrusted CAs however.
311 Do not verify the signers certificate of a signed message.
315 When signing a message the signer's certificate is normally included
316 with this option it is excluded. This will reduce the size of the
317 signed message but the verifier must have a copy of the signers certificate
318 available locally (passed using the B<-certfile> option for example).
322 Normally when a message is signed a set of attributes are included which
323 include the signing time and supported symmetric algorithms. With this
324 option they are not included.
328 Exclude the list of supported algorithms from signed attributes, other options
329 such as signing time and content type are still included.
333 Normally the input message is converted to "canonical" format which is
334 effectively using CR and LF as end of line: as required by the S/MIME
335 specification. When this option is present no translation occurs. This
336 is useful when handling binary data which may not be in MIME format.
340 Normally the output file uses a single B<LF> as end of line. When this
341 option is present B<CRLF> is used instead.
345 When signing use ASCII CRLF format canonicalisation. This strips trailing
346 whitespace from all lines, deletes trailing blank lines at EOF and sets
347 the encapsulated content type. This option is normally used with detached
348 content and an output signature format of DER. This option is not normally
349 needed when verifying as it is enabled automatically if the encapsulated
350 content format is detected.
354 When signing a message use opaque signing: this form is more resistant
355 to translation by mail relays but it cannot be read by mail agents that
356 do not support S/MIME. Without this option cleartext signing with
357 the MIME type multipart/signed is used.
359 =item B<-certfile> I<file>
361 Allows additional certificates to be specified. When signing these will
362 be included with the message. When verifying these will be searched for
363 the signers certificates. The certificates should be in PEM format.
365 =item B<-certsout> I<file>
367 Any certificates contained in the message are written to I<file>.
369 =item B<-signer> I<file>
371 A signing certificate when signing or resigning a message, this option can be
372 used multiple times if more than one signer is required. If a message is being
373 verified then the signers certificates will be written to this file if the
374 verification was successful.
376 =item B<-recip> I<file>
378 When decrypting a message this specifies the recipients certificate. The
379 certificate must match one of the recipients of the message or an error
382 When encrypting a message this option may be used multiple times to specify
383 each recipient. This form B<must> be used if customised parameters are
384 required (for example to specify RSA-OAEP).
386 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
391 Use subject key identifier to identify certificates instead of issuer name and
392 serial number. The supplied certificate B<must> include a subject key
393 identifier extension. Supported by B<-sign> and B<-encrypt> options.
395 =item B<-receipt_request_all>, B<-receipt_request_first>
397 For B<-sign> option include a signed receipt request. Indicate requests should
398 be provided by all recipient or first tier recipients (those mailed directly
399 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
401 =item B<-receipt_request_from> I<emailaddress>
403 For B<-sign> option include a signed receipt request. Add an explicit email
404 address where receipts should be supplied.
406 =item B<-receipt_request_to> I<emailaddress>
408 Add an explicit email address where signed receipts should be sent to. This
409 option B<must> but supplied if a signed receipt it requested.
411 =item B<-receipt_request_print>
413 For the B<-verify> operation print out the contents of any signed receipt
416 =item B<-pwri_password> I<password>
418 Specify password for recipient.
420 =item B<-secretkey> I<key>
422 Specify symmetric key to use. The key must be supplied in hex format and be
423 consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt>
424 B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used
425 with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the
426 content encryption key using an AES key in the B<KEKRecipientInfo> type.
428 =item B<-secretkeyid> I<id>
430 The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type.
431 This option B<must> be present if the B<-secretkey> option is used with
432 B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the
433 relevant key if it is not supplied then an attempt is used to decrypt any
434 B<KEKRecipientInfo> structures.
436 =item B<-econtent_type> I<type>
438 Set the encapsulated content type to I<type> if not supplied the B<Data> type
439 is used. The I<type> argument can be any valid OID name in either text or
442 =item B<-inkey> I<file>
444 The private key to use when signing or decrypting. This must match the
445 corresponding certificate. If this option is not specified then the
446 private key must be included in the certificate file specified with
447 the B<-recip> or B<-signer> file. When signing this option can be used
448 multiple times to specify successive keys.
450 =item B<-keyopt> I<name>:I<parameter>
452 For signing and encryption this option can be used multiple times to
453 set customised parameters for the preceding key or certificate. It can
454 currently be used to set RSA-PSS for signing, RSA-OAEP for encryption
455 or to modify default parameters for ECDH.
457 =item B<-passin> I<arg>
459 The private key password source. For more information about the format of B<arg>
460 see L<openssl(1)/Pass Phrase Options>.
462 =item B<-to>, B<-from>, B<-subject>
464 The relevant mail headers. These are included outside the signed
465 portion of a message so they may be included manually. If signing
466 then many S/MIME mail clients check the signers certificate's email
467 address matches that specified in the From: address.
469 {- $OpenSSL::safe::opt_v_item -}
471 Any verification errors cause the command to exit.
473 {- $OpenSSL::safe::opt_trust_item -}
475 {- $OpenSSL::safe::opt_r_item -}
477 {- $OpenSSL::safe::opt_engine_item -}
479 =item I<cert.pem> ...
481 One or more certificates of message recipients: used when encrypting
488 The MIME message must be sent without any blank lines between the
489 headers and the output. Some mail programs will automatically add
490 a blank line. Piping the mail directly to sendmail is one way to
491 achieve the correct format.
493 The supplied message to be signed or encrypted must include the
494 necessary MIME headers or many S/MIME clients won't display it
495 properly (if at all). You can use the B<-text> option to automatically
496 add plain text headers.
498 A "signed and encrypted" message is one where a signed message is
499 then encrypted. This can be produced by encrypting an already signed
500 message: see the examples section.
502 This version of the program only allows one signer per message but it
503 will verify multiple signers on received messages. Some S/MIME clients
504 choke if a message contains multiple signers. It is possible to sign
505 messages "in parallel" by signing an already signed message.
507 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
508 clients. Strictly speaking these process CMS enveloped data: CMS
509 encrypted data is used for other purposes.
511 The B<-resign> option uses an existing message digest when adding a new
512 signer. This means that attributes must be present in at least one existing
513 signer using the same message digest or this operation will fail.
515 The B<-stream> and B<-indef> options enable streaming I/O support.
516 As a result the encoding is BER using indefinite length constructed encoding
517 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
518 B<-sign> operation if the content is not detached.
520 Streaming is always used for the B<-sign> operation with detached data but
521 since the content is no longer part of the CMS structure the encoding
524 If the B<-decrypt> option is used without a recipient certificate then an
525 attempt is made to locate the recipient by trying each potential recipient
526 in turn using the supplied private key. To thwart the MMA attack
527 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
528 tried whether they succeed or not and if no recipients match the message
529 is "decrypted" using a random key which will typically output garbage.
530 The B<-debug_decrypt> option can be used to disable the MMA attack protection
531 and return an error if no recipient can be found: this option should be used
532 with caution. For a fuller description see L<CMS_decrypt(3)>).
534 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
536 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
542 The signed user data as defined in CMS (RFC 3852);
546 Content-type of the EncapsulatedContentInfo value being signed;
550 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
554 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
555 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
556 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
560 The digital signature value computed on the user data and, when present, on the signed attributes.
562 Note that currently the B<-cades> option applies only to the B<-sign> operation and is ignored during
563 the B<-verify> operation, i.e. the signing certification is not checked during the verification process.
564 This feature might be added in a future version.
574 The operation was completely successfully.
578 An error occurred parsing the command options.
582 One of the input files could not be read.
586 An error occurred creating the CMS file or when reading the MIME
591 An error occurred decrypting or verifying the message.
595 The message was verified correctly but an error occurred writing out
596 the signers certificates.
600 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
602 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
603 B<openssl cms> supports Cryptographic Message Syntax format.
604 Use of some features will result in messages which cannot be processed by
605 applications which only support the older format. These are detailed below.
607 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
609 The B<-outform> I<PEM> option uses different headers.
611 The B<-compress> option.
613 The B<-secretkey> option when used with B<-encrypt>.
615 The use of PSS with B<-sign>.
617 The use of OAEP or non-RSA keys with B<-encrypt>.
619 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
620 be processed by the older L<openssl-smime(1)> command.
624 Create a cleartext signed message:
626 openssl cms -sign -in message.txt -text -out mail.msg \
629 Create an opaque signed message
631 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
634 Create a signed message, include some additional certificates and
635 read the private key from another file:
637 openssl cms -sign -in in.txt -text -out mail.msg \
638 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
640 Create a signed message with two signers, use key identifier:
642 openssl cms -sign -in message.txt -text -out mail.msg \
643 -signer mycert.pem -signer othercert.pem -keyid
645 Send a signed message under Unix directly to sendmail, including headers:
647 openssl cms -sign -in in.txt -text -signer mycert.pem \
648 -from steve@openssl.org -to someone@somewhere \
649 -subject "Signed message" | sendmail someone@somewhere
651 Verify a message and extract the signer's certificate if successful:
653 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
655 Send encrypted mail using triple DES:
657 openssl cms -encrypt -in in.txt -from steve@openssl.org \
658 -to someone@somewhere -subject "Encrypted message" \
659 -des3 user.pem -out mail.msg
661 Sign and encrypt mail:
663 openssl cms -sign -in ml.txt -signer my.pem -text \
664 | openssl cms -encrypt -out mail.msg \
665 -from steve@openssl.org -to someone@somewhere \
666 -subject "Signed and Encrypted message" -des3 user.pem
668 Note: the encryption command does not include the B<-text> option because the
669 message being encrypted already has MIME headers.
673 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
675 The output from Netscape form signing is a PKCS#7 structure with the
676 detached signature format. You can use this program to verify the
677 signature by line wrapping the base64 encoded structure and surrounding
680 -----BEGIN PKCS7-----
683 and using the command,
685 openssl cms -verify -inform PEM -in signature.pem -content content.txt
687 alternatively you can base64 decode the signature and use
689 openssl cms -verify -inform DER -in signature.der -content content.txt
691 Create an encrypted message using 128 bit Camellia:
693 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
695 Add a signer to an existing message:
697 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
699 Sign mail using RSA-PSS:
701 openssl cms -sign -in message.txt -text -out mail.msg \
702 -signer mycert.pem -keyopt rsa_padding_mode:pss
704 Create encrypted mail using RSA-OAEP:
706 openssl cms -encrypt -in plain.txt -out mail.msg \
707 -recip cert.pem -keyopt rsa_padding_mode:oaep
709 Use SHA256 KDF with an ECDH certificate:
711 openssl cms -encrypt -in plain.txt -out mail.msg \
712 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
716 The MIME parser isn't very clever: it seems to handle most messages that I've
717 thrown at it but it may choke on others.
719 The code currently will only write out the signer's certificate to a file: if
720 the signer has a separate encryption certificate this must be manually
721 extracted. There should be some heuristic that determines the correct
722 encryption certificate.
724 Ideally a database should be maintained of a certificates for each email
727 The code doesn't currently take note of the permitted symmetric encryption
728 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
729 user has to manually include the correct encryption algorithm. It should store
730 the list of permitted ciphers in a database and only use those.
732 No revocation checking is done on the signer's certificate.
736 L<ossl_store-file(7)>
740 The use of multiple B<-signer> options and the B<-resign> command were first
741 added in OpenSSL 1.0.0.
743 The B<-keyopt> option was added in OpenSSL 1.0.2.
745 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
747 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
748 was added in OpenSSL 1.0.2.
750 The -no_alt_chains option was added in OpenSSL 1.0.2b.
754 Copyright 2008-2019 The OpenSSL Project Authors. All Rights Reserved.
756 Licensed under the Apache License 2.0 (the "License"). You may not use
757 this file except in compliance with the License. You can obtain a copy
758 in the file LICENSE in the source distribution or at
759 L<https://www.openssl.org/source/license.html>.