]>
Commit | Line | Data |
---|---|---|
7122aafc | 1 | =pod |
625c781d | 2 | {- OpenSSL::safe::output_do_not_edit_headers(); -} |
9fcb9702 | 3 | |
7122aafc DSH |
4 | =head1 NAME |
5 | ||
4b537191 | 6 | openssl-cms - CMS command |
7122aafc DSH |
7 | |
8 | =head1 SYNOPSIS | |
9 | ||
10 | B<openssl> B<cms> | |
169394d4 | 11 | [B<-help>] |
7122aafc DSH |
12 | [B<-encrypt>] |
13 | [B<-decrypt>] | |
65718c51 | 14 | [B<-debug_decrypt>] |
7122aafc | 15 | [B<-sign>] |
7122aafc | 16 | [B<-verify>] |
65718c51 RS |
17 | [B<-verify_retcode>] |
18 | [B<-no_attr_verify>] | |
19 | [B<-nosigs>] | |
20 | [B<-no_content_verify>] | |
7122aafc | 21 | [B<-cmsout>] |
41f81a01 | 22 | [B<-resign>] |
e85d19c6 | 23 | [B<-cades>] |
41f81a01 DSH |
24 | [B<-data_create>] |
25 | [B<-data_out>] | |
26 | [B<-digest_create>] | |
27 | [B<-digest_verify>] | |
28 | [B<-compress>] | |
29 | [B<-uncompress>] | |
65718c51 | 30 | [B<-EncryptedData_decrypt>] |
41f81a01 DSH |
31 | [B<-EncryptedData_encrypt>] |
32 | [B<-sign_receipt>] | |
e8769719 RS |
33 | [B<-verify_receipt> I<receipt>] |
34 | [B<-in> I<filename>] | |
e8769719 | 35 | [B<-out> I<filename>] |
777182a0 | 36 | [B<-inform> B<DER>|B<PEM>|B<SMIME>] |
e8769719 | 37 | [B<-outform> B<DER>|B<PEM>|B<SMIME>] |
777182a0 | 38 | [B<-rctform> B<DER>|B<PEM>|B<SMIME>] |
6d382c74 | 39 | [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>] |
e8769719 RS |
40 | [B<-stream>] |
41 | [B<-indef>] | |
41f81a01 | 42 | [B<-noindef>] |
e8769719 | 43 | [B<-content> I<filename>] |
41f81a01 DSH |
44 | [B<-text>] |
45 | [B<-noout>] | |
46 | [B<-print>] | |
922f1565 | 47 | [B<-nameopt> I<option>] |
e8769719 | 48 | [B<-md> I<digest>] |
8dc57d76 | 49 | [B<-I<cipher>>] |
34890077 | 50 | [B<-wrap> I<cipher>] |
41f81a01 | 51 | [B<-nointern>] |
e75138ab | 52 | [B<-noverify>] |
41f81a01 DSH |
53 | [B<-nocerts>] |
54 | [B<-noattr>] | |
55 | [B<-nosmimecap>] | |
56 | [B<-binary>] | |
2197494d | 57 | [B<-crlfeol>] |
847865d0 | 58 | [B<-asciicrlf>] |
41f81a01 | 59 | [B<-nodetach>] |
68581885 | 60 | [B<-certfile> I<file>] |
e8769719 RS |
61 | [B<-certsout> I<file>] |
62 | [B<-signer> I<file>] | |
34890077 | 63 | [B<-originator> I<file>] |
e8769719 | 64 | [B<-recip> I<file>] |
41f81a01 | 65 | [B<-keyid>] |
dfee8626 RS |
66 | [B<-receipt_request_all>] |
67 | [B<-receipt_request_first>] | |
e8769719 RS |
68 | [B<-receipt_request_from> I<emailaddress>] |
69 | [B<-receipt_request_to> I<emailaddress>] | |
41f81a01 | 70 | [B<-receipt_request_print>] |
65718c51 | 71 | [B<-pwri_password> I<password>] |
e8769719 RS |
72 | [B<-secretkey> I<key>] |
73 | [B<-secretkeyid> I<id>] | |
74 | [B<-econtent_type> I<type>] | |
75 | [B<-inkey> I<file>] | |
76 | [B<-keyopt> I<name>:I<parameter>] | |
77 | [B<-passin> I<arg>] | |
e8769719 RS |
78 | [B<-to> I<addr>] |
79 | [B<-from> I<addr>] | |
80 | [B<-subject> I<subj>] | |
21d08b9e | 81 | {- $OpenSSL::safe::opt_v_synopsis -} |
9fcb9702 RS |
82 | {- $OpenSSL::safe::opt_trust_synopsis -} |
83 | {- $OpenSSL::safe::opt_r_synopsis -} | |
65718c51 | 84 | {- $OpenSSL::safe::opt_engine_synopsis -} |
6bd4e3f2 | 85 | {- $OpenSSL::safe::opt_provider_synopsis -} |
c1669f41 | 86 | {- $OpenSSL::safe::opt_config_synopsis -} |
6d382c74 | 87 | [I<recipient-cert> ...] |
7122aafc | 88 | |
9f3c076b | 89 | =for openssl ifdef des-wrap engine |
1738c0ce | 90 | |
7122aafc DSH |
91 | =head1 DESCRIPTION |
92 | ||
35a810bb RL |
93 | This command handles S/MIME v3.1 mail. It can encrypt, decrypt, |
94 | sign and verify, compress and uncompress S/MIME messages. | |
7122aafc | 95 | |
3dfda1a6 | 96 | =head1 OPTIONS |
7122aafc | 97 | |
41f81a01 DSH |
98 | There are fourteen operation options that set the type of operation to be |
99 | performed. The meaning of the other options varies according to the operation | |
7122aafc DSH |
100 | type. |
101 | ||
102 | =over 4 | |
103 | ||
169394d4 MR |
104 | =item B<-help> |
105 | ||
106 | Print out a usage message. | |
107 | ||
7122aafc DSH |
108 | =item B<-encrypt> |
109 | ||
c4de074e | 110 | Encrypt mail for the given recipient certificates. Input file is the message |
7122aafc | 111 | to be encrypted. The output file is the encrypted mail in MIME format. The |
3f2a8d97 | 112 | actual CMS type is B<EnvelopedData>. |
7122aafc | 113 | |
2a9afa40 RS |
114 | Note that no revocation check is done for the recipient cert, so if that |
115 | key has been compromised, others may be able to decrypt the text. | |
116 | ||
7122aafc DSH |
117 | =item B<-decrypt> |
118 | ||
c4de074e | 119 | Decrypt mail using the supplied certificate and private key. Expects an |
7122aafc DSH |
120 | encrypted mail message in MIME format for the input file. The decrypted mail |
121 | is written to the output file. | |
122 | ||
0dd5b94a DSH |
123 | =item B<-debug_decrypt> |
124 | ||
c4de074e | 125 | This option sets the B<CMS_DEBUG_DECRYPT> flag. This option should be used |
0dd5b94a DSH |
126 | with caution: see the notes section below. |
127 | ||
7122aafc DSH |
128 | =item B<-sign> |
129 | ||
c4de074e | 130 | Sign mail using the supplied certificate and private key. Input file is |
7122aafc DSH |
131 | the message to be signed. The signed message in MIME format is written |
132 | to the output file. | |
133 | ||
134 | =item B<-verify> | |
135 | ||
c4de074e | 136 | Verify signed mail. Expects a signed mail message on input and outputs |
7122aafc DSH |
137 | the signed data. Both clear text and opaque signing is supported. |
138 | ||
65718c51 RS |
139 | =item B<-verify_retcode> |
140 | ||
141 | Exit nonzero on verification failure. | |
142 | ||
143 | =item B<-no_attr_verify> | |
144 | ||
145 | Do not verify signed attribute signatures. | |
146 | ||
147 | =item B<-no_content_verify> | |
148 | ||
149 | Do not verify signed content signatures. | |
150 | ||
151 | =item B<-nosigs> | |
152 | ||
153 | Don't verify message signature. | |
154 | ||
7122aafc DSH |
155 | =item B<-cmsout> |
156 | ||
c4de074e | 157 | Takes an input message and writes out a PEM encoded CMS structure. |
7122aafc DSH |
158 | |
159 | =item B<-resign> | |
160 | ||
c4de074e | 161 | Resign a message: take an existing message and one or more new signers. |
7122aafc | 162 | |
e85d19c6 AI |
163 | =item B<-cades> |
164 | ||
165 | Add an ESS signing-certificate or ESS signing-certificate-v2 signed-attribute to the SignerInfo, in order to make | |
166 | the signature comply with the requirements for a CAdES Basic Electronic Signature (CAdES-BES). See the NOTES | |
167 | section for more details. | |
168 | ||
7122aafc DSH |
169 | =item B<-data_create> |
170 | ||
171 | Create a CMS B<Data> type. | |
172 | ||
173 | =item B<-data_out> | |
174 | ||
175 | B<Data> type and output the content. | |
176 | ||
177 | =item B<-digest_create> | |
178 | ||
179 | Create a CMS B<DigestedData> type. | |
180 | ||
181 | =item B<-digest_verify> | |
182 | ||
183 | Verify a CMS B<DigestedData> type and output the content. | |
184 | ||
185 | =item B<-compress> | |
186 | ||
187 | Create a CMS B<CompressedData> type. OpenSSL must be compiled with B<zlib> | |
188 | support for this option to work, otherwise it will output an error. | |
189 | ||
190 | =item B<-uncompress> | |
191 | ||
192 | Uncompress a CMS B<CompressedData> type and output the content. OpenSSL must be | |
193 | compiled with B<zlib> support for this option to work, otherwise it will | |
194 | output an error. | |
195 | ||
65718c51 RS |
196 | =item B<-EncryptedData_decrypt> |
197 | ||
198 | Decrypt content using supplied symmetric key and algorithm using a CMS | |
199 | B<EncryptedData> type and output the content. | |
200 | ||
7122aafc DSH |
201 | =item B<-EncryptedData_encrypt> |
202 | ||
a9661e45 | 203 | Encrypt content using supplied symmetric key and algorithm using a CMS |
27b138e9 | 204 | B<EncryptedData> type and output the content. |
7122aafc | 205 | |
41f81a01 DSH |
206 | =item B<-sign_receipt> |
207 | ||
1bc74519 | 208 | Generate and output a signed receipt for the supplied message. The input |
41f81a01 DSH |
209 | message B<must> contain a signed receipt request. Functionality is otherwise |
210 | similar to the B<-sign> operation. | |
211 | ||
e8769719 | 212 | =item B<-verify_receipt> I<receipt> |
41f81a01 | 213 | |
1bc74519 | 214 | Verify a signed receipt in filename B<receipt>. The input message B<must> |
41f81a01 DSH |
215 | contain the original receipt request. Functionality is otherwise similar |
216 | to the B<-verify> operation. | |
217 | ||
e8769719 | 218 | =item B<-in> I<filename> |
7122aafc | 219 | |
c4de074e | 220 | The input message to be encrypted or signed or the message to be decrypted |
41f81a01 | 221 | or verified. |
7122aafc | 222 | |
777182a0 RS |
223 | =item B<-out> I<filename> |
224 | ||
225 | The message text that has been decrypted or verified or the output MIME | |
226 | format message that has been signed or verified. | |
227 | ||
e8769719 | 228 | =item B<-inform> B<DER>|B<PEM>|B<SMIME> |
7122aafc | 229 | |
777182a0 RS |
230 | The input format of the CMS structure (if one is being read); |
231 | the default is B<SMIME>. | |
232 | See L<openssl(1)/Format Options> for details. | |
7122aafc | 233 | |
777182a0 | 234 | =item B<-outform> B<DER>|B<PEM>|B<SMIME> |
41f81a01 | 235 | |
777182a0 RS |
236 | The output format of the CMS structure (if one is being written); |
237 | the default is B<SMIME>. | |
238 | See L<openssl(1)/Format Options> for details. | |
41f81a01 | 239 | |
6d382c74 | 240 | =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE> |
7122aafc | 241 | |
777182a0 | 242 | The format of the private key file; the default is B<PEM>. |
6d382c74 | 243 | The only value with effect is B<ENGINE>; all others have become obsolete. |
777182a0 | 244 | See L<openssl(1)/Format Options> for details. |
7122aafc | 245 | |
777182a0 | 246 | =item B<-rctform> B<DER>|B<PEM>|B<SMIME> |
7122aafc | 247 | |
777182a0 RS |
248 | The signed receipt format for use with the B<-receipt_verify>; the default |
249 | is B<SMIME>. | |
250 | See L<openssl(1)/Format Options> for details. | |
7122aafc | 251 | |
65718c51 | 252 | =item B<-stream>, B<-indef> |
7122aafc | 253 | |
c4de074e | 254 | The B<-stream> and B<-indef> options are equivalent and enable streaming I/O |
7122aafc DSH |
255 | for encoding operations. This permits single pass processing of data without |
256 | the need to hold the entire contents in memory, potentially supporting very | |
257 | large files. Streaming is automatically set for S/MIME signing with detached | |
258 | data if the output format is B<SMIME> it is currently off by default for all | |
259 | other operations. | |
260 | ||
261 | =item B<-noindef> | |
262 | ||
c4de074e | 263 | Disable streaming I/O where it would produce and indefinite length constructed |
7122aafc DSH |
264 | encoding. This option currently has no effect. In future streaming will be |
265 | enabled by default on all relevant operations and this option will disable it. | |
266 | ||
e8769719 | 267 | =item B<-content> I<filename> |
7122aafc DSH |
268 | |
269 | This specifies a file containing the detached content, this is only | |
270 | useful with the B<-verify> command. This is only usable if the CMS | |
271 | structure is using the detached signature form where the content is | |
272 | not included. This option will override any content if the input format | |
273 | is S/MIME and it uses the multipart/signed MIME content type. | |
274 | ||
275 | =item B<-text> | |
276 | ||
c4de074e | 277 | This option adds plain text (text/plain) MIME headers to the supplied |
7122aafc | 278 | message if encrypting or signing. If decrypting or verifying it strips |
1bc74519 | 279 | off text headers: if the decrypted or verified message is not of MIME |
7122aafc DSH |
280 | type text/plain then an error occurs. |
281 | ||
41f81a01 DSH |
282 | =item B<-noout> |
283 | ||
c4de074e | 284 | For the B<-cmsout> operation do not output the parsed CMS structure. This |
41f81a01 DSH |
285 | is useful when combined with the B<-print> option or if the syntax of the CMS |
286 | structure is being checked. | |
287 | ||
288 | =item B<-print> | |
289 | ||
c4de074e | 290 | For the B<-cmsout> operation print out all fields of the CMS structure. This |
41f81a01 DSH |
291 | is mainly useful for testing purposes. |
292 | ||
922f1565 DB |
293 | =item B<-nameopt> I<option> |
294 | ||
295 | For the B<-cmsout> operation when B<-print> option is in use, specifies | |
296 | printing options for string fields. For most cases B<utf8> is reasonable value. | |
297 | See L<openssl(1)/Name Format Options> for details. | |
298 | ||
e8769719 | 299 | =item B<-md> I<digest> |
7122aafc | 300 | |
c4de074e | 301 | Digest algorithm to use when signing or resigning. If not present then the |
7122aafc DSH |
302 | default digest algorithm for the signing key will be used (usually SHA1). |
303 | ||
8dc57d76 | 304 | =item B<-I<cipher>> |
7122aafc | 305 | |
c4de074e | 306 | The encryption algorithm to use. For example triple DES (168 bits) - B<-des3> |
e5fa864f | 307 | or 256 bit AES - B<-aes256>. Any standard algorithm name (as used by the |
1bc74519 | 308 | EVP_get_cipherbyname() function) can also be used preceded by a dash, for |
8bc93d2f | 309 | example B<-aes-128-cbc>. See L<openssl-enc(1)> for a list of ciphers |
e5fa864f | 310 | supported by your version of OpenSSL. |
7122aafc | 311 | |
1bc74519 | 312 | If not specified triple DES is used. Only used with B<-encrypt> and |
7122aafc DSH |
313 | B<-EncryptedData_create> commands. |
314 | ||
34890077 DB |
315 | =item B<-wrap> I<cipher> |
316 | ||
317 | Cipher algorithm to use for key wrap when encrypting the message using Key | |
318 | Agreement for key transport. The algorithm specified should be suitable for key | |
319 | wrap. | |
320 | ||
7122aafc DSH |
321 | =item B<-nointern> |
322 | ||
c4de074e | 323 | When verifying a message normally certificates (if any) included in |
7122aafc DSH |
324 | the message are searched for the signing certificate. With this option |
325 | only the certificates specified in the B<-certfile> option are used. | |
326 | The supplied certificates can still be used as untrusted CAs however. | |
327 | ||
e75138ab | 328 | =item B<-noverify> |
7122aafc | 329 | |
c4de074e | 330 | Do not verify the signers certificate of a signed message. |
7122aafc DSH |
331 | |
332 | =item B<-nocerts> | |
333 | ||
c4de074e | 334 | When signing a message the signer's certificate is normally included |
7122aafc DSH |
335 | with this option it is excluded. This will reduce the size of the |
336 | signed message but the verifier must have a copy of the signers certificate | |
337 | available locally (passed using the B<-certfile> option for example). | |
338 | ||
339 | =item B<-noattr> | |
340 | ||
c4de074e | 341 | Normally when a message is signed a set of attributes are included which |
7122aafc DSH |
342 | include the signing time and supported symmetric algorithms. With this |
343 | option they are not included. | |
344 | ||
345 | =item B<-nosmimecap> | |
346 | ||
c4de074e | 347 | Exclude the list of supported algorithms from signed attributes, other options |
7122aafc DSH |
348 | such as signing time and content type are still included. |
349 | ||
350 | =item B<-binary> | |
351 | ||
c4de074e | 352 | Normally the input message is converted to "canonical" format which is |
7122aafc DSH |
353 | effectively using CR and LF as end of line: as required by the S/MIME |
354 | specification. When this option is present no translation occurs. This | |
355 | is useful when handling binary data which may not be in MIME format. | |
356 | ||
2197494d DSH |
357 | =item B<-crlfeol> |
358 | ||
c4de074e | 359 | Normally the output file uses a single B<LF> as end of line. When this |
2197494d DSH |
360 | option is present B<CRLF> is used instead. |
361 | ||
847865d0 DSH |
362 | =item B<-asciicrlf> |
363 | ||
c4de074e | 364 | When signing use ASCII CRLF format canonicalisation. This strips trailing |
847865d0 DSH |
365 | whitespace from all lines, deletes trailing blank lines at EOF and sets |
366 | the encapsulated content type. This option is normally used with detached | |
367 | content and an output signature format of DER. This option is not normally | |
368 | needed when verifying as it is enabled automatically if the encapsulated | |
369 | content format is detected. | |
370 | ||
7122aafc DSH |
371 | =item B<-nodetach> |
372 | ||
c4de074e | 373 | When signing a message use opaque signing: this form is more resistant |
7122aafc DSH |
374 | to translation by mail relays but it cannot be read by mail agents that |
375 | do not support S/MIME. Without this option cleartext signing with | |
376 | the MIME type multipart/signed is used. | |
377 | ||
e8769719 | 378 | =item B<-certfile> I<file> |
7122aafc | 379 | |
c4de074e | 380 | Allows additional certificates to be specified. When signing these will |
7122aafc | 381 | be included with the message. When verifying these will be searched for |
6d382c74 | 382 | the signers certificates. |
7122aafc | 383 | |
e8769719 | 384 | =item B<-certsout> I<file> |
4a954b56 | 385 | |
2f0ea936 | 386 | Any certificates contained in the message are written to I<file>. |
4a954b56 | 387 | |
e8769719 | 388 | =item B<-signer> I<file> |
7122aafc | 389 | |
c4de074e | 390 | A signing certificate when signing or resigning a message, this option can be |
7122aafc DSH |
391 | used multiple times if more than one signer is required. If a message is being |
392 | verified then the signers certificates will be written to this file if the | |
393 | verification was successful. | |
394 | ||
34890077 DB |
395 | =item B<-originator> I<file> |
396 | ||
397 | A certificate of the originator of the encrypted message. Necessary for | |
398 | decryption when Key Agreement is in use for a shared key. | |
399 | ||
e8769719 | 400 | =item B<-recip> I<file> |
7122aafc | 401 | |
c4de074e | 402 | When decrypting a message this specifies the recipients certificate. The |
4bf4a650 DSH |
403 | certificate must match one of the recipients of the message or an error |
404 | occurs. | |
405 | ||
406 | When encrypting a message this option may be used multiple times to specify | |
407 | each recipient. This form B<must> be used if customised parameters are | |
408 | required (for example to specify RSA-OAEP). | |
7122aafc | 409 | |
ecd4b8fe MC |
410 | Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this |
411 | option. | |
412 | ||
7122aafc DSH |
413 | =item B<-keyid> |
414 | ||
c4de074e | 415 | Use subject key identifier to identify certificates instead of issuer name and |
7122aafc DSH |
416 | serial number. The supplied certificate B<must> include a subject key |
417 | identifier extension. Supported by B<-sign> and B<-encrypt> options. | |
418 | ||
dfee8626 | 419 | =item B<-receipt_request_all>, B<-receipt_request_first> |
41f81a01 | 420 | |
c4de074e | 421 | For B<-sign> option include a signed receipt request. Indicate requests should |
4c583c36 | 422 | be provided by all recipient or first tier recipients (those mailed directly |
41f81a01 DSH |
423 | and not from a mailing list). Ignored it B<-receipt_request_from> is included. |
424 | ||
e8769719 | 425 | =item B<-receipt_request_from> I<emailaddress> |
41f81a01 | 426 | |
c4de074e | 427 | For B<-sign> option include a signed receipt request. Add an explicit email |
41f81a01 DSH |
428 | address where receipts should be supplied. |
429 | ||
e8769719 | 430 | =item B<-receipt_request_to> I<emailaddress> |
41f81a01 | 431 | |
1bc74519 | 432 | Add an explicit email address where signed receipts should be sent to. This |
41f81a01 DSH |
433 | option B<must> but supplied if a signed receipt it requested. |
434 | ||
435 | =item B<-receipt_request_print> | |
436 | ||
437 | For the B<-verify> operation print out the contents of any signed receipt | |
438 | requests. | |
439 | ||
65718c51 RS |
440 | =item B<-pwri_password> I<password> |
441 | ||
442 | Specify password for recipient. | |
443 | ||
e8769719 | 444 | =item B<-secretkey> I<key> |
7122aafc | 445 | |
c4de074e | 446 | Specify symmetric key to use. The key must be supplied in hex format and be |
7122aafc | 447 | consistent with the algorithm used. Supported by the B<-EncryptedData_encrypt> |
4c583c36 | 448 | B<-EncryptedData_decrypt>, B<-encrypt> and B<-decrypt> options. When used |
7122aafc DSH |
449 | with B<-encrypt> or B<-decrypt> the supplied key is used to wrap or unwrap the |
450 | content encryption key using an AES key in the B<KEKRecipientInfo> type. | |
451 | ||
e8769719 | 452 | =item B<-secretkeyid> I<id> |
7122aafc | 453 | |
c4de074e | 454 | The key identifier for the supplied symmetric key for B<KEKRecipientInfo> type. |
7122aafc | 455 | This option B<must> be present if the B<-secretkey> option is used with |
2f0ea936 | 456 | B<-encrypt>. With B<-decrypt> operations the I<id> is used to locate the |
7122aafc DSH |
457 | relevant key if it is not supplied then an attempt is used to decrypt any |
458 | B<KEKRecipientInfo> structures. | |
459 | ||
e8769719 | 460 | =item B<-econtent_type> I<type> |
7122aafc | 461 | |
2f0ea936 RL |
462 | Set the encapsulated content type to I<type> if not supplied the B<Data> type |
463 | is used. The I<type> argument can be any valid OID name in either text or | |
1bc74519 | 464 | numerical format. |
7122aafc | 465 | |
e8769719 | 466 | =item B<-inkey> I<file> |
7122aafc | 467 | |
c4de074e | 468 | The private key to use when signing or decrypting. This must match the |
7122aafc DSH |
469 | corresponding certificate. If this option is not specified then the |
470 | private key must be included in the certificate file specified with | |
471 | the B<-recip> or B<-signer> file. When signing this option can be used | |
472 | multiple times to specify successive keys. | |
473 | ||
e8769719 | 474 | =item B<-keyopt> I<name>:I<parameter> |
4bf4a650 | 475 | |
c4de074e | 476 | For signing and encryption this option can be used multiple times to |
4bf4a650 | 477 | set customised parameters for the preceding key or certificate. It can |
dfcb42c6 DSH |
478 | currently be used to set RSA-PSS for signing, RSA-OAEP for encryption |
479 | or to modify default parameters for ECDH. | |
4bf4a650 | 480 | |
e8769719 | 481 | =item B<-passin> I<arg> |
7122aafc | 482 | |
c4de074e | 483 | The private key password source. For more information about the format of B<arg> |
3a4e43de | 484 | see L<openssl(1)/Pass Phrase Options>. |
7122aafc | 485 | |
e8769719 | 486 | =item B<-to>, B<-from>, B<-subject> |
7122aafc | 487 | |
c4de074e | 488 | The relevant mail headers. These are included outside the signed |
7122aafc DSH |
489 | portion of a message so they may be included manually. If signing |
490 | then many S/MIME mail clients check the signers certificate's email | |
491 | address matches that specified in the From: address. | |
492 | ||
21d08b9e | 493 | {- $OpenSSL::safe::opt_v_item -} |
e5fa864f | 494 | |
21d08b9e | 495 | Any verification errors cause the command to exit. |
e5fa864f | 496 | |
9fcb9702 RS |
497 | {- $OpenSSL::safe::opt_trust_item -} |
498 | ||
499 | {- $OpenSSL::safe::opt_r_item -} | |
500 | ||
65718c51 RS |
501 | {- $OpenSSL::safe::opt_engine_item -} |
502 | ||
6bd4e3f2 P |
503 | {- $OpenSSL::safe::opt_provider_item -} |
504 | ||
c1669f41 SL |
505 | {- $OpenSSL::safe::opt_config_item -} |
506 | ||
6d382c74 | 507 | =item I<recipient-cert> ... |
9fcb9702 RS |
508 | |
509 | One or more certificates of message recipients: used when encrypting | |
510 | a message. | |
511 | ||
7122aafc DSH |
512 | =back |
513 | ||
514 | =head1 NOTES | |
515 | ||
516 | The MIME message must be sent without any blank lines between the | |
517 | headers and the output. Some mail programs will automatically add | |
518 | a blank line. Piping the mail directly to sendmail is one way to | |
519 | achieve the correct format. | |
520 | ||
521 | The supplied message to be signed or encrypted must include the | |
60250017 | 522 | necessary MIME headers or many S/MIME clients won't display it |
7122aafc DSH |
523 | properly (if at all). You can use the B<-text> option to automatically |
524 | add plain text headers. | |
525 | ||
526 | A "signed and encrypted" message is one where a signed message is | |
527 | then encrypted. This can be produced by encrypting an already signed | |
528 | message: see the examples section. | |
529 | ||
530 | This version of the program only allows one signer per message but it | |
531 | will verify multiple signers on received messages. Some S/MIME clients | |
532 | choke if a message contains multiple signers. It is possible to sign | |
533 | messages "in parallel" by signing an already signed message. | |
534 | ||
535 | The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME | |
536 | clients. Strictly speaking these process CMS enveloped data: CMS | |
537 | encrypted data is used for other purposes. | |
538 | ||
539 | The B<-resign> option uses an existing message digest when adding a new | |
540 | signer. This means that attributes must be present in at least one existing | |
541 | signer using the same message digest or this operation will fail. | |
542 | ||
e4ef2e25 | 543 | The B<-stream> and B<-indef> options enable streaming I/O support. |
7122aafc DSH |
544 | As a result the encoding is BER using indefinite length constructed encoding |
545 | and no longer DER. Streaming is supported for the B<-encrypt> operation and the | |
546 | B<-sign> operation if the content is not detached. | |
547 | ||
548 | Streaming is always used for the B<-sign> operation with detached data but | |
549 | since the content is no longer part of the CMS structure the encoding | |
550 | remains DER. | |
551 | ||
0dd5b94a DSH |
552 | If the B<-decrypt> option is used without a recipient certificate then an |
553 | attempt is made to locate the recipient by trying each potential recipient | |
554 | in turn using the supplied private key. To thwart the MMA attack | |
555 | (Bleichenbacher's attack on PKCS #1 v1.5 RSA padding) all recipients are | |
556 | tried whether they succeed or not and if no recipients match the message | |
1bc74519 | 557 | is "decrypted" using a random key which will typically output garbage. |
0dd5b94a DSH |
558 | The B<-debug_decrypt> option can be used to disable the MMA attack protection |
559 | and return an error if no recipient can be found: this option should be used | |
9b86974e | 560 | with caution. For a fuller description see L<CMS_decrypt(3)>). |
0dd5b94a | 561 | |
485d3361 | 562 | =head1 CADES BASIC ELECTRONIC SIGNATURE (CADES-BES) |
e85d19c6 AI |
563 | |
564 | A CAdES Basic Electronic Signature (CAdES-BES), as defined in the European Standard ETSI EN 319 122-1 V1.1.1, contains: | |
565 | ||
566 | =over 4 | |
567 | ||
568 | =item * | |
569 | ||
570 | The signed user data as defined in CMS (RFC 3852); | |
571 | ||
572 | =item * | |
573 | ||
574 | Content-type of the EncapsulatedContentInfo value being signed; | |
575 | ||
576 | =item * | |
577 | ||
578 | Message-digest of the eContent OCTET STRING within encapContentInfo being signed; | |
579 | ||
580 | =item * | |
581 | ||
9e3c510b F |
582 | An ESS signing-certificate or ESS signing-certificate-v2 attribute, as defined |
583 | in Enhanced Security Services (ESS), RFC 2634 and RFC 5035. | |
e85d19c6 AI |
584 | An ESS signing-certificate attribute only allows for the use of SHA-1 as a digest algorithm. |
585 | An ESS signing-certificate-v2 attribute allows for the use of any digest algorithm. | |
586 | ||
587 | =item * | |
588 | ||
589 | The digital signature value computed on the user data and, when present, on the signed attributes. | |
590 | ||
9e3c510b F |
591 | NOTE that the B<-cades> option applies to the B<-sign> or B<-verify> operations. |
592 | With this option, the B<-verify> operation also checks that the signing-certificates | |
593 | attribute is present, and its value matches the verification trust chain built | |
594 | during the verification process. | |
e85d19c6 AI |
595 | |
596 | =back | |
597 | ||
7122aafc DSH |
598 | =head1 EXIT CODES |
599 | ||
600 | =over 4 | |
601 | ||
c8919dde | 602 | =item Z<>0 |
7122aafc | 603 | |
c4de074e | 604 | The operation was completely successfully. |
7122aafc | 605 | |
c8919dde | 606 | =item Z<>1 |
7122aafc | 607 | |
c4de074e | 608 | An error occurred parsing the command options. |
7122aafc | 609 | |
c8919dde | 610 | =item Z<>2 |
7122aafc | 611 | |
c4de074e | 612 | One of the input files could not be read. |
7122aafc | 613 | |
c8919dde | 614 | =item Z<>3 |
7122aafc | 615 | |
c4de074e | 616 | An error occurred creating the CMS file or when reading the MIME |
7122aafc DSH |
617 | message. |
618 | ||
c8919dde | 619 | =item Z<>4 |
7122aafc | 620 | |
c4de074e | 621 | An error occurred decrypting or verifying the message. |
7122aafc | 622 | |
c8919dde | 623 | =item Z<>5 |
7122aafc | 624 | |
c4de074e | 625 | The message was verified correctly but an error occurred writing out |
7122aafc DSH |
626 | the signers certificates. |
627 | ||
628 | =back | |
629 | ||
485d3361 | 630 | =head1 COMPATIBILITY WITH PKCS#7 FORMAT |
7122aafc | 631 | |
35a810bb RL |
632 | L<openssl-smime(1)> can only process the older B<PKCS#7> format. |
633 | B<openssl cms> supports Cryptographic Message Syntax format. | |
634 | Use of some features will result in messages which cannot be processed by | |
635 | applications which only support the older format. These are detailed below. | |
7122aafc DSH |
636 | |
637 | The use of the B<-keyid> option with B<-sign> or B<-encrypt>. | |
638 | ||
e8769719 | 639 | The B<-outform> I<PEM> option uses different headers. |
7122aafc DSH |
640 | |
641 | The B<-compress> option. | |
642 | ||
643 | The B<-secretkey> option when used with B<-encrypt>. | |
644 | ||
dfcb42c6 DSH |
645 | The use of PSS with B<-sign>. |
646 | ||
647 | The use of OAEP or non-RSA keys with B<-encrypt>. | |
648 | ||
7122aafc | 649 | Additionally the B<-EncryptedData_create> and B<-data_create> type cannot |
35a810bb | 650 | be processed by the older L<openssl-smime(1)> command. |
7122aafc DSH |
651 | |
652 | =head1 EXAMPLES | |
653 | ||
654 | Create a cleartext signed message: | |
655 | ||
656 | openssl cms -sign -in message.txt -text -out mail.msg \ | |
1bc74519 | 657 | -signer mycert.pem |
7122aafc DSH |
658 | |
659 | Create an opaque signed message | |
660 | ||
661 | openssl cms -sign -in message.txt -text -out mail.msg -nodetach \ | |
1bc74519 | 662 | -signer mycert.pem |
7122aafc DSH |
663 | |
664 | Create a signed message, include some additional certificates and | |
665 | read the private key from another file: | |
666 | ||
667 | openssl cms -sign -in in.txt -text -out mail.msg \ | |
1bc74519 | 668 | -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem |
7122aafc DSH |
669 | |
670 | Create a signed message with two signers, use key identifier: | |
671 | ||
672 | openssl cms -sign -in message.txt -text -out mail.msg \ | |
1bc74519 | 673 | -signer mycert.pem -signer othercert.pem -keyid |
7122aafc DSH |
674 | |
675 | Send a signed message under Unix directly to sendmail, including headers: | |
676 | ||
677 | openssl cms -sign -in in.txt -text -signer mycert.pem \ | |
1bc74519 RS |
678 | -from steve@openssl.org -to someone@somewhere \ |
679 | -subject "Signed message" | sendmail someone@somewhere | |
7122aafc DSH |
680 | |
681 | Verify a message and extract the signer's certificate if successful: | |
682 | ||
683 | openssl cms -verify -in mail.msg -signer user.pem -out signedtext.txt | |
684 | ||
685 | Send encrypted mail using triple DES: | |
686 | ||
687 | openssl cms -encrypt -in in.txt -from steve@openssl.org \ | |
1bc74519 RS |
688 | -to someone@somewhere -subject "Encrypted message" \ |
689 | -des3 user.pem -out mail.msg | |
7122aafc DSH |
690 | |
691 | Sign and encrypt mail: | |
692 | ||
693 | openssl cms -sign -in ml.txt -signer my.pem -text \ | |
1bc74519 RS |
694 | | openssl cms -encrypt -out mail.msg \ |
695 | -from steve@openssl.org -to someone@somewhere \ | |
696 | -subject "Signed and Encrypted message" -des3 user.pem | |
7122aafc DSH |
697 | |
698 | Note: the encryption command does not include the B<-text> option because the | |
699 | message being encrypted already has MIME headers. | |
700 | ||
701 | Decrypt mail: | |
702 | ||
703 | openssl cms -decrypt -in mail.msg -recip mycert.pem -inkey key.pem | |
704 | ||
705 | The output from Netscape form signing is a PKCS#7 structure with the | |
706 | detached signature format. You can use this program to verify the | |
707 | signature by line wrapping the base64 encoded structure and surrounding | |
708 | it with: | |
709 | ||
710 | -----BEGIN PKCS7----- | |
711 | -----END PKCS7----- | |
712 | ||
1bc74519 | 713 | and using the command, |
7122aafc DSH |
714 | |
715 | openssl cms -verify -inform PEM -in signature.pem -content content.txt | |
716 | ||
717 | alternatively you can base64 decode the signature and use | |
718 | ||
719 | openssl cms -verify -inform DER -in signature.der -content content.txt | |
720 | ||
721 | Create an encrypted message using 128 bit Camellia: | |
722 | ||
723 | openssl cms -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem | |
724 | ||
725 | Add a signer to an existing message: | |
726 | ||
727 | openssl cms -resign -in mail.msg -signer newsign.pem -out mail2.msg | |
728 | ||
4bf4a650 DSH |
729 | Sign mail using RSA-PSS: |
730 | ||
731 | openssl cms -sign -in message.txt -text -out mail.msg \ | |
1bc74519 | 732 | -signer mycert.pem -keyopt rsa_padding_mode:pss |
4bf4a650 DSH |
733 | |
734 | Create encrypted mail using RSA-OAEP: | |
735 | ||
dfcb42c6 | 736 | openssl cms -encrypt -in plain.txt -out mail.msg \ |
1bc74519 | 737 | -recip cert.pem -keyopt rsa_padding_mode:oaep |
4bf4a650 | 738 | |
dfcb42c6 DSH |
739 | Use SHA256 KDF with an ECDH certificate: |
740 | ||
741 | openssl cms -encrypt -in plain.txt -out mail.msg \ | |
1bc74519 | 742 | -recip ecdhcert.pem -keyopt ecdh_kdf_md:sha256 |
dfcb42c6 | 743 | |
7122aafc DSH |
744 | =head1 BUGS |
745 | ||
746 | The MIME parser isn't very clever: it seems to handle most messages that I've | |
747 | thrown at it but it may choke on others. | |
748 | ||
749 | The code currently will only write out the signer's certificate to a file: if | |
750 | the signer has a separate encryption certificate this must be manually | |
751 | extracted. There should be some heuristic that determines the correct | |
752 | encryption certificate. | |
753 | ||
754 | Ideally a database should be maintained of a certificates for each email | |
755 | address. | |
756 | ||
757 | The code doesn't currently take note of the permitted symmetric encryption | |
758 | algorithms as supplied in the SMIMECapabilities signed attribute. this means the | |
759 | user has to manually include the correct encryption algorithm. It should store | |
760 | the list of permitted ciphers in a database and only use those. | |
761 | ||
762 | No revocation checking is done on the signer's certificate. | |
763 | ||
fd3397fc RL |
764 | =head1 SEE ALSO |
765 | ||
766 | L<ossl_store-file(7)> | |
767 | ||
7122aafc DSH |
768 | =head1 HISTORY |
769 | ||
770 | The use of multiple B<-signer> options and the B<-resign> command were first | |
ecd4b8fe | 771 | added in OpenSSL 1.0.0. |
4bf4a650 | 772 | |
2f0ea936 | 773 | The B<-keyopt> option was added in OpenSSL 1.0.2. |
4bf4a650 | 774 | |
fc5ecadd | 775 | Support for RSA-OAEP and RSA-PSS was added in OpenSSL 1.0.2. |
7122aafc | 776 | |
fc5ecadd DMSP |
777 | The use of non-RSA keys with B<-encrypt> and B<-decrypt> |
778 | was added in OpenSSL 1.0.2. | |
dfcb42c6 | 779 | |
fc5ecadd | 780 | The -no_alt_chains option was added in OpenSSL 1.0.2b. |
fa7b0111 | 781 | |
6d382c74 DDO |
782 | All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0 |
783 | and have no effect. | |
784 | ||
922f1565 DB |
785 | The B<-nameopt> option was added in OpenSSL 3.0.0. |
786 | ||
0f221d9c P |
787 | The B<-engine> option was deprecated in OpenSSL 3.0. |
788 | ||
e2f92610 RS |
789 | =head1 COPYRIGHT |
790 | ||
33388b44 | 791 | Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 792 | |
449040b4 | 793 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
794 | this file except in compliance with the License. You can obtain a copy |
795 | in the file LICENSE in the source distribution or at | |
796 | L<https://www.openssl.org/source/license.html>. | |
797 | ||
798 | =cut |