doc/crypto/RSA_get0_key.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_set0_key, RSA_set0_factors, RSA_set0_crt_params, RSA_get0_key,
   6 RSA_get0_factors, RSA_get0_crt_params, RSA_clear_flags,
   7 RSA_test_flags, RSA_set_flags, RSA_get0_engine - Routines for getting
   8 and setting data in an RSA object
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/rsa.h>
  13
  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, BIGNUM **n, BIGNUM **e, BIGNUM **d);
  18  void RSA_get0_factors(const RSA *r, BIGNUM **p, BIGNUM **q);
  19  void RSA_get0_crt_params(const RSA *r,
  20                           BIGNUM **dmp1, BIGNUM **dmq1, BIGNUM **iqmp);
  21  void RSA_clear_flags(RSA *r, int flags);
  22  int RSA_test_flags(const RSA *r, int flags);
  23  void RSA_set_flags(RSA *r, int flags);
  24  ENGINE *RSA_get0_engine(RSA *r);
  25
  26 =head1 DESCRIPTION
  27
  28 An RSA object contains the components for the public and private key,
  29 B<n>, B<e>, B<d>, B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp>.  B<n> is
  30 the modulus common to both public and private key, B<e> is the public
  31 exponent and B<d> is the private exponent.  B<p>, B<q>, B<dmp1>,
  32 B<dmq1> and B<iqmp> are the factors for the second representation of a
  33 private key (see PKCS#1 section 3 Key Types), where B<p> and B<q> are
  34 the first and second factor of B<n> and B<dmp1>, B<dmq1> and B<iqmp>
  35 are the exponents and coefficient for CRT calculations.
  36
  37 The B<n>, B<e> and B<d> parameters can be obtained by calling
  38 RSA_get0_key().  If they have not been set yet, then B<*n>, B<*e> and
  39 B<*d> will be set to NULL.  Otherwise, they are set to pointers to
  40 their respective values. These point directly to the internal
  41 representations of the values and therefore should not be freed
  42 by the caller.
  43
  44 The B<n>, B<e> and B<d> parameter values can be set by calling
  45 RSA_set0_key() and passing the new values for B<n>, B<e> and B<d> as
  46 parameters to the function.  The values B<n> and B<e> must be non-NULL
  47 the first time this function is called on a given RSA object. The
  48 value B<d> may be NULL. On subsequent calls any of these values may be
  49 NULL which means the corresponding RSA field is left untouched.
  50 Calling this function transfers the memory management of the values to
  51 the RSA object, and therefore the values that have been passed in
  52 should not be freed by the caller after this function has been called.
  53
  54 In a similar fashion, the B<p> and B<q> parameters can be obtained and
  55 set with RSA_get0_factors() and RSA_set0_factors(), and the B<dmp1>,
  56 B<dmq1> and B<iqmp> parameters can be obtained and set with
  57 RSA_get0_crt_params() and RSA_set0_crt_params().
  58
  59 RSA_set_flags() sets the flags in the B<flags> parameter on the RSA
  60 object. Multiple flags can be passed in one go (bitwise ORed together).
  61 Any flags that are already set are left set. RSA_test_flags() tests to
  62 see whether the flags passed in the B<flags> parameter are currently
  63 set in the RSA object. Multiple flags can be tested in one go. All
  64 flags that are currently set are returned, or zero if none of the
  65 flags are set. RSA_clear_flags() clears the specified flags within the
  66 RSA object.
  67
  68 RSA_get0_engine() returns a handle to the ENGINE that has been set for
  69 this RSA object, or NULL if no such ENGINE has been set.
  70
  71 =head1 NOTES
  72
  73 Values retrieved with RSA_get0_key() are owned by the RSA object used
  74 in the call and may therefore I<not> be passed to RSA_set0_key().  If
  75 needed, duplicate the received value using BN_dup() and pass the
  76 duplicate.  The same applies to RSA_get0_factors() and RSA_set0_factors()
  77 as well as RSA_get0_crt_params() and RSA_set0_crt_params().
  78
  79 =head1 RETURN VALUES
  80
  81 RSA_set0_key(), RSA_set0_factors and RSA_set0_crt_params() return 1 on
  82 success or 0 on failure.
  83
  84 RSA_test_flags() returns the current state of the flags in the RSA object.
  85
  86 RSA_get0_engine() returns the ENGINE set for the RSA object or NULL if no
  87 ENGINE has been set.
  88
  89 =head1 SEE ALSO
  90
  91 L<rsa(3)>, L<RSA_new(3)>, L<RSA_size(3)>
  92
  93 =head1 HISTORY
  94
  95 The functions described here were added in OpenSSL version 1.1.0.
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 100
 101 Licensed under the OpenSSL license (the "License").  You may not use
 102 this file except in compliance with the License.  You can obtain a copy
 103 in the file LICENSE in the source distribution or at
 104 L<https://www.openssl.org/source/license.html>.
 105
 106 =cut