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
  41 =for openssl ifdef pvk-string pvk-weak pvk-none engine
  42
  43 =head1 DESCRIPTION
  44
  45 This command has been deprecated.
  46 The L<openssl-pkey(1)> command should be used instead.
  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>, B<-outform> B<DER>|B<PEM>
  62
  63 The input and formats; the default is B<PEM>.
  64 See L<openssl(1)/Format Options> for details.
  65
  66 Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
  67 B<q>, B<g>, and the public and and private key components.  Public keys
  68 are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
  69
  70 The B<PEM> format also accepts PKCS#8 data.
  71
  72 =item B<-in> I<filename>
  73
  74 This specifies the input filename to read a key from or standard input if this
  75 option is not specified. If the key is encrypted a pass phrase will be
  76 prompted for.
  77
  78 =item B<-out> I<filename>
  79
  80 This specifies the output filename to write a key to or standard output by
  81 is not specified. If any encryption options are set then a pass phrase will be
  82 prompted for. The output filename should B<not> be the same as the input
  83 filename.
  84
  85 =item B<-passin> I<arg>, B<-passout> I<arg>
  86
  87 The password source for the input and output file.
  88 For more information about the format of B<arg>
  89 see L<openssl(1)/Pass Phrase Options>.
  90
  91 =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>
  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 this command can be used to remove the pass phrase from a key
  97 by not giving any encryption option is given, or to add or change the pass
  98 phrase by setting them.
  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 {- $OpenSSL::safe::opt_engine_item -}
 125
 126 =back
 127
 128 =head1 EXAMPLES
 129
 130 Examples equivalent to these can be found in the documentation for the
 131 non-deprecated L<openssl-pkey(1)> command.
 132
 133 To remove the pass phrase on a DSA private key:
 134
 135  openssl dsa -in key.pem -out keyout.pem
 136
 137 To encrypt a private key using triple DES:
 138
 139  openssl dsa -in key.pem -des3 -out keyout.pem
 140
 141 To convert a private key from PEM to DER format:
 142
 143  openssl dsa -in key.pem -outform DER -out keyout.der
 144
 145 To print out the components of a private key to standard output:
 146
 147  openssl dsa -in key.pem -text -noout
 148
 149 To just output the public part of a private key:
 150
 151  openssl dsa -in key.pem -pubout -out pubkey.pem
 152
 153 =head1 SEE ALSO
 154
 155 L<openssl(1)>,
 156 L<openssl-pkey(1)>,
 157 L<openssl-dsaparam(1)>,
 158 L<openssl-gendsa(1)>,
 159 L<openssl-rsa(1)>,
 160 L<openssl-genrsa(1)>
 161
 162 =head1 HISTORY
 163
 164 This command was deprecated in OpenSSL 3.0.
 165
 166 =head1 COPYRIGHT
 167
 168 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 169
 170 Licensed under the Apache License 2.0 (the "License").  You may not use
 171 this file except in compliance with the License.  You can obtain a copy
 172 in the file LICENSE in the source distribution or at
 173 L<https://www.openssl.org/source/license.html>.
 174
 175 =cut