4 {- join("\n", @autowarntext) -}
10 openssl-pkey - public or private key processing tool
16 [B<-inform> B<DER>|B<PEM>]
17 [B<-outform> B<DER>|B<PEM>]
31 [B<-ec_conv_form> I<arg>]
32 [B<-ec_param_enc> I<arg>]
33 {- $OpenSSL::safe::opt_engine_synopsis -}
34 {- $OpenSSL::safe::opt_provider_synopsis -}
36 =for openssl ifdef engine
40 This command processes public or private keys. They can be
41 converted between various forms and their components printed out.
49 Print out a usage message.
51 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
53 The input and formats; the default is B<PEM>.
54 See L<openssl(1)/Format Options> for details.
56 =item B<-in> I<filename>
58 This specifies the input filename to read a key from or standard input if this
59 option is not specified. If the key is encrypted a pass phrase will be
62 =item B<-passin> I<arg>, B<-passout> I<arg>
64 The password source for the input and output file.
65 For more information about the format of B<arg>
66 see L<openssl(1)/Pass Phrase Options>.
68 =item B<-out> I<filename>
70 This specifies the output filename to write a key to or standard output if this
71 option is not specified. If any encryption options are set then a pass phrase
72 will be prompted for. The output filename should B<not> be the same as the input
77 Normally a private key is written using standard format: this is PKCS#8 form
78 with the appropriate encryption algorithm (if any). If the B<-traditional>
79 option is specified then the older "traditional" format is used instead.
83 These options encrypt the private key with the supplied cipher. Any algorithm
84 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
88 Prints out the various public or private key components in
89 plain text in addition to the encoded version.
93 Print out only public key components even if a private key is being processed.
97 Do not output the encoded version of the key.
101 By default a private key is read from the input file: with this
102 option a public key is read instead.
106 By default a private key is output: with this option a public
107 key will be output instead. This option is automatically set if
108 the input is a public key.
112 This option checks the consistency of a key pair for both public and private
117 This option checks the correctness of either a public key or the public component
120 =item B<-ec_conv_form> I<arg>
122 This option only applies to elliptic curve based public and private keys.
124 This specifies how the points on the elliptic curve are converted
125 into octet strings. Possible values are: B<compressed> (the default
126 value), B<uncompressed> and B<hybrid>. For more information regarding
127 the point conversion forms please read the X9.62 standard.
128 B<Note> Due to patent issues the B<compressed> option is disabled
129 by default for binary curves and can be enabled by defining
130 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
132 =item B<-ec_param_enc> I<arg>
134 This option only applies to elliptic curve based public and private keys.
136 This specifies how the elliptic curve parameters are encoded.
137 Possible value are: B<named_curve>, i.e. the ec parameters are
138 specified by an OID, or B<explicit> where the ec parameters are
139 explicitly given (see RFC 3279 for the definition of the
140 EC parameters structures). The default value is B<named_curve>.
141 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
142 is currently not implemented in OpenSSL.
144 {- $OpenSSL::safe::opt_engine_item -}
146 {- $OpenSSL::safe::opt_provider_item -}
152 To remove the pass phrase on a private key:
154 openssl pkey -in key.pem -out keyout.pem
156 To encrypt a private key using triple DES:
158 openssl pkey -in key.pem -des3 -out keyout.pem
160 To convert a private key from PEM to DER format:
162 openssl pkey -in key.pem -outform DER -out keyout.der
164 To print out the components of a private key to standard output:
166 openssl pkey -in key.pem -text -noout
168 To print out the public components of a private key to standard output:
170 openssl pkey -in key.pem -text_pub -noout
172 To just output the public part of a private key:
174 openssl pkey -in key.pem -pubout -out pubkey.pem
176 To change the EC parameters encoding to B<explicit>:
178 openssl pkey -in key.pem -ec_param_enc explicit -out keyout.pem
180 To change the EC point conversion form to B<compressed>:
182 openssl pkey -in key.pem -ec_conv_form compressed -out keyout.pem
187 L<openssl-genpkey(1)>,
191 L<openssl-genrsa(1)>,
196 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
198 Licensed under the Apache License 2.0 (the "License"). You may not use
199 this file except in compliance with the License. You can obtain a copy
200 in the file LICENSE in the source distribution or at
201 L<https://www.openssl.org/source/license.html>.