Switch from OpenSSL 0.9.7d to 0.9.7e.
[dragonfly.git] / secure / lib / libcrypto / man / RSA_set_method.3
CommitLineData
74dab6c2
JR
1.rn '' }`
2''' $RCSfile$$Revision$$Date$
3'''
4''' $Log$
5'''
6.de Sh
984263bc
MD
7.br
8.if t .Sp
9.ne 5
10.PP
11\fB\\$1\fR
12.PP
13..
74dab6c2 14.de Sp
984263bc
MD
15.if t .sp .5v
16.if n .sp
17..
74dab6c2 18.de Ip
984263bc
MD
19.br
20.ie \\n(.$>=3 .ne \\$3
21.el .ne 3
22.IP "\\$1" \\$2
23..
74dab6c2 24.de Vb
984263bc
MD
25.ft CW
26.nf
27.ne \\$1
28..
74dab6c2 29.de Ve
984263bc
MD
30.ft R
31
32.fi
33..
74dab6c2
JR
34'''
35'''
36''' Set up \*(-- to give an unbreakable dash;
37''' string Tr holds user defined translation string.
38''' Bell System Logo is used as a dummy character.
39'''
984263bc 40.tr \(*W-|\(bv\*(Tr
984263bc 41.ie n \{\
74dab6c2
JR
42.ds -- \(*W-
43.ds PI pi
44.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46.ds L" ""
47.ds R" ""
48''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49''' \*(L" and \*(R", except that they are used on ".xx" lines,
50''' such as .IP and .SH, which do another additional levels of
51''' double-quote interpretation
52.ds M" """
53.ds S" """
54.ds N" """""
55.ds T" """""
56.ds L' '
57.ds R' '
58.ds M' '
59.ds S' '
60.ds N' '
61.ds T' '
984263bc
MD
62'br\}
63.el\{\
74dab6c2
JR
64.ds -- \(em\|
65.tr \*(Tr
66.ds L" ``
67.ds R" ''
68.ds M" ``
69.ds S" ''
70.ds N" ``
71.ds T" ''
72.ds L' `
73.ds R' '
74.ds M' `
75.ds S' '
76.ds N' `
77.ds T' '
78.ds PI \(*p
984263bc 79'br\}
74dab6c2
JR
80.\" If the F register is turned on, we'll generate
81.\" index entries out stderr for the following things:
82.\" TH Title
83.\" SH Header
84.\" Sh Subsection
85.\" Ip Item
86.\" X<> Xref (embedded
87.\" Of course, you have to process the output yourself
88.\" in some meaninful fashion.
89.if \nF \{
90.de IX
91.tm Index:\\$1\t\\n%\t"\\$2"
984263bc 92..
74dab6c2
JR
93.nr % 0
94.rr F
984263bc 95.\}
74dab6c2
JR
96.TH RSA_set_method 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97.UC
98.if n .hy 0
984263bc 99.if n .na
74dab6c2
JR
100.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101.de CQ \" put $1 in typewriter font
102.ft CW
103'if n "\c
104'if t \\&\\$1\c
105'if n \\&\\$1\c
106'if n \&"
107\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108'.ft R
109..
110.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111. \" AM - accent mark definitions
984263bc 112.bd B 3
74dab6c2 113. \" fudge factors for nroff and troff
984263bc 114.if n \{\
74dab6c2
JR
115. ds #H 0
116. ds #V .8m
117. ds #F .3m
118. ds #[ \f1
119. ds #] \fP
984263bc
MD
120.\}
121.if t \{\
74dab6c2
JR
122. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123. ds #V .6m
124. ds #F 0
125. ds #[ \&
126. ds #] \&
984263bc 127.\}
74dab6c2 128. \" simple accents for nroff and troff
984263bc 129.if n \{\
74dab6c2
JR
130. ds ' \&
131. ds ` \&
132. ds ^ \&
133. ds , \&
134. ds ~ ~
135. ds ? ?
136. ds ! !
137. ds /
138. ds q
984263bc
MD
139.\}
140.if t \{\
74dab6c2
JR
141. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
984263bc 150.\}
74dab6c2 151. \" troff and (daisy-wheel) nroff accents
984263bc
MD
152.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
74dab6c2
JR
154.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
984263bc
MD
158.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163.ds ae a\h'-(\w'a'u*4/10)'e
164.ds Ae A\h'-(\w'A'u*4/10)'E
74dab6c2
JR
165.ds oe o\h'-(\w'o'u*4/10)'e
166.ds Oe O\h'-(\w'O'u*4/10)'E
167. \" corrections for vroff
984263bc
MD
168.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
74dab6c2 170. \" for low resolution devices (crt and lpr)
984263bc
MD
171.if \n(.H>23 .if \n(.V>19 \
172\{\
74dab6c2
JR
173. ds : e
174. ds 8 ss
175. ds v \h'-1'\o'\(aa\(ga'
176. ds _ \h'-1'^
177. ds . \h'-1'.
178. ds 3 3
179. ds o a
180. ds d- d\h'-1'\(ga
181. ds D- D\h'-1'\(hy
182. ds th \o'bp'
183. ds Th \o'LP'
184. ds ae ae
185. ds Ae AE
186. ds oe oe
187. ds Oe OE
984263bc
MD
188.\}
189.rm #[ #] #H #V #F C
984263bc
MD
190.SH "NAME"
191RSA_set_default_method, RSA_get_default_method, RSA_set_method,
192RSA_get_method, RSA_PKCS1_SSLeay, RSA_null_method, RSA_flags,
74dab6c2 193RSA_new_method \- select RSA method
984263bc 194.SH "SYNOPSIS"
74dab6c2 195.PP
984263bc
MD
196.Vb 1
197\& #include <openssl/rsa.h>
198.Ve
199.Vb 1
200\& void RSA_set_default_method(const RSA_METHOD *meth);
201.Ve
202.Vb 1
203\& RSA_METHOD *RSA_get_default_method(void);
204.Ve
205.Vb 1
206\& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
207.Ve
208.Vb 1
209\& RSA_METHOD *RSA_get_method(const RSA *rsa);
210.Ve
211.Vb 1
212\& RSA_METHOD *RSA_PKCS1_SSLeay(void);
213.Ve
214.Vb 1
215\& RSA_METHOD *RSA_null_method(void);
216.Ve
217.Vb 1
218\& int RSA_flags(const RSA *rsa);
219.Ve
220.Vb 1
221\& RSA *RSA_new_method(RSA_METHOD *method);
222.Ve
223.SH "DESCRIPTION"
74dab6c2 224An \fBRSA_METHOD\fR specifies the functions that OpenSSL uses for RSA
984263bc 225operations. By modifying the method, alternative implementations such as
74dab6c2
JR
226hardware accelerators may be used. IMPORTANT: See the NOTES section for
227important information about how these RSA API functions are affected by the
228use of \fBENGINE\fR API calls.
984263bc 229.PP
74dab6c2 230Initially, the default RSA_METHOD is the OpenSSL internal implementation,
984263bc
MD
231as returned by \fIRSA_PKCS1_SSLeay()\fR.
232.PP
74dab6c2
JR
233\fIRSA_set_default_method()\fR makes \fBmeth\fR the default method for all RSA
234structures created later. \fBNB\fR: This is true only whilst no ENGINE has
235been set as a default for RSA, so this function is no longer recommended.
984263bc 236.PP
74dab6c2
JR
237\fIRSA_get_default_method()\fR returns a pointer to the current default
238RSA_METHOD. However, the meaningfulness of this result is dependant on
239whether the ENGINE API is being used, so this function is no longer
984263bc
MD
240recommended.
241.PP
74dab6c2
JR
242\fIRSA_set_method()\fR selects \fBmeth\fR to perform all operations using the key
243\fBrsa\fR. This will replace the RSA_METHOD used by the RSA key and if the
244previous method was supplied by an ENGINE, the handle to that ENGINE will
245be released during the change. It is possible to have RSA keys that only
246work with certain RSA_METHOD implementations (eg. from an ENGINE module
984263bc 247that supports embedded hardware-protected keys), and in such cases
74dab6c2 248attempting to change the RSA_METHOD for the key can have unexpected
984263bc
MD
249results.
250.PP
74dab6c2
JR
251\fIRSA_get_method()\fR returns a pointer to the RSA_METHOD being used by \fBrsa\fR.
252This method may or may not be supplied by an ENGINE implementation, but if
984263bc 253it is, the return value can only be guaranteed to be valid as long as the
74dab6c2
JR
254RSA key itself is valid and does not have its implementation changed by
255\fIRSA_set_method()\fR.
984263bc 256.PP
74dab6c2
JR
257\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current
258RSA_METHOD. See the BUGS section.
984263bc 259.PP
74dab6c2
JR
260\fIRSA_new_method()\fR allocates and initializes an RSA structure so that
261\fBengine\fR will be used for the RSA operations. If \fBengine\fR is NULL, the
262default ENGINE for RSA operations is used, and if no default ENGINE is set,
263the RSA_METHOD controlled by \fIRSA_set_default_method()\fR is used.
984263bc 264.PP
74dab6c2 265\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current method.
984263bc 266.PP
74dab6c2
JR
267\fIRSA_new_method()\fR allocates and initializes an \fBRSA\fR structure so that
268\fBmethod\fR will be used for the RSA operations. If \fBmethod\fR is \fBNULL\fR,
984263bc
MD
269the default method is used.
270.SH "THE RSA_METHOD STRUCTURE"
74dab6c2 271.PP
984263bc
MD
272.Vb 4
273\& typedef struct rsa_meth_st
274\& {
275\& /* name of the implementation */
276\& const char *name;
277.Ve
278.Vb 3
279\& /* encrypt */
280\& int (*rsa_pub_enc)(int flen, unsigned char *from,
281\& unsigned char *to, RSA *rsa, int padding);
282.Ve
283.Vb 3
284\& /* verify arbitrary data */
285\& int (*rsa_pub_dec)(int flen, unsigned char *from,
286\& unsigned char *to, RSA *rsa, int padding);
287.Ve
288.Vb 3
289\& /* sign arbitrary data */
290\& int (*rsa_priv_enc)(int flen, unsigned char *from,
291\& unsigned char *to, RSA *rsa, int padding);
292.Ve
293.Vb 3
294\& /* decrypt */
295\& int (*rsa_priv_dec)(int flen, unsigned char *from,
296\& unsigned char *to, RSA *rsa, int padding);
297.Ve
298.Vb 3
299\& /* compute r0 = r0 ^ I mod rsa->n (May be NULL for some
300\& implementations) */
301\& int (*rsa_mod_exp)(BIGNUM *r0, BIGNUM *I, RSA *rsa);
302.Ve
303.Vb 3
304\& /* compute r = a ^ p mod m (May be NULL for some implementations) */
305\& int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
306\& const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
307.Ve
308.Vb 2
309\& /* called at RSA_new */
310\& int (*init)(RSA *rsa);
311.Ve
312.Vb 2
313\& /* called at RSA_free */
314\& int (*finish)(RSA *rsa);
315.Ve
316.Vb 7
317\& /* RSA_FLAG_EXT_PKEY - rsa_mod_exp is called for private key
318\& * operations, even if p,q,dmp1,dmq1,iqmp
319\& * are NULL
320\& * RSA_FLAG_SIGN_VER - enable rsa_sign and rsa_verify
321\& * RSA_METHOD_FLAG_NO_CHECK - don't check pub/private match
322\& */
323\& int flags;
324.Ve
325.Vb 1
326\& char *app_data; /* ?? */
327.Ve
328.Vb 5
329\& /* sign. For backward compatibility, this is used only
330\& * if (flags & RSA_FLAG_SIGN_VER)
331\& */
332\& int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len,
333\& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
334.Ve
335.Vb 5
336\& /* verify. For backward compatibility, this is used only
337\& * if (flags & RSA_FLAG_SIGN_VER)
338\& */
339\& int (*rsa_verify)(int type, unsigned char *m, unsigned int m_len,
340\& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
341.Ve
342.Vb 1
343\& } RSA_METHOD;
344.Ve
345.SH "RETURN VALUES"
74dab6c2 346\fIRSA_PKCS1_SSLeay()\fR, \fIRSA_PKCS1_null_method()\fR, \fIRSA_get_default_method()\fR
984263bc
MD
347and \fIRSA_get_method()\fR return pointers to the respective RSA_METHODs.
348.PP
74dab6c2 349\fIRSA_set_default_method()\fR returns no value.
984263bc 350.PP
74dab6c2 351\fIRSA_set_method()\fR returns a pointer to the old RSA_METHOD implementation
984263bc 352that was replaced. However, this return value should probably be ignored
74dab6c2
JR
353because if it was supplied by an ENGINE, the pointer could be invalidated
354at any time if the ENGINE is unloaded (in fact it could be unloaded as a
984263bc 355result of the \fIRSA_set_method()\fR function releasing its handle to the
74dab6c2 356ENGINE). For this reason, the return type may be replaced with a \fBvoid\fR
984263bc
MD
357declaration in a future release.
358.PP
74dab6c2 359\fIRSA_new_method()\fR returns NULL and sets an error code that can be obtained
984263bc
MD
360by ERR_get_error(3) if the allocation fails. Otherwise
361it returns a pointer to the newly allocated structure.
362.SH "NOTES"
74dab6c2
JR
363As of version 0.9.7, RSA_METHOD implementations are grouped together with
364other algorithmic APIs (eg. DSA_METHOD, EVP_CIPHER, etc) into \fBENGINE\fR
365modules. If a default ENGINE is specified for RSA functionality using an
366ENGINE API function, that will override any RSA defaults set using the RSA
367API (ie. \fIRSA_set_default_method()\fR). For this reason, the ENGINE API is the
368recommended way to control default implementations for use in RSA and other
984263bc
MD
369cryptographic algorithms.
370.SH "BUGS"
984263bc 371The behaviour of \fIRSA_flags()\fR is a mis-feature that is left as-is for now
74dab6c2
JR
372to avoid creating compatibility problems. RSA functionality, such as the
373encryption functions, are controlled by the \fBflags\fR value in the RSA key
374itself, not by the \fBflags\fR value in the RSA_METHOD attached to the RSA key
375(which is what this function returns). If the flags element of an RSA key
376is changed, the changes will be honoured by RSA functionality but will not
984263bc 377be reflected in the return value of the \fIRSA_flags()\fR function \- in effect
74dab6c2 378\fIRSA_flags()\fR behaves more like an \fIRSA_default_flags()\fR function (which does
984263bc
MD
379not currently exist).
380.SH "SEE ALSO"
984263bc
MD
381rsa(3), RSA_new(3)
382.SH "HISTORY"
74dab6c2
JR
383\fIRSA_new_method()\fR and \fIRSA_set_default_method()\fR appeared in SSLeay 0.8.
384\fIRSA_get_default_method()\fR, \fIRSA_set_method()\fR and \fIRSA_get_method()\fR as
385well as the rsa_sign and rsa_verify components of RSA_METHOD were
984263bc
MD
386added in OpenSSL 0.9.4.
387.PP
74dab6c2 388\fIRSA_set_default_openssl_method()\fR and \fIRSA_get_default_openssl_method()\fR
984263bc
MD
389replaced \fIRSA_set_default_method()\fR and \fIRSA_get_default_method()\fR
390respectively, and \fIRSA_set_method()\fR and \fIRSA_new_method()\fR were altered to use
74dab6c2
JR
391\fBENGINE\fRs rather than \fBRSA_METHOD\fRs during development of the engine
392version of OpenSSL 0.9.6. For 0.9.7, the handling of defaults in the ENGINE
393API was restructured so that this change was reversed, and behaviour of the
984263bc 394other functions resembled more closely the previous behaviour. The
74dab6c2
JR
395behaviour of defaults in the ENGINE API now transparently overrides the
396behaviour of defaults in the RSA API without requiring changing these
984263bc 397function prototypes.
74dab6c2
JR
398
399.rn }` ''
400.IX Title "RSA_set_method 3"
401.IX Name "RSA_set_default_method, RSA_get_default_method, RSA_set_method,
402RSA_get_method, RSA_PKCS1_SSLeay, RSA_null_method, RSA_flags,
403RSA_new_method - select RSA method"
404
405.IX Header "NAME"
406
407.IX Header "SYNOPSIS"
408
409.IX Header "DESCRIPTION"
410
411.IX Header "THE RSA_METHOD STRUCTURE"
412
413.IX Header "RETURN VALUES"
414
415.IX Header "NOTES"
416
417.IX Header "BUGS"
418
419.IX Header "SEE ALSO"
420
421.IX Header "HISTORY"
422