doc/man1/openssl-ec.pod.in

   1 =pod
   2
   3 =begin comment
   4 {- join("\n", @autowarntext) -}
   5
   6 =end comment
   7
   8 =head1 NAME
   9
  10 openssl-ec - EC key processing
  11
  12 =head1 SYNOPSIS
  13
  14 B<openssl> B<ec>
  15 [B<-help>]
  16 [B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  17 [B<-outform> B<DER>|B<PEM>]
  18 [B<-in> I<filename>|I<uri>]
  19 [B<-passin> I<arg>]
  20 [B<-out> I<filename>]
  21 [B<-passout> I<arg>]
  22 [B<-des>]
  23 [B<-des3>]
  24 [B<-idea>]
  25 [B<-text>]
  26 [B<-noout>]
  27 [B<-param_out>]
  28 [B<-pubin>]
  29 [B<-pubout>]
  30 [B<-conv_form> I<arg>]
  31 [B<-param_enc> I<arg>]
  32 [B<-no_public>]
  33 [B<-check>]
  34 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  35
  36 =for openssl ifdef engine
  37
  38 =head1 DESCRIPTION
  39
  40 The L<openssl-ec(1)> command processes EC keys. They can be converted between
  41 various forms and their components printed out. B<Note> OpenSSL uses the
  42 private key format specified in 'SEC 1: Elliptic Curve Cryptography'
  43 (http://www.secg.org/). To convert an OpenSSL EC private key into the
  44 PKCS#8 private key format use the L<openssl-pkcs8(1)> command.
  45
  46 =head1 OPTIONS
  47
  48 =over 4
  49
  50 =item B<-help>
  51
  52 Print out a usage message.
  53
  54 =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  55
  56 The key input format; unspecified by default.
  57 See L<openssl-format-options(1)> for details.
  58
  59 =item B<-outform> B<DER>|B<PEM>
  60
  61 The key output format; the default is B<PEM>.
  62 See L<openssl-format-options(1)> for details.
  63
  64 Private keys are an SEC1 private key or PKCS#8 format.
  65 Public keys are a B<SubjectPublicKeyInfo> as specified in IETF RFC 3280.
  66
  67 =item B<-in> I<filename>|I<uri>
  68
  69 This specifies the input to read a key from or standard input if this
  70 option is not specified. If the key is encrypted a pass phrase will be
  71 prompted for.
  72
  73 =item B<-out> I<filename>
  74
  75 This specifies the output filename to write a key to or standard output by
  76 is not specified. If any encryption options are set then a pass phrase will be
  77 prompted for. The output filename should B<not> be the same as the input
  78 filename.
  79
  80 =item B<-passin> I<arg>, B<-passout> I<arg>
  81
  82 The password source for the input and output file.
  83 For more information about the format of B<arg>
  84 see L<openssl-passphrase-options(1)>.
  85
  86 =item B<-des>|B<-des3>|B<-idea>
  87
  88 These options encrypt the private key with the DES, triple DES, IDEA or
  89 any other cipher supported by OpenSSL before outputting it. A pass phrase is
  90 prompted for.
  91 If none of these options is specified the key is written in plain text. This
  92 means that using this command to read in an encrypted key with no
  93 encryption option can be used to remove the pass phrase from a key, or by
  94 setting the encryption options it can be use to add or change the pass phrase.
  95 These options can only be used with PEM format output files.
  96
  97 =item B<-text>
  98
  99 Prints out the public, private key components and parameters.
 100
 101 =item B<-noout>
 102
 103 This option prevents output of the encoded version of the key.
 104
 105 =item B<-pubin>
 106
 107 By default, a private key is read from the input file. With this option a
 108 public key is read instead.
 109
 110 =item B<-pubout>
 111
 112 By default a private key is output. With this option a public
 113 key will be output instead. This option is automatically set if the input is
 114 a public key.
 115
 116 =item B<-conv_form> I<arg>
 117
 118 This specifies how the points on the elliptic curve are converted
 119 into octet strings. Possible values are: B<compressed> (the default
 120 value), B<uncompressed> and B<hybrid>. For more information regarding
 121 the point conversion forms please read the X9.62 standard.
 122 B<Note> Due to patent issues the B<compressed> option is disabled
 123 by default for binary curves and can be enabled by defining
 124 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
 125
 126 =item B<-param_enc> I<arg>
 127
 128 This specifies how the elliptic curve parameters are encoded.
 129 Possible value are: B<named_curve>, i.e. the ec parameters are
 130 specified by an OID, or B<explicit> where the ec parameters are
 131 explicitly given (see RFC 3279 for the definition of the
 132 EC parameters structures). The default value is B<named_curve>.
 133 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
 134 is currently not implemented in OpenSSL.
 135
 136 =item B<-no_public>
 137
 138 This option omits the public key components from the private key output.
 139
 140 =item B<-check>
 141
 142 This option checks the consistency of an EC private or public key.
 143
 144 {- $OpenSSL::safe::opt_engine_item -}
 145
 146 {- $OpenSSL::safe::opt_provider_item -}
 147
 148 =back
 149
 150 The L<openssl-pkey(1)> command is capable of performing all the operations
 151 this command can, as well as supporting other public key types.
 152
 153 =head1 EXAMPLES
 154
 155 The documentation for the L<openssl-pkey(1)> command contains examples
 156 equivalent to the ones listed here.
 157
 158 To encrypt a private key using triple DES:
 159
 160  openssl ec -in key.pem -des3 -out keyout.pem
 161
 162 To convert a private key from PEM to DER format:
 163
 164  openssl ec -in key.pem -outform DER -out keyout.der
 165
 166 To print out the components of a private key to standard output:
 167
 168  openssl ec -in key.pem -text -noout
 169
 170 To just output the public part of a private key:
 171
 172  openssl ec -in key.pem -pubout -out pubkey.pem
 173
 174 To change the parameters encoding to B<explicit>:
 175
 176  openssl ec -in key.pem -param_enc explicit -out keyout.pem
 177
 178 To change the point conversion form to B<compressed>:
 179
 180  openssl ec -in key.pem -conv_form compressed -out keyout.pem
 181
 182 =head1 SEE ALSO
 183
 184 L<openssl(1)>,
 185 L<openssl-pkey(1)>,
 186 L<openssl-ecparam(1)>,
 187 L<openssl-dsa(1)>,
 188 L<openssl-rsa(1)>
 189
 190 =head1 HISTORY
 191
 192 The B<-engine> option was deprecated in OpenSSL 3.0.
 193
 194 The B<-conv_form> and B<-no_public> options are no longer supported
 195 with keys loaded from an engine in OpenSSL 3.0.
 196
 197 =head1 COPYRIGHT
 198
 199 Copyright 2003-2021 The OpenSSL Project Authors. All Rights Reserved.
 200
 201 Licensed under the Apache License 2.0 (the "License").  You may not use
 202 this file except in compliance with the License.  You can obtain a copy
 203 in the file LICENSE in the source distribution or at
 204 L<https://www.openssl.org/source/license.html>.
 205
 206 =cut