Documentation the changed {RSA,DSA,DH}_set0_* functionality change
[openssl.git] / doc / crypto / DH_get0_pqg.pod
1 =pod
2
3 =head1 NAME
4
5 DH_get0_pqg, DH_set0_pqg, DH_get0_key, DH_set0_key, DH_clear_flags,
6 DH_test_flags, DH_set_flags, DH_get0_engine, DH_get_length,
7 DH_set_length - Routines for getting and setting data in a DH object
8
9 =head1 SYNOPSIS
10
11  #include <openssl/dh.h>
12
13  void DH_get0_pqg(const DH *dh, BIGNUM **p, BIGNUM **q, BIGNUM **g);
14  int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
15  void DH_get0_key(const DH *dh, BIGNUM **pub_key, BIGNUM **priv_key);
16  int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
17  void DH_clear_flags(DH *dh, int flags);
18  int DH_test_flags(const DH *dh, int flags);
19  void DH_set_flags(DH *dh, int flags);
20  ENGINE *DH_get0_engine(DH *d);
21  long DH_get_length(const DH *dh);
22  int DH_set_length(DH *dh, long length);
23
24 =head1 DESCRIPTION
25
26 A DH object contains the parameters B<p>, B<q> and B<g>. Note that the B<q>
27 parameter is optional. It also contains a public key (B<pub_key>) and
28 (optionally) a private key (B<priv_key>).
29
30 The B<p>, B<q> and B<g> parameters can be obtained by calling DH_get0_pqg().
31 If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set
32 to NULL. Otherwise they are set to pointers to their respective values. These
33 point directly to the internal representations of the values and therefore
34 should not be freed directly.
35
36 The B<p>, B<q> and B<g> values can be set by calling DH_set0_pqg() and passing
37 the new values for B<p>, B<q> and B<g> as parameters to the function. Calling
38 this function transfers the memory management of the values to the DH object,
39 and therefore the values that have been passed in should not be freed directly
40 after this function has been called. The B<q> parameter may be NULL.
41
42 To get the public and private key values use the DH_get0_key() function. A
43 pointer to the public key will be stored in B<*pub_key>, and a pointer to the
44 private key will be stored in B<*priv_key>. Either may be NULL if they have not
45 been set yet, although if the private key has been set then the public key must
46 be. The values point to the internal representation of the public key and
47 private key values. This memory should not be freed directly.
48
49 The public and private key values can be set using DH_set0_key(). The public
50 key must be non-NULL the first time this function is called on a given DH
51 object. The private key may be NULL.  On subsequent calls, either may be NULL,
52 which means the corresponding DH field is left untouched. As for DH_set0_pqg()
53 this function transfers the memory management of the key values to the DH
54 object, and therefore they should not be freed directly after this function has
55 been called.
56
57 DH_set_flags() sets the flags in the B<flags> parameter on the DH object.
58 Multiple flags can be passed in one go (bitwise ORed together). Any flags that
59 are already set are left set. DH_test_flags() tests to see whether the flags
60 passed in the B<flags> parameter are currently set in the DH object. Multiple
61 flags can be tested in one go. All flags that are currently set are returned, or
62 zero if none of the flags are set. DH_clear_flags() clears the specified flags
63 within the DH object.
64
65 DH_get0_engine() returns a handle to the ENGINE that has been set for this DH
66 object, or NULL if no such ENGINE has been set.
67
68 The DH_get_length() and DH_set_length() functions get and set the optional
69 length parameter associated with this DH object. If the length is non-zero then
70 it is used, otherwise it is ignored. The B<length> parameter indicates the
71 length of the secret exponent (private key) in bits.
72
73 =head1 NOTES
74
75 Values retrieved with DH_get0_key() are owned by the DH object used
76 in the call and may therefore I<not> be passed to DH_set0_key().  If
77 needed, duplicate the received value using BN_dup() and pass the
78 duplicate.  The same applies to DH_get0_pqg() and DH_set0_pqg().
79
80 =head1 RETURN VALUES
81
82 DH_set0_pqg() and DH_set0_key() return 1 on success or 0 on failure.
83
84 DH_test_flags() returns the current state of the flags in the DH object.
85
86 DH_get0_engine() returns the ENGINE set for the DH object or NULL if no ENGINE
87 has been set.
88
89 DH_get_length() returns the length of the secret exponent (private key) in bits,
90 or zero if no such length has been explicitly set.
91
92 =head1 SEE ALSO
93
94 L<dh(3)>, L<DH_new(3)>, L<DH_generate_parameters(3)>, L<DH_generate_key(3)>,
95 L<DH_set_method(3)>, L<DH_size(3)>, L<DH_meth_new(3)>
96
97 =head1 HISTORY
98
99 The functions described here were added in OpenSSL version 1.1.0.
100
101 =cut