doc/man1/openssl-dsa.pod

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