4 {- join("\n", @autowarntext) -}
10 openssl-cms - CMS utility
29 [B<-EncryptedData_encrypt>]
31 [B<-verify_receipt> I<receipt>]
34 [B<-inform> B<DER>|B<PEM>|B<SMIME>]
35 [B<-outform> B<DER>|B<PEM>|B<SMIME>]
36 [B<-rctform> B<DER>|B<PEM>|B<SMIME>]
37 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
42 [B<-content> I<filename>]
46 [B<-attime> I<timestamp>]
60 [B<-purpose> I<purpose>]
67 [B<-auth_level> I<num>]
68 [B<-verify_depth> I<num>]
69 [B<-verify_email> I<email>]
70 [B<-verify_hostname> I<hostname>]
72 [B<-verify_name> I<name>]
85 [B<-certfile> I<file>]
86 [B<-certsout> I<file>]
90 [B<-receipt_request_all>]
91 [B<-receipt_request_first>]
92 [B<-receipt_request_from> I<emailaddress>]
93 [B<-receipt_request_to> I<emailaddress>]
94 [B<-receipt_request_print>]
95 [B<-secretkey> I<key>]
96 [B<-secretkeyid> I<id>]
97 [B<-econtent_type> I<type>]
99 [B<-keyopt> I<name>:I<parameter>]
103 [B<-subject> I<subj>]
104 {- $OpenSSL::safe::opt_trust_synopsis -}
105 {- $OpenSSL::safe::opt_r_synopsis -}
108 =for openssl ifdef des-wrap engine
112 This command handles S/MIME v3.1 mail. It can encrypt, decrypt,
113 sign and verify, compress and uncompress S/MIME messages.
117 There are fourteen operation options that set the type of operation to be
118 performed. The meaning of the other options varies according to the operation
125 Print out a usage message.
129 Encrypt mail for the given recipient certificates. Input file is the message
130 to be encrypted. The output file is the encrypted mail in MIME format. The
131 actual CMS type is <B>EnvelopedData<B>.
133 Note that no revocation check is done for the recipient cert, so if that
134 key has been compromised, others may be able to decrypt the text.
138 Decrypt mail using the supplied certificate and private key. Expects an
139 encrypted mail message in MIME format for the input file. The decrypted mail
140 is written to the output file.
142 =item B<-debug_decrypt>
144 This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used
145 with caution: see the notes section below.
149 Sign mail using the supplied certificate and private key. Input file is
150 the message to be signed. The signed message in MIME format is written
155 Verify signed mail. Expects a signed mail message on input and outputs
156 the signed data. Both clear text and opaque signing is supported.
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 Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make
169 the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES
170 section for more details.
172 =item B<-data_create>
174 Create a CMS B<Data> type.
178 B<Data> type and output the content.
180 =item B<-digest_create>
182 Create a CMS B<DigestedData> type.
184 =item B<-digest_verify>
186 Verify a CMS B<DigestedData> type and output the content.
190 Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib>
191 support for this option to work, otherwise it will output an error.
195 Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be
196 compiled with B<zlib> support for this option to work, otherwise it will
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<ENGINE>
240 The format of the private key file; the default is B<PEM>.
241 See L<openssl(1)/Format Options> for details.
243 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
245 The signed receipt format for use with the B<-receipt_verify>; the default
247 See L<openssl(1)/Format Options> for details.
249 =item B<-stream>, B<-indef>, B<-noindef>
251 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
252 for encoding operations. This permits single pass processing of data without
253 the need to hold the entire contents in memory, potentially supporting very
254 large files. Streaming is automatically set for S/MIME signing with detached
255 data if the output format is B<SMIME> it is currently off by default for all
260 Disable streaming I/O where it would produce and indefinite length constructed
261 encoding. This option currently has no effect. In future streaming will be
262 enabled by default on all relevant operations and this option will disable it.
264 =item B<-content> I<filename>
266 This specifies a file containing the detached content, this is only
267 useful with the B<-verify> command. This is only usable if the CMS
268 structure is using the detached signature form where the content is
269 not included. This option will override any content if the input format
270 is S/MIME and it uses the multipart/signed MIME content type.
274 This option adds plain text (text/plain) MIME headers to the supplied
275 message if encrypting or signing. If decrypting or verifying it strips
276 off text headers: if the decrypted or verified message is not of MIME
277 type text/plain then an error occurs.
281 For the B<-cmsout> operation do not output the parsed CMS structure. This
282 is useful when combined with the B<-print> option or if the syntax of the CMS
283 structure is being checked.
287 For the B<-cmsout> operation print out all fields of the CMS structure. This
288 is mainly useful for testing purposes.
290 =item B<-md> I<digest>
292 Digest algorithm to use when signing or resigning. If not present then the
293 default digest algorithm for the signing key will be used (usually SHA1).
297 The encryption algorithm to use. For example triple DES (168 bits) - B<-des3>
298 or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the
299 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
300 example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers
301 supported by your version of OpenSSL.
303 If not specified triple DES is used. Only used with B<-encrypt> and
304 B<-EncryptedData_create> commands.
308 When verifying a message normally certificates (if any) included in
309 the message are searched for the signing certificate. With this option
310 only the certificates specified in the B<-certfile> option are used.
311 The supplied certificates can still be used as untrusted CAs however.
315 Do not verify the signers certificate of a signed message.
319 When signing a message the signer's certificate is normally included
320 with this option it is excluded. This will reduce the size of the
321 signed message but the verifier must have a copy of the signers certificate
322 available locally (passed using the B<-certfile> option for example).
326 Normally when a message is signed a set of attributes are included which
327 include the signing time and supported symmetric algorithms. With this
328 option they are not included.
332 Exclude the list of supported algorithms from signed attributes, other options
333 such as signing time and content type are still included.
337 Normally the input message is converted to "canonical" format which is
338 effectively using CR and LF as end of line: as required by the S/MIME
339 specification. When this option is present no translation occurs. This
340 is useful when handling binary data which may not be in MIME format.
344 Normally the output file uses a single B<LF> as end of line. When this
345 option is present B<CRLF> is used instead.
349 When signing use ASCII CRLF format canonicalisation. This strips trailing
350 whitespace from all lines, deletes trailing blank lines at EOF and sets
351 the encapsulated content type. This option is normally used with detached
352 content and an output signature format of DER. This option is not normally
353 needed when verifying as it is enabled automatically if the encapsulated
354 content format is detected.
358 When signing a message use opaque signing: this form is more resistant
359 to translation by mail relays but it cannot be read by mail agents that
360 do not support S/MIME. Without this option cleartext signing with
361 the MIME type multipart/signed is used.
363 =item B<-certfile> I<file>
365 Allows additional certificates to be specified. When signing these will
366 be included with the message. When verifying these will be searched for
367 the signers certificates. The certificates should be in PEM format.
369 =item B<-certsout> I<file>
371 Any certificates contained in the message are written to I<file>.
373 =item B<-signer> I<file>
375 A signing certificate when signing or resigning a message, this option can be
376 used multiple times if more than one signer is required. If a message is being
377 verified then the signers certificates will be written to this file if the
378 verification was successful.
380 =item B<-recip> I<file>
382 When decrypting a message this specifies the recipients certificate. The
383 certificate must match one of the recipients of the message or an error
386 When encrypting a message this option may be used multiple times to specify
387 each recipient. This form B<must> be used if customised parameters are
388 required (for example to specify RSA-OAEP).
390 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
395 Use subject key identifier to identify certificates instead of issuer name and
396 serial number. The supplied certificate B<must> include a subject key
397 identifier extension. Supported by B<-sign> and B<-encrypt> options.
399 =item B<-receipt_request_all>, B<-receipt_request_first>
401 For B<-sign> option include a signed receipt request. Indicate requests should
402 be provided by all recipient or first tier recipients (those mailed directly
403 and not from a mailing list). Ignored it B<-receipt_request_from> is included.
405 =item B<-receipt_request_from> I<emailaddress>
407 For B<-sign> option include a signed receipt request. Add an explicit email
408 address where receipts should be supplied.
410 =item B<-receipt_request_to> I<emailaddress>
412 Add an explicit email address where signed receipts should be sent to. This
413 option B<must> but supplied if a signed receipt it requested.
415 =item B<-receipt_request_print>
417 For the B<-verify> operation print out the contents of any signed receipt
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 =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,
470 B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,
471 B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>,
472 B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,
473 B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,
474 B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,
475 B<-verify_ip>, B<-verify_name>, B<-x509_strict>
477 Set various certificate chain validation options. See the
478 L<openssl-verify(1)> manual page for details.
480 {- $OpenSSL::safe::opt_trust_item -}
482 {- $OpenSSL::safe::opt_r_item -}
484 =item I<cert.pem> ...
486 One or more certificates of message recipients: used when encrypting
493 The MIME message must be sent without any blank lines between the
494 headers and the output. Some mail programs will automatically add
495 a blank line. Piping the mail directly to sendmail is one way to
496 achieve the correct format.
498 The supplied message to be signed or encrypted must include the
499 necessary MIME headers or many S/MIME clients won't display it
500 properly (if at all). You can use the B<-text> option to automatically
501 add plain text headers.
503 A "signed and encrypted" message is one where a signed message is
504 then encrypted. This can be produced by encrypting an already signed
505 message: see the examples section.
507 This version of the program only allows one signer per message but it
508 will verify multiple signers on received messages. Some S/MIME clients
509 choke if a message contains multiple signers. It is possible to sign
510 messages "in parallel" by signing an already signed message.
512 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
513 clients. Strictly speaking these process CMS enveloped data: CMS
514 encrypted data is used for other purposes.
516 The B<-resign> option uses an existing message digest when adding a new
517 signer. This means that attributes must be present in at least one existing
518 signer using the same message digest or this operation will fail.
520 The B<-stream> and B<-indef> options enable streaming I/O support.
521 As a result the encoding is BER using indefinite length constructed encoding
522 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
523 B<-sign> operation if the content is not detached.
525 Streaming is always used for the B<-sign> operation with detached data but
526 since the content is no longer part of the CMS structure the encoding
529 If the B<-decrypt> option is used without a recipient certificate then an
530 attempt is made to locate the recipient by trying each potential recipient
531 in turn using the supplied private key. To thwart the MMA attack
532 (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are
533 tried whether they succeed or not and if no recipients match the message
534 is "decrypted" using a random key which will typically output garbage.
535 The B<-debug_decrypt> option can be used to disable the MMA attack protection
536 and return an error if no recipient can be found: this option should be used
537 with caution. For a fuller description see L<CMS_decrypt(3)>).
539 =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)
541 A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains:
547 The signed user data as defined in CMS (RFC 3852);
551 Content-type of the EncapsulatedContentInfo value being signed;
555 Message-digest of the eContent OCTET STRING within encapContentInfo being signed;
559 An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined in Enhanced Security Services (ESS), RFC 2634 and RFC 5035.
560 An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm.
561 An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm.
565 The digital signature value computed on the user data and, when present, on the signed attributes.
567 Note that currently the B<-cades> option applies only to the B<-sign> operation and is ignored during
568 the B<-verify> operation, i.e. the signing certification is not checked during the verification process.
569 This feature might be added in a future version.
579 The operation was completely successfully.
583 An error occurred parsing the command options.
587 One of the input files could not be read.
591 An error occurred creating the CMS file or when reading the MIME
596 An error occurred decrypting or verifying the message.
600 The message was verified correctly but an error occurred writing out
601 the signers certificates.
605 =head1 COMPATIBILITY WITH PKCS#7 FORMAT
607 L<openssl-smime(1)> can only process the older B<PKCS#7> format.
608 B<openssl cms> supports Cryptographic Message Syntax format.
609 Use of some features will result in messages which cannot be processed by
610 applications which only support the older format. These are detailed below.
612 The use of the B<-keyid> option with B<-sign> or B<-encrypt>.
614 The B<-outform> I<PEM> option uses different headers.
616 The B<-compress> option.
618 The B<-secretkey> option when used with B<-encrypt>.
620 The use of PSS with B<-sign>.
622 The use of OAEP or non-RSA keys with B<-encrypt>.
624 Additionally the B<-EncryptedData_create> and B<-data_create> type cannot
625 be processed by the older L<openssl-smime(1)> command.
629 Create a cleartext signed message:
631 openssl cms -sign -in message.txt -text -out mail.msg \
634 Create an opaque signed message
636 openssl cms -sign -in message.txt -text -out mail.msg -nodetach \
639 Create a signed message, include some additional certificates and
640 read the private key from another file:
642 openssl cms -sign -in in.txt -text -out mail.msg \
643 -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
645 Create a signed message with two signers, use key identifier:
647 openssl cms -sign -in message.txt -text -out mail.msg \
648 -signer mycert.pem -signer othercert.pem -keyid
650 Send a signed message under Unix directly to sendmail, including headers:
652 openssl cms -sign -in in.txt -text -signer mycert.pem \
653 -from steve@openssl.org -to someone@somewhere \
654 -subject "Signed message" | sendmail someone@somewhere
656 Verify a message and extract the signer's certificate if successful:
658 openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt
660 Send encrypted mail using triple DES:
662 openssl cms -encrypt -in in.txt -from steve@openssl.org \
663 -to someone@somewhere -subject "Encrypted message" \
664 -des3 user.pem -out mail.msg
666 Sign and encrypt mail:
668 openssl cms -sign -in ml.txt -signer my.pem -text \
669 | openssl cms -encrypt -out mail.msg \
670 -from steve@openssl.org -to someone@somewhere \
671 -subject "Signed and Encrypted message" -des3 user.pem
673 Note: the encryption command does not include the B<-text> option because the
674 message being encrypted already has MIME headers.
678 openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
680 The output from Netscape form signing is a PKCS#7 structure with the
681 detached signature format. You can use this program to verify the
682 signature by line wrapping the base64 encoded structure and surrounding
685 -----BEGIN PKCS7-----
688 and using the command,
690 openssl cms -verify -inform PEM -in signature.pem -content content.txt
692 alternatively you can base64 decode the signature and use
694 openssl cms -verify -inform DER -in signature.der -content content.txt
696 Create an encrypted message using 128 bit Camellia:
698 openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
700 Add a signer to an existing message:
702 openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg
704 Sign mail using RSA-PSS:
706 openssl cms -sign -in message.txt -text -out mail.msg \
707 -signer mycert.pem -keyopt rsa_padding_mode:pss
709 Create encrypted mail using RSA-OAEP:
711 openssl cms -encrypt -in plain.txt -out mail.msg \
712 -recip cert.pem -keyopt rsa_padding_mode:oaep
714 Use SHA256 KDF with an ECDH certificate:
716 openssl cms -encrypt -in plain.txt -out mail.msg \
717 -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256
721 The MIME parser isn't very clever: it seems to handle most messages that I've
722 thrown at it but it may choke on others.
724 The code currently will only write out the signer's certificate to a file: if
725 the signer has a separate encryption certificate this must be manually
726 extracted. There should be some heuristic that determines the correct
727 encryption certificate.
729 Ideally a database should be maintained of a certificates for each email
732 The code doesn't currently take note of the permitted symmetric encryption
733 algorithms as supplied in the SMIMECapabilities signed attribute. this means the
734 user has to manually include the correct encryption algorithm. It should store
735 the list of permitted ciphers in a database and only use those.
737 No revocation checking is done on the signer's certificate.
741 L<ossl_store-file(7)>
745 The use of multiple B<-signer> options and the B<-resign> command were first
746 added in OpenSSL 1.0.0.
748 The B<-keyopt> option was added in OpenSSL 1.0.2.
750 Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2.
752 The use of non-RSA keys with B<-encrypt> and B<-decrypt>
753 was added in OpenSSL 1.0.2.
755 The -no_alt_chains option was added in OpenSSL 1.0.2b.
759 Copyright 2008-2019 The OpenSSL Project Authors. All Rights Reserved.
761 Licensed under the Apache License 2.0 (the "License"). You may not use
762 this file except in compliance with the License. You can obtain a copy
763 in the file LICENSE in the source distribution or at
764 L<https://www.openssl.org/source/license.html>.