secure/usr.bin/openssl/man/dsa.1

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "DSA 1"
 132 .TH DSA 1 "2018-08-14" "1.0.2p" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-dsa,
 139 dsa \- DSA key processing
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBdsa\fR
 143 [\fB\-inform PEM|DER\fR]
 144 [\fB\-outform PEM|DER\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-passin arg\fR]
 147 [\fB\-out filename\fR]
 148 [\fB\-passout arg\fR]
 149 [\fB\-aes128\fR]
 150 [\fB\-aes192\fR]
 151 [\fB\-aes256\fR]
 152 [\fB\-camellia128\fR]
 153 [\fB\-camellia192\fR]
 154 [\fB\-camellia256\fR]
 155 [\fB\-des\fR]
 156 [\fB\-des3\fR]
 157 [\fB\-idea\fR]
 158 [\fB\-text\fR]
 159 [\fB\-noout\fR]
 160 [\fB\-modulus\fR]
 161 [\fB\-pubin\fR]
 162 [\fB\-pubout\fR]
 163 [\fB\-engine id\fR]
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \fBdsa\fR command processes \s-1DSA\s0 keys. They can be converted between various
 167 forms and their components printed out. \fBNote\fR This command uses the
 168 traditional SSLeay compatible format for private key encryption: newer
 169 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
 170 .SH "COMMAND OPTIONS"
 171 .IX Header "COMMAND OPTIONS"
 172 .IP "\fB\-inform DER|PEM\fR" 4
 173 .IX Item "-inform DER|PEM"
 174 This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
 175 an \s-1ASN1 DER\s0 encoded form of an \s-1ASN.1 SEQUENCE\s0 consisting of the values of
 176 version (currently zero), p, q, g, the public and private key components
 177 respectively as \s-1ASN.1\s0 INTEGERs. When used with a public key it uses a
 178 SubjectPublicKeyInfo structure: it is an error if the key is not \s-1DSA.\s0
 179 .Sp
 180 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 181 encoded with additional header and footer lines. In the case of a private key
 182 PKCS#8 format is also accepted.
 183 .IP "\fB\-outform DER|PEM\fR" 4
 184 .IX Item "-outform DER|PEM"
 185 This specifies the output format, the options have the same meaning as the
 186 \&\fB\-inform\fR option.
 187 .IP "\fB\-in filename\fR" 4
 188 .IX Item "-in filename"
 189 This specifies the input filename to read a key from or standard input if this
 190 option is not specified. If the key is encrypted a pass phrase will be
 191 prompted for.
 192 .IP "\fB\-passin arg\fR" 4
 193 .IX Item "-passin arg"
 194 the input file password source. For more information about the format of \fBarg\fR
 195 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 196 .IP "\fB\-out filename\fR" 4
 197 .IX Item "-out filename"
 198 This specifies the output filename to write a key to or standard output by
 199 is not specified. If any encryption options are set then a pass phrase will be
 200 prompted for. The output filename should \fBnot\fR be the same as the input
 201 filename.
 202 .IP "\fB\-passout arg\fR" 4
 203 .IX Item "-passout arg"
 204 the output file password source. For more information about the format of \fBarg\fR
 205 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 206 .IP "\fB\-aes128|\-aes192|\-aes256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
 207 .IX Item "-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
 208 These options encrypt the private key with the specified
 209 cipher before outputting it. A pass phrase is prompted for.
 210 If none of these options is specified the key is written in plain text. This
 211 means that using the \fBdsa\fR utility to read in an encrypted key with no
 212 encryption option can be used to remove the pass phrase from a key, or by
 213 setting the encryption options it can be use to add or change the pass phrase.
 214 These options can only be used with \s-1PEM\s0 format output files.
 215 .IP "\fB\-text\fR" 4
 216 .IX Item "-text"
 217 prints out the public, private key components and parameters.
 218 .IP "\fB\-noout\fR" 4
 219 .IX Item "-noout"
 220 this option prevents output of the encoded version of the key.
 221 .IP "\fB\-modulus\fR" 4
 222 .IX Item "-modulus"
 223 this option prints out the value of the public key component of the key.
 224 .IP "\fB\-pubin\fR" 4
 225 .IX Item "-pubin"
 226 by default a private key is read from the input file: with this option a
 227 public key is read instead.
 228 .IP "\fB\-pubout\fR" 4
 229 .IX Item "-pubout"
 230 by default a private key is output. With this option a public
 231 key will be output instead. This option is automatically set if the input is
 232 a public key.
 233 .IP "\fB\-engine id\fR" 4
 234 .IX Item "-engine id"
 235 specifying an engine (by its unique \fBid\fR string) will cause \fBdsa\fR
 236 to attempt to obtain a functional reference to the specified engine,
 237 thus initialising it if needed. The engine will then be set as the default
 238 for all available algorithms.
 239 .SH "NOTES"
 240 .IX Header "NOTES"
 241 The \s-1PEM\s0 private key format uses the header and footer lines:
 242 .PP
 243 .Vb 2
 244 \& \-\-\-\-\-BEGIN DSA PRIVATE KEY\-\-\-\-\-
 245 \& \-\-\-\-\-END DSA PRIVATE KEY\-\-\-\-\-
 246 .Ve
 247 .PP
 248 The \s-1PEM\s0 public key format uses the header and footer lines:
 249 .PP
 250 .Vb 2
 251 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
 252 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
 253 .Ve
 254 .SH "EXAMPLES"
 255 .IX Header "EXAMPLES"
 256 To remove the pass phrase on a \s-1DSA\s0 private key:
 257 .PP
 258 .Vb 1
 259 \& openssl dsa \-in key.pem \-out keyout.pem
 260 .Ve
 261 .PP
 262 To encrypt a private key using triple \s-1DES:\s0
 263 .PP
 264 .Vb 1
 265 \& openssl dsa \-in key.pem \-des3 \-out keyout.pem
 266 .Ve
 267 .PP
 268 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 269 .PP
 270 .Vb 1
 271 \& openssl dsa \-in key.pem \-outform DER \-out keyout.der
 272 .Ve
 273 .PP
 274 To print out the components of a private key to standard output:
 275 .PP
 276 .Vb 1
 277 \& openssl dsa \-in key.pem \-text \-noout
 278 .Ve
 279 .PP
 280 To just output the public part of a private key:
 281 .PP
 282 .Vb 1
 283 \& openssl dsa \-in key.pem \-pubout \-out pubkey.pem
 284 .Ve
 285 .SH "SEE ALSO"
 286 .IX Header "SEE ALSO"
 287 \&\fIdsaparam\fR\|(1), \fIgendsa\fR\|(1), \fIrsa\fR\|(1),
 288 \&\fIgenrsa\fR\|(1)