doc/man1/openssl-dsa.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-dsa - DSA key processing
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<dsa>
  10 [B<-help>]
  11 [B<-inform> B<DER>|B<PEM>]
  12 [B<-outform> B<DER>|B<PEM>]
  13 [B<-in> I<filename>]
  14 [B<-passin> I<arg>]
  15 [B<-out> I<filename>]
  16 [B<-passout> I<arg>]
  17 [B<-aes128>]
  18 [B<-aes192>]
  19 [B<-aes256>]
  20 [B<-aria128>]
  21 [B<-aria192>]
  22 [B<-aria256>]
  23 [B<-camellia128>]
  24 [B<-camellia192>]
  25 [B<-camellia256>]
  26 [B<-des>]
  27 [B<-des3>]
  28 [B<-idea>]
  29 [B<-text>]
  30 [B<-noout>]
  31 [B<-modulus>]
  32 [B<-pubin>]
  33 [B<-pubout>]
  34 [B<-engine> I<id>]
  35
  36 =for openssl ifdef pvk-string pvk-weak pvk-none engine
  37
  38 =head1 DESCRIPTION
  39
  40 This command processes DSA keys. They can be converted between various
  41 forms and their components printed out. B<Note> This command uses the
  42 traditional SSLeay compatible format for private key encryption: newer
  43 applications should use the more secure PKCS#8 format using the B<pkcs8>
  44
  45 =head1 OPTIONS
  46
  47 =over 4
  48
  49 =item B<-help>
  50
  51 Print out a usage message.
  52
  53 =item B<-inform> B<DER>|B<PEM>
  54
  55 This specifies the input format. The B<DER> option with a private key uses
  56 an ASN1 DER encoded form of an ASN.1 SEQUENCE consisting of the values of
  57 version (currently zero), p, q, g, the public and private key components
  58 respectively as ASN.1 INTEGERs. When used with a public key it uses a
  59 SubjectPublicKeyInfo structure: it is an error if the key is not DSA.
  60
  61 The B<PEM> form is the default format: it consists of the B<DER> format base64
  62 encoded with additional header and footer lines. In the case of a private key
  63 PKCS#8 format is also accepted.
  64
  65 =item B<-outform> B<DER>|B<PEM>
  66
  67 This specifies the output format, the options have the same meaning and default
  68 as the B<-inform> option.
  69
  70 =item B<-in> I<filename>
  71
  72 This specifies the input filename to read a key from or standard input if this
  73 option is not specified. If the key is encrypted a pass phrase will be
  74 prompted for.
  75
  76 =item B<-out> I<filename>
  77
  78 This specifies the output filename to write a key to or standard output by
  79 is not specified. If any encryption options are set then a pass phrase will be
  80 prompted for. The output filename should B<not> be the same as the input
  81 filename.
  82
  83 =item B<-passin> I<arg>, B<-passout> I<arg>
  84
  85 The password source for the input and output file.
  86 For more information about the format of B<arg>
  87 see L<openssl(1)/Pass Phrase Options>.
  88
  89 =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>
  90
  91 These options encrypt the private key with the specified
  92 cipher before outputting it. A pass phrase is prompted for.
  93 If none of these options is specified the key is written in plain text. This
  94 means that this command can be used to remove the pass phrase from a key
  95 by not giving any encryption option is given, or to add or change the pass
  96 phrase by setting them.
  97 These options can only be used with PEM format output files.
  98
  99 =item B<-text>
 100
 101 Prints out the public, private key components and parameters.
 102
 103 =item B<-noout>
 104
 105 This option prevents output of the encoded version of the key.
 106
 107 =item B<-modulus>
 108
 109 This option prints out the value of the public key component of the key.
 110
 111 =item B<-pubin>
 112
 113 By default, a private key is read from the input file. With this option a
 114 public key is read instead.
 115
 116 =item B<-pubout>
 117
 118 By default, a private key is output. With this option a public
 119 key will be output instead. This option is automatically set if the input is
 120 a public key.
 121
 122 =item B<-engine> I<id>
 123
 124 Specifying an engine (by its unique I<id> string) will cause L<openssl-dsa(1)>
 125 to attempt to obtain a functional reference to the specified engine,
 126 thus initialising it if needed. The engine will then be set as the default
 127 for all available algorithms.
 128
 129 =back
 130
 131 =head1 NOTES
 132
 133 The PEM private key format uses the header and footer lines:
 134
 135  -----BEGIN DSA PRIVATE KEY-----
 136  -----END DSA PRIVATE KEY-----
 137
 138 The PEM public key format uses the header and footer lines:
 139
 140  -----BEGIN PUBLIC KEY-----
 141  -----END PUBLIC KEY-----
 142
 143 =head1 EXAMPLES
 144
 145 To remove the pass phrase on a DSA private key:
 146
 147  openssl dsa -in key.pem -out keyout.pem
 148
 149 To encrypt a private key using triple DES:
 150
 151  openssl dsa -in key.pem -des3 -out keyout.pem
 152
 153 To convert a private key from PEM to DER format:
 154
 155  openssl dsa -in key.pem -outform DER -out keyout.der
 156
 157 To print out the components of a private key to standard output:
 158
 159  openssl dsa -in key.pem -text -noout
 160
 161 To just output the public part of a private key:
 162
 163  openssl dsa -in key.pem -pubout -out pubkey.pem
 164
 165 =head1 SEE ALSO
 166
 167 L<openssl(1)>,
 168 L<openssl-dsaparam(1)>,
 169 L<openssl-gendsa(1)>,
 170 L<openssl-rsa(1)>,
 171 L<openssl-genrsa(1)>
 172
 173 =head1 COPYRIGHT
 174
 175 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 176
 177 Licensed under the Apache License 2.0 (the "License").  You may not use
 178 this file except in compliance with the License.  You can obtain a copy
 179 in the file LICENSE in the source distribution or at
 180 L<https://www.openssl.org/source/license.html>.
 181
 182 =cut