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