RSA_get0_key.pod 8.0 KB

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