Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "RSA_METH_NEW 3ossl"
way too many mistakes in technical documents.
The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):
.Vb 2 RSA_METHOD *RSA_meth_new(const char *name, int flags); void RSA_meth_free(RSA_METHOD *meth); \& RSA_METHOD *RSA_meth_dup(const RSA_METHOD *meth); \& const char *RSA_meth_get0_name(const RSA_METHOD *meth); int RSA_meth_set1_name(RSA_METHOD *meth, const char *name); \& int RSA_meth_get_flags(const RSA_METHOD *meth); int RSA_meth_set_flags(RSA_METHOD *meth, int flags); \& void *RSA_meth_get0_app_data(const RSA_METHOD *meth); int RSA_meth_set0_app_data(RSA_METHOD *meth, void *app_data); \& int (*RSA_meth_get_pub_enc(const RSA_METHOD *meth))(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); int RSA_meth_set_pub_enc(RSA_METHOD *rsa, int (*pub_enc)(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding)); \& int (*RSA_meth_get_pub_dec(const RSA_METHOD *meth)) (int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); int RSA_meth_set_pub_dec(RSA_METHOD *rsa, int (*pub_dec)(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding)); \& int (*RSA_meth_get_priv_enc(const RSA_METHOD *meth))(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); int RSA_meth_set_priv_enc(RSA_METHOD *rsa, int (*priv_enc)(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding)); \& int (*RSA_meth_get_priv_dec(const RSA_METHOD *meth))(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); int RSA_meth_set_priv_dec(RSA_METHOD *rsa, int (*priv_dec)(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding)); \& /* Can be null */ int (*RSA_meth_get_mod_exp(const RSA_METHOD *meth))(BIGNUM *r0, const BIGNUM *i, RSA *rsa, BN_CTX *ctx); int RSA_meth_set_mod_exp(RSA_METHOD *rsa, int (*mod_exp)(BIGNUM *r0, const BIGNUM *i, RSA *rsa, BN_CTX *ctx)); \& /* Can be null */ int (*RSA_meth_get_bn_mod_exp(const RSA_METHOD *meth))(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); int RSA_meth_set_bn_mod_exp(RSA_METHOD *rsa, int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)); \& /* called at new */ int (*RSA_meth_get_init(const RSA_METHOD *meth) (RSA *rsa); int RSA_meth_set_init(RSA_METHOD *rsa, int (*init (RSA *rsa)); \& /* called at free */ int (*RSA_meth_get_finish(const RSA_METHOD *meth))(RSA *rsa); int RSA_meth_set_finish(RSA_METHOD *rsa, int (*finish)(RSA *rsa)); \& int (*RSA_meth_get_sign(const RSA_METHOD *meth))(int type, const unsigned char *m, unsigned int m_length, unsigned char *sigret, unsigned int *siglen, const RSA *rsa); int RSA_meth_set_sign(RSA_METHOD *rsa, int (*sign)(int type, const unsigned char *m, unsigned int m_length, unsigned char *sigret, unsigned int *siglen, const RSA *rsa)); \& int (*RSA_meth_get_verify(const RSA_METHOD *meth))(int dtype, const unsigned char *m, unsigned int m_length, const unsigned char *sigbuf, unsigned int siglen, const RSA *rsa); int RSA_meth_set_verify(RSA_METHOD *rsa, int (*verify)(int dtype, const unsigned char *m, unsigned int m_length, const unsigned char *sigbuf, unsigned int siglen, const RSA *rsa)); \& int (*RSA_meth_get_keygen(const RSA_METHOD *meth))(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb); int RSA_meth_set_keygen(RSA_METHOD *rsa, int (*keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb)); \& int (*RSA_meth_get_multi_prime_keygen(const RSA_METHOD *meth))(RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb); \& int RSA_meth_set_multi_prime_keygen(RSA_METHOD *meth, int (*keygen) (RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb)); .Ve
The \s-1RSA_METHOD\s0 type is a structure used for the provision of custom \s-1RSA\s0 implementations. It provides a set of functions used by OpenSSL for the implementation of the various \s-1RSA\s0 capabilities.
\fBRSA_meth_new() creates a new \s-1RSA_METHOD\s0 structure. It should be given a unique name and a set of flags. The name should be a \s-1NULL\s0 terminated string, which will be duplicated and stored in the \fB\s-1RSA_METHOD\s0 object. It is the callers responsibility to free the original string. The flags will be used during the construction of a new \s-1RSA\s0 object based on this \s-1RSA_METHOD\s0. Any new \s-1RSA\s0 object will have those flags set by default.
\fBRSA_meth_dup() creates a duplicate copy of the \s-1RSA_METHOD\s0 object passed as a parameter. This might be useful for creating a new \fB\s-1RSA_METHOD\s0 based on an existing one, but with some differences.
\fBRSA_meth_free() destroys an \s-1RSA_METHOD\s0 structure and frees up any memory associated with it.
\fBRSA_meth_get0_name() will return a pointer to the name of this \s-1RSA_METHOD.\s0 This is a pointer to the internal name string and so should not be freed by the caller. RSA_meth_set1_name() sets the name of the \s-1RSA_METHOD\s0 to name. The string is duplicated and the copy is stored in the \s-1RSA_METHOD\s0 structure, so the caller remains responsible for freeing the memory associated with the name.
\fBRSA_meth_get_flags() returns the current value of the flags associated with this \s-1RSA_METHOD.\s0 RSA_meth_set_flags() provides the ability to set these flags.
The functions RSA_meth_get0_app_data() and RSA_meth_set0_app_data() provide the ability to associate implementation specific data with the \s-1RSA_METHOD.\s0 It is the application's responsibility to free this data before the \s-1RSA_METHOD\s0 is freed via a call to RSA_meth_free().
\fBRSA_meth_get_sign() and RSA_meth_set_sign() get and set the function used for creating an \s-1RSA\s0 signature respectively. This function will be called in response to the application calling RSA_sign(). The parameters for the function have the same meaning as for RSA_sign().
\fBRSA_meth_get_verify() and RSA_meth_set_verify() get and set the function used for verifying an \s-1RSA\s0 signature respectively. This function will be called in response to the application calling \fBRSA_verify(). The parameters for the function have the same meaning as for RSA_verify().
\fBRSA_meth_get_mod_exp() and RSA_meth_set_mod_exp() get and set the function used for \s-1CRT\s0 computations.
\fBRSA_meth_get_bn_mod_exp() and RSA_meth_set_bn_mod_exp() get and set the function used for \s-1CRT\s0 computations, specifically the following value:
.Vb 1 r = a ^ p mod m .Ve
Both the mod_exp() and bn_mod_exp() functions are called by the default OpenSSL method during encryption, decryption, signing and verification.
\fBRSA_meth_get_init() and RSA_meth_set_init() get and set the function used for creating a new \s-1RSA\s0 instance respectively. This function will be called in response to the application calling RSA_new() (if the current default \s-1RSA_METHOD\s0 is this one) or RSA_new_method(). The \fBRSA_new() and RSA_new_method() functions will allocate the memory for the new \s-1RSA\s0 object, and a pointer to this newly allocated structure will be passed as a parameter to the function. This function may be \s-1NULL.\s0
\fBRSA_meth_get_finish() and RSA_meth_set_finish() get and set the function used for destroying an instance of an \s-1RSA\s0 object respectively. This function will be called in response to the application calling \fBRSA_free(). A pointer to the \s-1RSA\s0 to be destroyed is passed as a parameter. The destroy function should be used for \s-1RSA\s0 implementation specific clean up. The memory for the \s-1RSA\s0 itself should not be freed by this function. This function may be \s-1NULL.\s0
\fBRSA_meth_get_keygen() and RSA_meth_set_keygen() get and set the function used for generating a new \s-1RSA\s0 key pair respectively. This function will be called in response to the application calling \fBRSA_generate_key_ex(). The parameter for the function has the same meaning as for RSA_generate_key_ex().
\fBRSA_meth_get_multi_prime_keygen() and RSA_meth_set_multi_prime_keygen() get and set the function used for generating a new multi-prime \s-1RSA\s0 key pair respectively. This function will be called in response to the application calling \fBRSA_generate_multi_prime_key(). The parameter for the function has the same meaning as for RSA_generate_multi_prime_key().
\fBRSA_meth_get_pub_enc(), RSA_meth_set_pub_enc(), \fBRSA_meth_get_pub_dec(), RSA_meth_set_pub_dec(), \fBRSA_meth_get_priv_enc(), RSA_meth_set_priv_enc(), \fBRSA_meth_get_priv_dec(), RSA_meth_set_priv_dec() get and set the functions used for public and private key encryption and decryption. These functions will be called in response to the application calling \fBRSA_public_encrypt(), RSA_private_decrypt(), RSA_private_encrypt() and \fBRSA_public_decrypt() and take the same parameters as those.
\fBRSA_meth_get0_name() and RSA_meth_get_flags() return the name and flags associated with the \s-1RSA_METHOD\s0 respectively.
All other RSA_meth_get_*() functions return the appropriate function pointer that has been set in the \s-1RSA_METHOD,\s0 or \s-1NULL\s0 if no such pointer has yet been set.
RSA_meth_set1_name and all RSA_meth_set_*() functions return 1 on success or 0 on failure.
\fBRSA_meth_get_multi_prime_keygen() and RSA_meth_set_multi_prime_keygen() were added in OpenSSL 1.1.1.
Other functions described here were added in OpenSSL 1.1.0.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.