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

   1 .\" Automatically generated by Pod::Man 4.10 (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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "ECPARAM 1"
 136 .TH ECPARAM 1 "2019-02-26" "1.0.2r" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 openssl\-ecparam,
 143 ecparam \- EC parameter manipulation and generation
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 \&\fBopenssl ecparam\fR
 147 [\fB\-inform DER|PEM\fR]
 148 [\fB\-outform DER|PEM\fR]
 149 [\fB\-in filename\fR]
 150 [\fB\-out filename\fR]
 151 [\fB\-noout\fR]
 152 [\fB\-text\fR]
 153 [\fB\-C\fR]
 154 [\fB\-check\fR]
 155 [\fB\-name arg\fR]
 156 [\fB\-list_curves\fR]
 157 [\fB\-conv_form arg\fR]
 158 [\fB\-param_enc arg\fR]
 159 [\fB\-no_seed\fR]
 160 [\fB\-rand file(s)\fR]
 161 [\fB\-genkey\fR]
 162 [\fB\-engine id\fR]
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 This command is used to manipulate or generate \s-1EC\s0 parameter files.
 166 .SH "OPTIONS"
 167 .IX Header "OPTIONS"
 168 .IP "\fB\-inform DER|PEM\fR" 4
 169 .IX Item "-inform DER|PEM"
 170 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN.1 DER\s0 encoded
 171 form compatible with \s-1RFC 3279\s0 EcpkParameters. The \s-1PEM\s0 form is the default
 172 format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with additional
 173 header and footer lines.
 174 .IP "\fB\-outform DER|PEM\fR" 4
 175 .IX Item "-outform DER|PEM"
 176 This specifies the output format, the options have the same meaning as the
 177 \&\fB\-inform\fR option.
 178 .IP "\fB\-in filename\fR" 4
 179 .IX Item "-in filename"
 180 This specifies the input filename to read parameters from or standard input if
 181 this option is not specified.
 182 .IP "\fB\-out filename\fR" 4
 183 .IX Item "-out filename"
 184 This specifies the output filename parameters to. Standard output is used
 185 if this option is not present. The output filename should \fBnot\fR be the same
 186 as the input filename.
 187 .IP "\fB\-noout\fR" 4
 188 .IX Item "-noout"
 189 This option inhibits the output of the encoded version of the parameters.
 190 .IP "\fB\-text\fR" 4
 191 .IX Item "-text"
 192 This option prints out the \s-1EC\s0 parameters in human readable form.
 193 .IP "\fB\-C\fR" 4
 194 .IX Item "-C"
 195 This option converts the \s-1EC\s0 parameters into C code. The parameters can then
 196 be loaded by calling the \fB\fBget_ec_group_XXX()\fB\fR function.
 197 .IP "\fB\-check\fR" 4
 198 .IX Item "-check"
 199 Validate the elliptic curve parameters.
 200 .IP "\fB\-name arg\fR" 4
 201 .IX Item "-name arg"
 202 Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR
 203 to get a list of all currently implemented \s-1EC\s0 parameters.
 204 .IP "\fB\-list_curves\fR" 4
 205 .IX Item "-list_curves"
 206 If this options is specified \fBecparam\fR will print out a list of all
 207 currently implemented \s-1EC\s0 parameters names and exit.
 208 .IP "\fB\-conv_form\fR" 4
 209 .IX Item "-conv_form"
 210 This specifies how the points on the elliptic curve are converted
 211 into octet strings. Possible values are: \fBcompressed\fR, \fBuncompressed\fR (the
 212 default value) and \fBhybrid\fR. For more information regarding
 213 the point conversion forms please read the X9.62 standard.
 214 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
 215 by default for binary curves and can be enabled by defining
 216 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
 217 .IP "\fB\-param_enc arg\fR" 4
 218 .IX Item "-param_enc arg"
 219 This specifies how the elliptic curve parameters are encoded.
 220 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
 221 specified by a \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
 222 explicitly given (see \s-1RFC 3279\s0 for the definition of the
 223 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
 224 \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC 3279,\s0
 225 is currently not implemented in OpenSSL.
 226 .IP "\fB\-no_seed\fR" 4
 227 .IX Item "-no_seed"
 228 This option inhibits that the 'seed' for the parameter generation
 229 is included in the ECParameters structure (see \s-1RFC 3279\s0).
 230 .IP "\fB\-genkey\fR" 4
 231 .IX Item "-genkey"
 232 This option will generate a \s-1EC\s0 private key using the specified parameters.
 233 .IP "\fB\-rand file(s)\fR" 4
 234 .IX Item "-rand file(s)"
 235 a file or files containing random data used to seed the random number
 236 generator, or an \s-1EGD\s0 socket (see \fBRAND_egd\fR\|(3)).
 237 Multiple files can be specified separated by a OS-dependent character.
 238 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 239 all others.
 240 .IP "\fB\-engine id\fR" 4
 241 .IX Item "-engine id"
 242 specifying an engine (by its unique \fBid\fR string) will cause \fBecparam\fR
 243 to attempt to obtain a functional reference to the specified engine,
 244 thus initialising it if needed. The engine will then be set as the default
 245 for all available algorithms.
 246 .SH "NOTES"
 247 .IX Header "NOTES"
 248 \&\s-1PEM\s0 format \s-1EC\s0 parameters use the header and footer lines:
 249 .PP
 250 .Vb 2
 251 \& \-\-\-\-\-BEGIN EC PARAMETERS\-\-\-\-\-
 252 \& \-\-\-\-\-END EC PARAMETERS\-\-\-\-\-
 253 .Ve
 254 .PP
 255 OpenSSL is currently not able to generate new groups and therefore
 256 \&\fBecparam\fR can only create \s-1EC\s0 parameters from known (named) curves.
 257 .SH "EXAMPLES"
 258 .IX Header "EXAMPLES"
 259 To create \s-1EC\s0 parameters with the group 'prime192v1':
 260 .PP
 261 .Vb 1
 262 \&  openssl ecparam \-out ec_param.pem \-name prime192v1
 263 .Ve
 264 .PP
 265 To create \s-1EC\s0 parameters with explicit parameters:
 266 .PP
 267 .Vb 1
 268 \&  openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
 269 .Ve
 270 .PP
 271 To validate given \s-1EC\s0 parameters:
 272 .PP
 273 .Vb 1
 274 \&  openssl ecparam \-in ec_param.pem \-check
 275 .Ve
 276 .PP
 277 To create \s-1EC\s0 parameters and a private key:
 278 .PP
 279 .Vb 1
 280 \&  openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
 281 .Ve
 282 .PP
 283 To change the point encoding to 'compressed':
 284 .PP
 285 .Vb 1
 286 \&  openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
 287 .Ve
 288 .PP
 289 To print out the \s-1EC\s0 parameters to standard output:
 290 .PP
 291 .Vb 1
 292 \&  openssl ecparam \-in ec_param.pem \-noout \-text
 293 .Ve
 294 .SH "SEE ALSO"
 295 .IX Header "SEE ALSO"
 296 \&\fBec\fR\|(1), \fBdsaparam\fR\|(1)
 297 .SH "HISTORY"
 298 .IX Header "HISTORY"
 299 The ecparam command was first introduced in OpenSSL 0.9.8.
 300 .SH "AUTHOR"
 301 .IX Header "AUTHOR"
 302 Nils Larsch for the OpenSSL project (http://www.openssl.org)