309 lines
10 KiB
Groff
309 lines
10 KiB
Groff
.\" $NetBSD: openssl_rsa.1,v 1.18 2007/11/27 22:19:53 christos Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.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. | will give a
|
|
.\" real vertical bar. \*(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-|\(bv\*(Tr
|
|
.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\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" 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 "RSA 1"
|
|
.TH RSA 1 "2003-07-24" "0.9.8e" "OpenSSL"
|
|
.SH "NAME"
|
|
rsa \- RSA key processing tool
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl\fR \fBrsa\fR
|
|
[\fB\-inform PEM|NET|DER\fR]
|
|
[\fB\-outform PEM|NET|DER\fR]
|
|
[\fB\-in filename\fR]
|
|
[\fB\-passin arg\fR]
|
|
[\fB\-out filename\fR]
|
|
[\fB\-passout arg\fR]
|
|
[\fB\-sgckey\fR]
|
|
[\fB\-des\fR]
|
|
[\fB\-des3\fR]
|
|
[\fB\-idea\fR]
|
|
[\fB\-text\fR]
|
|
[\fB\-noout\fR]
|
|
[\fB\-modulus\fR]
|
|
[\fB\-check\fR]
|
|
[\fB\-pubin\fR]
|
|
[\fB\-pubout\fR]
|
|
[\fB\-engine id\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fBrsa\fR command processes \s-1RSA\s0 keys. They can be converted between various
|
|
forms and their components printed out. \fBNote\fR this command uses the
|
|
traditional SSLeay compatible format for private key encryption: newer
|
|
applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
|
|
utility.
|
|
.SH "COMMAND OPTIONS"
|
|
.IX Header "COMMAND OPTIONS"
|
|
.IP "\fB\-inform DER|NET|PEM\fR" 4
|
|
.IX Item "-inform DER|NET|PEM"
|
|
This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
|
|
form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
|
|
The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
|
|
encoded with additional header and footer lines. On input PKCS#8 format private
|
|
keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
|
|
section.
|
|
.IP "\fB\-outform DER|NET|PEM\fR" 4
|
|
.IX Item "-outform DER|NET|PEM"
|
|
This specifies the output format, the options have the same meaning as the
|
|
\&\fB\-inform\fR option.
|
|
.IP "\fB\-in filename\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 arg\fR" 4
|
|
.IX Item "-passin arg"
|
|
the input file password source. For more information about the format of \fBarg\fR
|
|
see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
|
|
.IP "\fB\-out filename\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\-passout password\fR" 4
|
|
.IX Item "-passout password"
|
|
the output file password source. For more information about the format of \fBarg\fR
|
|
see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
|
|
.IP "\fB\-sgckey\fR" 4
|
|
.IX Item "-sgckey"
|
|
use the modified \s-1NET\s0 algorithm used with some versions of Microsoft \s-1IIS\s0 and \s-1SGC\s0
|
|
keys.
|
|
.IP "\fB\-des|\-des3|\-idea\fR" 4
|
|
.IX Item "-des|-des3|-idea"
|
|
These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
|
|
\&\s-1IDEA\s0 ciphers respectively before outputting it. A pass phrase is prompted for.
|
|
If none of these options is specified the key is written in plain text. This
|
|
means that using the \fBrsa\fR utility to read in an encrypted key with no
|
|
encryption option can be used to remove the pass phrase from a key, or by
|
|
setting the encryption options it can be use to add or change the pass phrase.
|
|
These options can only be used with \s-1PEM\s0 format output files.
|
|
.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\-noout\fR" 4
|
|
.IX Item "-noout"
|
|
this option prevents output of the encoded version of the key.
|
|
.IP "\fB\-modulus\fR" 4
|
|
.IX Item "-modulus"
|
|
this option prints out the value of the modulus of the key.
|
|
.IP "\fB\-check\fR" 4
|
|
.IX Item "-check"
|
|
this option checks the consistency of an \s-1RSA\s0 private 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\-engine id\fR" 4
|
|
.IX Item "-engine id"
|
|
specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
|
|
to attempt to obtain a functional reference to the specified engine,
|
|
thus initialising it if needed. The engine will then be set as the default
|
|
for all available algorithms.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The \s-1PEM\s0 private key format uses the header and footer lines:
|
|
.PP
|
|
.Vb 2
|
|
\& -----BEGIN RSA PRIVATE KEY-----
|
|
\& -----END RSA PRIVATE KEY-----
|
|
.Ve
|
|
.PP
|
|
The \s-1PEM\s0 public key format uses the header and footer lines:
|
|
.PP
|
|
.Vb 2
|
|
\& -----BEGIN PUBLIC KEY-----
|
|
\& -----END PUBLIC KEY-----
|
|
.Ve
|
|
.PP
|
|
The \fB\s-1NET\s0\fR form is a format compatible with older Netscape servers
|
|
and Microsoft \s-1IIS\s0 .key files, this uses unsalted \s-1RC4\s0 for its encryption.
|
|
It is not very secure and so should only be used when necessary.
|
|
.PP
|
|
Some newer version of \s-1IIS\s0 have additional data in the exported .key
|
|
files. To use these with the utility, view the file with a binary editor
|
|
and look for the string \*(L"private\-key\*(R", then trace back to the byte
|
|
sequence 0x30, 0x82 (this is an \s-1ASN1\s0 \s-1SEQUENCE\s0). Copy all the data
|
|
from this point onwards to another file and use that as the input
|
|
to the \fBrsa\fR utility with the \fB\-inform \s-1NET\s0\fR option. If you get
|
|
an error after entering the password try the \fB\-sgckey\fR option.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
To remove the pass phrase on an \s-1RSA\s0 private key:
|
|
.PP
|
|
.Vb 1
|
|
\& openssl rsa -in key.pem -out keyout.pem
|
|
.Ve
|
|
.PP
|
|
To encrypt a private key using triple \s-1DES:\s0
|
|
.PP
|
|
.Vb 1
|
|
\& openssl rsa -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 rsa -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 rsa -in key.pem -text -noout
|
|
.Ve
|
|
.PP
|
|
To just output the public part of a private key:
|
|
.PP
|
|
.Vb 1
|
|
\& openssl rsa -in key.pem -pubout -out pubkey.pem
|
|
.Ve
|
|
.SH "BUGS"
|
|
.IX Header "BUGS"
|
|
The command line password arguments don't currently work with
|
|
\&\fB\s-1NET\s0\fR format.
|
|
.PP
|
|
There should be an option that automatically handles .key files,
|
|
without having to manually edit them.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl_pkcs8\fR\|(1), \fIopenssl_dsa\fR\|(1), \fIopenssl_genrsa\fR\|(1),
|
|
\&\fIopenssl_gendsa\fR\|(1)
|