3a73c4bed9adb468acaa144f23b9c5e184e346c5
[dragonfly.git] / secure / lib / libcrypto / man / EVP_PKEY_CTX_ctrl.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "EVP_PKEY_CTX_ctrl 3"
136 .TH EVP_PKEY_CTX_ctrl 3 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 EVP_PKEY_ctrl, EVP_PKEY_ctrl_str \- algorithm specific control operations
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/evp.h>
147 \&
148 \& int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
149 \&                                int cmd, int p1, void *p2);
150 \& int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *type,
151 \&                                                const char *value);
152 \&
153 \& int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid);
154 \&
155 \& #include <openssl/rsa.h>
156 \&
157 \& int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
158 \&
159 \& int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad);
160 \& int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int len);
161 \& int EVP_PKEY_CTX_set_rsa_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int mbits);
162 \& int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);
163 \&
164 \& #include <openssl/dsa.h>
165 \& int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits);
166 \&
167 \& #include <openssl/dh.h>
168 \& int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int len);
169 \& int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);
170 \&
171 \& #include <openssl/ec.h>
172 \& int EVP_PKEY_CTX_set_ec_paramgen_curve_nid(EVP_PKEY_CTX *ctx, int nid);
173 .Ve
174 .SH "DESCRIPTION"
175 .IX Header "DESCRIPTION"
176 The function \fIEVP_PKEY_CTX_ctrl()\fR sends a control operation to the context
177 \&\fBctx\fR. The key type used must match \fBkeytype\fR if it is not \-1. The parameter
178 \&\fBoptype\fR is a mask indicating which operations the control can be applied to.
179 The control command is indicated in \fBcmd\fR and any additional arguments in
180 \&\fBp1\fR and \fBp2\fR.
181 .PP
182 Applications will not normally call \fIEVP_PKEY_CTX_ctrl()\fR directly but will
183 instead call one of the algorithm specific macros below.
184 .PP
185 The function \fIEVP_PKEY_ctrl_str()\fR allows an application to send an algorithm
186 specific control operation to a context \fBctx\fR in string form. This is
187 intended to be used for options specified on the command line or in text
188 files. The commands supported are documented in the openssl utility
189 command line pages for the option \fB\-pkeyopt\fR which is supported by the
190 \&\fBpkeyutl\fR, \fBgenpkey\fR and \fBreq\fR commands.
191 .PP
192 All the remaining \*(L"functions\*(R" are implemented as macros.
193 .PP
194 The \fIEVP_PKEY_CTX_set_signature_md()\fR macro sets the message digest type used
195 in a signature. It can be used with any public key algorithm supporting
196 signature operations.
197 .PP
198 The macro \fIEVP_PKEY_CTX_set_rsa_padding()\fR sets the \s-1RSA\s0 padding mode for \fBctx\fR.
199 The \fBpad\fR parameter can take the value \s-1RSA_PKCS1_PADDING\s0 for PKCS#1 padding,
200 \&\s-1RSA_SSLV23_PADDING\s0 for SSLv23 padding, \s-1RSA_NO_PADDING\s0 for no padding,
201 \&\s-1RSA_PKCS1_OAEP_PADDING\s0 for \s-1OAEP\s0 padding (encrypt and decrypt only),
202 \&\s-1RSA_X931_PADDING\s0 for X9.31 padding (signature operations only) and 
203 \&\s-1RSA_PKCS1_PSS_PADDING \s0(sign and verify only).
204 .PP
205 Two \s-1RSA\s0 padding modes behave differently if \fIEVP_PKEY_CTX_set_signature_md()\fR
206 is used. If this macro is called for PKCS#1 padding the plaintext buffer is
207 an actual digest value and is encapsulated in a DigestInfo structure according
208 to PKCS#1 when signing and this structure is expected (and stripped off) when
209 verifying. If this control is not used with \s-1RSA\s0 and PKCS#1 padding then the
210 supplied data is used directly and not encapsulated. In the case of X9.31
211 padding for \s-1RSA\s0 the algorithm identifier byte is added or checked and removed
212 if this control is called. If it is not called then the first byte of the plaintext buffer is expected to be the algorithm identifier byte.
213 .PP
214 The \fIEVP_PKEY_CTX_set_rsa_pss_saltlen()\fR macro sets the \s-1RSA PSS\s0 salt length to
215 \&\fBlen\fR as its name implies it is only supported for \s-1PSS\s0 padding.  Two special
216 values are supported: \-1 sets the salt length to the digest length. When
217 signing \-2 sets the salt length to the maximum permissible value. When
218 verifying \-2 causes the salt length to be automatically determined based on the
219 \&\fB\s-1PSS\s0\fR block structure. If this macro is not called a salt length value of \-2
220 is used by default.
221 .PP
222 The \fIEVP_PKEY_CTX_set_rsa_rsa_keygen_bits()\fR macro sets the \s-1RSA\s0 key length for
223 \&\s-1RSA\s0 key genration to \fBbits\fR. If not specified 1024 bits is used.
224 .PP
225 The \fIEVP_PKEY_CTX_set_rsa_keygen_pubexp()\fR macro sets the public exponent value
226 for \s-1RSA\s0 key generation to \fBpubexp\fR currently it should be an odd integer. The
227 \&\fBpubexp\fR pointer is used internally by this function so it should not be 
228 modified or free after the call. If this macro is not called then 65537 is used.
229 .PP
230 The macro \fIEVP_PKEY_CTX_set_dsa_paramgen_bits()\fR sets the number of bits used
231 for \s-1DSA\s0 parameter generation to \fBbits\fR. If not specified 1024 is used.
232 .PP
233 The macro \fIEVP_PKEY_CTX_set_dh_paramgen_prime_len()\fR sets the length of the \s-1DH\s0
234 prime parameter \fBp\fR for \s-1DH\s0 parameter generation. If this macro is not called
235 then 1024 is used.
236 .PP
237 The \fIEVP_PKEY_CTX_set_dh_paramgen_generator()\fR macro sets \s-1DH\s0 generator to \fBgen\fR
238 for \s-1DH\s0 parameter generation. If not specified 2 is used.
239 .PP
240 The \fIEVP_PKEY_CTX_set_ec_paramgen_curve_nid()\fR sets the \s-1EC\s0 curve for \s-1EC\s0 parameter
241 generation to \fBnid\fR. For \s-1EC\s0 parameter generation this macro must be called
242 or an error occurs because there is no default curve.
243 .SH "RETURN VALUES"
244 .IX Header "RETURN VALUES"
245 \&\fIEVP_PKEY_CTX_ctrl()\fR and its macros return a positive value for success and 0
246 or a negative value for failure. In particular a return value of \-2
247 indicates the operation is not supported by the public key algorithm.
248 .SH "SEE ALSO"
249 .IX Header "SEE ALSO"
250 \&\fIEVP_PKEY_CTX_new\fR\|(3),
251 \&\fIEVP_PKEY_encrypt\fR\|(3),
252 \&\fIEVP_PKEY_decrypt\fR\|(3),
253 \&\fIEVP_PKEY_sign\fR\|(3),
254 \&\fIEVP_PKEY_verify\fR\|(3),
255 \&\fIEVP_PKEY_verify_recover\fR\|(3),
256 \&\fIEVP_PKEY_derive\fR\|(3) 
257 \&\fIEVP_PKEY_keygen\fR\|(3)
258 .SH "HISTORY"
259 .IX Header "HISTORY"
260 These functions were first added to OpenSSL 1.0.0.