diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-cms.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-cms.1 | 436 |
1 files changed, 194 insertions, 242 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-cms.1 b/secure/usr.bin/openssl/man/openssl-cms.1 index 0d965105311c..5aa3a6f7750a 100644 --- a/secure/usr.bin/openssl/man/openssl-cms.1 +++ b/secure/usr.bin/openssl/man/openssl-cms.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,77 +52,17 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OPENSSL-CMS 1ossl" -.TH OPENSSL-CMS 1ossl "2023-09-22" "3.0.11" "OpenSSL" +.TH OPENSSL-CMS 1ossl 2025-07-24 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME openssl\-cms \- CMS command -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBcms\fR [\fB\-help\fR] @@ -158,6 +82,7 @@ Operation options: [\fB\-resign\fR] [\fB\-sign_receipt\fR] [\fB\-verify_receipt\fR \fIreceipt\fR] +[\fB\-digest\fR \fIdigest\fR] [\fB\-digest_create\fR] [\fB\-digest_verify\fR] [\fB\-compress\fR] @@ -170,9 +95,9 @@ Operation options: .PP File format options: .PP -[\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR] -[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR] -[\fB\-rctform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR] +[\fB\-inform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR] +[\fB\-outform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR] +[\fB\-rctform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR] [\fB\-stream\fR] [\fB\-indef\fR] [\fB\-noindef\fR] @@ -188,10 +113,11 @@ Keys and password options: [\fB\-inkey\fR \fIfilename\fR|\fIuri\fR] [\fB\-passin\fR \fIarg\fR] [\fB\-keyopt\fR \fIname\fR:\fIparameter\fR] -[\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR] +[\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR] [\fB\-engine\fR \fIid\fR] [\fB\-provider\fR \fIname\fR] [\fB\-provider\-path\fR \fIpath\fR] +[\fB\-provparam\fR \fI[name:]key=value\fR] [\fB\-propquery\fR \fIpropq\fR] [\fB\-rand\fR \fIfiles\fR] [\fB\-writerand\fR \fIfile\fR] @@ -201,7 +127,7 @@ Encryption options: [\fB\-originator\fR \fIfile\fR] [\fB\-recip\fR \fIfile\fR] [\fIrecipient-cert\fR ...] -[\fB\-\f(BIcipher\fB\fR] +[\fB\-\fR\f(BIcipher\fR] [\fB\-wrap\fR \fIcipher\fR] [\fB\-aes128\-wrap\fR] [\fB\-aes192\-wrap\fR] @@ -219,6 +145,7 @@ Signing options: [\fB\-nocerts\fR] [\fB\-noattr\fR] [\fB\-nosmimecap\fR] +[\fB\-no_signing_time\fR] [\fB\-receipt_request_all\fR] [\fB\-receipt_request_first\fR] [\fB\-receipt_request_from\fR \fIemailaddress\fR] @@ -291,11 +218,11 @@ Validation options: [\fB\-verify_name\fR \fIname\fR] [\fB\-x509_strict\fR] [\fB\-issuer_checks\fR] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -This command handles data in \s-1CMS\s0 format such as S/MIME v3.1 email messages. +This command handles data in CMS format such as S/MIME v3.1 email messages. It can encrypt, decrypt, sign, verify, compress, uncompress, and print messages. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" There are a number of operation options that set the type of operation to be performed: encrypt, decrypt, sign, verify, resign, sign_receipt, verify_receipt, @@ -303,7 +230,7 @@ digest_create, digest_verify, compress, uncompress, EncryptedData_encrypt, EncryptedData_decrypt, data_create, data_out, or cmsout. The relevance of the other options depends on the operation type and their meaning may vary according to it. -.IP "\fB\-help\fR" 4 +.IP \fB\-help\fR 4 .IX Item "-help" Print out a usage message. .SS "General options" @@ -314,39 +241,43 @@ The input message to be encrypted or signed or the message to be decrypted or verified. .IP "\fB\-out\fR \fIfilename\fR" 4 .IX Item "-out filename" -The message text that has been decrypted or verified or the output \s-1MIME\s0 +The message text that has been decrypted or verified or the output MIME format message that has been signed or verified. .IP "\fB\-config\fR \fIconfigfile\fR" 4 .IX Item "-config configfile" -See \*(L"Configuration Option\*(R" in \fBopenssl\fR\|(1). +See "Configuration Option" in \fBopenssl\fR\|(1). .SS "Operation options" .IX Subsection "Operation options" -.IP "\fB\-encrypt\fR" 4 +.IP \fB\-encrypt\fR 4 .IX Item "-encrypt" Encrypt data for the given recipient certificates. Input file is the message -to be encrypted. The output file is the encrypted data in \s-1MIME\s0 format. The -actual \s-1CMS\s0 type is \fBEnvelopedData\fR. +to be encrypted. The output file is the encrypted data in MIME format. The +actual CMS type is \fBEnvelopedData\fR. .Sp Note that no revocation check is done for the recipient cert, so if that key has been compromised, others may be able to decrypt the text. -.IP "\fB\-decrypt\fR" 4 +.IP \fB\-decrypt\fR 4 .IX Item "-decrypt" Decrypt data using the supplied certificate and private key. Expects -encrypted datain \s-1MIME\s0 format for the input file. The decrypted data +encrypted datain MIME format for the input file. The decrypted data is written to the output file. -.IP "\fB\-sign\fR" 4 +.IP \fB\-sign\fR 4 .IX Item "-sign" Sign data using the supplied certificate and private key. Input file is -the message to be signed. The signed data in \s-1MIME\s0 format is written +the message to be signed. The signed data in MIME format is written to the output file. -.IP "\fB\-verify\fR" 4 +.IP \fB\-verify\fR 4 .IX Item "-verify" Verify signed data. Expects a signed data on input and outputs the signed data. Both clear text and opaque signing is supported. -.IP "\fB\-resign\fR" 4 +.Sp +By default, validation of signer certificates and their chain +is done w.r.t. the S/MIME signing (\f(CW\*(C`smimesign\*(C'\fR) purpose. +For details see "Certificate Extensions" in \fBopenssl\-verification\-options\fR\|(1). +.IP \fB\-resign\fR 4 .IX Item "-resign" Resign a message: take an existing message and one or more new signers. -.IP "\fB\-sign_receipt\fR" 4 +.IP \fB\-sign_receipt\fR 4 .IX Item "-sign_receipt" Generate and output a signed receipt for the supplied message. The input message \fBmust\fR contain a signed receipt request. Functionality is otherwise @@ -356,54 +287,63 @@ similar to the \fB\-sign\fR operation. Verify a signed receipt in filename \fBreceipt\fR. The input message \fBmust\fR contain the original receipt request. Functionality is otherwise similar to the \fB\-verify\fR operation. -.IP "\fB\-digest_create\fR" 4 +.IP "\fB\-digest\fR \fIdigest\fR" 4 +.IX Item "-digest digest" +When used with \fB\-sign\fR, provides the digest in hexadecimal form instead of +computing it from the original message content. Cannot be combined with \fB\-in\fR +or \fB\-nodetach\fR. +.Sp +This operation is the CMS equivalent of \fBopenssl\-pkeyutl\fR\|(1) signing. +When signing a pre-computed digest, the security relies on the digest and its +computation from the original message being trusted. +.IP \fB\-digest_create\fR 4 .IX Item "-digest_create" -Create a \s-1CMS\s0 \fBDigestedData\fR type. -.IP "\fB\-digest_verify\fR" 4 +Create a CMS \fBDigestedData\fR type. +.IP \fB\-digest_verify\fR 4 .IX Item "-digest_verify" -Verify a \s-1CMS\s0 \fBDigestedData\fR type and output the content. -.IP "\fB\-compress\fR" 4 +Verify a CMS \fBDigestedData\fR type and output the content. +.IP \fB\-compress\fR 4 .IX Item "-compress" -Create a \s-1CMS\s0 \fBCompressedData\fR type. OpenSSL must be compiled with \fBzlib\fR +Create a CMS \fBCompressedData\fR type. OpenSSL must be compiled with \fBzlib\fR support for this option to work, otherwise it will output an error. -.IP "\fB\-uncompress\fR" 4 +.IP \fB\-uncompress\fR 4 .IX Item "-uncompress" -Uncompress a \s-1CMS\s0 \fBCompressedData\fR type and output the content. OpenSSL must be +Uncompress a CMS \fBCompressedData\fR type and output the content. OpenSSL must be compiled with \fBzlib\fR support for this option to work, otherwise it will output an error. -.IP "\fB\-EncryptedData_encrypt\fR" 4 +.IP \fB\-EncryptedData_encrypt\fR 4 .IX Item "-EncryptedData_encrypt" -Encrypt content using supplied symmetric key and algorithm using a \s-1CMS\s0 +Encrypt content using supplied symmetric key and algorithm using a CMS \&\fBEncryptedData\fR type and output the content. -.IP "\fB\-EncryptedData_decrypt\fR" 4 +.IP \fB\-EncryptedData_decrypt\fR 4 .IX Item "-EncryptedData_decrypt" -Decrypt content using supplied symmetric key and algorithm using a \s-1CMS\s0 +Decrypt content using supplied symmetric key and algorithm using a CMS \&\fBEncryptedData\fR type and output the content. -.IP "\fB\-data_create\fR" 4 +.IP \fB\-data_create\fR 4 .IX Item "-data_create" -Create a \s-1CMS\s0 \fBData\fR type. -.IP "\fB\-data_out\fR" 4 +Create a CMS \fBData\fR type. +.IP \fB\-data_out\fR 4 .IX Item "-data_out" \&\fBData\fR type and output the content. -.IP "\fB\-cmsout\fR" 4 +.IP \fB\-cmsout\fR 4 .IX Item "-cmsout" -Takes an input message and writes out a \s-1PEM\s0 encoded \s-1CMS\s0 structure. +Takes an input message and writes out a PEM encoded CMS structure. .SS "File format options" .IX Subsection "File format options" -.IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR" 4 +.IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR" 4 .IX Item "-inform DER|PEM|SMIME" -The input format of the \s-1CMS\s0 structure (if one is being read); -the default is \fB\s-1SMIME\s0\fR. +The input format of the CMS structure (if one is being read); +the default is \fBSMIME\fR. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR" 4 +.IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR" 4 .IX Item "-outform DER|PEM|SMIME" -The output format of the \s-1CMS\s0 structure (if one is being written); -the default is \fB\s-1SMIME\s0\fR. +The output format of the CMS structure (if one is being written); +the default is \fBSMIME\fR. See \fBopenssl\-format\-options\fR\|(1) for details. -.IP "\fB\-rctform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fB\s-1SMIME\s0\fR" 4 +.IP "\fB\-rctform\fR \fBDER\fR|\fBPEM\fR|\fBSMIME\fR" 4 .IX Item "-rctform DER|PEM|SMIME" The signed receipt format for use with the \fB\-receipt_verify\fR; the default -is \fB\s-1SMIME\s0\fR. +is \fBSMIME\fR. See \fBopenssl\-format\-options\fR\|(1) for details. .IP "\fB\-stream\fR, \fB\-indef\fR" 4 .IX Item "-stream, -indef" @@ -411,29 +351,29 @@ The \fB\-stream\fR and \fB\-indef\fR options are equivalent and enable streaming for encoding operations. This permits single pass processing of data without the need to hold the entire contents in memory, potentially supporting very large files. Streaming is automatically set for S/MIME signing with detached -data if the output format is \fB\s-1SMIME\s0\fR it is currently off by default for all +data if the output format is \fBSMIME\fR it is currently off by default for all other operations. -.IP "\fB\-noindef\fR" 4 +.IP \fB\-noindef\fR 4 .IX Item "-noindef" Disable streaming I/O where it would produce and indefinite length constructed encoding. This option currently has no effect. In future streaming will be enabled by default on all relevant operations and this option will disable it. -.IP "\fB\-binary\fR" 4 +.IP \fB\-binary\fR 4 .IX Item "-binary" -Normally the input message is converted to \*(L"canonical\*(R" format which is -effectively using \s-1CR\s0 and \s-1LF\s0 as end of line: as required by the S/MIME +Normally the input message is converted to "canonical" format which is +effectively using CR and LF as end of line: as required by the S/MIME specification. When this option is present no translation occurs. This -is useful when handling binary data which may not be in \s-1MIME\s0 format. -.IP "\fB\-crlfeol\fR" 4 +is useful when handling binary data which may not be in MIME format. +.IP \fB\-crlfeol\fR 4 .IX Item "-crlfeol" -Normally the output file uses a single \fB\s-1LF\s0\fR as end of line. When this -option is present \fB\s-1CRLF\s0\fR is used instead. -.IP "\fB\-asciicrlf\fR" 4 +Normally the output file uses a single \fBLF\fR as end of line. When this +option is present \fBCRLF\fR is used instead. +.IP \fB\-asciicrlf\fR 4 .IX Item "-asciicrlf" -When signing use \s-1ASCII CRLF\s0 format canonicalisation. This strips trailing -whitespace from all lines, deletes trailing blank lines at \s-1EOF\s0 and sets +When signing use ASCII CRLF format canonicalisation. This strips trailing +whitespace from all lines, deletes trailing blank lines at EOF and sets the encapsulated content type. This option is normally used with detached -content and an output signature format of \s-1DER.\s0 This option is not normally +content and an output signature format of DER. This option is not normally needed when verifying as it is enabled automatically if the encapsulated content format is detected. .SS "Keys and password options" @@ -447,7 +387,7 @@ Specify symmetric key to use. The key must be supplied in hex format and be consistent with the algorithm used. Supported by the \fB\-EncryptedData_encrypt\fR \&\fB\-EncryptedData_decrypt\fR, \fB\-encrypt\fR and \fB\-decrypt\fR options. When used with \fB\-encrypt\fR or \fB\-decrypt\fR the supplied key is used to wrap or unwrap the -content encryption key using an \s-1AES\s0 key in the \fBKEKRecipientInfo\fR type. +content encryption key using an AES key in the \fBKEKRecipientInfo\fR type. .IP "\fB\-secretkeyid\fR \fIid\fR" 4 .IX Item "-secretkeyid id" The key identifier for the supplied symmetric key for \fBKEKRecipientInfo\fR type. @@ -471,33 +411,36 @@ see \fBopenssl\-passphrase\-options\fR\|(1). For signing and encryption this option can be used multiple times to set customised parameters for the preceding key or certificate. It can currently be used to set RSA-PSS for signing, RSA-OAEP for encryption -or to modify default parameters for \s-1ECDH.\s0 -.IP "\fB\-keyform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR|\fBP12\fR|\fB\s-1ENGINE\s0\fR" 4 +or to modify default parameters for ECDH. +.IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR|\fBENGINE\fR" 4 .IX Item "-keyform DER|PEM|P12|ENGINE" The format of the private key file; unspecified by default. See \fBopenssl\-format\-options\fR\|(1) for details. .IP "\fB\-engine\fR \fIid\fR" 4 .IX Item "-engine id" -See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1). +See "Engine Options" in \fBopenssl\fR\|(1). This option is deprecated. .IP "\fB\-provider\fR \fIname\fR" 4 .IX Item "-provider name" .PD 0 .IP "\fB\-provider\-path\fR \fIpath\fR" 4 .IX Item "-provider-path path" +.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 +.IX Item "-provparam [name:]key=value" .IP "\fB\-propquery\fR \fIpropq\fR" 4 .IX Item "-propquery propq" .PD -See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4 .IX Item "-rand files, -writerand file" -See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details. +See "Random State Options" in \fBopenssl\fR\|(1) for details. .SS "Encryption and decryption options" .IX Subsection "Encryption and decryption options" .IP "\fB\-originator\fR \fIfile\fR" 4 .IX Item "-originator file" A certificate of the originator of the encrypted message. Necessary for -decryption when Key Agreement is in use for a shared key. +decryption when Key Agreement is in use for a shared key. Currently, not +allowed for encryption. .IP "\fB\-recip\fR \fIfile\fR" 4 .IX Item "-recip file" When decrypting a message this specifies the certificate of the recipient. @@ -507,24 +450,24 @@ When encrypting a message this option may be used multiple times to specify each recipient. This form \fBmust\fR be used if customised parameters are required (for example to specify RSA-OAEP). .Sp -Only certificates carrying \s-1RSA,\s0 Diffie-Hellman or \s-1EC\s0 keys are supported by this +Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this option. .IP "\fIrecipient-cert\fR ..." 4 .IX Item "recipient-cert ..." This is an alternative to using the \fB\-recip\fR option when encrypting a message. One or more certificate filenames may be given. -.IP "\fB\-\f(BIcipher\fB\fR" 4 +.IP \fB\-\fR\f(BIcipher\fR 4 .IX Item "-cipher" -The encryption algorithm to use. For example triple \s-1DES\s0 (168 bits) \- \fB\-des3\fR -or 256 bit \s-1AES\s0 \- \fB\-aes256\fR. Any standard algorithm name (as used by the +The encryption algorithm to use. For example, AES (256 bits) \- \fB\-aes256\fR +or triple DES (168 bits) \- \fB\-des3\fR. Any standard algorithm name (as used by the \&\fBEVP_get_cipherbyname()\fR function) can also be used preceded by a dash, for example \fB\-aes\-128\-cbc\fR. See \fBopenssl\-enc\fR\|(1) for a list of ciphers supported by your version of OpenSSL. .Sp -Currently the \s-1AES\s0 variants with \s-1GCM\s0 mode are the only supported \s-1AEAD\s0 +Currently, the AES variants with GCM mode are the only supported AEAD algorithms. .Sp -If not specified triple \s-1DES\s0 is used. Only used with \fB\-encrypt\fR and +If not specified, AES\-256\-CBC is used as the default. Only used with \fB\-encrypt\fR and \&\fB\-EncryptedData_create\fR commands. .IP "\fB\-wrap\fR \fIcipher\fR" 4 .IX Item "-wrap cipher" @@ -533,18 +476,18 @@ Agreement for key transport. The algorithm specified should be suitable for key wrap. .IP "\fB\-aes128\-wrap\fR, \fB\-aes192\-wrap\fR, \fB\-aes256\-wrap\fR, \fB\-des3\-wrap\fR" 4 .IX Item "-aes128-wrap, -aes192-wrap, -aes256-wrap, -des3-wrap" -Use \s-1AES128, AES192, AES256,\s0 or 3DES\-EDE, respectively, to wrap key. +Use AES128, AES192, AES256, or 3DES\-EDE, respectively, to wrap key. Depending on the OpenSSL build options used, \fB\-des3\-wrap\fR may not be supported. -.IP "\fB\-debug_decrypt\fR" 4 +.IP \fB\-debug_decrypt\fR 4 .IX Item "-debug_decrypt" -This option sets the \fB\s-1CMS_DEBUG_DECRYPT\s0\fR flag. This option should be used +This option sets the \fBCMS_DEBUG_DECRYPT\fR flag. This option should be used with caution: see the notes section below. .SS "Signing options" .IX Subsection "Signing options" .IP "\fB\-md\fR \fIdigest\fR" 4 .IX Item "-md digest" Digest algorithm to use when signing or resigning. If not present then the -default digest algorithm for the signing key will be used (usually \s-1SHA1\s0). +default digest algorithm for the signing key will be used (usually SHA1). .IP "\fB\-signer\fR \fIfile\fR" 4 .IX Item "-signer file" A signing certificate. When signing or resigning a message, this option can be @@ -552,36 +495,41 @@ used multiple times if more than one signer is required. .IP "\fB\-certfile\fR \fIfile\fR" 4 .IX Item "-certfile file" Allows additional certificates to be specified. When signing these will -be included with the message. When verifying these will be searched for -the signers certificates. -The input can be in \s-1PEM, DER,\s0 or PKCS#12 format. -.IP "\fB\-cades\fR" 4 +be included with the message. When verifying, these will be searched for +signer certificates and will be used for chain building. +.Sp +The input can be in PEM, DER, or PKCS#12 format. +.IP \fB\-cades\fR 4 .IX Item "-cades" When used with \fB\-sign\fR, -add an \s-1ESS\s0 signingCertificate or \s-1ESS\s0 signingCertificateV2 signed-attribute +add an ESS signingCertificate or ESS signingCertificateV2 signed-attribute to the SignerInfo, in order to make the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). -.IP "\fB\-nodetach\fR" 4 +.IP \fB\-nodetach\fR 4 .IX Item "-nodetach" When signing a message use opaque signing: this form is more resistant to translation by mail relays but it cannot be read by mail agents that do not support S/MIME. Without this option cleartext signing with -the \s-1MIME\s0 type multipart/signed is used. -.IP "\fB\-nocerts\fR" 4 +the MIME type multipart/signed is used. +.IP \fB\-nocerts\fR 4 .IX Item "-nocerts" When signing a message the signer's certificate is normally included with this option it is excluded. This will reduce the size of the signed message but the verifier must have a copy of the signers certificate available locally (passed using the \fB\-certfile\fR option for example). -.IP "\fB\-noattr\fR" 4 +.IP \fB\-noattr\fR 4 .IX Item "-noattr" Normally when a message is signed a set of attributes are included which include the signing time and supported symmetric algorithms. With this option they are not included. -.IP "\fB\-nosmimecap\fR" 4 +.IP \fB\-nosmimecap\fR 4 .IX Item "-nosmimecap" Exclude the list of supported algorithms from signed attributes, other options -such as signing time and content type are still included. +such as content type and (optionally) signing time are still included. +.IP \fB\-no_signing_time\fR 4 +.IX Item "-no_signing_time" +Exclude the signing time from signed attributes, other options +such as content type are still included. .IP "\fB\-receipt_request_all\fR, \fB\-receipt_request_first\fR" 4 .IX Item "-receipt_request_all, -receipt_request_first" For \fB\-sign\fR option include a signed receipt request. Indicate requests should @@ -604,41 +552,41 @@ will be written to this file if the verification was successful. .IP "\fB\-content\fR \fIfilename\fR" 4 .IX Item "-content filename" This specifies a file containing the detached content for operations taking -S/MIME input, such as the \fB\-verify\fR command. This is only usable if the \s-1CMS\s0 +S/MIME input, such as the \fB\-verify\fR command. This is only usable if the CMS structure is using the detached signature form where the content is not included. This option will override any content if the input format -is S/MIME and it uses the multipart/signed \s-1MIME\s0 content type. -.IP "\fB\-no_content_verify\fR" 4 +is S/MIME and it uses the multipart/signed MIME content type. +.IP \fB\-no_content_verify\fR 4 .IX Item "-no_content_verify" Do not verify signed content signatures. -.IP "\fB\-no_attr_verify\fR" 4 +.IP \fB\-no_attr_verify\fR 4 .IX Item "-no_attr_verify" Do not verify signed attribute signatures. -.IP "\fB\-nosigs\fR" 4 +.IP \fB\-nosigs\fR 4 .IX Item "-nosigs" Don't verify message signature. -.IP "\fB\-noverify\fR" 4 +.IP \fB\-noverify\fR 4 .IX Item "-noverify" Do not verify the signers certificate of a signed message. -.IP "\fB\-nointern\fR" 4 +.IP \fB\-nointern\fR 4 .IX Item "-nointern" When verifying a message normally certificates (if any) included in the message are searched for the signing certificate. With this option only the certificates specified in the \fB\-certfile\fR option are used. The supplied certificates can still be used as untrusted CAs however. -.IP "\fB\-cades\fR" 4 +.IP \fB\-cades\fR 4 .IX Item "-cades" When used with \fB\-verify\fR, require and check signer certificate digest. -See the \s-1NOTES\s0 section for more details. -.IP "\fB\-verify_retcode\fR" 4 +See the NOTES section for more details. +.IP \fB\-verify_retcode\fR 4 .IX Item "-verify_retcode" Exit nonzero on verification failure. .IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4 .IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore" -See \*(L"Trusted Certificate Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details. +See "Trusted Certificate Options" in \fBopenssl\-verification\-options\fR\|(1) for details. .SS "Output options" .IX Subsection "Output options" -.IP "\fB\-keyid\fR" 4 +.IP \fB\-keyid\fR 4 .IX Item "-keyid" Use subject key identifier to identify certificates instead of issuer name and serial number. The supplied certificate \fBmust\fR include a subject key @@ -646,13 +594,13 @@ identifier extension. Supported by \fB\-sign\fR and \fB\-encrypt\fR options. .IP "\fB\-econtent_type\fR \fItype\fR" 4 .IX Item "-econtent_type type" Set the encapsulated content type to \fItype\fR if not supplied the \fBData\fR type -is used. The \fItype\fR argument can be any valid \s-1OID\s0 name in either text or +is used. The \fItype\fR argument can be any valid OID name in either text or numerical format. -.IP "\fB\-text\fR" 4 +.IP \fB\-text\fR 4 .IX Item "-text" -This option adds plain text (text/plain) \s-1MIME\s0 headers to the supplied +This option adds plain text (text/plain) MIME headers to the supplied message if encrypting or signing. If decrypting or verifying it strips -off text headers: if the decrypted or verified message is not of \s-1MIME\s0 +off text headers: if the decrypted or verified message is not of MIME type text/plain then an error occurs. .IP "\fB\-certsout\fR \fIfile\fR" 4 .IX Item "-certsout file" @@ -665,13 +613,13 @@ then many S/MIME mail clients check the signers certificate's email address matches that specified in the From: address. .SS "Printing options" .IX Subsection "Printing options" -.IP "\fB\-noout\fR" 4 +.IP \fB\-noout\fR 4 .IX Item "-noout" -For the \fB\-cmsout\fR operation do not output the parsed \s-1CMS\s0 structure. -This is useful if the syntax of the \s-1CMS\s0 structure is being checked. -.IP "\fB\-print\fR" 4 +For the \fB\-cmsout\fR operation do not output the parsed CMS structure. +This is useful if the syntax of the CMS structure is being checked. +.IP \fB\-print\fR 4 .IX Item "-print" -For the \fB\-cmsout\fR operation print out all fields of the \s-1CMS\s0 structure. +For the \fB\-cmsout\fR operation print out all fields of the CMS structure. This implies \fB\-noout\fR. This is mainly useful for testing purposes. .IP "\fB\-nameopt\fR \fIoption\fR" 4 @@ -679,7 +627,7 @@ This is mainly useful for testing purposes. For the \fB\-cmsout\fR operation when \fB\-print\fR option is in use, specifies printing options for string fields. For most cases \fButf8\fR is reasonable value. See \fBopenssl\-namedisplay\-options\fR\|(1) for details. -.IP "\fB\-receipt_request_print\fR" 4 +.IP \fB\-receipt_request_print\fR 4 .IX Item "-receipt_request_print" For the \fB\-verify\fR operation print out the contents of any signed receipt requests. @@ -688,32 +636,32 @@ requests. .IP "\fB\-allow_proxy_certs\fR, \fB\-attime\fR, \fB\-no_check_time\fR, \fB\-check_ss_sig\fR, \fB\-crl_check\fR, \fB\-crl_check_all\fR, \fB\-explicit_policy\fR, \fB\-extended_crl\fR, \fB\-ignore_critical\fR, \fB\-inhibit_any\fR, \fB\-inhibit_map\fR, \fB\-no_alt_chains\fR, \fB\-partial_chain\fR, \fB\-policy\fR, \fB\-policy_check\fR, \fB\-policy_print\fR, \fB\-purpose\fR, \fB\-suiteB_128\fR, \fB\-suiteB_128_only\fR, \fB\-suiteB_192\fR, \fB\-trusted_first\fR, \fB\-use_deltas\fR, \fB\-auth_level\fR, \fB\-verify_depth\fR, \fB\-verify_email\fR, \fB\-verify_hostname\fR, \fB\-verify_ip\fR, \fB\-verify_name\fR, \fB\-x509_strict\fR \fB\-issuer_checks\fR" 4 .IX Item "-allow_proxy_certs, -attime, -no_check_time, -check_ss_sig, -crl_check, -crl_check_all, -explicit_policy, -extended_crl, -ignore_critical, -inhibit_any, -inhibit_map, -no_alt_chains, -partial_chain, -policy, -policy_check, -policy_print, -purpose, -suiteB_128, -suiteB_128_only, -suiteB_192, -trusted_first, -use_deltas, -auth_level, -verify_depth, -verify_email, -verify_hostname, -verify_ip, -verify_name, -x509_strict -issuer_checks" Set various options of certificate chain verification. -See \*(L"Verification Options\*(R" in \fBopenssl\-verification\-options\fR\|(1) for details. +See "Verification Options" in \fBopenssl\-verification\-options\fR\|(1) for details. .Sp Any validation errors cause the command to exit. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" -The \s-1MIME\s0 message must be sent without any blank lines between the +The MIME message must be sent without any blank lines between the headers and the output. Some mail programs will automatically add a blank line. Piping the mail directly to sendmail is one way to achieve the correct format. .PP The supplied message to be signed or encrypted must include the -necessary \s-1MIME\s0 headers or many S/MIME clients won't display it +necessary MIME headers or many S/MIME clients won't display it properly (if at all). You can use the \fB\-text\fR option to automatically add plain text headers. .PP -A \*(L"signed and encrypted\*(R" message is one where a signed message is +A "signed and encrypted" message is one where a signed message is then encrypted. This can be produced by encrypting an already signed message: see the examples section. .PP This version of the program only allows one signer per message but it will verify multiple signers on received messages. Some S/MIME clients choke if a message contains multiple signers. It is possible to sign -messages \*(L"in parallel\*(R" by signing an already signed message. +messages "in parallel" by signing an already signed message. .PP The options \fB\-encrypt\fR and \fB\-decrypt\fR reflect common usage in S/MIME -clients. Strictly speaking these process \s-1CMS\s0 enveloped data: \s-1CMS\s0 +clients. Strictly speaking these process CMS enveloped data: CMS encrypted data is used for other purposes. .PP The \fB\-resign\fR option uses an existing message digest when adding a new @@ -721,63 +669,63 @@ signer. This means that attributes must be present in at least one existing signer using the same message digest or this operation will fail. .PP The \fB\-stream\fR and \fB\-indef\fR options enable streaming I/O support. -As a result the encoding is \s-1BER\s0 using indefinite length constructed encoding -and no longer \s-1DER.\s0 Streaming is supported for the \fB\-encrypt\fR operation and the +As a result the encoding is BER using indefinite length constructed encoding +and no longer DER. Streaming is supported for the \fB\-encrypt\fR operation and the \&\fB\-sign\fR operation if the content is not detached. .PP Streaming is always used for the \fB\-sign\fR operation with detached data but -since the content is no longer part of the \s-1CMS\s0 structure the encoding -remains \s-1DER.\s0 +since the content is no longer part of the CMS structure the encoding +remains DER. .PP If the \fB\-decrypt\fR option is used without a recipient certificate then an attempt is made to locate the recipient by trying each potential recipient -in turn using the supplied private key. To thwart the \s-1MMA\s0 attack -(Bleichenbacher's attack on \s-1PKCS\s0 #1 v1.5 \s-1RSA\s0 padding) all recipients are +in turn using the supplied private key. To thwart the MMA attack +(Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are tried whether they succeed or not and if no recipients match the message -is \*(L"decrypted\*(R" using a random key which will typically output garbage. -The \fB\-debug_decrypt\fR option can be used to disable the \s-1MMA\s0 attack protection +is "decrypted" using a random key which will typically output garbage. +The \fB\-debug_decrypt\fR option can be used to disable the MMA attack protection and return an error if no recipient can be found: this option should be used with caution. For a fuller description see \fBCMS_decrypt\fR\|(3)). .SH "CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)" .IX Header "CADES BASIC ELECTRONIC SIGNATURE (CADES-BES)" A CAdES Basic Electronic Signature (CAdES-BES), -as defined in the European Standard \s-1ETSI EN 319 122\-1 V1.1.1,\s0 contains: -.IP "\(bu" 4 -The signed user data as defined in \s-1CMS\s0 (\s-1RFC 3852\s0); -.IP "\(bu" 4 +as defined in the European Standard ETSI EN 319 122\-1 V1.1.1, contains: +.IP \(bu 4 +The signed user data as defined in CMS (RFC 3852); +.IP \(bu 4 Content-type of the EncapsulatedContentInfo value being signed; -.IP "\(bu" 4 -Message-digest of the eContent \s-1OCTET STRING\s0 within encapContentInfo being signed; -.IP "\(bu" 4 -An \s-1ESS\s0 signingCertificate or \s-1ESS\s0 signingCertificateV2 attribute, -as defined in Enhanced Security Services (\s-1ESS\s0), \s-1RFC 2634\s0 and \s-1RFC 5035.\s0 -An \s-1ESS\s0 signingCertificate attribute only allows for \s-1SHA\-1\s0 as digest algorithm. -An \s-1ESS\s0 signingCertificateV2 attribute allows for any digest algorithm. -.IP "\(bu" 4 +.IP \(bu 4 +Message-digest of the eContent OCTET STRING within encapContentInfo being signed; +.IP \(bu 4 +An ESS signingCertificate or ESS signingCertificateV2 attribute, +as defined in Enhanced Security Services (ESS), RFC 2634 and RFC 5035. +An ESS signingCertificate attribute only allows for SHA\-1 as digest algorithm. +An ESS signingCertificateV2 attribute allows for any digest algorithm. +.IP \(bu 4 The digital signature value computed on the user data and, when present, on the signed attributes. .Sp -\&\s-1NOTE\s0 that the \fB\-cades\fR option applies to the \fB\-sign\fR or \fB\-verify\fR operations. +NOTE that the \fB\-cades\fR option applies to the \fB\-sign\fR or \fB\-verify\fR operations. With this option, the \fB\-verify\fR operation also requires that the signingCertificate attribute is present and checks that the given identifiers match the verification trust chain built during the verification process. .SH "EXIT CODES" .IX Header "EXIT CODES" -.IP "0" 4 +.IP 0 4 The operation was completely successfully. -.IP "1" 4 +.IP 1 4 .IX Item "1" An error occurred parsing the command options. -.IP "2" 4 +.IP 2 4 .IX Item "2" One of the input files could not be read. -.IP "3" 4 +.IP 3 4 .IX Item "3" -An error occurred creating the \s-1CMS\s0 file or when reading the \s-1MIME\s0 +An error occurred creating the CMS file or when reading the MIME message. -.IP "4" 4 +.IP 4 4 .IX Item "4" An error occurred decrypting or verifying the message. -.IP "5" 4 +.IP 5 4 .IX Item "5" The message was verified correctly but an error occurred writing out the signers certificates. @@ -790,19 +738,19 @@ applications which only support the older format. These are detailed below. .PP The use of the \fB\-keyid\fR option with \fB\-sign\fR or \fB\-encrypt\fR. .PP -The \fB\-outform\fR \fI\s-1PEM\s0\fR option uses different headers. +The \fB\-outform\fR \fIPEM\fR option uses different headers. .PP The \fB\-compress\fR option. .PP The \fB\-secretkey\fR option when used with \fB\-encrypt\fR. .PP -The use of \s-1PSS\s0 with \fB\-sign\fR. +The use of PSS with \fB\-sign\fR. .PP -The use of \s-1OAEP\s0 or non-RSA keys with \fB\-encrypt\fR. +The use of OAEP or non-RSA keys with \fB\-encrypt\fR. .PP Additionally the \fB\-EncryptedData_create\fR and \fB\-data_create\fR type cannot be processed by the older \fBopenssl\-smime\fR\|(1) command. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" Create a cleartext signed message: .PP @@ -847,7 +795,7 @@ Verify a message and extract the signer's certificate if successful: \& openssl cms \-verify \-in mail.msg \-signer user.pem \-out signedtext.txt .Ve .PP -Send encrypted mail using triple \s-1DES:\s0 +Send encrypted mail using triple DES: .PP .Vb 3 \& openssl cms \-encrypt \-in in.txt \-from steve@openssl.org \e @@ -865,7 +813,7 @@ Sign and encrypt mail: .Ve .PP Note: the encryption command does not include the \fB\-text\fR option because the -message being encrypted already has \s-1MIME\s0 headers. +message being encrypted already has MIME headers. .PP Decrypt a message: .PP @@ -921,19 +869,19 @@ Create an encrypted message using RSA-OAEP: \& \-recip cert.pem \-keyopt rsa_padding_mode:oaep .Ve .PP -Use \s-1SHA256 KDF\s0 with an \s-1ECDH\s0 certificate: +Use SHA256 KDF with an ECDH certificate: .PP .Vb 2 \& openssl cms \-encrypt \-in plain.txt \-out mail.msg \e \& \-recip ecdhcert.pem \-keyopt ecdh_kdf_md:sha256 .Ve .PP -Print \s-1CMS\s0 signed binary data in human-readable form: +Print CMS signed binary data in human-readable form: .PP -openssl cms \-in signed.cms \-binary \-inform \s-1DER\s0 \-cmsout \-print -.SH "BUGS" +openssl cms \-in signed.cms \-binary \-inform DER \-cmsout \-print +.SH BUGS .IX Header "BUGS" -The \s-1MIME\s0 parser isn't very clever: it seems to handle most messages that I've +The MIME parser isn't very clever: it seems to handle most messages that I've thrown at it but it may choke on others. .PP The code currently will only write out the signer's certificate to a file: if @@ -953,8 +901,10 @@ No revocation checking is done on the signer's certificate. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBossl_store\-file\fR\|(7) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" +The default encryption cipher was changed from 3DES to AES\-256 in OpenSSL 3.5. +.PP The use of multiple \fB\-signer\fR options and the \fB\-resign\fR command were first added in OpenSSL 1.0.0. .PP @@ -970,11 +920,13 @@ The \-no_alt_chains option was added in OpenSSL 1.0.2b. The \fB\-nameopt\fR option was added in OpenSSL 3.0.0. .PP The \fB\-engine\fR option was deprecated in OpenSSL 3.0. -.SH "COPYRIGHT" +.PP +The \fB\-digest\fR option was added in OpenSSL 3.2. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2008\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2008\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |