openssl-prebuild/linux_amd64/share/doc/openssl/html/man1/ecparam.html

244 lines
8.8 KiB
HTML

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>ecparam</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#options">OPTIONS</a></li>
<li><a href="#notes">NOTES</a></li>
<li><a href="#examples">EXAMPLES</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<hr />
<h1><a name="name">NAME</a></h1>
<p>openssl-ecparam,
ecparam - EC parameter manipulation and generation</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>openssl ecparam</strong>
[<strong>-help</strong>]
[<strong>-inform DER|PEM</strong>]
[<strong>-outform DER|PEM</strong>]
[<strong>-in filename</strong>]
[<strong>-out filename</strong>]
[<strong>-noout</strong>]
[<strong>-text</strong>]
[<strong>-C</strong>]
[<strong>-check</strong>]
[<strong>-name arg</strong>]
[<strong>-list_curves</strong>]
[<strong>-conv_form arg</strong>]
[<strong>-param_enc arg</strong>]
[<strong>-no_seed</strong>]
[<strong>-rand file...</strong>]
[<strong>-writerand file</strong>]
[<strong>-genkey</strong>]
[<strong>-engine id</strong>]</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>This command is used to manipulate or generate EC parameter files.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<dl>
<dt><strong><a name="help" class="item"><strong>-help</strong></a></strong></dt>
<dd>
<p>Print out a usage message.</p>
</dd>
<dt><strong><a name="inform_der_pem" class="item"><strong>-inform DER|PEM</strong></a></strong></dt>
<dd>
<p>This specifies the input format. The <strong>DER</strong> option uses an ASN.1 DER encoded
form compatible with <a href="http://www.ietf.org/rfc/rfc3279.txt" class="rfc">RFC 3279</a> EcpkParameters. The PEM form is the default
format: it consists of the <strong>DER</strong> format base64 encoded with additional
header and footer lines.</p>
</dd>
<dt><strong><a name="outform_der_pem" class="item"><strong>-outform DER|PEM</strong></a></strong></dt>
<dd>
<p>This specifies the output format, the options have the same meaning and default
as the <strong>-inform</strong> option.</p>
</dd>
<dt><strong><a name="in_filename" class="item"><strong>-in filename</strong></a></strong></dt>
<dd>
<p>This specifies the input filename to read parameters from or standard input if
this option is not specified.</p>
</dd>
<dt><strong><a name="out_filename" class="item"><strong>-out filename</strong></a></strong></dt>
<dd>
<p>This specifies the output filename parameters to. Standard output is used
if this option is not present. The output filename should <strong>not</strong> be the same
as the input filename.</p>
</dd>
<dt><strong><a name="noout" class="item"><strong>-noout</strong></a></strong></dt>
<dd>
<p>This option inhibits the output of the encoded version of the parameters.</p>
</dd>
<dt><strong><a name="text" class="item"><strong>-text</strong></a></strong></dt>
<dd>
<p>This option prints out the EC parameters in human readable form.</p>
</dd>
<dt><strong><a name="c" class="item"><strong>-C</strong></a></strong></dt>
<dd>
<p>This option converts the EC parameters into C code. The parameters can then
be loaded by calling the <code>get_ec_group_XXX()</code> function.</p>
</dd>
<dt><strong><a name="check" class="item"><strong>-check</strong></a></strong></dt>
<dd>
<p>Validate the elliptic curve parameters.</p>
</dd>
<dt><strong><a name="name_arg" class="item"><strong>-name arg</strong></a></strong></dt>
<dd>
<p>Use the EC parameters with the specified 'short' name. Use <strong>-list_curves</strong>
to get a list of all currently implemented EC parameters.</p>
</dd>
<dt><strong><a name="list_curves" class="item"><strong>-list_curves</strong></a></strong></dt>
<dd>
<p>If this options is specified <strong>ecparam</strong> will print out a list of all
currently implemented EC parameters names and exit.</p>
</dd>
<dt><strong><a name="conv_form" class="item"><strong>-conv_form</strong></a></strong></dt>
<dd>
<p>This specifies how the points on the elliptic curve are converted
into octet strings. Possible values are: <strong>compressed</strong>, <strong>uncompressed</strong> (the
default value) and <strong>hybrid</strong>. For more information regarding
the point conversion forms please read the X9.62 standard.
<strong>Note</strong> Due to patent issues the <strong>compressed</strong> option is disabled
by default for binary curves and can be enabled by defining
the preprocessor macro <strong>OPENSSL_EC_BIN_PT_COMP</strong> at compile time.</p>
</dd>
<dt><strong><a name="param_enc_arg" class="item"><strong>-param_enc arg</strong></a></strong></dt>
<dd>
<p>This specifies how the elliptic curve parameters are encoded.
Possible value are: <strong>named_curve</strong>, i.e. the ec parameters are
specified by an OID, or <strong>explicit</strong> where the ec parameters are
explicitly given (see <a href="http://www.ietf.org/rfc/rfc3279.txt" class="rfc">RFC 3279</a> for the definition of the
EC parameters structures). The default value is <strong>named_curve</strong>.
<strong>Note</strong> the <strong>implicitlyCA</strong> alternative, as specified in <a href="http://www.ietf.org/rfc/rfc3279.txt" class="rfc">RFC 3279</a>,
is currently not implemented in OpenSSL.</p>
</dd>
<dt><strong><a name="no_seed" class="item"><strong>-no_seed</strong></a></strong></dt>
<dd>
<p>This option inhibits that the 'seed' for the parameter generation
is included in the ECParameters structure (see <a href="http://www.ietf.org/rfc/rfc3279.txt" class="rfc">RFC 3279</a>).</p>
</dd>
<dt><strong><a name="genkey" class="item"><strong>-genkey</strong></a></strong></dt>
<dd>
<p>This option will generate an EC private key using the specified parameters.</p>
</dd>
<dt><strong><a name="rand_file" class="item"><strong>-rand file...</strong></a></strong></dt>
<dd>
<p>A file or files containing random data used to seed the random number
generator.
Multiple files can be specified separated by an OS-dependent character.
The separator is <strong>;</strong> for MS-Windows, <strong>,</strong> for OpenVMS, and <strong>:</strong> for
all others.</p>
</dd>
<dt><strong><a name="writerand_file" class="item">[<strong>-writerand file</strong>]</a></strong></dt>
<dd>
<p>Writes random data to the specified <em>file</em> upon exit.
This can be used with a subsequent <strong>-rand</strong> flag.</p>
</dd>
<dt><strong><a name="engine_id" class="item"><strong>-engine id</strong></a></strong></dt>
<dd>
<p>Specifying an engine (by its unique <strong>id</strong> string) will cause <strong>ecparam</strong>
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p>PEM format EC parameters use the header and footer lines:</p>
<pre>
-----BEGIN EC PARAMETERS-----
-----END EC PARAMETERS-----</pre>
<p>OpenSSL is currently not able to generate new groups and therefore
<strong>ecparam</strong> can only create EC parameters from known (named) curves.</p>
<p>
</p>
<hr />
<h1><a name="examples">EXAMPLES</a></h1>
<p>To create EC parameters with the group 'prime192v1':</p>
<pre>
openssl ecparam -out ec_param.pem -name prime192v1</pre>
<p>To create EC parameters with explicit parameters:</p>
<pre>
openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit</pre>
<p>To validate given EC parameters:</p>
<pre>
openssl ecparam -in ec_param.pem -check</pre>
<p>To create EC parameters and a private key:</p>
<pre>
openssl ecparam -out ec_key.pem -name prime192v1 -genkey</pre>
<p>To change the point encoding to 'compressed':</p>
<pre>
openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed</pre>
<p>To print out the EC parameters to standard output:</p>
<pre>
openssl ecparam -in ec_param.pem -noout -text</pre>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><em>ec(1)</em>, <em>dsaparam(1)</em></p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright 2003-2018 The OpenSSL Project Authors. All Rights Reserved.</p>
<p>Licensed under the OpenSSL license (the &quot;License&quot;). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
</body>
</html>