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