mirror of
https://github.com/openssl/openssl.git
synced 2024-11-21 01:15:20 +08:00
Doc for the added internal RSA functions
It was forgotten in the previous commit. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10206)
This commit is contained in:
parent
f545346211
commit
5bd7865da0
75
doc/internal/man3/rsa_get0_all_params.pod
Normal file
75
doc/internal/man3/rsa_get0_all_params.pod
Normal file
@ -0,0 +1,75 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
rsa_set0_all_params, rsa_get0_all_params
|
||||
- Internal routines for getting and setting data in an RSA object
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
#include "crypto/rsa.h"
|
||||
|
||||
int rsa_get0_all_params(RSA *r, STACK_OF(BIGNUM_const) *primes,
|
||||
STACK_OF(BIGNUM_const) *exps,
|
||||
STACK_OF(BIGNUM_const) *coeffs);
|
||||
int rsa_set0_all_params(RSA *r, const STACK_OF(BIGNUM) *primes,
|
||||
const STACK_OF(BIGNUM) *exps,
|
||||
const STACK_OF(BIGNUM) *coeffs);
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
rsa_set0_all_params() sets all primes, CRT exponents and CRT coefficients
|
||||
in the B<RSA> object I<r> to the contents of the stacks of BIGNUMs I<primes>,
|
||||
I<exps> and I<coeffs>. The B<RSA> object takes ownership of the BIGNUMs,
|
||||
but not of the stacks.
|
||||
|
||||
rsa_get0_all_params() gets all primes, CRT exponents and CRT coefficients
|
||||
in the B<RSA> object I<r> and pushes them on the stacks of constant BIGNUMs
|
||||
I<primes>, I<exps> and I<coeffs>. The B<RSA> object retains ownership of the
|
||||
BIGNUMs, but not of the stacks.
|
||||
|
||||
=head1 NOTES
|
||||
|
||||
For RSA_set0_all_params() and RSA_get0_all_params():
|
||||
|
||||
=over 4
|
||||
|
||||
=item *
|
||||
|
||||
the I<primes> stack contains I<p>, I<q>, and then the rest of the primes
|
||||
if the B<RSA> object is a multi-prime RSA key.
|
||||
|
||||
=item *
|
||||
|
||||
the I<exps> stack contains I<dP>, I<dQ>, and then the rest of the exponents
|
||||
if the B<RSA> object is a multi-prime RSA key.
|
||||
|
||||
=item *
|
||||
|
||||
the I<coeffs> stack contains I<qInv>, and then the rest of the coefficients
|
||||
if the B<RSA> object is a multi-prime RSA key.
|
||||
|
||||
=back
|
||||
|
||||
The number of primes must always be equal to the number of exponents, and
|
||||
the number of coefficients must be one less than the number of primes.
|
||||
|
||||
=head1 RETURN VALUES
|
||||
|
||||
rsa_get0_all_params() and rsa_set0_all_params() return 1 on success, or
|
||||
0 on failure.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<RSA_set0_multi_prime_params(3)>
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License 2.0 (the "License"). You may not use
|
||||
this file except in compliance with the License. You can obtain a copy
|
||||
in the file LICENSE in the source distribution or at
|
||||
L<https://www.openssl.org/source/license.html>.
|
||||
|
||||
=cut
|
Loading…
Reference in New Issue
Block a user