doc/man1/openssl-pkey.pod.in

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