doc/man1/dsa.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 dsa - DSA key processing
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<dsa>
  10 [B<-help>]
  11 [B<-inform PEM|DER>]
  12 [B<-outform PEM|DER>]
  13 [B<-in filename>]
  14 [B<-passin arg>]
  15 [B<-out filename>]
  16 [B<-passout arg>]
  17 [B<-aes128>]
  18 [B<-aes192>]
  19 [B<-aes256>]
  20 [B<-aria128>]
  21 [B<-aria192>]
  22 [B<-aria256>]
  23 [B<-camellia128>]
  24 [B<-camellia192>]
  25 [B<-camellia256>]
  26 [B<-des>]
  27 [B<-des3>]
  28 [B<-idea>]
  29 [B<-text>]
  30 [B<-noout>]
  31 [B<-modulus>]
  32 [B<-pubin>]
  33 [B<-pubout>]
  34 [B<-engine id>]
  35
  36 =head1 DESCRIPTION
  37
  38 The B<dsa> command processes DSA keys. They can be converted between various
  39 forms and their components printed out. B<Note> This command uses the
  40 traditional SSLeay compatible format for private key encryption: newer
  41 applications should use the more secure PKCS#8 format using the B<pkcs8>
  42
  43 =head1 OPTIONS
  44
  45 =over 4
  46
  47 =item B<-help>
  48
  49 Print out a usage message.
  50
  51 =item B<-inform DER|PEM>
  52
  53 This specifies the input format. The B<DER> option with a private key uses
  54 an ASN1 DER encoded form of an ASN.1 SEQUENCE consisting of the values of
  55 version (currently zero), p, q, g, the public and private key components
  56 respectively as ASN.1 INTEGERs. When used with a public key it uses a
  57 SubjectPublicKeyInfo structure: it is an error if the key is not DSA.
  58
  59 The B<PEM> form is the default format: it consists of the B<DER> format base64
  60 encoded with additional header and footer lines. In the case of a private key
  61 PKCS#8 format is also accepted.
  62
  63 =item B<-outform DER|PEM>
  64
  65 This specifies the output format, the options have the same meaning and default
  66 as the B<-inform> option.
  67
  68 =item B<-in filename>
  69
  70 This specifies the input filename to read a key from or standard input if this
  71 option is not specified. If the key is encrypted a pass phrase will be
  72 prompted for.
  73
  74 =item B<-passin arg>
  75
  76 The input file password source. For more information about the format of B<arg>
  77 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  78
  79 =item B<-out filename>
  80
  81 This specifies the output filename to write a key to or standard output by
  82 is not specified. If any encryption options are set then a pass phrase will be
  83 prompted for. The output filename should B<not> be the same as the input
  84 filename.
  85
  86 =item B<-passout arg>
  87
  88 The output file password source. For more information about the format of B<arg>
  89 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  90
  91 =item B<-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
  92
  93 These options encrypt the private key with the specified
  94 cipher before outputting it. A pass phrase is prompted for.
  95 If none of these options is specified the key is written in plain text. This
  96 means that using the B<dsa> utility to read in an encrypted key with no
  97 encryption option can be used to remove the pass phrase from a key, or by
  98 setting the encryption options it can be use to add or change the pass phrase.
  99 These options can only be used with PEM format output files.
 100
 101 =item B<-text>
 102
 103 Prints out the public, private key components and parameters.
 104
 105 =item B<-noout>
 106
 107 This option prevents output of the encoded version of the key.
 108
 109 =item B<-modulus>
 110
 111 This option prints out the value of the public key component of the key.
 112
 113 =item B<-pubin>
 114
 115 By default, a private key is read from the input file. With this option a
 116 public key is read instead.
 117
 118 =item B<-pubout>
 119
 120 By default, a private key is output. With this option a public
 121 key will be output instead. This option is automatically set if the input is
 122 a public key.
 123
 124 =item B<-engine id>
 125
 126 Specifying an engine (by its unique B<id> string) will cause B<dsa>
 127 to attempt to obtain a functional reference to the specified engine,
 128 thus initialising it if needed. The engine will then be set as the default
 129 for all available algorithms.
 130
 131 =back
 132
 133 =head1 NOTES
 134
 135 The PEM private key format uses the header and footer lines:
 136
 137  -----BEGIN DSA PRIVATE KEY-----
 138  -----END DSA PRIVATE KEY-----
 139
 140 The PEM public key format uses the header and footer lines:
 141
 142  -----BEGIN PUBLIC KEY-----
 143  -----END PUBLIC KEY-----
 144
 145 =head1 EXAMPLES
 146
 147 To remove the pass phrase on a DSA private key:
 148
 149  openssl dsa -in key.pem -out keyout.pem
 150
 151 To encrypt a private key using triple DES:
 152
 153  openssl dsa -in key.pem -des3 -out keyout.pem
 154
 155 To convert a private key from PEM to DER format:
 156
 157  openssl dsa -in key.pem -outform DER -out keyout.der
 158
 159 To print out the components of a private key to standard output:
 160
 161  openssl dsa -in key.pem -text -noout
 162
 163 To just output the public part of a private key:
 164
 165  openssl dsa -in key.pem -pubout -out pubkey.pem
 166
 167 =head1 SEE ALSO
 168
 169 L<dsaparam(1)>, L<gendsa(1)>, L<rsa(1)>,
 170 L<genrsa(1)>
 171
 172 =head1 COPYRIGHT
 173
 174 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 175
 176 Licensed under the OpenSSL license (the "License").  You may not use
 177 this file except in compliance with the License.  You can obtain a copy
 178 in the file LICENSE in the source distribution or at
 179 L<https://www.openssl.org/source/license.html>.
 180
 181 =cut