2c63e52b38d3601e9899410ca42c6c357dab4c8c
[openssl.git] / doc / man3 / DH_get0_pqg.pod
1 =pod
2
3 =head1 NAME
4
5 DH_get0_pqg, DH_set0_pqg, DH_get0_key, DH_set0_key,
6 DH_get0_p, DH_get0_q, DH_get0_g,
7 DH_get0_priv_key, DH_get0_pub_key,
8 DH_clear_flags, DH_test_flags, DH_set_flags, DH_get0_engine,
9 DH_get_length, DH_set_length - Routines for getting and setting data in a DH object
10
11 =head1 SYNOPSIS
12
13  #include <openssl/dh.h>
14
15  void DH_get0_pqg(const DH *dh,
16                   const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
17  int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
18  void DH_get0_key(const DH *dh,
19                   const BIGNUM **pub_key, const BIGNUM **priv_key);
20  int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
21  const BIGNUM *DH_get0_p(const DH *dh);
22  const BIGNUM *DH_get0_q(const DH *dh);
23  const BIGNUM *DH_get0_g(const DH *dh);
24  const BIGNUM *DH_get0_priv_key(const DH *dh);
25  const BIGNUM *DH_get0_pub_key(const DH *dh);
26  void DH_clear_flags(DH *dh, int flags);
27  int DH_test_flags(const DH *dh, int flags);
28  void DH_set_flags(DH *dh, int flags);
29
30  long DH_get_length(const DH *dh);
31  int DH_set_length(DH *dh, long length);
32
33 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
34 B<OPENSSL_API_COMPAT> with a suitable version value, see
35 L<openssl_user_macros(7)>:
36
37  ENGINE *DH_get0_engine(DH *d);
38
39 =head1 DESCRIPTION
40
41 A DH object contains the parameters I<p>, I<q> and I<g>. Note that the I<q>
42 parameter is optional. It also contains a public key (I<pub_key>) and
43 (optionally) a private key (I<priv_key>).
44
45 The I<p>, I<q> and I<g> parameters can be obtained by calling DH_get0_pqg().
46 If the parameters have not yet been set then I<*p>, I<*q> and I<*g> will be set
47 to NULL. Otherwise they are set to pointers to their respective values. These
48 point directly to the internal representations of the values and therefore
49 should not be freed directly.
50 Any of the out parameters I<p>, I<q>, and I<g> can be NULL, in which case no
51 value will be returned for that parameter.
52
53 The I<p>, I<q> and I<g> values can be set by calling DH_set0_pqg() and passing
54 the new values for I<p>, I<q> and I<g> as parameters to the function. Calling
55 this function transfers the memory management of the values to the DH object,
56 and therefore the values that have been passed in should not be freed directly
57 after this function has been called. The I<q> parameter may be NULL.
58 DH_set0_pqg() also checks if the parameters associated with I<p> and I<g> and
59 optionally I<q> are associated with known safe prime groups. If it is a safe
60 prime group then the value of I<q> will be set to q = (p - 1) / 2 if I<q> is NULL.
61 For safe prime groups the optional length parameter I<length> is set to twice
62 the value of the maximum_target_security_strength(BN_num_bits(I<p>)) as listed in
63 SP800-56Ar3 Table(s) 25 & 26. If it is not a safe prime group then the optional
64 length parameter will be set if I<q> is not NULL to BN_num_bits(I<q>).
65
66 To get the public and private key values use the DH_get0_key() function. A
67 pointer to the public key will be stored in I<*pub_key>, and a pointer to the
68 private key will be stored in I<*priv_key>. Either may be NULL if they have not
69 been set yet, although if the private key has been set then the public key must
70 be. The values point to the internal representation of the public key and
71 private key values. This memory should not be freed directly.
72 Any of the out parameters I<pub_key> and I<priv_key> can be NULL, in which case
73 no value will be returned for that parameter.
74
75 The public and private key values can be set using DH_set0_key(). Either
76 parameter may be NULL, which means the corresponding DH field is left
77 untouched. As with DH_set0_pqg() this function transfers the memory management
78 of the key values to the DH object, and therefore they should not be freed
79 directly after this function has been called.
80
81 Any of the values I<p>, I<q>, I<g>, I<priv_key>, and I<pub_key> can also be
82 retrieved separately by the corresponding function DH_get0_p(), DH_get0_q(),
83 DH_get0_g(), DH_get0_priv_key(), and DH_get0_pub_key(), respectively.
84
85 DH_set_flags() sets the flags in the I<flags> parameter on the DH object.
86 Multiple flags can be passed in one go (bitwise ORed together). Any flags that
87 are already set are left set. DH_test_flags() tests to see whether the flags
88 passed in the I<flags> parameter are currently set in the DH object. Multiple
89 flags can be tested in one go. All flags that are currently set are returned, or
90 zero if none of the flags are set. DH_clear_flags() clears the specified flags
91 within the DH object.
92
93 DH_get0_engine() returns a handle to the ENGINE that has been set for this DH
94 object, or NULL if no such ENGINE has been set. This function is deprecated.
95
96 The DH_get_length() and DH_set_length() functions get and set the optional
97 length parameter associated with this DH object. If the length is nonzero then
98 it is used, otherwise it is ignored. The I<length> parameter indicates the
99 length of the secret exponent (private key) in bits.
100
101 =head1 NOTES
102
103 Values retrieved with DH_get0_key() are owned by the DH object used
104 in the call and may therefore I<not> be passed to DH_set0_key().  If
105 needed, duplicate the received value using BN_dup() and pass the
106 duplicate.  The same applies to DH_get0_pqg() and DH_set0_pqg().
107
108 =head1 RETURN VALUES
109
110 DH_set0_pqg() and DH_set0_key() return 1 on success or 0 on failure.
111
112 DH_get0_p(), DH_get0_q(), DH_get0_g(), DH_get0_priv_key(), and DH_get0_pub_key()
113 return the respective value, or NULL if it is unset.
114
115 DH_test_flags() returns the current state of the flags in the DH object.
116
117 DH_get0_engine() returns the ENGINE set for the DH object or NULL if no ENGINE
118 has been set.
119
120 DH_get_length() returns the length of the secret exponent (private key) in bits,
121 or zero if no such length has been explicitly set.
122
123 =head1 SEE ALSO
124
125 L<DH_new(3)>, L<DH_new(3)>, L<DH_generate_parameters(3)>, L<DH_generate_key(3)>,
126 L<DH_set_method(3)>, L<DH_size(3)>, L<DH_meth_new(3)>
127
128 =head1 HISTORY
129
130 The DH_get0_engine() function was deprecated in OpenSSL 3.0.
131
132 The functions described here were added in OpenSSL 1.1.0.
133
134 =head1 COPYRIGHT
135
136 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
137
138 Licensed under the Apache License 2.0 (the "License").  You may not use
139 this file except in compliance with the License.  You can obtain a copy
140 in the file LICENSE in the source distribution or at
141 L<https://www.openssl.org/source/license.html>.
142
143 =cut