5 RSA_meth_get0_app_data, RSA_meth_set0_app_data,
6 RSA_meth_new, RSA_meth_free, RSA_meth_dup, RSA_meth_get0_name,
7 RSA_meth_set1_name, RSA_meth_get_flags, RSA_meth_set_flags,
9 RSA_meth_set_pub_enc, RSA_meth_get_pub_dec, RSA_meth_set_pub_dec,
10 RSA_meth_get_priv_enc, RSA_meth_set_priv_enc, RSA_meth_get_priv_dec,
11 RSA_meth_set_priv_dec, RSA_meth_get_mod_exp, RSA_meth_set_mod_exp,
12 RSA_meth_get_bn_mod_exp, RSA_meth_set_bn_mod_exp, RSA_meth_get_init,
13 RSA_meth_set_init, RSA_meth_get_finish, RSA_meth_set_finish,
14 RSA_meth_get_sign, RSA_meth_set_sign, RSA_meth_get_verify,
15 RSA_meth_set_verify, RSA_meth_get_keygen, RSA_meth_set_keygen,
16 RSA_meth_get_multi_prime_keygen, RSA_meth_set_multi_prime_keygen
17 - Routines to build up RSA methods
21 #include <openssl/rsa.h>
23 RSA_METHOD *RSA_meth_new(const char *name, int flags);
24 void RSA_meth_free(RSA_METHOD *meth);
26 RSA_METHOD *RSA_meth_dup(const RSA_METHOD *meth);
28 const char *RSA_meth_get0_name(const RSA_METHOD *meth);
29 int RSA_meth_set1_name(RSA_METHOD *meth, const char *name);
31 int RSA_meth_get_flags(const RSA_METHOD *meth);
32 int RSA_meth_set_flags(RSA_METHOD *meth, int flags);
34 void *RSA_meth_get0_app_data(const RSA_METHOD *meth);
35 int RSA_meth_set0_app_data(RSA_METHOD *meth, void *app_data);
37 int (*RSA_meth_get_pub_enc(const RSA_METHOD *meth))(int flen, const unsigned char *from,
38 unsigned char *to, RSA *rsa, int padding);
39 int RSA_meth_set_pub_enc(RSA_METHOD *rsa,
40 int (*pub_enc)(int flen, const unsigned char *from,
41 unsigned char *to, RSA *rsa,
44 int (*RSA_meth_get_pub_dec(const RSA_METHOD *meth))
45 (int flen, const unsigned char *from,
46 unsigned char *to, RSA *rsa, int padding);
47 int RSA_meth_set_pub_dec(RSA_METHOD *rsa,
48 int (*pub_dec)(int flen, const unsigned char *from,
49 unsigned char *to, RSA *rsa,
52 int (*RSA_meth_get_priv_enc(const RSA_METHOD *meth))(int flen, const unsigned char *from,
53 unsigned char *to, RSA *rsa,
55 int RSA_meth_set_priv_enc(RSA_METHOD *rsa,
56 int (*priv_enc)(int flen, const unsigned char *from,
57 unsigned char *to, RSA *rsa, int padding));
59 int (*RSA_meth_get_priv_dec(const RSA_METHOD *meth))(int flen, const unsigned char *from,
60 unsigned char *to, RSA *rsa,
62 int RSA_meth_set_priv_dec(RSA_METHOD *rsa,
63 int (*priv_dec)(int flen, const unsigned char *from,
64 unsigned char *to, RSA *rsa, int padding));
67 int (*RSA_meth_get_mod_exp(const RSA_METHOD *meth))(BIGNUM *r0, const BIGNUM *i,
68 RSA *rsa, BN_CTX *ctx);
69 int RSA_meth_set_mod_exp(RSA_METHOD *rsa,
70 int (*mod_exp)(BIGNUM *r0, const BIGNUM *i, RSA *rsa,
74 int (*RSA_meth_get_bn_mod_exp(const RSA_METHOD *meth))(BIGNUM *r, const BIGNUM *a,
75 const BIGNUM *p, const BIGNUM *m,
76 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
77 int RSA_meth_set_bn_mod_exp(RSA_METHOD *rsa,
78 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a,
79 const BIGNUM *p, const BIGNUM *m,
80 BN_CTX *ctx, BN_MONT_CTX *m_ctx));
83 int (*RSA_meth_get_init(const RSA_METHOD *meth) (RSA *rsa);
84 int RSA_meth_set_init(RSA_METHOD *rsa, int (*init (RSA *rsa));
87 int (*RSA_meth_get_finish(const RSA_METHOD *meth))(RSA *rsa);
88 int RSA_meth_set_finish(RSA_METHOD *rsa, int (*finish)(RSA *rsa));
90 int (*RSA_meth_get_sign(const RSA_METHOD *meth))(int type, const unsigned char *m,
91 unsigned int m_length,
92 unsigned char *sigret,
93 unsigned int *siglen, const RSA *rsa);
94 int RSA_meth_set_sign(RSA_METHOD *rsa,
95 int (*sign)(int type, const unsigned char *m,
96 unsigned int m_length, unsigned char *sigret,
97 unsigned int *siglen, const RSA *rsa));
99 int (*RSA_meth_get_verify(const RSA_METHOD *meth))(int dtype, const unsigned char *m,
100 unsigned int m_length,
101 const unsigned char *sigbuf,
102 unsigned int siglen, const RSA *rsa);
103 int RSA_meth_set_verify(RSA_METHOD *rsa,
104 int (*verify)(int dtype, const unsigned char *m,
105 unsigned int m_length,
106 const unsigned char *sigbuf,
107 unsigned int siglen, const RSA *rsa));
109 int (*RSA_meth_get_keygen(const RSA_METHOD *meth))(RSA *rsa, int bits, BIGNUM *e,
111 int RSA_meth_set_keygen(RSA_METHOD *rsa,
112 int (*keygen)(RSA *rsa, int bits, BIGNUM *e,
115 int (*RSA_meth_get_multi_prime_keygen(const RSA_METHOD *meth))(RSA *rsa, int bits,
116 int primes, BIGNUM *e,
119 int RSA_meth_set_multi_prime_keygen(RSA_METHOD *meth,
120 int (*keygen) (RSA *rsa, int bits,
121 int primes, BIGNUM *e,
126 The B<RSA_METHOD> type is a structure used for the provision of custom
127 RSA implementations. It provides a set of functions used by OpenSSL
128 for the implementation of the various RSA capabilities.
130 RSA_meth_new() creates a new B<RSA_METHOD> structure. It should be
131 given a unique B<name> and a set of B<flags>. The B<name> should be a
132 NULL terminated string, which will be duplicated and stored in the
133 B<RSA_METHOD> object. It is the callers responsibility to free the
134 original string. The flags will be used during the construction of a
135 new B<RSA> object based on this B<RSA_METHOD>. Any new B<RSA> object
136 will have those flags set by default.
138 RSA_meth_dup() creates a duplicate copy of the B<RSA_METHOD> object
139 passed as a parameter. This might be useful for creating a new
140 B<RSA_METHOD> based on an existing one, but with some differences.
142 RSA_meth_free() destroys an B<RSA_METHOD> structure and frees up any
143 memory associated with it.
145 RSA_meth_get0_name() will return a pointer to the name of this
146 RSA_METHOD. This is a pointer to the internal name string and so
147 should not be freed by the caller. RSA_meth_set1_name() sets the name
148 of the RSA_METHOD to B<name>. The string is duplicated and the copy is
149 stored in the RSA_METHOD structure, so the caller remains responsible
150 for freeing the memory associated with the name.
152 RSA_meth_get_flags() returns the current value of the flags associated
153 with this RSA_METHOD. RSA_meth_set_flags() provides the ability to set
156 The functions RSA_meth_get0_app_data() and RSA_meth_set0_app_data()
157 provide the ability to associate implementation specific data with the
158 RSA_METHOD. It is the application's responsibility to free this data
159 before the RSA_METHOD is freed via a call to RSA_meth_free().
161 RSA_meth_get_sign() and RSA_meth_set_sign() get and set the function
162 used for creating an RSA signature respectively. This function will be
163 called in response to the application calling RSA_sign(). The
164 parameters for the function have the same meaning as for RSA_sign().
166 RSA_meth_get_verify() and RSA_meth_set_verify() get and set the
167 function used for verifying an RSA signature respectively. This
168 function will be called in response to the application calling
169 RSA_verify(). The parameters for the function have the same meaning as
172 RSA_meth_get_mod_exp() and RSA_meth_set_mod_exp() get and set the
173 function used for CRT computations.
175 RSA_meth_get_bn_mod_exp() and RSA_meth_set_bn_mod_exp() get and set
176 the function used for CRT computations, specifically the following
181 Both the mod_exp() and bn_mod_exp() functions are called by the
182 default OpenSSL method during encryption, decryption, signing and
185 RSA_meth_get_init() and RSA_meth_set_init() get and set the function
186 used for creating a new RSA instance respectively. This function will
187 be called in response to the application calling RSA_new() (if the
188 current default RSA_METHOD is this one) or RSA_new_method(). The
189 RSA_new() and RSA_new_method() functions will allocate the memory for
190 the new RSA object, and a pointer to this newly allocated structure
191 will be passed as a parameter to the function. This function may be
194 RSA_meth_get_finish() and RSA_meth_set_finish() get and set the
195 function used for destroying an instance of an RSA object respectively.
196 This function will be called in response to the application calling
197 RSA_free(). A pointer to the RSA to be destroyed is passed as a
198 parameter. The destroy function should be used for RSA implementation
199 specific clean up. The memory for the RSA itself should not be freed
200 by this function. This function may be NULL.
202 RSA_meth_get_keygen() and RSA_meth_set_keygen() get and set the
203 function used for generating a new RSA key pair respectively. This
204 function will be called in response to the application calling
205 RSA_generate_key_ex(). The parameter for the function has the same
206 meaning as for RSA_generate_key_ex().
208 RSA_meth_get_multi_prime_keygen() and RSA_meth_set_multi_prime_keygen() get
209 and set the function used for generating a new multi-prime RSA key pair
210 respectively. This function will be called in response to the application calling
211 RSA_generate_multi_prime_key(). The parameter for the function has the same
212 meaning as for RSA_generate_multi_prime_key().
214 RSA_meth_get_pub_enc(), RSA_meth_set_pub_enc(),
215 RSA_meth_get_pub_dec(), RSA_meth_set_pub_dec(),
216 RSA_meth_get_priv_enc(), RSA_meth_set_priv_enc(),
217 RSA_meth_get_priv_dec(), RSA_meth_set_priv_dec() get and set the
218 functions used for public and private key encryption and decryption.
219 These functions will be called in response to the application calling
220 RSA_public_encrypt(), RSA_private_decrypt(), RSA_private_encrypt() and
221 RSA_public_decrypt() and take the same parameters as those.
226 RSA_meth_new() and RSA_meth_dup() return the newly allocated
227 RSA_METHOD object or NULL on failure.
229 RSA_meth_get0_name() and RSA_meth_get_flags() return the name and
230 flags associated with the RSA_METHOD respectively.
232 All other RSA_meth_get_*() functions return the appropriate function
233 pointer that has been set in the RSA_METHOD, or NULL if no such
234 pointer has yet been set.
236 RSA_meth_set1_name and all RSA_meth_set_*() functions return 1 on
237 success or 0 on failure.
241 L<RSA_new(3)>, L<RSA_generate_key_ex(3)>, L<RSA_sign(3)>,
242 L<RSA_set_method(3)>, L<RSA_size(3)>, L<RSA_get0_key(3)>,
243 L<RSA_generate_multi_prime_key(3)>
247 RSA_meth_get_multi_prime_keygen() and RSA_meth_set_multi_prime_keygen() were
248 added in OpenSSL 1.1.1.
250 Other functions described here were added in OpenSSL 1.1.0.
254 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
256 Licensed under the Apache License 2.0 (the "License"). You may not use
257 this file except in compliance with the License. You can obtain a copy
258 in the file LICENSE in the source distribution or at
259 L<https://www.openssl.org/source/license.html>.