doc/man1/openssl-smime.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-smime - S/MIME utility
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<smime>
  11 [B<-help>]
  12 [B<-encrypt>]
  13 [B<-decrypt>]
  14 [B<-sign>]
  15 [B<-resign>]
  16 [B<-verify>]
  17 [B<-pk7out>]
  18 [B<-binary>]
  19 [B<-crlfeol>]
  20 [B<-I<cipher>>]
  21 [B<-in> I<file>]
  22 [B<-certfile> I<file>]
  23 [B<-signer> I<file>]
  24 [B<-nointern>]
  25 [B<-noverify>]
  26 [B<-nochain>]
  27 [B<-nosigs>]
  28 [B<-nocerts>]
  29 [B<-noattr>]
  30 [B<-nodetach>]
  31 [B<-nosmimecap>]
  32 [B<-recip> I< file>]
  33 [B<-inform> B<DER>|B<PEM>|B<SMIME>]
  34 [B<-outform> B<DER>|B<PEM>|B<SMIME>]
  35 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
  36 [B<-passin> I<arg>]
  37 [B<-inkey> I<file_or_id>]
  38 [B<-out> I<file>]
  39 [B<-content> I<file>]
  40 [B<-to> I<addr>]
  41 [B<-from> I<ad>]
  42 [B<-subject> I<s>]
  43 [B<-text>]
  44 [B<-indef>]
  45 [B<-noindef>]
  46 [B<-stream>]
  47 [B<-md> I<digest>]
  48 {- $OpenSSL::safe::opt_trust_synopsis -}
  49 {- $OpenSSL::safe::opt_engine_synopsis -}
  50 {- $OpenSSL::safe::opt_r_synopsis -}
  51 {- $OpenSSL::safe::opt_v_synopsis -}
  52 I<cert.pem> ...
  53
  54 =for openssl ifdef engine
  55
  56 =head1 DESCRIPTION
  57
  58 This command handles S/MIME mail. It can encrypt, decrypt, sign
  59 and verify S/MIME messages.
  60
  61 =head1 OPTIONS
  62
  63 There are six operation options that set the type of operation to be performed.
  64 The meaning of the other options varies according to the operation type.
  65
  66 =over 4
  67
  68 =item B<-help>
  69
  70 Print out a usage message.
  71
  72 =item B<-encrypt>
  73
  74 Encrypt mail for the given recipient certificates. Input file is the message
  75 to be encrypted. The output file is the encrypted mail in MIME format.
  76
  77 Note that no revocation check is done for the recipient cert, so if that
  78 key has been compromised, others may be able to decrypt the text.
  79
  80 =item B<-decrypt>
  81
  82 Decrypt mail using the supplied certificate and private key. Expects an
  83 encrypted mail message in MIME format for the input file. The decrypted mail
  84 is written to the output file.
  85
  86 =item B<-sign>
  87
  88 Sign mail using the supplied certificate and private key. Input file is
  89 the message to be signed. The signed message in MIME format is written
  90 to the output file.
  91
  92 =item B<-verify>
  93
  94 Verify signed mail. Expects a signed mail message on input and outputs
  95 the signed data. Both clear text and opaque signing is supported.
  96
  97 =item B<-pk7out>
  98
  99 Takes an input message and writes out a PEM encoded PKCS#7 structure.
 100
 101 =item B<-resign>
 102
 103 Resign a message: take an existing message and one or more new signers.
 104
 105 =item B<-in> I<filename>
 106
 107 The input message to be encrypted or signed or the MIME message to
 108 be decrypted or verified.
 109
 110 =item B<-out> I<filename>
 111
 112 The message text that has been decrypted or verified or the output MIME
 113 format message that has been signed or verified.
 114
 115 =item B<-inform> B<DER>|B<PEM>|B<SMIME>
 116
 117 The input format of the PKCS#7 (S/MIME) structure (if one is being read);
 118 the default is B<SMIME>.
 119 See L<openssl(1)/Format Options> for details.
 120
 121 =item B<-outform> B<DER>|B<PEM>|B<SMIME>
 122
 123 The output format of the PKCS#7 (S/MIME) structure (if one is being written);
 124 the default is B<SMIME>.
 125 See L<openssl(1)/Format Options> for details.
 126
 127 =item B<-keyform> B<DER>|B<PEM>
 128
 129 The key format; the default is B<PEM>.
 130 See L<openssl(1)/Format Options> for details.
 131
 132 =item B<-stream>, B<-indef>, B<-noindef>
 133
 134 The B<-stream> and B<-indef> options are equivalent and enable streaming I/O
 135 for encoding operations. This permits single pass processing of data without
 136 the need to hold the entire contents in memory, potentially supporting very
 137 large files. Streaming is automatically set for S/MIME signing with detached
 138 data if the output format is B<SMIME> it is currently off by default for all
 139 other operations.
 140
 141 =item B<-noindef>
 142
 143 Disable streaming I/O where it would produce and indefinite length constructed
 144 encoding. This option currently has no effect. In future streaming will be
 145 enabled by default on all relevant operations and this option will disable it.
 146
 147 =item B<-content> I<filename>
 148
 149 This specifies a file containing the detached content, this is only
 150 useful with the B<-verify> command. This is only usable if the PKCS#7
 151 structure is using the detached signature form where the content is
 152 not included. This option will override any content if the input format
 153 is S/MIME and it uses the multipart/signed MIME content type.
 154
 155 =item B<-text>
 156
 157 This option adds plain text (text/plain) MIME headers to the supplied
 158 message if encrypting or signing. If decrypting or verifying it strips
 159 off text headers: if the decrypted or verified message is not of MIME
 160 type text/plain then an error occurs.
 161
 162 =item B<-md> I<digest>
 163
 164 Digest algorithm to use when signing or resigning. If not present then the
 165 default digest algorithm for the signing key will be used (usually SHA1).
 166
 167 =item B<-I<cipher>>
 168
 169 The encryption algorithm to use. For example DES  (56 bits) - B<-des>,
 170 triple DES (168 bits) - B<-des3>,
 171 EVP_get_cipherbyname() function) can also be used preceded by a dash, for
 172 example B<-aes-128-cbc>. See L<openssl-enc(1)> for list of ciphers
 173 supported by your version of OpenSSL.
 174
 175 If not specified triple DES is used. Only used with B<-encrypt>.
 176
 177 =item B<-nointern>
 178
 179 When verifying a message normally certificates (if any) included in
 180 the message are searched for the signing certificate. With this option
 181 only the certificates specified in the B<-certfile> option are used.
 182 The supplied certificates can still be used as untrusted CAs however.
 183
 184 =item B<-noverify>
 185
 186 Do not verify the signers certificate of a signed message.
 187
 188 =item B<-nochain>
 189
 190 Do not do chain verification of signers certificates; that is, do not
 191 use the certificates in the signed message as untrusted CAs.
 192
 193 =item B<-nosigs>
 194
 195 Don't try to verify the signatures on the message.
 196
 197 =item B<-nocerts>
 198
 199 When signing a message the signer's certificate is normally included
 200 with this option it is excluded. This will reduce the size of the
 201 signed message but the verifier must have a copy of the signers certificate
 202 available locally (passed using the B<-certfile> option for example).
 203
 204 =item B<-noattr>
 205
 206 Normally when a message is signed a set of attributes are included which
 207 include the signing time and supported symmetric algorithms. With this
 208 option they are not included.
 209
 210 =item B<-nodetach>
 211
 212 When signing a message use opaque signing. This form is more resistant
 213 to translation by mail relays but it cannot be read by mail agents that
 214 do not support S/MIME.  Without this option cleartext signing with
 215 the MIME type multipart/signed is used.
 216
 217 =item B<-nosmimecap>
 218
 219 When signing a message, do not include the B<SMIMECapabilities> attribute.
 220
 221 =item B<-binary>
 222
 223 Normally the input message is converted to "canonical" format which is
 224 effectively using CR and LF as end of line: as required by the S/MIME
 225 specification. When this option is present no translation occurs. This
 226 is useful when handling binary data which may not be in MIME format.
 227
 228 =item B<-crlfeol>
 229
 230 Normally the output file uses a single B<LF> as end of line. When this
 231 option is present B<CRLF> is used instead.
 232
 233 =item B<-certfile> I<file>
 234
 235 Allows additional certificates to be specified. When signing these will
 236 be included with the message. When verifying these will be searched for
 237 the signers certificates. The certificates should be in PEM format.
 238
 239 =item B<-signer> I<file>
 240
 241 A signing certificate when signing or resigning a message, this option can be
 242 used multiple times if more than one signer is required. If a message is being
 243 verified then the signers certificates will be written to this file if the
 244 verification was successful.
 245
 246 =item B<-nocerts>
 247
 248 Don't include signers certificate when signing.
 249
 250 =item B<-noattr>
 251
 252 Don't include any signed attributes when signing.
 253
 254 =item B<-recip> I<file>
 255
 256 The recipients certificate when decrypting a message. This certificate
 257 must match one of the recipients of the message or an error occurs.
 258
 259 =item B<-inkey> I<file_or_id>
 260
 261 The private key to use when signing or decrypting. This must match the
 262 corresponding certificate. If this option is not specified then the
 263 private key must be included in the certificate file specified with
 264 the B<-recip> or B<-signer> file. When signing this option can be used
 265 multiple times to specify successive keys.
 266 If no engine is used, the argument is taken as a file; if an engine is
 267 specified, the argument is given to the engine as a key identifier.
 268
 269 =item B<-passin> I<arg>
 270
 271 The private key password source. For more information about the format of I<arg>
 272 see L<openssl(1)/Pass Phrase Options>.
 273
 274 =item B<-to>, B<-from>, B<-subject>
 275
 276 The relevant mail headers. These are included outside the signed
 277 portion of a message so they may be included manually. If signing
 278 then many S/MIME mail clients check the signers certificate's email
 279 address matches that specified in the From: address.
 280
 281 {- $OpenSSL::safe::opt_v_item -}
 282
 283 Any verification errors cause the command to exit.
 284
 285 {- $OpenSSL::safe::opt_trust_item -}
 286
 287 {- $OpenSSL::safe::opt_engine_item -}
 288
 289 {- $OpenSSL::safe::opt_r_item -}
 290
 291 =item I<cert.pem> ...
 292
 293 One or more certificates of message recipients, used when encrypting
 294 a message.
 295
 296 =back
 297
 298 =head1 NOTES
 299
 300 The MIME message must be sent without any blank lines between the
 301 headers and the output. Some mail programs will automatically add
 302 a blank line. Piping the mail directly to sendmail is one way to
 303 achieve the correct format.
 304
 305 The supplied message to be signed or encrypted must include the
 306 necessary MIME headers or many S/MIME clients won't display it
 307 properly (if at all). You can use the B<-text> option to automatically
 308 add plain text headers.
 309
 310 A "signed and encrypted" message is one where a signed message is
 311 then encrypted. This can be produced by encrypting an already signed
 312 message: see the examples section.
 313
 314 This version of the program only allows one signer per message but it
 315 will verify multiple signers on received messages. Some S/MIME clients
 316 choke if a message contains multiple signers. It is possible to sign
 317 messages "in parallel" by signing an already signed message.
 318
 319 The options B<-encrypt> and B<-decrypt> reflect common usage in S/MIME
 320 clients. Strictly speaking these process PKCS#7 enveloped data: PKCS#7
 321 encrypted data is used for other purposes.
 322
 323 The B<-resign> option uses an existing message digest when adding a new
 324 signer. This means that attributes must be present in at least one existing
 325 signer using the same message digest or this operation will fail.
 326
 327 The B<-stream> and B<-indef> options enable streaming I/O support.
 328 As a result the encoding is BER using indefinite length constructed encoding
 329 and no longer DER. Streaming is supported for the B<-encrypt> operation and the
 330 B<-sign> operation if the content is not detached.
 331
 332 Streaming is always used for the B<-sign> operation with detached data but
 333 since the content is no longer part of the PKCS#7 structure the encoding
 334 remains DER.
 335
 336 =head1 EXIT CODES
 337
 338 =over 4
 339
 340 =item Z<>0
 341
 342 The operation was completely successfully.
 343
 344 =item Z<>1
 345
 346 An error occurred parsing the command options.
 347
 348 =item Z<>2
 349
 350 One of the input files could not be read.
 351
 352 =item Z<>3
 353
 354 An error occurred creating the PKCS#7 file or when reading the MIME
 355 message.
 356
 357 =item Z<>4
 358
 359 An error occurred decrypting or verifying the message.
 360
 361 =item Z<>5
 362
 363 The message was verified correctly but an error occurred writing out
 364 the signers certificates.
 365
 366 =back
 367
 368 =head1 EXAMPLES
 369
 370 Create a cleartext signed message:
 371
 372  openssl smime -sign -in message.txt -text -out mail.msg \
 373         -signer mycert.pem
 374
 375 Create an opaque signed message:
 376
 377  openssl smime -sign -in message.txt -text -out mail.msg -nodetach \
 378         -signer mycert.pem
 379
 380 Create a signed message, include some additional certificates and
 381 read the private key from another file:
 382
 383  openssl smime -sign -in in.txt -text -out mail.msg \
 384         -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
 385
 386 Create a signed message with two signers:
 387
 388  openssl smime -sign -in message.txt -text -out mail.msg \
 389         -signer mycert.pem -signer othercert.pem
 390
 391 Send a signed message under Unix directly to sendmail, including headers:
 392
 393  openssl smime -sign -in in.txt -text -signer mycert.pem \
 394         -from steve@openssl.org -to someone@somewhere \
 395         -subject "Signed message" | sendmail someone@somewhere
 396
 397 Verify a message and extract the signer's certificate if successful:
 398
 399  openssl smime -verify -in mail.msg -signer user.pem -out signedtext.txt
 400
 401 Send encrypted mail using triple DES:
 402
 403  openssl smime -encrypt -in in.txt -from steve@openssl.org \
 404         -to someone@somewhere -subject "Encrypted message" \
 405         -des3 user.pem -out mail.msg
 406
 407 Sign and encrypt mail:
 408
 409  openssl smime -sign -in ml.txt -signer my.pem -text \
 410         | openssl smime -encrypt -out mail.msg \
 411         -from steve@openssl.org -to someone@somewhere \
 412         -subject "Signed and Encrypted message" -des3 user.pem
 413
 414 Note: the encryption command does not include the B<-text> option because the
 415 message being encrypted already has MIME headers.
 416
 417 Decrypt mail:
 418
 419  openssl smime -decrypt -in mail.msg -recip mycert.pem -inkey key.pem
 420
 421 The output from Netscape form signing is a PKCS#7 structure with the
 422 detached signature format. You can use this program to verify the
 423 signature by line wrapping the base64 encoded structure and surrounding
 424 it with:
 425
 426  -----BEGIN PKCS7-----
 427  -----END PKCS7-----
 428
 429 and using the command:
 430
 431  openssl smime -verify -inform PEM -in signature.pem -content content.txt
 432
 433 Alternatively you can base64 decode the signature and use:
 434
 435  openssl smime -verify -inform DER -in signature.der -content content.txt
 436
 437 Create an encrypted message using 128 bit Camellia:
 438
 439  openssl smime -encrypt -in plain.txt -camellia128 -out mail.msg cert.pem
 440
 441 Add a signer to an existing message:
 442
 443  openssl smime -resign -in mail.msg -signer newsign.pem -out mail2.msg
 444
 445 =head1 BUGS
 446
 447 The MIME parser isn't very clever: it seems to handle most messages that I've
 448 thrown at it but it may choke on others.
 449
 450 The code currently will only write out the signer's certificate to a file: if
 451 the signer has a separate encryption certificate this must be manually
 452 extracted. There should be some heuristic that determines the correct
 453 encryption certificate.
 454
 455 Ideally a database should be maintained of a certificates for each email
 456 address.
 457
 458 The code doesn't currently take note of the permitted symmetric encryption
 459 algorithms as supplied in the SMIMECapabilities signed attribute. This means the
 460 user has to manually include the correct encryption algorithm. It should store
 461 the list of permitted ciphers in a database and only use those.
 462
 463 No revocation checking is done on the signer's certificate.
 464
 465 The current code can only handle S/MIME v2 messages, the more complex S/MIME v3
 466 structures may cause parsing errors.
 467
 468 =head1 SEE ALSO
 469
 470 L<ossl_store-file(7)>
 471
 472 =head1 HISTORY
 473
 474 The use of multiple B<-signer> options and the B<-resign> command were first
 475 added in OpenSSL 1.0.0
 476
 477 The -no_alt_chains option was added in OpenSSL 1.1.0.
 478
 479 =head1 COPYRIGHT
 480
 481 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 482
 483 Licensed under the Apache License 2.0 (the "License").  You may not use
 484 this file except in compliance with the License.  You can obtain a copy
 485 in the file LICENSE in the source distribution or at
 486 L<https://www.openssl.org/source/license.html>.
 487
 488 =cut