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 -}
35 =for openssl ifdef engine
39 This command processes public or private keys. They can be
40 converted between various forms and their components printed out.
48 Print out a usage message.
50 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
52 The input and formats; the default is B<PEM>.
53 See L<openssl(1)/Format Options> for details.
55 =item B<-in> I<filename>
57 This specifies the input filename to read a key from or standard input if this
58 option is not specified. If the key is encrypted a pass phrase will be
61 =item B<-passin> I<arg>, B<-passout> I<arg>
63 The password source for the input and output file.
64 For more information about the format of B<arg>
65 see L<openssl(1)/Pass Phrase Options>.
67 =item B<-out> I<filename>
69 This specifies the output filename to write a key to or standard output if this
70 option is not specified. If any encryption options are set then a pass phrase
71 will be prompted for. The output filename should B<not> be the same as the input
76 Normally a private key is written using standard format: this is PKCS#8 form
77 with the appropriate encryption algorithm (if any). If the B<-traditional>
78 option is specified then the older "traditional" format is used instead.
82 These options encrypt the private key with the supplied cipher. Any algorithm
83 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
87 Prints out the various public or private key components in
88 plain text in addition to the encoded version.
92 Print out only public key components even if a private key is being processed.
96 Do not output the encoded version of the key.
100 By default a private key is read from the input file: with this
101 option a public key is read instead.
105 By default a private key is output: with this option a public
106 key will be output instead. This option is automatically set if
107 the input is a public key.
111 This option checks the consistency of a key pair for both public and private
116 This option checks the correctness of either a public key or the public component
119 =item B<-ec_conv_form> I<arg>
121 This option only applies to elliptic curve based public and private keys.
123 This specifies how the points on the elliptic curve are converted
124 into octet strings. Possible values are: B<compressed> (the default
125 value), B<uncompressed> and B<hybrid>. For more information regarding
126 the point conversion forms please read the X9.62 standard.
127 B<Note> Due to patent issues the B<compressed> option is disabled
128 by default for binary curves and can be enabled by defining
129 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
131 =item B<-ec_param_enc> I<arg>
133 This option only applies to elliptic curve based public and private keys.
135 This specifies how the elliptic curve parameters are encoded.
136 Possible value are: B<named_curve>, i.e. the ec parameters are
137 specified by an OID, or B<explicit> where the ec parameters are
138 explicitly given (see RFC 3279 for the definition of the
139 EC parameters structures). The default value is B<named_curve>.
140 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
141 is currently not implemented in OpenSSL.
143 {- $OpenSSL::safe::opt_engine_item -}
149 To remove the pass phrase on a private key:
151 openssl pkey -in key.pem -out keyout.pem
153 To encrypt a private key using triple DES:
155 openssl pkey -in key.pem -des3 -out keyout.pem
157 To convert a private key from PEM to DER format:
159 openssl pkey -in key.pem -outform DER -out keyout.der
161 To print out the components of a private key to standard output:
163 openssl pkey -in key.pem -text -noout
165 To print out the public components of a private key to standard output:
167 openssl pkey -in key.pem -text_pub -noout
169 To just output the public part of a private key:
171 openssl pkey -in key.pem -pubout -out pubkey.pem
173 To change the EC parameters encoding to B<explicit>:
175 openssl pkey -in key.pem -ec_param_enc explicit -out keyout.pem
177 To change the EC point conversion form to B<compressed>:
179 openssl pkey -in key.pem -ec_conv_form compressed -out keyout.pem
184 L<openssl-genpkey(1)>,
188 L<openssl-genrsa(1)>,
193 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
195 Licensed under the Apache License 2.0 (the "License"). You may not use
196 this file except in compliance with the License. You can obtain a copy
197 in the file LICENSE in the source distribution or at
198 L<https://www.openssl.org/source/license.html>.