| blob | 44ec7aec6dc6e71a2b2c0de0fbf77eb898d51e68 |
1 .\" $NetBSD: openssl_pkeyutl.1,v 1.14 2015/06/12 17:01:15 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "PKEYUTL 1"
138 .TH PKEYUTL 1 "2009-07-19" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 pkeyutl \- public key algorithm utility
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 \&\fBopenssl\fR \fBpkeyutl\fR
150 [\fB\-in file\fR]
151 [\fB\-out file\fR]
152 [\fB\-sigfile file\fR]
153 [\fB\-inkey file\fR]
154 [\fB\-keyform PEM|DER\fR]
155 [\fB\-passin arg\fR]
156 [\fB\-peerkey file\fR]
157 [\fB\-peerform PEM|DER\fR]
158 [\fB\-pubin\fR]
159 [\fB\-certin\fR]
160 [\fB\-rev\fR]
161 [\fB\-sign\fR]
162 [\fB\-verify\fR]
163 [\fB\-verifyrecover\fR]
164 [\fB\-encrypt\fR]
165 [\fB\-decrypt\fR]
166 [\fB\-derive\fR]
167 [\fB\-pkeyopt opt:value\fR]
168 [\fB\-hexdump\fR]
169 [\fB\-asn1parse\fR]
170 [\fB\-engine id\fR]
171 .SH "DESCRIPTION"
172 .IX Header "DESCRIPTION"
173 The \fBpkeyutl\fR command can be used to perform public key operations using
174 any supported algorithm.
175 .SH "COMMAND OPTIONS"
176 .IX Header "COMMAND OPTIONS"
177 .IP "\fB\-in filename\fR" 4
178 .IX Item "-in filename"
179 This specifies the input filename to read data from or standard input
180 if this option is not specified.
181 .IP "\fB\-out filename\fR" 4
182 .IX Item "-out filename"
183 specifies the output filename to write to or standard output by
184 default.
185 .IP "\fB\-inkey file\fR" 4
186 .IX Item "-inkey file"
187 the input key file, by default it should be a private key.
188 .IP "\fB\-keyform PEM|DER\fR" 4
189 .IX Item "-keyform PEM|DER"
190 the key format \s-1PEM, DER\s0 or \s-1ENGINE.\s0
191 .IP "\fB\-passin arg\fR" 4
192 .IX Item "-passin arg"
193 the input key password source. For more information about the format of \fBarg\fR
194 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
195 .IP "\fB\-peerkey file\fR" 4
196 .IX Item "-peerkey file"
197 the peer key file, used by key derivation (agreement) operations.
198 .IP "\fB\-peerform PEM|DER\fR" 4
199 .IX Item "-peerform PEM|DER"
200 the peer key format \s-1PEM, DER\s0 or \s-1ENGINE.\s0
201 .IP "\fB\-engine id\fR" 4
202 .IX Item "-engine id"
203 specifying an engine (by its unique \fBid\fR string) will cause \fBpkeyutl\fR
204 to attempt to obtain a functional reference to the specified engine,
205 thus initialising it if needed. The engine will then be set as the default
206 for all available algorithms.
207 .IP "\fB\-pubin\fR" 4
208 .IX Item "-pubin"
209 the input file is a public key.
210 .IP "\fB\-certin\fR" 4
211 .IX Item "-certin"
212 the input is a certificate containing a public key.
213 .IP "\fB\-rev\fR" 4
214 .IX Item "-rev"
215 reverse the order of the input buffer. This is useful for some libraries
216 (such as CryptoAPI) which represent the buffer in little endian format.
217 .IP "\fB\-sign\fR" 4
218 .IX Item "-sign"
219 sign the input data and output the signed result. This requires
220 a private key.
221 .IP "\fB\-verify\fR" 4
222 .IX Item "-verify"
223 verify the input data against the signature file and indicate if the
224 verification succeeded or failed.
225 .IP "\fB\-verifyrecover\fR" 4
226 .IX Item "-verifyrecover"
227 verify the input data and output the recovered data.
228 .IP "\fB\-encrypt\fR" 4
229 .IX Item "-encrypt"
230 encrypt the input data using a public key.
231 .IP "\fB\-decrypt\fR" 4
232 .IX Item "-decrypt"
233 decrypt the input data using a private key.
234 .IP "\fB\-derive\fR" 4
235 .IX Item "-derive"
236 derive a shared secret using the peer key.
237 .IP "\fB\-hexdump\fR" 4
238 .IX Item "-hexdump"
239 hex dump the output data.
240 .IP "\fB\-asn1parse\fR" 4
241 .IX Item "-asn1parse"
242 asn1parse the output data, this is useful when combined with the
243 \&\fB\-verifyrecover\fR option when an \s-1ASN1\s0 structure is signed.
244 .SH "NOTES"
245 .IX Header "NOTES"
246 The operations and options supported vary according to the key algorithm
247 and its implementation. The OpenSSL operations and options are indicated below.
248 .PP
249 Unless otherwise mentioned all algorithms support the \fBdigest:alg\fR option
250 which specifies the digest in use for sign, verify and verifyrecover operations.
251 The value \fBalg\fR should represent a digest name as used in the
252 \&\fIEVP_get_digestbyname()\fR function for example \fBsha1\fR.
253 .SH "RSA ALGORITHM"
254 .IX Header "RSA ALGORITHM"
255 The \s-1RSA\s0 algorithm supports encrypt, decrypt, sign, verify and verifyrecover
256 operations in general. Some padding modes only support some of these
257 operations however.
258 .IP "\-\fBrsa_padding_mode:mode\fR" 4
259 .IX Item "-rsa_padding_mode:mode"
260 This sets the \s-1RSA\s0 padding mode. Acceptable values for \fBmode\fR are \fBpkcs1\fR for
261 PKCS#1 padding, \fBsslv23\fR for SSLv23 padding, \fBnone\fR for no padding, \fBoaep\fR
262 for \fB\s-1OAEP\s0\fR mode, \fBx931\fR for X9.31 mode and \fBpss\fR for \s-1PSS.\s0
263 .Sp
264 In PKCS#1 padding if the message digest is not set then the supplied data is
265 signed or verified directly instead of using a \fBDigestInfo\fR structure. If a
266 digest is set then the a \fBDigestInfo\fR structure is used and its the length
267 must correspond to the digest type.
268 .Sp
269 For \fBoeap\fR mode only encryption and decryption is supported.
270 .Sp
271 For \fBx931\fR if the digest type is set it is used to format the block data
272 otherwise the first byte is used to specify the X9.31 digest \s-1ID.\s0 Sign,
273 verify and verifyrecover are can be performed in this mode.
274 .Sp
275 For \fBpss\fR mode only sign and verify are supported and the digest type must be
276 specified.
277 .IP "\fBrsa_pss_saltlen:len\fR" 4
278 .IX Item "rsa_pss_saltlen:len"
279 For \fBpss\fR mode only this option specifies the salt length. Two special values
280 are supported: \-1 sets the salt length to the digest length. When signing \-2
281 sets the salt length to the maximum permissible value. When verifying \-2 causes
282 the salt length to be automatically determined based on the \fB\s-1PSS\s0\fR block
283 structure.
284 .SH "DSA ALGORITHM"
285 .IX Header "DSA ALGORITHM"
286 The \s-1DSA\s0 algorithm supports signing and verification operations only. Currently
287 there are no additional options other than \fBdigest\fR. Only the \s-1SHA1\s0
288 digest can be used and this digest is assumed by default.
289 .SH "DH ALGORITHM"
290 .IX Header "DH ALGORITHM"
291 The \s-1DH\s0 algorithm only supports the derivation operation and no additional
292 options.
293 .SH "EC ALGORITHM"
294 .IX Header "EC ALGORITHM"
295 The \s-1EC\s0 algorithm supports sign, verify and derive operations. The sign and
296 verify operations use \s-1ECDSA\s0 and derive uses \s-1ECDH.\s0 Currently there are no
297 additional options other than \fBdigest\fR. Only the \s-1SHA1\s0 digest can be used and
298 this digest is assumed by default.
299 .SH "EXAMPLES"
300 .IX Header "EXAMPLES"
301 Sign some data using a private key:
302 .PP
303 .Vb 1
304 \& openssl pkeyutl \-sign \-in file \-inkey key.pem \-out sig
305 .Ve
306 .PP
307 Recover the signed data (e.g. if an \s-1RSA\s0 key is used):
308 .PP
309 .Vb 1
310 \& openssl pkeyutl \-verifyrecover \-in sig \-inkey key.pem
311 .Ve
312 .PP
313 Verify the signature (e.g. a \s-1DSA\s0 key):
314 .PP
315 .Vb 1
316 \& openssl pkeyutl \-verify \-in file \-sigfile sig \-inkey key.pem
317 .Ve
318 .PP
319 Sign data using a message digest value (this is currently only valid for \s-1RSA\s0):
320 .PP
321 .Vb 1
322 \& openssl pkeyutl \-sign \-in file \-inkey key.pem \-out sig \-pkeyopt digest:sha256
323 .Ve
324 .PP
325 Derive a shared secret value:
326 .PP
327 .Vb 1
328 \& openssl pkeyutl \-derive \-inkey key.pem \-peerkey pubkey.pem \-out secret
329 .Ve
330 .SH "SEE ALSO"
331 .IX Header "SEE ALSO"
332 \&\fIgenpkey\fR\|(1), \fIpkey\fR\|(1), \fIopenssl_rsautl\fR\|(1)
333 \&\fIopenssl_dgst\fR\|(1), \fIopenssl_rsa\fR\|(1), \fIopenssl_genrsa\fR\|(1)