312 lines
10 KiB
Groff
312 lines
10 KiB
Groff
|
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
||
|
|
.\"
|
||
|
|
.\" Standard preamble:
|
||
|
|
.\" ========================================================================
|
||
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
||
|
|
.if t .sp .5v
|
||
|
|
.if n .sp
|
||
|
|
..
|
||
|
|
.de Vb \" Begin verbatim text
|
||
|
|
.ft CW
|
||
|
|
.nf
|
||
|
|
.ne \\$1
|
||
|
|
..
|
||
|
|
.de Ve \" End verbatim text
|
||
|
|
.ft R
|
||
|
|
.fi
|
||
|
|
..
|
||
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
||
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
||
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
||
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
||
|
|
.\" nothing in troff, for use with C<>.
|
||
|
|
.tr \(*W-
|
||
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||
|
|
.ie n \{\
|
||
|
|
. ds -- \(*W-
|
||
|
|
. ds PI pi
|
||
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
||
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||
|
|
. ds L" ""
|
||
|
|
. ds R" ""
|
||
|
|
. ds C` ""
|
||
|
|
. ds C' ""
|
||
|
|
'br\}
|
||
|
|
.el\{\
|
||
|
|
. ds -- \|\(em\|
|
||
|
|
. ds PI \(*p
|
||
|
|
. ds L" ``
|
||
|
|
. ds R" ''
|
||
|
|
'br\}
|
||
|
|
.\"
|
||
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\"
|
||
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
|
.\" output yourself in some meaningful fashion.
|
||
|
|
.ie \nF \{\
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. nr % 0
|
||
|
|
. rr F
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
. de IX
|
||
|
|
..
|
||
|
|
.\}
|
||
|
|
.\"
|
||
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||
|
|
. \" fudge factors for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds #H 0
|
||
|
|
. ds #V .8m
|
||
|
|
. ds #F .3m
|
||
|
|
. ds #[ \f1
|
||
|
|
. ds #] \fP
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
|
. ds #V .6m
|
||
|
|
. ds #F 0
|
||
|
|
. ds #[ \&
|
||
|
|
. ds #] \&
|
||
|
|
.\}
|
||
|
|
. \" simple accents for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds ' \&
|
||
|
|
. ds ` \&
|
||
|
|
. ds ^ \&
|
||
|
|
. ds , \&
|
||
|
|
. ds ~ ~
|
||
|
|
. ds /
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||
|
|
.\}
|
||
|
|
. \" troff and (daisy-wheel) nroff accents
|
||
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
|
. \" corrections for vroff
|
||
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
|
. \" for low resolution devices (crt and lpr)
|
||
|
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
|
\{\
|
||
|
|
. ds : e
|
||
|
|
. ds 8 ss
|
||
|
|
. ds o a
|
||
|
|
. ds d- d\h'-1'\(ga
|
||
|
|
. ds D- D\h'-1'\(hy
|
||
|
|
. ds th \o'bp'
|
||
|
|
. ds Th \o'LP'
|
||
|
|
. ds ae ae
|
||
|
|
. ds Ae AE
|
||
|
|
.\}
|
||
|
|
.rm #[ #] #H #V #F C
|
||
|
|
.\" ========================================================================
|
||
|
|
.\"
|
||
|
|
.IX Title "OPENSSL-PKEY 1"
|
||
|
|
.TH OPENSSL-PKEY 1 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
||
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
|
.\" way too many mistakes in technical documents.
|
||
|
|
.if n .ad l
|
||
|
|
.nh
|
||
|
|
.SH "NAME"
|
||
|
|
openssl\-pkey \- public or private key processing tool
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
\&\fBopenssl\fR \fBpkey\fR
|
||
|
|
[\fB\-help\fR]
|
||
|
|
[\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
|
||
|
|
[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
|
||
|
|
[\fB\-in\fR \fIfilename\fR]
|
||
|
|
[\fB\-passin\fR \fIarg\fR]
|
||
|
|
[\fB\-out\fR \fIfilename\fR]
|
||
|
|
[\fB\-passout\fR \fIarg\fR]
|
||
|
|
[\fB\-traditional\fR]
|
||
|
|
[\fB\-\f(BIcipher\fB\fR]
|
||
|
|
[\fB\-text\fR]
|
||
|
|
[\fB\-text_pub\fR]
|
||
|
|
[\fB\-noout\fR]
|
||
|
|
[\fB\-pubin\fR]
|
||
|
|
[\fB\-pubout\fR]
|
||
|
|
[\fB\-check\fR]
|
||
|
|
[\fB\-pubcheck\fR]
|
||
|
|
[\fB\-ec_conv_form\fR \fIarg\fR]
|
||
|
|
[\fB\-ec_param_enc\fR \fIarg\fR]
|
||
|
|
[\fB\-engine\fR \fIid\fR]
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
This command processes public or private keys. They can be
|
||
|
|
converted between various forms and their components printed out.
|
||
|
|
.SH "OPTIONS"
|
||
|
|
.IX Header "OPTIONS"
|
||
|
|
.IP "\fB\-help\fR" 4
|
||
|
|
.IX Item "-help"
|
||
|
|
Print out a usage message.
|
||
|
|
.IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR, \fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
|
||
|
|
.IX Item "-inform DER|PEM, -outform DER|PEM"
|
||
|
|
The input and formats; the default is \fB\s-1PEM\s0\fR.
|
||
|
|
See \*(L"Format Options\*(R" in \fIopenssl\fR\|(1) for details.
|
||
|
|
.IP "\fB\-in\fR \fIfilename\fR" 4
|
||
|
|
.IX Item "-in filename"
|
||
|
|
This specifies the input filename to read a key from or standard input if this
|
||
|
|
option is not specified. If the key is encrypted a pass phrase will be
|
||
|
|
prompted for.
|
||
|
|
.IP "\fB\-passin\fR \fIarg\fR, \fB\-passout\fR \fIarg\fR" 4
|
||
|
|
.IX Item "-passin arg, -passout arg"
|
||
|
|
The password source for the input and output file.
|
||
|
|
For more information about the format of \fBarg\fR
|
||
|
|
see \*(L"Pass Phrase Options\*(R" in \fIopenssl\fR\|(1).
|
||
|
|
.IP "\fB\-out\fR \fIfilename\fR" 4
|
||
|
|
.IX Item "-out filename"
|
||
|
|
This specifies the output filename to write a key to or standard output if this
|
||
|
|
option is not specified. If any encryption options are set then a pass phrase
|
||
|
|
will be prompted for. The output filename should \fBnot\fR be the same as the input
|
||
|
|
filename.
|
||
|
|
.IP "\fB\-traditional\fR" 4
|
||
|
|
.IX Item "-traditional"
|
||
|
|
Normally a private key is written using standard format: this is PKCS#8 form
|
||
|
|
with the appropriate encryption algorithm (if any). If the \fB\-traditional\fR
|
||
|
|
option is specified then the older \*(L"traditional\*(R" format is used instead.
|
||
|
|
.IP "\fB\-\f(BIcipher\fB\fR" 4
|
||
|
|
.IX Item "-cipher"
|
||
|
|
These options encrypt the private key with the supplied cipher. Any algorithm
|
||
|
|
name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
|
||
|
|
.IP "\fB\-text\fR" 4
|
||
|
|
.IX Item "-text"
|
||
|
|
Prints out the various public or private key components in
|
||
|
|
plain text in addition to the encoded version.
|
||
|
|
.IP "\fB\-text_pub\fR" 4
|
||
|
|
.IX Item "-text_pub"
|
||
|
|
Print out only public key components even if a private key is being processed.
|
||
|
|
.IP "\fB\-noout\fR" 4
|
||
|
|
.IX Item "-noout"
|
||
|
|
Do not output the encoded version of the key.
|
||
|
|
.IP "\fB\-pubin\fR" 4
|
||
|
|
.IX Item "-pubin"
|
||
|
|
By default a private key is read from the input file: with this
|
||
|
|
option a public key is read instead.
|
||
|
|
.IP "\fB\-pubout\fR" 4
|
||
|
|
.IX Item "-pubout"
|
||
|
|
By default a private key is output: with this option a public
|
||
|
|
key will be output instead. This option is automatically set if
|
||
|
|
the input is a public key.
|
||
|
|
.IP "\fB\-check\fR" 4
|
||
|
|
.IX Item "-check"
|
||
|
|
This option checks the consistency of a key pair for both public and private
|
||
|
|
components.
|
||
|
|
.IP "\fB\-pubcheck\fR" 4
|
||
|
|
.IX Item "-pubcheck"
|
||
|
|
This option checks the correctness of either a public key or the public component
|
||
|
|
of a key pair.
|
||
|
|
.IP "\fB\-ec_conv_form\fR \fIarg\fR" 4
|
||
|
|
.IX Item "-ec_conv_form arg"
|
||
|
|
This option only applies to elliptic curve based public and private keys.
|
||
|
|
.Sp
|
||
|
|
This specifies how the points on the elliptic curve are converted
|
||
|
|
into octet strings. Possible values are: \fBcompressed\fR (the default
|
||
|
|
value), \fBuncompressed\fR and \fBhybrid\fR. For more information regarding
|
||
|
|
the point conversion forms please read the X9.62 standard.
|
||
|
|
\&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
|
||
|
|
by default for binary curves and can be enabled by defining
|
||
|
|
the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
|
||
|
|
.IP "\fB\-ec_param_enc\fR \fIarg\fR" 4
|
||
|
|
.IX Item "-ec_param_enc arg"
|
||
|
|
This option only applies to elliptic curve based public and private keys.
|
||
|
|
.Sp
|
||
|
|
This specifies how the elliptic curve parameters are encoded.
|
||
|
|
Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
|
||
|
|
specified by an \s-1OID\s0, or \fBexplicit\fR where the ec parameters are
|
||
|
|
explicitly given (see \s-1RFC\s0 3279 for the definition of the
|
||
|
|
\&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
|
||
|
|
\&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in \s-1RFC\s0 3279,
|
||
|
|
is currently not implemented in OpenSSL.
|
||
|
|
.IP "\fB\-engine\fR \fIid\fR" 4
|
||
|
|
.IX Item "-engine id"
|
||
|
|
See \*(L"Engine Options\*(R" in \fIopenssl\fR\|(1).
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
To remove the pass phrase on a private key:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-out keyout.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To encrypt a private key using triple \s-1DES:\s0
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-des3 \-out keyout.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-outform DER \-out keyout.der
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To print out the components of a private key to standard output:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-text \-noout
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To print out the public components of a private key to standard output:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-text_pub \-noout
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To just output the public part of a private key:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To change the \s-1EC\s0 parameters encoding to \fBexplicit\fR:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-ec_param_enc explicit \-out keyout.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To change the \s-1EC\s0 point conversion form to \fBcompressed\fR:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl pkey \-in key.pem \-ec_conv_form compressed \-out keyout.pem
|
||
|
|
.Ve
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIopenssl\fR\|(1),
|
||
|
|
\&\fIopenssl\-genpkey\fR\|(1),
|
||
|
|
\&\fIopenssl\-rsa\fR\|(1),
|
||
|
|
\&\fIopenssl\-pkcs8\fR\|(1),
|
||
|
|
\&\fIopenssl\-dsa\fR\|(1),
|
||
|
|
\&\fIopenssl\-genrsa\fR\|(1),
|
||
|
|
\&\fIopenssl\-gendsa\fR\|(1)
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2006\-2019 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
|
.PP
|
||
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
|
this file except in compliance with the License. You can obtain a copy
|
||
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
|
<https://www.openssl.org/source/license.html>.
|