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

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "DSAPARAM 1"
 135 .TH DSAPARAM 1 "2009-01-11" "0.9.8j" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 dsaparam \- DSA parameter manipulation and generation
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 \&\fBopenssl dsaparam\fR
 145 [\fB\-inform DER|PEM\fR]
 146 [\fB\-outform DER|PEM\fR]
 147 [\fB\-in filename\fR]
 148 [\fB\-out filename\fR]
 149 [\fB\-noout\fR]
 150 [\fB\-text\fR]
 151 [\fB\-C\fR]
 152 [\fB\-rand file(s)\fR]
 153 [\fB\-genkey\fR]
 154 [\fB\-engine id\fR]
 155 [\fBnumbits\fR]
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 This command is used to manipulate or generate \s-1DSA\s0 parameter files.
 159 .SH "OPTIONS"
 160 .IX Header "OPTIONS"
 161 .IP "\fB\-inform DER|PEM\fR" 4
 162 .IX Item "-inform DER|PEM"
 163 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
 164 form compatible with \s-1RFC2459\s0 (\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
 165 of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
 166 of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
 167 .IP "\fB\-outform DER|PEM\fR" 4
 168 .IX Item "-outform DER|PEM"
 169 This specifies the output format, the options have the same meaning as the
 170 \&\fB\-inform\fR option.
 171 .IP "\fB\-in filename\fR" 4
 172 .IX Item "-in filename"
 173 This specifies the input filename to read parameters from or standard input if
 174 this option is not specified. If the \fBnumbits\fR parameter is included then
 175 this option will be ignored.
 176 .IP "\fB\-out filename\fR" 4
 177 .IX Item "-out filename"
 178 This specifies the output filename parameters to. Standard output is used
 179 if this option is not present. The output filename should \fBnot\fR be the same
 180 as the input filename.
 181 .IP "\fB\-noout\fR" 4
 182 .IX Item "-noout"
 183 this option inhibits the output of the encoded version of the parameters.
 184 .IP "\fB\-text\fR" 4
 185 .IX Item "-text"
 186 this option prints out the \s-1DSA\s0 parameters in human readable form.
 187 .IP "\fB\-C\fR" 4
 188 .IX Item "-C"
 189 this option converts the parameters into C code. The parameters can then
 190 be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
 191 .IP "\fB\-genkey\fR" 4
 192 .IX Item "-genkey"
 193 this option will generate a \s-1DSA\s0 either using the specified or generated
 194 parameters.
 195 .IP "\fB\-rand file(s)\fR" 4
 196 .IX Item "-rand file(s)"
 197 a file or files containing random data used to seed the random number
 198 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 199 Multiple files can be specified separated by a OS-dependent character.
 200 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 201 all others.
 202 .IP "\fBnumbits\fR" 4
 203 .IX Item "numbits"
 204 this option specifies that a parameter set should be generated of size
 205 \&\fBnumbits\fR. It must be the last option. If this option is included then
 206 the input file (if any) is ignored.
 207 .IP "\fB\-engine id\fR" 4
 208 .IX Item "-engine id"
 209 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
 210 to attempt to obtain a functional reference to the specified engine,
 211 thus initialising it if needed. The engine will then be set as the default
 212 for all available algorithms.
 213 .SH "NOTES"
 214 .IX Header "NOTES"
 215 \&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
 216 .PP
 217 .Vb 2
 218 \& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
 219 \& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
 220 .Ve
 221 .PP
 222 \&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
 223 \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 227 \&\fIrsa\fR\|(1)