3c29b3a67c5afe602af066c80cc8ffcbe58687bb
[openssl.git] / doc / apps / pkeyutl.pod
1 =pod
2
3 =head1 NAME
4
5 pkeyutl - public key algorithm utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<pkeyutl>
10 [B<-in file>]
11 [B<-out file>]
12 [B<-sigfile file>]
13 [B<-inkey file>]
14 [B<-keyform PEM|DER>]
15 [B<-passin arg>]
16 [B<-peerkey file>]
17 [B<-peerform PEM|DER>]
18 [B<-pubin>]
19 [B<-certin>]
20 [B<-rev>]
21 [B<-sign>]
22 [B<-verify>]
23 [B<-verifyrecover>]
24 [B<-encrypt>]
25 [B<-decrypt>]
26 [B<-derive>]
27 [B<-pkeyopt opt:value>]
28 [B<-hexdump>]
29 [B<-asn1parse>]
30 [B<-engine id>]
31
32 =head1 DESCRIPTION
33
34 The B<pkeyutl> command can be used to perform public key operations using
35 any supported algorithm.
36
37 =head1 COMMAND OPTIONS
38
39 =over 4
40
41 =item B<-in filename>
42
43 This specifies the input filename to read data from or standard input
44 if this option is not specified.
45
46 =item B<-out filename>
47
48 specifies the output filename to write to or standard output by
49 default.
50
51 =item B<-inkey file>
52
53 the input key file, by default it should be a private key.
54
55 =item B<-keyform PEM|DER>
56
57 the key format PEM, DER or ENGINE.
58
59 =item B<-passin arg>
60
61 the input key password source. For more information about the format of B<arg>
62 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
63
64
65 =item B<-peerkey file>
66
67 the peer key file, used by key derivation (agreement) operations.
68
69 =item B<-peerform PEM|DER>
70
71 the peer key format PEM, DER or ENGINE.
72
73 =item B<-engine id>
74
75 specifying an engine (by its unique B<id> string) will cause B<pkeyutl>
76 to attempt to obtain a functional reference to the specified engine,
77 thus initialising it if needed. The engine will then be set as the default
78 for all available algorithms.
79
80
81 =item B<-pubin>
82
83 the input file is a public key. 
84
85 =item B<-certin>
86
87 the input is a certificate containing a public key. 
88
89 =item B<-rev>
90
91 reverse the order of the input buffer. This is useful for some libraries
92 (such as CryptoAPI) which represent the buffer in little endian format.
93
94 =item B<-sign>
95
96 sign the input data and output the signed result. This requires
97 a private key.
98
99 =item B<-verify>
100
101 verify the input data against the signature file and indicate if the
102 verification succeeded or failed.
103
104 =item B<-verifyrecover>
105
106 verify the input data and output the recovered data.
107
108 =item B<-encrypt>
109
110 encrypt the input data using a public key.
111
112 =item B<-decrypt>
113
114 decrypt the input data using a private key.
115
116 =item B<-derive>
117
118 derive a shared secret using the peer key.
119
120 =item B<-hexdump>
121
122 hex dump the output data.
123
124 =item B<-asn1parse>
125
126 asn1parse the output data, this is useful when combined with the
127 B<-verifyrecover> option when an ASN1 structure is signed.
128
129 =back
130
131 =head1 NOTES
132
133 The operations and options supported vary according to the key algorithm
134 and its implementation. The OpenSSL operations and options are indicated below.
135
136 Unless otherwise mentioned all algorithms support the B<digest:alg> option
137 which specifies the digest in use for sign, verify and verifyrecover operations.
138 The value B<alg> should represent a digest name as used in the
139 EVP_get_digestbyname() function for example B<sha1>.
140 This value is used only for sanity-checking the lengths of data passed in to
141 the B<pkeyutl> and for creating the structures that make up the signature
142 (e.g. B<DigestInfo> in RSASSA PKCS#1 v1.5 signatures).
143 In case of RSA, ECDSA and DSA signatures, this utility
144 will not perform hashing on input data but rather use the data directly as
145 input of signature algorithm. Depending on key type, signature type and mode
146 of padding, the maximum acceptable lengths of input data differ. In general,
147 with RSA the signed data can't be longer than the key modulus, in case of ECDSA
148 and DSA the data shouldn't be longer than field size, otherwise it will be
149 silently truncated to field size.
150
151 In other words, if the value of digest is B<sha1> the input should be 20 bytes
152 long binary encoding of SHA-1 hash function output.
153
154 =head1 RSA ALGORITHM
155
156 The RSA algorithm generally supports the encrypt, decrypt, sign,
157 verify and verifyrecover operations. However, some padding modes
158 support only a subset of these operations. The following additional
159 B<pkeyopt> values are supported:
160
161 =over 4
162
163 =item B<rsa_padding_mode:mode>
164
165 This sets the RSA padding mode. Acceptable values for B<mode> are B<pkcs1> for
166 PKCS#1 padding, B<sslv23> for SSLv23 padding, B<none> for no padding, B<oaep>
167 for B<OAEP> mode, B<x931> for X9.31 mode and B<pss> for PSS.
168
169 In PKCS#1 padding if the message digest is not set then the supplied data is 
170 signed or verified directly instead of using a B<DigestInfo> structure. If a
171 digest is set then the a B<DigestInfo> structure is used and its the length
172 must correspond to the digest type.
173
174 For B<oaep> mode only encryption and decryption is supported.
175
176 For B<x931> if the digest type is set it is used to format the block data
177 otherwise the first byte is used to specify the X9.31 digest ID. Sign,
178 verify and verifyrecover are can be performed in this mode.
179
180 For B<pss> mode only sign and verify are supported and the digest type must be
181 specified.
182
183 =item B<rsa_pss_saltlen:len>
184
185 For B<pss> mode only this option specifies the salt length. Two special values
186 are supported: -1 sets the salt length to the digest length. When signing -2
187 sets the salt length to the maximum permissible value. When verifying -2 causes
188 the salt length to be automatically determined based on the B<PSS> block
189 structure.
190
191 =back
192
193 =head1 DSA ALGORITHM
194
195 The DSA algorithm supports signing and verification operations only. Currently
196 there are no additional options other than B<digest>. Only the SHA1
197 digest can be used and this digest is assumed by default.
198
199 =head1 DH ALGORITHM
200
201 The DH algorithm only supports the derivation operation and no additional
202 options.
203
204 =head1 EC ALGORITHM
205
206 The EC algorithm supports sign, verify and derive operations. The sign and
207 verify operations use ECDSA and derive uses ECDH. Currently there are no
208 additional options other than B<digest>. Only the SHA1 digest can be used and
209 this digest is assumed by default.
210
211 =head1 EXAMPLES
212
213 Sign some data using a private key:
214
215  openssl pkeyutl -sign -in file -inkey key.pem -out sig
216
217 Recover the signed data (e.g. if an RSA key is used):
218
219  openssl pkeyutl -verifyrecover -in sig -inkey key.pem
220
221 Verify the signature (e.g. a DSA key):
222
223  openssl pkeyutl -verify -in file -sigfile sig -inkey key.pem
224
225 Sign data using a message digest value (this is currently only valid for RSA):
226
227  openssl pkeyutl -sign -in file -inkey key.pem -out sig -pkeyopt digest:sha256
228
229 Derive a shared secret value:
230
231  openssl pkeyutl -derive -inkey key.pem -peerkey pubkey.pem -out secret
232
233 =head1 SEE ALSO
234
235 L<genpkey(1)>, L<pkey(1)>, L<rsautl(1)>
236 L<dgst(1)>, L<rsa(1)>, L<genrsa(1)>