doc/man1/openssl-dsa.pod.in

   1 =pod
   2
   3 =begin comment
   4 {- join("\n", @autowarntext) -}
   5
   6 =end comment
   7
   8 =head1 NAME
   9
  10 openssl-dsa - DSA key processing
  11
  12 =head1 SYNOPSIS
  13
  14 B<openssl> B<dsa>
  15 [B<-help>]
  16 [B<-inform> B<DER>|B<PEM>]
  17 [B<-outform> B<DER>|B<PEM>]
  18 [B<-in> I<filename>]
  19 [B<-passin> I<arg>]
  20 [B<-out> I<filename>]
  21 [B<-passout> I<arg>]
  22 [B<-aes128>]
  23 [B<-aes192>]
  24 [B<-aes256>]
  25 [B<-aria128>]
  26 [B<-aria192>]
  27 [B<-aria256>]
  28 [B<-camellia128>]
  29 [B<-camellia192>]
  30 [B<-camellia256>]
  31 [B<-des>]
  32 [B<-des3>]
  33 [B<-idea>]
  34 [B<-text>]
  35 [B<-noout>]
  36 [B<-modulus>]
  37 [B<-pubin>]
  38 [B<-pubout>]
  39 [B<-pvk-strong>]
  40 [B<-pvk-weak>]
  41 [B<-pvk-none>]
  42 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  43
  44 =for openssl ifdef pvk-strong pvk-weak pvk-none engine
  45
  46 =head1 DESCRIPTION
  47
  48 This command processes DSA keys. They can be converted between various
  49 forms and their components printed out. B<Note> This command uses the
  50 traditional SSLeay compatible format for private key encryption: newer
  51 applications should use the more secure PKCS#8 format using the B<pkcs8>
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item B<-help>
  58
  59 Print out a usage message.
  60
  61 =item B<-inform> B<DER>|B<PEM>
  62
  63 The key input format; unspecified by default.
  64 See L<openssl-format-options(1)> for details.
  65
  66 =item B<-outform> B<DER>|B<PEM>
  67
  68 The key output format; the default is B<PEM>.
  69 See L<openssl-format-options(1)> for details.
  70
  71 Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
  72 B<q>, B<g>, and the public and private key components.  Public keys
  73 are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
  74
  75 The B<PEM> format also accepts PKCS#8 data.
  76
  77 =item B<-in> I<filename>
  78
  79 This specifies the input filename to read a key from or standard input if this
  80 option is not specified. If the key is encrypted a pass phrase will be
  81 prompted for.
  82
  83 =item B<-out> I<filename>
  84
  85 This specifies the output filename to write a key to or standard output by
  86 is not specified. If any encryption options are set then a pass phrase will be
  87 prompted for. The output filename should B<not> be the same as the input
  88 filename.
  89
  90 =item B<-passin> I<arg>, B<-passout> I<arg>
  91
  92 The password source for the input and output file.
  93 For more information about the format of B<arg>
  94 see L<openssl-passphrase-options(1)>.
  95
  96 =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>
  97
  98 These options encrypt the private key with the specified
  99 cipher before outputting it. A pass phrase is prompted for.
 100 If none of these options is specified the key is written in plain text. This
 101 means that this command can be used to remove the pass phrase from a key
 102 by not giving any encryption option is given, or to add or change the pass
 103 phrase by setting them.
 104 These options can only be used with PEM format output files.
 105
 106 =item B<-text>
 107
 108 Prints out the public, private key components and parameters.
 109
 110 =item B<-noout>
 111
 112 This option prevents output of the encoded version of the key.
 113
 114 =item B<-modulus>
 115
 116 This option prints out the value of the public key component of the key.
 117
 118 =item B<-pubin>
 119
 120 By default, a private key is read from the input file. With this option a
 121 public key is read instead.
 122
 123 =item B<-pubout>
 124
 125 By default, a private key is output. With this option a public
 126 key will be output instead. This option is automatically set if the input is
 127 a public key.
 128
 129 =item B<-pvk-strong>
 130
 131 Enable 'Strong' PVK encoding level (default).
 132
 133 =item B<-pvk-weak>
 134
 135 Enable 'Weak' PVK encoding level.
 136
 137 =item B<-pvk-none>
 138
 139 Don't enforce PVK encoding.
 140
 141 {- $OpenSSL::safe::opt_engine_item -}
 142
 143 {- $OpenSSL::safe::opt_provider_item -}
 144
 145 =back
 146
 147 The L<openssl-pkey(1)> command is capable of performing all the operations
 148 this command can, as well as supporting other public key types.
 149
 150 =head1 EXAMPLES
 151
 152 The documentation for the L<openssl-pkey(1)> command contains examples
 153 equivalent to the ones listed here.
 154
 155 To remove the pass phrase on a DSA private key:
 156
 157  openssl dsa -in key.pem -out keyout.pem
 158
 159 To encrypt a private key using triple DES:
 160
 161  openssl dsa -in key.pem -des3 -out keyout.pem
 162
 163 To convert a private key from PEM to DER format:
 164
 165  openssl dsa -in key.pem -outform DER -out keyout.der
 166
 167 To print out the components of a private key to standard output:
 168
 169  openssl dsa -in key.pem -text -noout
 170
 171 To just output the public part of a private key:
 172
 173  openssl dsa -in key.pem -pubout -out pubkey.pem
 174
 175 =head1 SEE ALSO
 176
 177 L<openssl(1)>,
 178 L<openssl-pkey(1)>,
 179 L<openssl-dsaparam(1)>,
 180 L<openssl-gendsa(1)>,
 181 L<openssl-rsa(1)>,
 182 L<openssl-genrsa(1)>
 183
 184 =head1 HISTORY
 185
 186 The B<-engine> option was deprecated in OpenSSL 3.0.
 187
 188 =head1 COPYRIGHT
 189
 190 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
 191
 192 Licensed under the Apache License 2.0 (the "License").  You may not use
 193 this file except in compliance with the License.  You can obtain a copy
 194 in the file LICENSE in the source distribution or at
 195 L<https://www.openssl.org/source/license.html>.
 196
 197 =cut