diff options
Diffstat (limited to 'secure/lib/libcrypto/man/RSA_meth_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/RSA_meth_new.3 | 106 |
1 files changed, 55 insertions, 51 deletions
diff --git a/secure/lib/libcrypto/man/RSA_meth_new.3 b/secure/lib/libcrypto/man/RSA_meth_new.3 index 3445b19e49113..35f73e6ab4ae5 100644 --- a/secure/lib/libcrypto/man/RSA_meth_new.3 +++ b/secure/lib/libcrypto/man/RSA_meth_new.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.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 +. 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. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RSA_METH_NEW 3" -.TH RSA_METH_NEW 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH RSA_METH_NEW 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -249,7 +253,7 @@ The \fB\s-1RSA_METHOD\s0\fR type is a structure used for the provision of custom 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 +\&\fBRSA_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 @@ -257,44 +261,44 @@ 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 +\&\fBRSA_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 +\&\fBRSA_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 +\&\fBRSA_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 +should not be freed by the caller. \fBRSA_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 +\&\fBRSA_meth_get_flags()\fR returns the current value of the flags associated +with this \s-1RSA_METHOD.\s0 \fBRSA_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 +The functions \fBRSA_meth_get0_app_data()\fR and \fBRSA_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. +before the \s-1RSA_METHOD\s0 is freed via a call to \fBRSA_meth_free()\fR. .PP -\&\fIRSA_meth_get_sign()\fR and \fIRSA_meth_set_sign()\fR get and set the function +\&\fBRSA_meth_get_sign()\fR and \fBRSA_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. +called in response to the application calling \fBRSA_sign()\fR. The +parameters for the function have the same meaning as for \fBRSA_sign()\fR. .PP -\&\fIRSA_meth_get_verify()\fR and \fIRSA_meth_set_verify()\fR get and set the +\&\fBRSA_meth_get_verify()\fR and \fBRSA_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. +\&\fBRSA_verify()\fR. The parameters for the function have the same meaning as +for \fBRSA_verify()\fR. .PP -\&\fIRSA_meth_get_mod_exp()\fR and \fIRSA_meth_set_mod_exp()\fR get and set the +\&\fBRSA_meth_get_mod_exp()\fR and \fBRSA_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 +\&\fBRSA_meth_get_bn_mod_exp()\fR and \fBRSA_meth_set_bn_mod_exp()\fR get and set the function used for \s-1CRT\s0 computations, specifically the following value: .PP @@ -302,53 +306,53 @@ value: \& r = a ^ p mod m .Ve .PP -Both the \fImod_exp()\fR and \fIbn_mod_exp()\fR functions are called by the +Both the \fBmod_exp()\fR and \fBbn_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 +\&\fBRSA_meth_get_init()\fR and \fBRSA_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 +be called in response to the application calling \fBRSA_new()\fR (if the +current default \s-1RSA_METHOD\s0 is this one) or \fBRSA_new_method()\fR. The +\&\fBRSA_new()\fR and \fBRSA_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 +\&\fBRSA_meth_get_finish()\fR and \fBRSA_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 +\&\fBRSA_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 +\&\fBRSA_meth_get_keygen()\fR and \fBRSA_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. +\&\fBRSA_generate_key_ex()\fR. The parameter for the function has the same +meaning as for \fBRSA_generate_key_ex()\fR. .PP -\&\fIRSA_meth_get_multi_prime_keygen()\fR and \fIRSA_meth_set_multi_prime_keygen()\fR get +\&\fBRSA_meth_get_multi_prime_keygen()\fR and \fBRSA_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. +\&\fBRSA_generate_multi_prime_key()\fR. The parameter for the function has the same +meaning as for \fBRSA_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 +\&\fBRSA_meth_get_pub_enc()\fR, \fBRSA_meth_set_pub_enc()\fR, +\&\fBRSA_meth_get_pub_dec()\fR, \fBRSA_meth_set_pub_dec()\fR, +\&\fBRSA_meth_get_priv_enc()\fR, \fBRSA_meth_set_priv_enc()\fR, +\&\fBRSA_meth_get_priv_dec()\fR, \fBRSA_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. +\&\fBRSA_public_encrypt()\fR, \fBRSA_private_decrypt()\fR, \fBRSA_private_encrypt()\fR and +\&\fBRSA_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 +\&\fBRSA_meth_new()\fR and \fBRSA_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 +\&\fBRSA_meth_get0_name()\fR and \fBRSA_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 @@ -359,12 +363,12 @@ 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) +\&\fBRSA_new\fR\|(3), \fBRSA_generate_key_ex\fR\|(3), \fBRSA_sign\fR\|(3), +\&\fBRSA_set_method\fR\|(3), \fBRSA_size\fR\|(3), \fBRSA_get0_key\fR\|(3), +\&\fBRSA_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 +\&\fBRSA_meth_get_multi_prime_keygen()\fR and \fBRSA_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. |