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