doc/man1/openssl-ecparam.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-ecparam - EC parameter manipulation and generation
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl ecparam>
  11 [B<-help>]
  12 [B<-inform> B<DER>|B<PEM>]
  13 [B<-outform> B<DER>|B<PEM>]
  14 [B<-in> I<filename>]
  15 [B<-out> I<filename>]
  16 [B<-noout>]
  17 [B<-text>]
  18 [B<-check>]
  19 [B<-check_named>]
  20 [B<-name> I<arg>]
  21 [B<-list_curves>]
  22 [B<-conv_form> I<arg>]
  23 [B<-param_enc> I<arg>]
  24 [B<-no_seed>]
  25 [B<-genkey>]
  26 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
  27 {- $OpenSSL::safe::opt_provider_synopsis -}
  28
  29 =for openssl ifdef engine
  30
  31 =head1 DESCRIPTION
  32
  33 This command is used to manipulate or generate EC parameter files.
  34
  35 OpenSSL is currently not able to generate new groups and therefore
  36 this command can only create EC parameters from known (named) curves.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<-help>
  43
  44 Print out a usage message.
  45
  46 =item B<-inform> B<DER>|B<PEM>
  47
  48 The EC parameters input format; unspecified by default.
  49 See L<openssl-format-options(1)> for details.
  50
  51 =item B<-outform> B<DER>|B<PEM>
  52
  53 The EC parameters output format; the default is B<PEM>.
  54 See L<openssl-format-options(1)> for details.
  55
  56 Parameters are encoded as B<EcpkParameters> as specified in IETF RFC 3279.
  57
  58 =item B<-in> I<filename>
  59
  60 This specifies the input filename to read parameters from or standard input if
  61 this option is not specified.
  62
  63 =item B<-out> I<filename>
  64
  65 This specifies the output filename parameters to. Standard output is used
  66 if this option is not present. The output filename should B<not> be the same
  67 as the input filename.
  68
  69 =item B<-noout>
  70
  71 This option inhibits the output of the encoded version of the parameters.
  72
  73 =item B<-text>
  74
  75 This option prints out the EC parameters in human readable form.
  76
  77 =item B<-check>
  78
  79 Validate the elliptic curve parameters.
  80
  81 =item B<-check_named>
  82
  83 Validate the elliptic name curve parameters by checking if the curve parameters
  84 match any built-in curves.
  85
  86 =item B<-name> I<arg>
  87
  88 Use the EC parameters with the specified 'short' name. Use B<-list_curves>
  89 to get a list of all currently implemented EC parameters.
  90
  91 =item B<-list_curves>
  92
  93 Print out a list of all currently implemented EC parameters names and exit.
  94
  95 =item B<-conv_form> I<arg>
  96
  97 This specifies how the points on the elliptic curve are converted
  98 into octet strings. Possible values are: B<compressed>, B<uncompressed> (the
  99 default value) and B<hybrid>. For more information regarding
 100 the point conversion forms please read the X9.62 standard.
 101 B<Note> Due to patent issues the B<compressed> option is disabled
 102 by default for binary curves and can be enabled by defining
 103 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
 104
 105 =item B<-param_enc> I<arg>
 106
 107 This specifies how the elliptic curve parameters are encoded.
 108 Possible value are: B<named_curve>, i.e. the ec parameters are
 109 specified by an OID, or B<explicit> where the ec parameters are
 110 explicitly given (see RFC 3279 for the definition of the
 111 EC parameters structures). The default value is B<named_curve>.
 112 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
 113 is currently not implemented in OpenSSL.
 114
 115 =item B<-no_seed>
 116
 117 This option inhibits that the 'seed' for the parameter generation
 118 is included in the ECParameters structure (see RFC 3279).
 119
 120 =item B<-genkey>
 121
 122 This option will generate an EC private key using the specified parameters.
 123
 124 {- $OpenSSL::safe::opt_engine_item -}
 125
 126 {- $OpenSSL::safe::opt_r_item -}
 127
 128 {- $OpenSSL::safe::opt_provider_item -}
 129
 130 =back
 131
 132 The L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)> commands are capable
 133 of performing all the operations this command can, as well as supporting
 134 other public key types.
 135
 136 =head1 EXAMPLES
 137
 138 The documentation for the L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)>
 139 commands contains examples equivalent to the ones listed here.
 140
 141 To create EC parameters with the group 'prime192v1':
 142
 143   openssl ecparam -out ec_param.pem -name prime192v1
 144
 145 To create EC parameters with explicit parameters:
 146
 147   openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
 148
 149 To validate given EC parameters:
 150
 151   openssl ecparam -in ec_param.pem -check
 152
 153 To create EC parameters and a private key:
 154
 155   openssl ecparam -out ec_key.pem -name prime192v1 -genkey
 156
 157 To change the point encoding to 'compressed':
 158
 159   openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
 160
 161 To print out the EC parameters to standard output:
 162
 163   openssl ecparam -in ec_param.pem -noout -text
 164
 165 =head1 SEE ALSO
 166
 167 L<openssl(1)>,
 168 L<openssl-pkeyparam(1)>,
 169 L<openssl-genpkey(1)>,
 170 L<openssl-ec(1)>,
 171 L<openssl-dsaparam(1)>
 172
 173 =head1 HISTORY
 174
 175 The B<-engine> option was deprecated in OpenSSL 3.0.
 176
 177 The B<-C> option was removed in OpenSSL 3.0.
 178
 179 =head1 COPYRIGHT
 180
 181 Copyright 2003-2021 The OpenSSL Project Authors. All Rights Reserved.
 182
 183 Licensed under the Apache License 2.0 (the "License").  You may not use
 184 this file except in compliance with the License.  You can obtain a copy
 185 in the file LICENSE in the source distribution or at
 186 L<https://www.openssl.org/source/license.html>.
 187
 188 =cut