[BACK]Return to openssl.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / openssl

Diff for /src/usr.bin/openssl/openssl.1 between version 1.69 and 1.70

version 1.69, 2016/09/04 19:38:51 version 1.70, 2016/09/08 18:24:08
Line 4265 
Line 4265 
 application.  application.
 This is, however, strongly discouraged and should only be used for  This is, however, strongly discouraged and should only be used for
 debugging purposes.  debugging purposes.
 .\"  
 .\" SMIME  
 .\"  
 .Sh SMIME  .Sh SMIME
 .nr nS 1  .nr nS 1
 .Nm "openssl smime"  .Nm "openssl smime"
 .Bk -words  
 .Oo  .Oo
 .Fl aes128 | aes192 | aes256 | des |  .Fl aes128 | aes192 | aes256 | des |
 .Fl des3 | rc2-40 | rc2-64 | rc2-128  .Fl des3 | rc2-40 | rc2-64 | rc2-128
Line 4291 
Line 4287 
 .Op Fl ignore_critical  .Op Fl ignore_critical
 .Op Fl in Ar file  .Op Fl in Ar file
 .Op Fl indef  .Op Fl indef
 .Op Fl inform Ar DER | PEM | SMIME  .Op Fl inform Cm der | pem | smime
 .Op Fl inkey Ar file  .Op Fl inkey Ar file
 .Op Fl issuer_checks  .Op Fl issuer_checks
 .Op Fl keyform Ar PEM  .Op Fl keyform Cm pem
 .Op Fl md Ar digest  .Op Fl md Ar digest
 .Op Fl noattr  .Op Fl noattr
 .Op Fl nocerts  .Op Fl nocerts
Line 4305 
Line 4301 
 .Op Fl nosigs  .Op Fl nosigs
 .Op Fl noverify  .Op Fl noverify
 .Op Fl out Ar file  .Op Fl out Ar file
 .Op Fl outform Ar DER | PEM | SMIME  .Op Fl outform Cm der | pem | smime
 .Op Fl passin Ar arg  .Op Fl passin Ar arg
 .Op Fl pk7out  .Op Fl pk7out
 .Op Fl policy_check  .Op Fl policy_check
Line 4320 
Line 4316 
 .Op Fl verify  .Op Fl verify
 .Op Fl x509_strict  .Op Fl x509_strict
 .Op Ar cert.pem ...  .Op Ar cert.pem ...
 .Ek  
 .nr nS 0  .nr nS 0
 .Pp  .Pp
 The  The
 .Nm smime  .Nm smime
 command handles  command handles S/MIME mail.
 .Em S/MIME  It can encrypt, decrypt, sign, and verify S/MIME messages.
 mail.  
 It can encrypt, decrypt, sign, and verify  
 .Em S/MIME  
 messages.  
 .Pp  .Pp
 There are six operation options that set the type of operation to be performed.  The MIME message must be sent without any blank lines between the
 The meaning of the other options varies according to the operation type.  headers and the output.
   Some mail programs will automatically add a blank line.
   Piping the mail directly to an MTA is one way to
   achieve the correct format.
 .Pp  .Pp
 The six operation options are as follows:  The supplied message to be signed or encrypted must include the necessary
   MIME headers or many S/MIME clients won't display it properly (if at all).
   Use the
   .Fl text
   option to automatically add plain text headers.
   .Pp
   A
   .Qq signed and encrypted
   message is one where a signed message is then encrypted.
   This can be produced by encrypting an already signed message.
   .Pp
   There are a number of operations that can be performed, as follows:
 .Bl -tag -width "XXXX"  .Bl -tag -width "XXXX"
 .It Fl decrypt  .It Fl decrypt
 Decrypt mail using the supplied certificate and private key.  Decrypt mail using the supplied certificate and private key.
 Expects an encrypted mail message in  The input file is an encrypted mail message in MIME format.
 .Em MIME  
 format for the input file.  
 The decrypted mail is written to the output file.  The decrypted mail is written to the output file.
 .It Fl encrypt  .It Fl encrypt
 Encrypt mail for the given recipient certificates.  Encrypt mail for the given recipient certificates.
 Input file is the message to be encrypted.  The input is the message to be encrypted.
 The output file is the encrypted mail in  The output file is the encrypted mail, in MIME format.
 .Em MIME  
 format.  
 .It Fl pk7out  .It Fl pk7out
 Takes an input message and writes out a PEM-encoded PKCS#7 structure.  Take an input message and write out a PEM-encoded PKCS#7 structure.
 .It Fl resign  .It Fl resign
 Resign a message: take an existing message and one or more new signers.  Resign a message: take an existing message and one or more new signers.
 .It Fl sign  .It Fl sign
 Sign mail using the supplied certificate and private key.  Sign mail using the supplied certificate and private key.
 Input file is the message to be signed.  The input file is the message to be signed.
 The signed message in  The signed message, in MIME format, is written to the output file.
 .Em MIME  
 format is written to the output file.  
 .It Fl verify  .It Fl verify
 Verify signed mail.  Verify signed mail.
 Expects a signed mail message on input and outputs the signed data.  The input is a signed mail message and the output is the signed data.
 Both clear text and opaque signing is supported.  Both clear text and opaque signing is supported.
 .El  .El
 .Pp  .Pp
Line 4372 
Line 4371 
 .Fl des3 | rc2-40 | rc2-64 | rc2-128  .Fl des3 | rc2-40 | rc2-64 | rc2-128
 .Xc  .Xc
 The encryption algorithm to use.  The encryption algorithm to use.
 128-, 192-, or 256-bit AES,  128-, 192-, or 256-bit AES, DES (56 bits), triple DES (168 bits),
 DES  
 .Pq 56 bits ,  
 triple DES  
 .Pq 168 bits ,  
 or 40-, 64-, or 128-bit RC2, respectively;  or 40-, 64-, or 128-bit RC2, respectively;
 if not specified, 40-bit RC2 is  if not specified, 40-bit RC2 is
 used.  used.
Line 4385 
Line 4380 
 .It Fl binary  .It Fl binary
 Normally, the input message is converted to  Normally, the input message is converted to
 .Qq canonical  .Qq canonical
 format which is effectively using CR and LF as end of line \-  format which uses CR/LF as end of line,
 as required by the  as required by the S/MIME specification.
 .Em S/MIME  
 specification.  
 When this option is present no translation occurs.  When this option is present no translation occurs.
 This is useful when handling binary data which may not be in  This is useful when handling binary data which may not be in MIME format.
 .Em MIME  
 format.  
 .It Fl CAfile Ar file  .It Fl CAfile Ar file
 A  A
 .Ar file  .Ar file
Line 4427 
Line 4418 
 .Xc  .Xc
 Set various certificate chain validation options.  Set various certificate chain validation options.
 See the  See the
 .Nm VERIFY  .Nm verify
 command for details.  command for details.
 .It Fl content Ar file  .It Fl content Ar file
 This specifies a file containing the detached content.  A file containing the detached content.
 This is only useful with the  This is only useful with the
 .Fl verify  .Fl verify
 command.  option,
 This is only usable if the PKCS#7 structure is using the detached  and only usable if the PKCS#7 structure is using the detached
 signature form where the content is not included.  signature form where the content is not included.
 This option will override any content if the input format is  This option will override any content if the input format is S/MIME
 .Em S/MIME  and it uses the multipart/signed MIME content type.
 and it uses the multipart/signed  
 .Em MIME  
 content type.  
 .It Xo  .It Xo
 .Fl from Ar addr ,  .Fl from Ar addr ,
 .Fl subject Ar s ,  .Fl subject Ar s ,
Line 4449 
Line 4437 
 The relevant mail headers.  The relevant mail headers.
 These are included outside the signed  These are included outside the signed
 portion of a message so they may be included manually.  portion of a message so they may be included manually.
 When signing, many  When signing, many S/MIME
 .Em S/MIME  
 mail clients check that the signer's certificate email  mail clients check that the signer's certificate email
 address matches the From: address.  address matches the From: address.
 .It Fl in Ar file  .It Fl in Ar file
 The input message to be encrypted or signed or the  The input file to read from.
 .Em MIME  
 message to  
 be decrypted or verified.  
 .It Fl indef  .It Fl indef
 Enable streaming I/O for encoding operations.  Enable streaming I/O for encoding operations.
 This permits single pass processing of data without  This permits single pass processing of data without
