1=pod 2 3=head1 NAME 4 5RSA_set0_key, RSA_set0_factors, RSA_set0_crt_params, RSA_get0_key, 6RSA_get0_factors, RSA_get0_crt_params, 7RSA_get0_n, RSA_get0_e, RSA_get0_d, RSA_get0_p, RSA_get0_q, 8RSA_get0_dmp1, RSA_get0_dmq1, RSA_get0_iqmp, 9RSA_clear_flags, 10RSA_test_flags, RSA_set_flags, RSA_get0_engine, RSA_get_multi_prime_extra_count, 11RSA_get0_multi_prime_factors, RSA_get0_multi_prime_crt_params, 12RSA_set0_multi_prime_params, RSA_get_version 13- Routines for getting and setting data in an RSA object 14 15=head1 SYNOPSIS 16 17 #include <openssl/rsa.h> 18 19 int RSA_set0_key(RSA *r, BIGNUM *n, BIGNUM *e, BIGNUM *d); 20 int RSA_set0_factors(RSA *r, BIGNUM *p, BIGNUM *q); 21 int RSA_set0_crt_params(RSA *r, BIGNUM *dmp1, BIGNUM *dmq1, BIGNUM *iqmp); 22 void RSA_get0_key(const RSA *r, 23 const BIGNUM **n, const BIGNUM **e, const BIGNUM **d); 24 void RSA_get0_factors(const RSA *r, const BIGNUM **p, const BIGNUM **q); 25 void RSA_get0_crt_params(const RSA *r, 26 const BIGNUM **dmp1, const BIGNUM **dmq1, 27 const BIGNUM **iqmp); 28 const BIGNUM *RSA_get0_n(const RSA *d); 29 const BIGNUM *RSA_get0_e(const RSA *d); 30 const BIGNUM *RSA_get0_d(const RSA *d); 31 const BIGNUM *RSA_get0_p(const RSA *d); 32 const BIGNUM *RSA_get0_q(const RSA *d); 33 const BIGNUM *RSA_get0_dmp1(const RSA *r); 34 const BIGNUM *RSA_get0_dmq1(const RSA *r); 35 const BIGNUM *RSA_get0_iqmp(const RSA *r); 36 void RSA_clear_flags(RSA *r, int flags); 37 int RSA_test_flags(const RSA *r, int flags); 38 void RSA_set_flags(RSA *r, int flags); 39 ENGINE *RSA_get0_engine(RSA *r); 40 int RSA_get_multi_prime_extra_count(const RSA *r); 41 int RSA_get0_multi_prime_factors(const RSA *r, const BIGNUM *primes[]); 42 int RSA_get0_multi_prime_crt_params(const RSA *r, const BIGNUM *exps[], 43 const BIGNUM *coeffs[]); 44 int RSA_set0_multi_prime_params(RSA *r, BIGNUM *primes[], BIGNUM *exps[], 45 BIGNUM *coeffs[], int pnum); 46 int RSA_get_version(RSA *r); 47 48=head1 DESCRIPTION 49 50An RSA object contains the components for the public and private key, 51B<n>, B<e>, B<d>, B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp>. B<n> is 52the modulus common to both public and private key, B<e> is the public 53exponent and B<d> is the private exponent. B<p>, B<q>, B<dmp1>, 54B<dmq1> and B<iqmp> are the factors for the second representation of a 55private key (see PKCS#1 section 3 Key Types), where B<p> and B<q> are 56the first and second factor of B<n> and B<dmp1>, B<dmq1> and B<iqmp> 57are the exponents and coefficient for CRT calculations. 58 59For multi-prime RSA (defined in RFC 8017), there are also one or more 60'triplet' in an RSA object. A triplet contains three members, B<r>, B<d> 61and B<t>. B<r> is the additional prime besides B<p> and B<q>. B<d> and 62B<t> are the exponent and coefficient for CRT calculations. 63 64The B<n>, B<e> and B<d> parameters can be obtained by calling 65RSA_get0_key(). If they have not been set yet, then B<*n>, B<*e> and 66B<*d> will be set to NULL. Otherwise, they are set to pointers to 67their respective values. These point directly to the internal 68representations of the values and therefore should not be freed 69by the caller. 70 71The B<n>, B<e> and B<d> parameter values can be set by calling 72RSA_set0_key() and passing the new values for B<n>, B<e> and B<d> as 73parameters to the function. The values B<n> and B<e> must be non-NULL 74the first time this function is called on a given RSA object. The 75value B<d> may be NULL. On subsequent calls any of these values may be 76NULL which means the corresponding RSA field is left untouched. 77Calling this function transfers the memory management of the values to 78the RSA object, and therefore the values that have been passed in 79should not be freed by the caller after this function has been called. 80 81In a similar fashion, the B<p> and B<q> parameters can be obtained and 82set with RSA_get0_factors() and RSA_set0_factors(), and the B<dmp1>, 83B<dmq1> and B<iqmp> parameters can be obtained and set with 84RSA_get0_crt_params() and RSA_set0_crt_params(). 85 86For RSA_get0_key(), RSA_get0_factors(), and RSA_get0_crt_params(), 87NULL value BIGNUM ** output parameters are permitted. The functions 88ignore NULL parameters but return values for other, non-NULL, parameters. 89 90For multi-prime RSA, RSA_get0_multi_prime_factors() and RSA_get0_multi_prime_params() 91can be used to obtain other primes and related CRT parameters. The 92return values are stored in an array of B<BIGNUM *>. RSA_set0_multi_prime_params() 93sets a collect of multi-prime 'triplet' members (prime, exponent and coefficient) 94into an RSA object. 95 96Any of the values B<n>, B<e>, B<d>, B<p>, B<q>, B<dmp1>, B<dmq1>, and B<iqmp> can also be 97retrieved separately by the corresponding function 98RSA_get0_n(), RSA_get0_e(), RSA_get0_d(), RSA_get0_p(), RSA_get0_q(), 99RSA_get0_dmp1(), RSA_get0_dmq1(), and RSA_get0_iqmp(), respectively. 100 101RSA_set_flags() sets the flags in the B<flags> parameter on the RSA 102object. Multiple flags can be passed in one go (bitwise ORed together). 103Any flags that are already set are left set. RSA_test_flags() tests to 104see whether the flags passed in the B<flags> parameter are currently 105set in the RSA object. Multiple flags can be tested in one go. All 106flags that are currently set are returned, or zero if none of the 107flags are set. RSA_clear_flags() clears the specified flags within the 108RSA object. 109 110RSA_get0_engine() returns a handle to the ENGINE that has been set for 111this RSA object, or NULL if no such ENGINE has been set. 112 113RSA_get_version() returns the version of an RSA object B<r>. 114 115=head1 NOTES 116 117Values retrieved with RSA_get0_key() are owned by the RSA object used 118in the call and may therefore I<not> be passed to RSA_set0_key(). If 119needed, duplicate the received value using BN_dup() and pass the 120duplicate. The same applies to RSA_get0_factors() and RSA_set0_factors() 121as well as RSA_get0_crt_params() and RSA_set0_crt_params(). 122 123The caller should obtain the size by calling RSA_get_multi_prime_extra_count() 124in advance and allocate sufficient buffer to store the return values before 125calling RSA_get0_multi_prime_factors() and RSA_get0_multi_prime_params(). 126 127RSA_set0_multi_prime_params() always clears the original multi-prime 128triplets in RSA object B<r> and assign the new set of triplets into it. 129 130=head1 RETURN VALUES 131 132RSA_set0_key(), RSA_set0_factors(), RSA_set0_crt_params() and 133RSA_set0_multi_prime_params() return 1 on success or 0 on failure. 134 135RSA_get0_n(), RSA_get0_e(), RSA_get0_d(), RSA_get0_p(), RSA_get0_q(), 136RSA_get0_dmp1(), RSA_get0_dmq1(), and RSA_get0_iqmp() 137return the respective value. 138 139RSA_get0_multi_prime_factors() and RSA_get0_multi_prime_crt_params() return 1401 on success or 0 on failure. 141 142RSA_get_multi_prime_extra_count() returns two less than the number of primes 143in use, which is 0 for traditional RSA and the number of extra primes for 144multi-prime RSA. 145 146RSA_get_version() returns B<RSA_ASN1_VERSION_MULTI> for multi-prime RSA and 147B<RSA_ASN1_VERSION_DEFAULT> for normal two-prime RSA, as defined in RFC 8017. 148 149RSA_test_flags() returns the current state of the flags in the RSA object. 150 151RSA_get0_engine() returns the ENGINE set for the RSA object or NULL if no 152ENGINE has been set. 153 154=head1 SEE ALSO 155 156L<RSA_new(3)>, L<RSA_size(3)> 157 158=head1 HISTORY 159 160The 161RSA_get_multi_prime_extra_count(), RSA_get0_multi_prime_factors(), 162RSA_get0_multi_prime_crt_params(), RSA_set0_multi_prime_params(), 163and RSA_get_version() functions were added in OpenSSL 1.1.1. 164 165Other functions described here were added in OpenSSL 1.1.0. 166 167=head1 COPYRIGHT 168 169Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. 170 171Licensed under the OpenSSL license (the "License"). You may not use 172this file except in compliance with the License. You can obtain a copy 173in the file LICENSE in the source distribution or at 174L<https://www.openssl.org/source/license.html>. 175 176=cut 177