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>, B<-outform> B<DER>|B<PEM>
  54
  55 The input and formats; the default is B<PEM>.
  56 See L<openssl(1)/Format Options> for details.
  57
  58 Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
  59 B<q>, B<g>, and the public and and private key components.  Public keys
  60 are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
  61
  62 The B<PEM> format also accepts PKCS#8 data.
  63
  64 =item B<-in> I<filename>
  65
  66 This specifies the input filename to read a key from or standard input if this
  67 option is not specified. If the key is encrypted a pass phrase will be
  68 prompted for.
  69
  70 =item B<-out> I<filename>
  71
  72 This specifies the output filename to write a key to or standard output by
  73 is not specified. If any encryption options are set then a pass phrase will be
  74 prompted for. The output filename should B<not> be the same as the input
  75 filename.
  76
  77 =item B<-passin> I<arg>, B<-passout> I<arg>
  78
  79 The password source for the input and output file.
  80 For more information about the format of B<arg>
  81 see L<openssl(1)/Pass Phrase Options>.
  82
  83 =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>
  84
  85 These options encrypt the private key with the specified
  86 cipher before outputting it. A pass phrase is prompted for.
  87 If none of these options is specified the key is written in plain text. This
  88 means that this command can be used to remove the pass phrase from a key
  89 by not giving any encryption option is given, or to add or change the pass
  90 phrase by setting them.
  91 These options can only be used with PEM format output files.
  92
  93 =item B<-text>
  94
  95 Prints out the public, private key components and parameters.
  96
  97 =item B<-noout>
  98
  99 This option prevents output of the encoded version of the key.
 100
 101 =item B<-modulus>
 102
 103 This option prints out the value of the public key component of the key.
 104
 105 =item B<-pubin>
 106
 107 By default, a private key is read from the input file. With this option a
 108 public key is read instead.
 109
 110 =item B<-pubout>
 111
 112 By default, a private key is output. With this option a public
 113 key will be output instead. This option is automatically set if the input is
 114 a public key.
 115
 116 =item B<-engine> I<id>
 117
 118 Specifying an engine (by its unique I<id> string) will cause L<openssl-dsa(1)>
 119 to attempt to obtain a functional reference to the specified engine,
 120 thus initialising it if needed. The engine will then be set as the default
 121 for all available algorithms.
 122
 123 =back
 124
 125 =head1 EXAMPLES
 126
 127 To remove the pass phrase on a DSA private key:
 128
 129  openssl dsa -in key.pem -out keyout.pem
 130
 131 To encrypt a private key using triple DES:
 132
 133  openssl dsa -in key.pem -des3 -out keyout.pem
 134
 135 To convert a private key from PEM to DER format:
 136
 137  openssl dsa -in key.pem -outform DER -out keyout.der
 138
 139 To print out the components of a private key to standard output:
 140
 141  openssl dsa -in key.pem -text -noout
 142
 143 To just output the public part of a private key:
 144
 145  openssl dsa -in key.pem -pubout -out pubkey.pem
 146
 147 =head1 SEE ALSO
 148
 149 L<openssl(1)>,
 150 L<openssl-dsaparam(1)>,
 151 L<openssl-gendsa(1)>,
 152 L<openssl-rsa(1)>,
 153 L<openssl-genrsa(1)>
 154
 155 =head1 COPYRIGHT
 156
 157 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 158
 159 Licensed under the Apache License 2.0 (the "License").  You may not use
 160 this file except in compliance with the License.  You can obtain a copy
 161 in the file LICENSE in the source distribution or at
 162 L<https://www.openssl.org/source/license.html>.
 163
 164 =cut