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