Line 4466 
Line 4450 
 Streaming is automatically set for S/MIME signing with detached  Streaming is automatically set for S/MIME signing with detached
 data if the output format is SMIME;  data if the output format is SMIME;
 it is currently off by default for all other operations.  it is currently off by default for all other operations.
 .It Fl inform Ar DER | PEM | SMIME  .It Fl inform Cm der | pem | smime
 This specifies the input format for the PKCS#7 structure.  The input format.
 The default is  
 .Em SMIME ,  
 which reads an  
 .Em S/MIME  
 format message.  
 .Ar PEM  
 and  
 .Ar DER  
 format change this to expect PEM and DER format PKCS#7 structures  
 instead.  
 This currently only affects the input format of the PKCS#7  
 structure; if no PKCS#7 structure is being input (for example with  
 .Fl encrypt  
 or  
 .Fl sign ) ,  
 this option has no effect.  
 .It Fl inkey Ar file  .It Fl inkey Ar file
 The private key to use when signing or decrypting.  The private key to use when signing or decrypting,
 This must match the corresponding certificate.  which must match the corresponding certificate.
 If this option is not specified, the private key must be included  If this option is not specified, the private key must be included
 in the certificate file specified with  in the certificate file specified with
 the  the
Line 4496 
Line 4464 
 file.  file.
 When signing,  When signing,
 this option can be used multiple times to specify successive keys.  this option can be used multiple times to specify successive keys.
 .It Fl keyform Ar PEM  .It Fl keyform Cm pem
 Input private key format.  Input private key format.
 .It Fl md Ar digest  .It Fl md Ar digest
 The digest algorithm to use when signing or resigning.  The digest algorithm to use when signing or resigning.
 If not present then the default digest algorithm for the signing key is used  If not present then the default digest algorithm for the signing key is used
 (usually SHA1).  (usually SHA1).
 .It Fl noattr  .It Fl noattr
 Normally, when a message is signed a set of attributes are included which  Do not include attributes.
 include the signing time and supported symmetric algorithms.  
 With this option they are not included.  
 .It Fl nocerts  .It Fl nocerts
 When signing a message, the signer's certificate is normally included;  Do not include the signer's certificate.
 with this option it is excluded.  
 This will reduce the size of the signed message but the verifier must  This will reduce the size of the signed message but the verifier must
 have a copy of the signer's certificate available locally (passed using the  have a copy of the signer's certificate available locally (passed using the
 .Fl certfile  .Fl certfile
Line 4519 
Line 4484 
 .It Fl nodetach  .It Fl nodetach
 When signing a message use opaque signing: this form is more resistant  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  to translation by mail relays but it cannot be read by mail agents that
 do not support  do not support S/MIME.
 .Em S/MIME .  Without this option cleartext signing with the MIME type
 Without this option cleartext signing with the  multipart/signed is used.
 .Em MIME  
 type multipart/signed is used.  
 .It Fl noindef  .It Fl noindef
 Disable streaming I/O where it would produce an encoding of indefinite length.  Disable streaming I/O where it would produce an encoding of indefinite length
 This option currently has no effect.  (currently has no effect).
 In future streaming will be enabled by default on all relevant operations  
 and this option will disable it.  
 .It Fl nointern  .It Fl nointern
 When verifying a message, normally certificates  Only use certificates specified in the
 .Pq if any  .Fl certfile .
 included in the message are searched for the signing certificate.  The supplied certificates can still be used as untrusted CAs.
 With this option, only the certificates specified in the  
 .Fl certfile  
 option are used.  
 The supplied certificates can still be used as untrusted CAs however.  
 .It Fl nosigs  .It Fl nosigs
 Don't try to verify the signatures on the message.  Do not try to verify the signatures on the message.
 .It Fl noverify  .It Fl noverify
 Do not verify the signer's certificate of a signed message.  Do not verify the signer's certificate of a signed message.
 .It Fl out Ar file  .It Fl out Ar file
 The message text that has been decrypted or verified, or the output  The output file to write to.
 .Em MIME  .It Fl outform Cm der | pem | smime
 format message that has been signed or verified.  The output format.
 .It Fl outform Ar DER | PEM | SMIME  The default is smime, which writes an S/MIME format message.
 This specifies the output format for the PKCS#7 structure.  .Cm pem
 The default is  
 .Em SMIME ,  
 which writes an  
 .Em S/MIME  
 format message.  
 .Ar PEM  
 and  and
 .Ar DER  .Cm der
 format change this to write PEM and DER format PKCS#7 structures  change this to write PEM and DER format PKCS#7 structures instead.
 instead.  
 This currently only affects the output format of the PKCS#7  This currently only affects the output format of the PKCS#7
 structure; if no PKCS#7 structure is being output (for example with  structure; if no PKCS#7 structure is being output (for example with
 .Fl verify  .Fl verify
Line 4578 
Line 4528 
 The same as  The same as
 .Fl indef .  .Fl indef .
 .It Fl text  .It Fl text
 This option adds plain text  Add plain text (text/plain) MIME
 .Pq text/plain  
 .Em MIME  
 headers to the supplied message if encrypting or signing.  headers to the supplied message if encrypting or signing.
 If decrypting or verifying, it strips off text headers:  If decrypting or verifying, it strips off text headers:
 if the decrypted or verified message is not of  if the decrypted or verified message is not of MIME type text/plain
 .Em MIME  then an error occurs.
 type text/plain then an error occurs.  
 .El  .El
 .Sh SMIME NOTES  
 The  
 .Em 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 an MTA is one way to  
 achieve the correct format.  
 .Pp  .Pp
 The supplied message to be signed or encrypted must include the  The exit codes for
 necessary  .Nm smime
 .Em MIME  are as follows:
 headers or many  
 .Em S/MIME  
 clients won't display it properly  
 .Pq if at all .  
 You can use the  
 .Fl text  
 option to automatically add plain text headers.  
 .Pp  .Pp
 A  .Bl -tag -width "XXXX"  -offset 3n -compact
 .Qq signed and encrypted  .It 0
 message is one where a signed message is then encrypted.  
 This can be produced by encrypting an already signed message:  
 see the  
 .Sx SMIME EXAMPLES  
 section.  
 .Pp  
 This version of the program only allows one signer per message, but it  
 will verify multiple signers on received messages.  
 Some  
 .Em S/MIME  
 clients choke if a message contains multiple signers.  
 It is possible to sign messages  
 .Qq in parallel  
 by signing an already signed message.  
 .Pp  
 The options  
 .Fl encrypt  
 and  
 .Fl decrypt  
 reflect common usage in  
 .Em S/MIME  
 clients.  
 Strictly speaking these process PKCS#7 enveloped data: PKCS#7  
 encrypted data is used for other purposes.  
 .Pp  
 The  
 .Fl resign  
 option uses an existing message digest when adding a new 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  
 .Fl stream  
 and  
 .Fl indef  
 options enable experimental streaming I/O support.  
 As a result the encoding is BER using indefinite length constructed encoding  
 and no longer DER.  
 Streaming is supported for the  
 .Fl encrypt  
 and  
 .Fl sign  
 operations if the content is not detached.  
 .Pp  
 Streaming is always used for the  
 .Fl sign  
 operation with detached data  
 but since the content is no longer part of the PKCS#7 structure  
 the encoding remains DER.  
 .Sh SMIME EXIT CODES  
 .Bl -tag -width "XXXX"  
 .It Ar 0  
 The operation was completely successful.  The operation was completely successful.
 .It Ar 1  .It 1
 An error occurred parsing the command options.  An error occurred parsing the command options.
 .It Ar 2  .It 2
 One of the input files could not be read.  One of the input files could not be read.
 .It Ar 3  .It 3
 An error occurred creating the PKCS#7 file or when reading the  An error occurred creating the file or when reading the message.
 .Em MIME  .It 4
 message.  
 .It Ar 4  
 An error occurred decrypting or verifying the message.  An error occurred decrypting or verifying the message.
 .It Ar 5  .It 5
 The message was verified correctly, but an error occurred writing out  An error occurred writing certificates.
 the signer's certificates.  
 .El  .El
 .Sh SMIME EXAMPLES  
 Create a cleartext signed message:  
 .Bd -literal -offset indent  
 $ openssl smime -sign -in message.txt -text -out mail.msg \e  
         -signer mycert.pem  
 .Ed  
 .Pp  
 Create an opaque signed message:  
 .Bd -literal -offset indent  
 $ openssl smime -sign -in message.txt -text -out mail.msg \e  
         -nodetach -signer mycert.pem  
 .Ed  
 .Pp  
 Create a signed message, include some additional certificates and  
 read the private key from another file:  
 .Bd -literal -offset indent  
 $ openssl smime -sign -in in.txt -text -out mail.msg \e  
         -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem  
 .Ed  
 .Pp  
 Create a signed message with two signers:  
 .Bd -literal -offset indent  
 openssl smime -sign -in message.txt -text -out mail.msg \e  
         -signer mycert.pem -signer othercert.pem  
 .Ed  
 .Pp  
 Send a signed message under  
 .Ux  
 directly to  
 .Xr sendmail 8 ,  
 including headers:  
 .Bd -literal -offset indent  
 $ openssl smime -sign -in in.txt -text -signer mycert.pem \e  
         -from steve@openssl.org -to someone@somewhere \e  
         -subject "Signed message" | sendmail someone@somewhere  
 .Ed  
 .Pp  
 Verify a message and extract the signer's certificate if successful:  
 .Bd -literal -offset indent  
 $ openssl smime -verify -in mail.msg -signer user.pem \e  
         -out signedtext.txt  
 .Ed  
 .Pp  
 Send encrypted mail using triple DES:  
 .Bd -literal -offset indent  
 $ openssl smime -encrypt -in in.txt -from steve@openssl.org \e  
         -to someone@somewhere -subject "Encrypted message" \e  
         -des3 -out mail.msg user.pem  
 .Ed  
 .Pp  
 Sign and encrypt mail:  
 .Bd -literal -offset indent  
 $ openssl smime -sign -in ml.txt -signer my.pem -text | \e  
         openssl smime -encrypt -out mail.msg \e  
         -from steve@openssl.org -to someone@somewhere \e  
         -subject "Signed and Encrypted message" -des3 user.pem  
 .Ed  
 .Pp  
 .Sy Note :  
 The encryption command does not include the  
 .Fl text  
 option because the message being encrypted already has  
 .Em MIME  
 headers.  
 .Pp  
 Decrypt mail:  
 .Bd -literal -offset indent  
 $ openssl smime -decrypt -in mail.msg -recip mycert.pem \e  
         -inkey key.pem"  
 .Ed  
 .Pp  
 The output from Netscape form signing is a PKCS#7 structure with the  
 detached signature format.  
 You can use this program to verify the signature by line wrapping the  
 base64-encoded structure and surrounding it with:  
 .Bd -unfilled -offset indent  
 -----BEGIN PKCS7-----  
 -----END PKCS7-----  
 .Ed  
 .Pp  
 and using the command:  
 .Bd -literal -offset indent  
 $ openssl smime -verify -inform PEM -in signature.pem \e  
         -content content.txt  
 .Ed  
 .Pp  
 Alternatively, you can base64 decode the signature and use:  
 .Bd -literal -offset indent  
 $ openssl smime -verify -inform DER -in signature.der \e  
         -content content.txt  
 .Ed  
 .Pp  
 Create an encrypted message using 128-bit AES:  
 .Bd -literal -offset indent  
 openssl smime -encrypt -in plain.txt -aes128 \e  
         -out mail.msg cert.pem  
 .Ed  
 .Pp  
 Add a signer to an existing message:  
 .Bd -literal -offset indent  
 openssl smime -resign -in mail.msg -signer newsign.pem \e  
         -out mail2.msg  
 .Ed  
 .Sh SMIME BUGS  
 The  
 .Em 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 the signer has a separate encryption certificate this must be manually  
 extracted.  
 There should be some heuristic that determines the correct encryption  
 certificate.  
 .Pp  
 Ideally, a database should be maintained of a certificate for each email  
 address.  
 .Pp  
 The code doesn't currently take note of the permitted symmetric encryption  
 algorithms as supplied in the  
 .Em SMIMECapabilities  
 signed attribute.  
 This means the user has to manually include the correct encryption algorithm.  
 It should store the list of permitted ciphers in a database and only use those.  
 .Pp  
 No revocation checking is done on the signer's certificate.  
 .Pp  
 The current code can only handle  
 .Em S/MIME  
 v2 messages; the more complex  
 .Em S/MIME  
 v3 structures may cause parsing errors.  
 .Sh SMIME HISTORY  
 The use of multiple  
 .Fl signer  
 options and the  
 .Fl resign  
 command were first added in  
 .Nm OpenSSL  
 1.0.0.  
 .\"  .\"
 .\" SPEED  .\" SPEED
 .\"  .\"
Line 7029 
Line 6766 
 .It Cm pem  .It Cm pem
 Privacy Enhanced Mail (PEM)  Privacy Enhanced Mail (PEM)
 is base64-encoded.  is base64-encoded.
   .It Cm smime
   An SMIME format message.
 .It Cm txt  .It Cm txt
 Plain ASCII text.  Plain ASCII text.
 .El  .El
Legend:
Removed from v.1.69  
changed lines
  Added in v.1.70