diff options
Diffstat (limited to 'src/lib/libcrypto/doc/RSA_set_method.pod')
-rw-r--r-- | src/lib/libcrypto/doc/RSA_set_method.pod | 201 |
1 files changed, 0 insertions, 201 deletions
diff --git a/src/lib/libcrypto/doc/RSA_set_method.pod b/src/lib/libcrypto/doc/RSA_set_method.pod deleted file mode 100644 index 3f50a89e5c..0000000000 --- a/src/lib/libcrypto/doc/RSA_set_method.pod +++ /dev/null | |||
@@ -1,201 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | RSA_set_default_method, RSA_get_default_method, RSA_set_method, | ||
6 | RSA_get_method, RSA_PKCS1_SSLeay, RSA_null_method, RSA_flags, | ||
7 | RSA_new_method, RSA_get_default_openssl_method, | ||
8 | RSA_set_default_openssl_method - select RSA method | ||
9 | |||
10 | =head1 SYNOPSIS | ||
11 | |||
12 | #include <openssl/rsa.h> | ||
13 | |||
14 | void RSA_set_default_method(const RSA_METHOD *meth); | ||
15 | |||
16 | RSA_METHOD *RSA_get_default_method(void); | ||
17 | |||
18 | int RSA_set_method(RSA *rsa, const RSA_METHOD *meth); | ||
19 | |||
20 | RSA_METHOD *RSA_get_method(const RSA *rsa); | ||
21 | |||
22 | RSA_METHOD *RSA_PKCS1_SSLeay(void); | ||
23 | |||
24 | RSA_METHOD *RSA_null_method(void); | ||
25 | |||
26 | int RSA_flags(const RSA *rsa); | ||
27 | |||
28 | RSA *RSA_new_method(RSA_METHOD *method); | ||
29 | |||
30 | =head1 DESCRIPTION | ||
31 | |||
32 | An B<RSA_METHOD> specifies the functions that OpenSSL uses for RSA | ||
33 | operations. By modifying the method, alternative implementations such as | ||
34 | hardware accelerators may be used. IMPORTANT: See the NOTES section for | ||
35 | important information about how these RSA API functions are affected by the | ||
36 | use of B<ENGINE> API calls. | ||
37 | |||
38 | Initially, the default RSA_METHOD is the OpenSSL internal implementation, | ||
39 | as returned by RSA_PKCS1_SSLeay(). | ||
40 | |||
41 | RSA_set_default_method() makes B<meth> the default method for all RSA | ||
42 | structures created later. B<NB>: This is true only whilst no ENGINE has | ||
43 | been set as a default for RSA, so this function is no longer recommended. | ||
44 | |||
45 | RSA_get_default_method() returns a pointer to the current default | ||
46 | RSA_METHOD. However, the meaningfulness of this result is dependent on | ||
47 | whether the ENGINE API is being used, so this function is no longer | ||
48 | recommended. | ||
49 | |||
50 | RSA_set_method() selects B<meth> to perform all operations using the key | ||
51 | B<rsa>. This will replace the RSA_METHOD used by the RSA key and if the | ||
52 | previous method was supplied by an ENGINE, the handle to that ENGINE will | ||
53 | be released during the change. It is possible to have RSA keys that only | ||
54 | work with certain RSA_METHOD implementations (eg. from an ENGINE module | ||
55 | that supports embedded hardware-protected keys), and in such cases | ||
56 | attempting to change the RSA_METHOD for the key can have unexpected | ||
57 | results. | ||
58 | |||
59 | RSA_get_method() returns a pointer to the RSA_METHOD being used by B<rsa>. | ||
60 | This method may or may not be supplied by an ENGINE implementation, but if | ||
61 | it is, the return value can only be guaranteed to be valid as long as the | ||
62 | RSA key itself is valid and does not have its implementation changed by | ||
63 | RSA_set_method(). | ||
64 | |||
65 | RSA_flags() returns the B<flags> that are set for B<rsa>'s current | ||
66 | RSA_METHOD. See the BUGS section. | ||
67 | |||
68 | RSA_new_method() allocates and initializes an RSA structure so that | ||
69 | B<engine> will be used for the RSA operations. If B<engine> is NULL, the | ||
70 | default ENGINE for RSA operations is used, and if no default ENGINE is set, | ||
71 | the RSA_METHOD controlled by RSA_set_default_method() is used. | ||
72 | |||
73 | RSA_flags() returns the B<flags> that are set for B<rsa>'s current method. | ||
74 | |||
75 | RSA_new_method() allocates and initializes an B<RSA> structure so that | ||
76 | B<method> will be used for the RSA operations. If B<method> is B<NULL>, | ||
77 | the default method is used. | ||
78 | |||
79 | =head1 THE RSA_METHOD STRUCTURE | ||
80 | |||
81 | typedef struct rsa_meth_st | ||
82 | { | ||
83 | /* name of the implementation */ | ||
84 | const char *name; | ||
85 | |||
86 | /* encrypt */ | ||
87 | int (*rsa_pub_enc)(int flen, unsigned char *from, | ||
88 | unsigned char *to, RSA *rsa, int padding); | ||
89 | |||
90 | /* verify arbitrary data */ | ||
91 | int (*rsa_pub_dec)(int flen, unsigned char *from, | ||
92 | unsigned char *to, RSA *rsa, int padding); | ||
93 | |||
94 | /* sign arbitrary data */ | ||
95 | int (*rsa_priv_enc)(int flen, unsigned char *from, | ||
96 | unsigned char *to, RSA *rsa, int padding); | ||
97 | |||
98 | /* decrypt */ | ||
99 | int (*rsa_priv_dec)(int flen, unsigned char *from, | ||
100 | unsigned char *to, RSA *rsa, int padding); | ||
101 | |||
102 | /* compute r0 = r0 ^ I mod rsa->n (May be NULL for some | ||
103 | implementations) */ | ||
104 | int (*rsa_mod_exp)(BIGNUM *r0, BIGNUM *I, RSA *rsa); | ||
105 | |||
106 | /* compute r = a ^ p mod m (May be NULL for some implementations) */ | ||
107 | int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p, | ||
108 | const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); | ||
109 | |||
110 | /* called at RSA_new */ | ||
111 | int (*init)(RSA *rsa); | ||
112 | |||
113 | /* called at RSA_free */ | ||
114 | int (*finish)(RSA *rsa); | ||
115 | |||
116 | /* RSA_FLAG_EXT_PKEY - rsa_mod_exp is called for private key | ||
117 | * operations, even if p,q,dmp1,dmq1,iqmp | ||
118 | * are NULL | ||
119 | * RSA_FLAG_SIGN_VER - enable rsa_sign and rsa_verify | ||
120 | * RSA_METHOD_FLAG_NO_CHECK - don't check pub/private match | ||
121 | */ | ||
122 | int flags; | ||
123 | |||
124 | char *app_data; /* ?? */ | ||
125 | |||
126 | /* sign. For backward compatibility, this is used only | ||
127 | * if (flags & RSA_FLAG_SIGN_VER) | ||
128 | */ | ||
129 | int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len, | ||
130 | unsigned char *sigret, unsigned int *siglen, RSA *rsa); | ||
131 | |||
132 | /* verify. For backward compatibility, this is used only | ||
133 | * if (flags & RSA_FLAG_SIGN_VER) | ||
134 | */ | ||
135 | int (*rsa_verify)(int type, unsigned char *m, unsigned int m_len, | ||
136 | unsigned char *sigbuf, unsigned int siglen, RSA *rsa); | ||
137 | |||
138 | } RSA_METHOD; | ||
139 | |||
140 | =head1 RETURN VALUES | ||
141 | |||
142 | RSA_PKCS1_SSLeay(), RSA_PKCS1_null_method(), RSA_get_default_method() | ||
143 | and RSA_get_method() return pointers to the respective RSA_METHODs. | ||
144 | |||
145 | RSA_set_method() returns a pointer to the old RSA_METHOD implementation | ||
146 | that was replaced. However, this return value should probably be ignored | ||
147 | because if it was supplied by an ENGINE, the pointer could be invalidated | ||
148 | at any time if the ENGINE is unloaded (in fact it could be unloaded as a | ||
149 | result of the RSA_set_method() function releasing its handle to the | ||
150 | ENGINE). For this reason, the return type may be replaced with a B<void> | ||
151 | declaration in a future release. | ||
152 | |||
153 | RSA_new_method() returns NULL and sets an error code that can be obtained | ||
154 | by L<ERR_get_error(3)|ERR_get_error(3)> if the allocation fails. Otherwise | ||
155 | it returns a pointer to the newly allocated structure. | ||
156 | |||
157 | =head1 NOTES | ||
158 | |||
159 | As of version 0.9.7, RSA_METHOD implementations are grouped together with | ||
160 | other algorithmic APIs (eg. DSA_METHOD, EVP_CIPHER, etc) into B<ENGINE> | ||
161 | modules. If a default ENGINE is specified for RSA functionality using an | ||
162 | ENGINE API function, that will override any RSA defaults set using the RSA | ||
163 | API (ie. RSA_set_default_method()). For this reason, the ENGINE API is the | ||
164 | recommended way to control default implementations for use in RSA and other | ||
165 | cryptographic algorithms. | ||
166 | |||
167 | =head1 BUGS | ||
168 | |||
169 | The behaviour of RSA_flags() is a mis-feature that is left as-is for now | ||
170 | to avoid creating compatibility problems. RSA functionality, such as the | ||
171 | encryption functions, are controlled by the B<flags> value in the RSA key | ||
172 | itself, not by the B<flags> value in the RSA_METHOD attached to the RSA key | ||
173 | (which is what this function returns). If the flags element of an RSA key | ||
174 | is changed, the changes will be honoured by RSA functionality but will not | ||
175 | be reflected in the return value of the RSA_flags() function - in effect | ||
176 | RSA_flags() behaves more like an RSA_default_flags() function (which does | ||
177 | not currently exist). | ||
178 | |||
179 | =head1 SEE ALSO | ||
180 | |||
181 | L<rsa(3)|rsa(3)>, L<RSA_new(3)|RSA_new(3)> | ||
182 | |||
183 | =head1 HISTORY | ||
184 | |||
185 | RSA_new_method() and RSA_set_default_method() appeared in SSLeay 0.8. | ||
186 | RSA_get_default_method(), RSA_set_method() and RSA_get_method() as | ||
187 | well as the rsa_sign and rsa_verify components of RSA_METHOD were | ||
188 | added in OpenSSL 0.9.4. | ||
189 | |||
190 | RSA_set_default_openssl_method() and RSA_get_default_openssl_method() | ||
191 | replaced RSA_set_default_method() and RSA_get_default_method() | ||
192 | respectively, and RSA_set_method() and RSA_new_method() were altered to use | ||
193 | B<ENGINE>s rather than B<RSA_METHOD>s during development of the engine | ||
194 | version of OpenSSL 0.9.6. For 0.9.7, the handling of defaults in the ENGINE | ||
195 | API was restructured so that this change was reversed, and behaviour of the | ||
196 | other functions resembled more closely the previous behaviour. The | ||
197 | behaviour of defaults in the ENGINE API now transparently overrides the | ||
198 | behaviour of defaults in the RSA API without requiring changing these | ||
199 | function prototypes. | ||
200 | |||
201 | =cut | ||