Current Path :
/
opt
/
alt
/
openssl11
/
share
/
man
/
man3
/
Or
Select Your Path :
Upload File :
New :
File
Dir
//opt/alt/openssl11/share/man/man3/RSA_meth_set0_app_data.3ssl
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . 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\} .el\{\ . 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. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, 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'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . 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 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . 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 .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RSA_METH_NEW 3" .TH RSA_METH_NEW 3 "2023-09-11" "1.1.1w" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" RSA_meth_get0_app_data, RSA_meth_set0_app_data, RSA_meth_new, RSA_meth_free, RSA_meth_dup, RSA_meth_get0_name, RSA_meth_set1_name, RSA_meth_get_flags, RSA_meth_set_flags, RSA_meth_get_pub_enc, RSA_meth_set_pub_enc, RSA_meth_get_pub_dec, RSA_meth_set_pub_dec, RSA_meth_get_priv_enc, RSA_meth_set_priv_enc, RSA_meth_get_priv_dec, RSA_meth_set_priv_dec, RSA_meth_get_mod_exp, RSA_meth_set_mod_exp, RSA_meth_get_bn_mod_exp, RSA_meth_set_bn_mod_exp, RSA_meth_get_init, RSA_meth_set_init, RSA_meth_get_finish, RSA_meth_set_finish, RSA_meth_get_sign, RSA_meth_set_sign, RSA_meth_get_verify, RSA_meth_set_verify, RSA_meth_get_keygen, RSA_meth_set_keygen, RSA_meth_get_multi_prime_keygen, RSA_meth_set_multi_prime_keygen \&\- Routines to build up RSA methods .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/rsa.h> \& \& 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 .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fB\s-1RSA_METHOD\s0\fR 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. See the rsa page for more information. .PP \&\fIRSA_meth_new()\fR creates a new \fB\s-1RSA_METHOD\s0\fR structure. It should be given a unique \fBname\fR and a set of \fBflags\fR. The \fBname\fR should be a \&\s-1NULL\s0 terminated string, which will be duplicated and stored in the \&\fB\s-1RSA_METHOD\s0\fR object. It is the callers responsibility to free the original string. The flags will be used during the construction of a new \fB\s-1RSA\s0\fR object based on this \fB\s-1RSA_METHOD\s0\fR. Any new \fB\s-1RSA\s0\fR object will have those flags set by default. .PP \&\fIRSA_meth_dup()\fR creates a duplicate copy of the \fB\s-1RSA_METHOD\s0\fR object passed as a parameter. This might be useful for creating a new \&\fB\s-1RSA_METHOD\s0\fR based on an existing one, but with some differences. .PP \&\fIRSA_meth_free()\fR destroys an \fB\s-1RSA_METHOD\s0\fR structure and frees up any memory associated with it. .PP \&\fIRSA_meth_get0_name()\fR 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. \fIRSA_meth_set1_name()\fR sets the name of the \s-1RSA_METHOD\s0 to \fBname\fR. 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. .PP \&\fIRSA_meth_get_flags()\fR returns the current value of the flags associated with this \s-1RSA_METHOD.\s0 \fIRSA_meth_set_flags()\fR provides the ability to set these flags. .PP The functions \fIRSA_meth_get0_app_data()\fR and \fIRSA_meth_set0_app_data()\fR 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 \fIRSA_meth_free()\fR. .PP \&\fIRSA_meth_get_sign()\fR and \fIRSA_meth_set_sign()\fR 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 \fIRSA_sign()\fR. The parameters for the function have the same meaning as for \fIRSA_sign()\fR. .PP \&\fIRSA_meth_get_verify()\fR and \fIRSA_meth_set_verify()\fR 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 \&\fIRSA_verify()\fR. The parameters for the function have the same meaning as for \fIRSA_verify()\fR. .PP \&\fIRSA_meth_get_mod_exp()\fR and \fIRSA_meth_set_mod_exp()\fR get and set the function used for \s-1CRT\s0 computations. .PP \&\fIRSA_meth_get_bn_mod_exp()\fR and \fIRSA_meth_set_bn_mod_exp()\fR get and set the function used for \s-1CRT\s0 computations, specifically the following value: .PP .Vb 1 \& r = a ^ p mod m .Ve .PP Both the \fImod_exp()\fR and \fIbn_mod_exp()\fR functions are called by the default OpenSSL method during encryption, decryption, signing and verification. .PP \&\fIRSA_meth_get_init()\fR and \fIRSA_meth_set_init()\fR 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 \fIRSA_new()\fR (if the current default \s-1RSA_METHOD\s0 is this one) or \fIRSA_new_method()\fR. The \&\fIRSA_new()\fR and \fIRSA_new_method()\fR 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 .PP \&\fIRSA_meth_get_finish()\fR and \fIRSA_meth_set_finish()\fR 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 \&\fIRSA_free()\fR. 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 .PP \&\fIRSA_meth_get_keygen()\fR and \fIRSA_meth_set_keygen()\fR 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 \&\fIRSA_generate_key_ex()\fR. The parameter for the function has the same meaning as for \fIRSA_generate_key_ex()\fR. .PP \&\fIRSA_meth_get_multi_prime_keygen()\fR and \fIRSA_meth_set_multi_prime_keygen()\fR 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 \&\fIRSA_generate_multi_prime_key()\fR. The parameter for the function has the same meaning as for \fIRSA_generate_multi_prime_key()\fR. .PP \&\fIRSA_meth_get_pub_enc()\fR, \fIRSA_meth_set_pub_enc()\fR, \&\fIRSA_meth_get_pub_dec()\fR, \fIRSA_meth_set_pub_dec()\fR, \&\fIRSA_meth_get_priv_enc()\fR, \fIRSA_meth_set_priv_enc()\fR, \&\fIRSA_meth_get_priv_dec()\fR, \fIRSA_meth_set_priv_dec()\fR 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 \&\fIRSA_public_encrypt()\fR, \fIRSA_private_decrypt()\fR, \fIRSA_private_encrypt()\fR and \&\fIRSA_public_decrypt()\fR and take the same parameters as those. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fIRSA_meth_new()\fR and \fIRSA_meth_dup()\fR return the newly allocated \&\s-1RSA_METHOD\s0 object or \s-1NULL\s0 on failure. .PP \&\fIRSA_meth_get0_name()\fR and \fIRSA_meth_get_flags()\fR return the name and flags associated with the \s-1RSA_METHOD\s0 respectively. .PP 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. .PP RSA_meth_set1_name and all RSA_meth_set_*() functions return 1 on success or 0 on failure. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIRSA_new\fR\|(3), \fIRSA_generate_key_ex\fR\|(3), \fIRSA_sign\fR\|(3), \&\fIRSA_set_method\fR\|(3), \fIRSA_size\fR\|(3), \fIRSA_get0_key\fR\|(3), \&\fIRSA_generate_multi_prime_key\fR\|(3) .SH "HISTORY" .IX Header "HISTORY" \&\fIRSA_meth_get_multi_prime_keygen()\fR and \fIRSA_meth_set_multi_prime_keygen()\fR were added in OpenSSL 1.1.1. .PP Other functions described here were added in OpenSSL 1.1.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the OpenSSL license (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>.
