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