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