Merge branch 'vendor/LIBPCAP' (early part)
[dragonfly.git] / secure / lib / libcrypto / man / RSA_set_method.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
55.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
98. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 115. \" corrections for vroff
984263bc
MD
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "RSA_set_method 3"
405d0527 135.TH RSA_set_method 3 "2009-04-11" "0.9.8k" "OpenSSL"
e257b235
PA
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
984263bc
MD
140.SH "NAME"
141RSA_set_default_method, RSA_get_default_method, RSA_set_method,
142RSA_get_method, RSA_PKCS1_SSLeay, RSA_null_method, RSA_flags,
74dab6c2 143RSA_new_method \- select RSA method
984263bc 144.SH "SYNOPSIS"
8b0cefbb 145.IX Header "SYNOPSIS"
984263bc
MD
146.Vb 1
147\& #include <openssl/rsa.h>
e257b235 148\&
984263bc 149\& void RSA_set_default_method(const RSA_METHOD *meth);
e257b235 150\&
984263bc 151\& RSA_METHOD *RSA_get_default_method(void);
e257b235 152\&
984263bc 153\& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
e257b235 154\&
984263bc 155\& RSA_METHOD *RSA_get_method(const RSA *rsa);
e257b235 156\&
984263bc 157\& RSA_METHOD *RSA_PKCS1_SSLeay(void);
e257b235 158\&
984263bc 159\& RSA_METHOD *RSA_null_method(void);
e257b235 160\&
984263bc 161\& int RSA_flags(const RSA *rsa);
e257b235 162\&
984263bc
MD
163\& RSA *RSA_new_method(RSA_METHOD *method);
164.Ve
165.SH "DESCRIPTION"
8b0cefbb
JR
166.IX Header "DESCRIPTION"
167An \fB\s-1RSA_METHOD\s0\fR specifies the functions that OpenSSL uses for \s-1RSA\s0
984263bc 168operations. By modifying the method, alternative implementations such as
8b0cefbb
JR
169hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
170important information about how these \s-1RSA\s0 \s-1API\s0 functions are affected by the
171use of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
984263bc 172.PP
8b0cefbb 173Initially, the default \s-1RSA_METHOD\s0 is the OpenSSL internal implementation,
984263bc
MD
174as returned by \fIRSA_PKCS1_SSLeay()\fR.
175.PP
8b0cefbb
JR
176\&\fIRSA_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1RSA\s0
177structures created later. \fB\s-1NB\s0\fR: This is true only whilst no \s-1ENGINE\s0 has
178been set as a default for \s-1RSA\s0, so this function is no longer recommended.
984263bc 179.PP
8b0cefbb 180\&\fIRSA_get_default_method()\fR returns a pointer to the current default
aac4ff6f 181\&\s-1RSA_METHOD\s0. However, the meaningfulness of this result is dependent on
8b0cefbb 182whether the \s-1ENGINE\s0 \s-1API\s0 is being used, so this function is no longer
984263bc
MD
183recommended.
184.PP
8b0cefbb
JR
185\&\fIRSA_set_method()\fR selects \fBmeth\fR to perform all operations using the key
186\&\fBrsa\fR. This will replace the \s-1RSA_METHOD\s0 used by the \s-1RSA\s0 key and if the
187previous method was supplied by an \s-1ENGINE\s0, the handle to that \s-1ENGINE\s0 will
188be released during the change. It is possible to have \s-1RSA\s0 keys that only
189work with certain \s-1RSA_METHOD\s0 implementations (eg. from an \s-1ENGINE\s0 module
984263bc 190that supports embedded hardware-protected keys), and in such cases
8b0cefbb 191attempting to change the \s-1RSA_METHOD\s0 for the key can have unexpected
984263bc
MD
192results.
193.PP
8b0cefbb
JR
194\&\fIRSA_get_method()\fR returns a pointer to the \s-1RSA_METHOD\s0 being used by \fBrsa\fR.
195This method may or may not be supplied by an \s-1ENGINE\s0 implementation, but if
984263bc 196it is, the return value can only be guaranteed to be valid as long as the
8b0cefbb
JR
197\&\s-1RSA\s0 key itself is valid and does not have its implementation changed by
198\&\fIRSA_set_method()\fR.
984263bc 199.PP
8b0cefbb
JR
200\&\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current
201\&\s-1RSA_METHOD\s0. See the \s-1BUGS\s0 section.
984263bc 202.PP
8b0cefbb
JR
203\&\fIRSA_new_method()\fR allocates and initializes an \s-1RSA\s0 structure so that
204\&\fBengine\fR will be used for the \s-1RSA\s0 operations. If \fBengine\fR is \s-1NULL\s0, the
205default \s-1ENGINE\s0 for \s-1RSA\s0 operations is used, and if no default \s-1ENGINE\s0 is set,
206the \s-1RSA_METHOD\s0 controlled by \fIRSA_set_default_method()\fR is used.
984263bc 207.PP
8b0cefbb 208\&\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current method.
984263bc 209.PP
8b0cefbb
JR
210\&\fIRSA_new_method()\fR allocates and initializes an \fB\s-1RSA\s0\fR structure so that
211\&\fBmethod\fR will be used for the \s-1RSA\s0 operations. If \fBmethod\fR is \fB\s-1NULL\s0\fR,
984263bc
MD
212the default method is used.
213.SH "THE RSA_METHOD STRUCTURE"
8b0cefbb 214.IX Header "THE RSA_METHOD STRUCTURE"
984263bc
MD
215.Vb 4
216\& typedef struct rsa_meth_st
217\& {
218\& /* name of the implementation */
219\& const char *name;
e257b235 220\&
984263bc
MD
221\& /* encrypt */
222\& int (*rsa_pub_enc)(int flen, unsigned char *from,
223\& unsigned char *to, RSA *rsa, int padding);
e257b235 224\&
984263bc
MD
225\& /* verify arbitrary data */
226\& int (*rsa_pub_dec)(int flen, unsigned char *from,
227\& unsigned char *to, RSA *rsa, int padding);
e257b235 228\&
984263bc
MD
229\& /* sign arbitrary data */
230\& int (*rsa_priv_enc)(int flen, unsigned char *from,
231\& unsigned char *to, RSA *rsa, int padding);
e257b235 232\&
984263bc
MD
233\& /* decrypt */
234\& int (*rsa_priv_dec)(int flen, unsigned char *from,
235\& unsigned char *to, RSA *rsa, int padding);
e257b235
PA
236\&
237\& /* compute r0 = r0 ^ I mod rsa\->n (May be NULL for some
984263bc
MD
238\& implementations) */
239\& int (*rsa_mod_exp)(BIGNUM *r0, BIGNUM *I, RSA *rsa);
e257b235 240\&
984263bc
MD
241\& /* compute r = a ^ p mod m (May be NULL for some implementations) */
242\& int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
243\& const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
e257b235 244\&
984263bc
MD
245\& /* called at RSA_new */
246\& int (*init)(RSA *rsa);
e257b235 247\&
984263bc
MD
248\& /* called at RSA_free */
249\& int (*finish)(RSA *rsa);
e257b235
PA
250\&
251\& /* RSA_FLAG_EXT_PKEY \- rsa_mod_exp is called for private key
984263bc
MD
252\& * operations, even if p,q,dmp1,dmq1,iqmp
253\& * are NULL
e257b235
PA
254\& * RSA_FLAG_SIGN_VER \- enable rsa_sign and rsa_verify
255\& * RSA_METHOD_FLAG_NO_CHECK \- don\*(Aqt check pub/private match
984263bc
MD
256\& */
257\& int flags;
e257b235 258\&
984263bc 259\& char *app_data; /* ?? */
e257b235 260\&
984263bc
MD
261\& /* sign. For backward compatibility, this is used only
262\& * if (flags & RSA_FLAG_SIGN_VER)
263\& */
264\& int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len,
265\& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
e257b235 266\&
984263bc
MD
267\& /* verify. For backward compatibility, this is used only
268\& * if (flags & RSA_FLAG_SIGN_VER)
269\& */
270\& int (*rsa_verify)(int type, unsigned char *m, unsigned int m_len,
271\& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
e257b235 272\&
984263bc
MD
273\& } RSA_METHOD;
274.Ve
275.SH "RETURN VALUES"
8b0cefbb
JR
276.IX Header "RETURN VALUES"
277\&\fIRSA_PKCS1_SSLeay()\fR, \fIRSA_PKCS1_null_method()\fR, \fIRSA_get_default_method()\fR
984263bc
MD
278and \fIRSA_get_method()\fR return pointers to the respective RSA_METHODs.
279.PP
8b0cefbb 280\&\fIRSA_set_default_method()\fR returns no value.
984263bc 281.PP
8b0cefbb 282\&\fIRSA_set_method()\fR returns a pointer to the old \s-1RSA_METHOD\s0 implementation
984263bc 283that was replaced. However, this return value should probably be ignored
8b0cefbb
JR
284because if it was supplied by an \s-1ENGINE\s0, the pointer could be invalidated
285at any time if the \s-1ENGINE\s0 is unloaded (in fact it could be unloaded as a
984263bc 286result of the \fIRSA_set_method()\fR function releasing its handle to the
8b0cefbb 287\&\s-1ENGINE\s0). For this reason, the return type may be replaced with a \fBvoid\fR
984263bc
MD
288declaration in a future release.
289.PP
8b0cefbb
JR
290\&\fIRSA_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be obtained
291by \fIERR_get_error\fR\|(3) if the allocation fails. Otherwise
984263bc
MD
292it returns a pointer to the newly allocated structure.
293.SH "NOTES"
8b0cefbb
JR
294.IX Header "NOTES"
295As of version 0.9.7, \s-1RSA_METHOD\s0 implementations are grouped together with
296other algorithmic APIs (eg. \s-1DSA_METHOD\s0, \s-1EVP_CIPHER\s0, etc) into \fB\s-1ENGINE\s0\fR
297modules. If a default \s-1ENGINE\s0 is specified for \s-1RSA\s0 functionality using an
298\&\s-1ENGINE\s0 \s-1API\s0 function, that will override any \s-1RSA\s0 defaults set using the \s-1RSA\s0
299\&\s-1API\s0 (ie. \fIRSA_set_default_method()\fR). For this reason, the \s-1ENGINE\s0 \s-1API\s0 is the
300recommended way to control default implementations for use in \s-1RSA\s0 and other
984263bc
MD
301cryptographic algorithms.
302.SH "BUGS"
8b0cefbb 303.IX Header "BUGS"
984263bc 304The behaviour of \fIRSA_flags()\fR is a mis-feature that is left as-is for now
8b0cefbb
JR
305to avoid creating compatibility problems. \s-1RSA\s0 functionality, such as the
306encryption functions, are controlled by the \fBflags\fR value in the \s-1RSA\s0 key
307itself, not by the \fBflags\fR value in the \s-1RSA_METHOD\s0 attached to the \s-1RSA\s0 key
308(which is what this function returns). If the flags element of an \s-1RSA\s0 key
309is changed, the changes will be honoured by \s-1RSA\s0 functionality but will not
984263bc 310be reflected in the return value of the \fIRSA_flags()\fR function \- in effect
8b0cefbb 311\&\fIRSA_flags()\fR behaves more like an \fIRSA_default_flags()\fR function (which does
984263bc
MD
312not currently exist).
313.SH "SEE ALSO"
8b0cefbb
JR
314.IX Header "SEE ALSO"
315\&\fIrsa\fR\|(3), \fIRSA_new\fR\|(3)
984263bc 316.SH "HISTORY"
8b0cefbb
JR
317.IX Header "HISTORY"
318\&\fIRSA_new_method()\fR and \fIRSA_set_default_method()\fR appeared in SSLeay 0.8.
319\&\fIRSA_get_default_method()\fR, \fIRSA_set_method()\fR and \fIRSA_get_method()\fR as
320well as the rsa_sign and rsa_verify components of \s-1RSA_METHOD\s0 were
984263bc
MD
321added in OpenSSL 0.9.4.
322.PP
8b0cefbb 323\&\fIRSA_set_default_openssl_method()\fR and \fIRSA_get_default_openssl_method()\fR
984263bc
MD
324replaced \fIRSA_set_default_method()\fR and \fIRSA_get_default_method()\fR
325respectively, and \fIRSA_set_method()\fR and \fIRSA_new_method()\fR were altered to use
8b0cefbb
JR
326\&\fB\s-1ENGINE\s0\fRs rather than \fB\s-1RSA_METHOD\s0\fRs during development of the engine
327version of OpenSSL 0.9.6. For 0.9.7, the handling of defaults in the \s-1ENGINE\s0
328\&\s-1API\s0 was restructured so that this change was reversed, and behaviour of the
984263bc 329other functions resembled more closely the previous behaviour. The
8b0cefbb
JR
330behaviour of defaults in the \s-1ENGINE\s0 \s-1API\s0 now transparently overrides the
331behaviour of defaults in the \s-1RSA\s0 \s-1API\s0 without requiring changing these
984263bc 332function prototypes.