Blame doc/man1/ecparam.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
openssl-ecparam,
Packit c4476c
ecparam - EC parameter manipulation and generation
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
B<openssl ecparam>
Packit c4476c
[B<-help>]
Packit c4476c
[B<-inform DER|PEM>]
Packit c4476c
[B<-outform DER|PEM>]
Packit c4476c
[B<-in filename>]
Packit c4476c
[B<-out filename>]
Packit c4476c
[B<-noout>]
Packit c4476c
[B<-text>]
Packit c4476c
[B<-C>]
Packit c4476c
[B<-check>]
Packit c4476c
[B<-name arg>]
Packit c4476c
[B<-list_curves>]
Packit c4476c
[B<-conv_form arg>]
Packit c4476c
[B<-param_enc arg>]
Packit c4476c
[B<-no_seed>]
Packit c4476c
[B<-rand file...>]
Packit c4476c
[B<-writerand file>]
Packit c4476c
[B<-genkey>]
Packit c4476c
[B<-engine id>]
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
This command is used to manipulate or generate EC parameter files.
Packit c4476c
Packit c4476c
=head1 OPTIONS
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item B<-help>
Packit c4476c
Packit c4476c
Print out a usage message.
Packit c4476c
Packit c4476c
=item B<-inform DER|PEM>
Packit c4476c
Packit c4476c
This specifies the input format. The B<DER> option uses an ASN.1 DER encoded
Packit c4476c
form compatible with RFC 3279 EcpkParameters. The PEM form is the default
Packit c4476c
format: it consists of the B<DER> format base64 encoded with additional
Packit c4476c
header and footer lines.
Packit c4476c
Packit c4476c
=item B<-outform DER|PEM>
Packit c4476c
Packit c4476c
This specifies the output format, the options have the same meaning and default
Packit c4476c
as the B<-inform> option.
Packit c4476c
Packit c4476c
=item B<-in filename>
Packit c4476c
Packit c4476c
This specifies the input filename to read parameters from or standard input if
Packit c4476c
this option is not specified.
Packit c4476c
Packit c4476c
=item B<-out filename>
Packit c4476c
Packit c4476c
This specifies the output filename parameters to. Standard output is used
Packit c4476c
if this option is not present. The output filename should B<not> be the same
Packit c4476c
as the input filename.
Packit c4476c
Packit c4476c
=item B<-noout>
Packit c4476c
Packit c4476c
This option inhibits the output of the encoded version of the parameters.
Packit c4476c
Packit c4476c
=item B<-text>
Packit c4476c
Packit c4476c
This option prints out the EC parameters in human readable form.
Packit c4476c
Packit c4476c
=item B<-C>
Packit c4476c
Packit c4476c
This option converts the EC parameters into C code. The parameters can then
Packit c4476c
be loaded by calling the get_ec_group_XXX() function.
Packit c4476c
Packit c4476c
=item B<-check>
Packit c4476c
Packit c4476c
Validate the elliptic curve parameters.
Packit c4476c
Packit c4476c
=item B<-name arg>
Packit c4476c
Packit c4476c
Use the EC parameters with the specified 'short' name. Use B<-list_curves>
Packit c4476c
to get a list of all currently implemented EC parameters.
Packit c4476c
Packit c4476c
=item B<-list_curves>
Packit c4476c
Packit c4476c
If this options is specified B<ecparam> will print out a list of all
Packit c4476c
currently implemented EC parameters names and exit.
Packit c4476c
Packit c4476c
=item B<-conv_form>
Packit c4476c
Packit c4476c
This specifies how the points on the elliptic curve are converted
Packit c4476c
into octet strings. Possible values are: B<compressed>, B<uncompressed> (the
Packit c4476c
default value) and B<hybrid>. For more information regarding
Packit c4476c
the point conversion forms please read the X9.62 standard.
Packit c4476c
B<Note> Due to patent issues the B<compressed> option is disabled
Packit c4476c
by default for binary curves and can be enabled by defining
Packit c4476c
the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
Packit c4476c
Packit c4476c
=item B<-param_enc arg>
Packit c4476c
Packit c4476c
This specifies how the elliptic curve parameters are encoded.
Packit c4476c
Possible value are: B<named_curve>, i.e. the ec parameters are
Packit c4476c
specified by an OID, or B<explicit> where the ec parameters are
Packit c4476c
explicitly given (see RFC 3279 for the definition of the
Packit c4476c
EC parameters structures). The default value is B<named_curve>.
Packit c4476c
B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
Packit c4476c
is currently not implemented in OpenSSL.
Packit c4476c
Packit c4476c
=item B<-no_seed>
Packit c4476c
Packit c4476c
This option inhibits that the 'seed' for the parameter generation
Packit c4476c
is included in the ECParameters structure (see RFC 3279).
Packit c4476c
Packit c4476c
=item B<-genkey>
Packit c4476c
Packit c4476c
This option will generate an EC private key using the specified parameters.
Packit c4476c
Packit c4476c
=item B<-rand file...>
Packit c4476c
Packit c4476c
A file or files containing random data used to seed the random number
Packit c4476c
generator.
Packit c4476c
Multiple files can be specified separated by an OS-dependent character.
Packit c4476c
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
Packit c4476c
all others.
Packit c4476c
Packit c4476c
=item [B<-writerand file>]
Packit c4476c
Packit c4476c
Writes random data to the specified I<file> upon exit.
Packit c4476c
This can be used with a subsequent B<-rand> flag.
Packit c4476c
Packit c4476c
=item B<-engine id>
Packit c4476c
Packit c4476c
Specifying an engine (by its unique B<id> string) will cause B<ecparam>
Packit c4476c
to attempt to obtain a functional reference to the specified engine,
Packit c4476c
thus initialising it if needed. The engine will then be set as the default
Packit c4476c
for all available algorithms.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
PEM format EC parameters use the header and footer lines:
Packit c4476c
Packit c4476c
 -----BEGIN EC PARAMETERS-----
Packit c4476c
 -----END EC PARAMETERS-----
Packit c4476c
Packit c4476c
OpenSSL is currently not able to generate new groups and therefore
Packit c4476c
B<ecparam> can only create EC parameters from known (named) curves.
Packit c4476c
Packit c4476c
=head1 EXAMPLES
Packit c4476c
Packit c4476c
To create EC parameters with the group 'prime192v1':
Packit c4476c
Packit c4476c
  openssl ecparam -out ec_param.pem -name prime192v1
Packit c4476c
Packit c4476c
To create EC parameters with explicit parameters:
Packit c4476c
Packit c4476c
  openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
Packit c4476c
Packit c4476c
To validate given EC parameters:
Packit c4476c
Packit c4476c
  openssl ecparam -in ec_param.pem -check
Packit c4476c
Packit c4476c
To create EC parameters and a private key:
Packit c4476c
Packit c4476c
  openssl ecparam -out ec_key.pem -name prime192v1 -genkey
Packit c4476c
Packit c4476c
To change the point encoding to 'compressed':
Packit c4476c
Packit c4476c
  openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
Packit c4476c
Packit c4476c
To print out the EC parameters to standard output:
Packit c4476c
Packit c4476c
  openssl ecparam -in ec_param.pem -noout -text
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ec(1)>, L<dsaparam(1)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2003-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut