]>
Commit | Line | Data |
---|---|---|
0263b992 MC |
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 | ||
fd809cfd RL |
13 | void DH_get0_pqg(const DH *dh, |
14 | const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); | |
0263b992 | 15 | int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); |
fd809cfd RL |
16 | void DH_get0_key(const DH *dh, |
17 | const BIGNUM **pub_key, const BIGNUM **priv_key); | |
0263b992 MC |
18 | int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); |
19 | void DH_clear_flags(DH *dh, int flags); | |
20 | int DH_test_flags(const DH *dh, int flags); | |
21 | void DH_set_flags(DH *dh, int flags); | |
22 | ENGINE *DH_get0_engine(DH *d); | |
23 | long DH_get_length(const DH *dh); | |
24 | int DH_set_length(DH *dh, long length); | |
25 | ||
26 | =head1 DESCRIPTION | |
27 | ||
28 | A DH object contains the parameters B<p>, B<q> and B<g>. Note that the B<q> | |
29 | parameter is optional. It also contains a public key (B<pub_key>) and | |
30 | (optionally) a private key (B<priv_key>). | |
31 | ||
32 | The B<p>, B<q> and B<g> parameters can be obtained by calling DH_get0_pqg(). | |
33 | If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set | |
34 | to NULL. Otherwise they are set to pointers to their respective values. These | |
35 | point directly to the internal representations of the values and therefore | |
36 | should not be freed directly. | |
37 | ||
38 | The B<p>, B<q> and B<g> values can be set by calling DH_set0_pqg() and passing | |
39 | the new values for B<p>, B<q> and B<g> as parameters to the function. Calling | |
40 | this function transfers the memory management of the values to the DH object, | |
41 | and therefore the values that have been passed in should not be freed directly | |
42 | after this function has been called. The B<q> parameter may be NULL. | |
43 | ||
44 | To get the public and private key values use the DH_get0_key() function. A | |
45 | pointer to the public key will be stored in B<*pub_key>, and a pointer to the | |
46 | private key will be stored in B<*priv_key>. Either may be NULL if they have not | |
47 | been set yet, although if the private key has been set then the public key must | |
48 | be. The values point to the internal representation of the public key and | |
49 | private key values. This memory should not be freed directly. | |
50 | ||
51 | The public and private key values can be set using DH_set0_key(). The public | |
4c5e6b2c RL |
52 | key must be non-NULL the first time this function is called on a given DH |
53 | object. The private key may be NULL. On subsequent calls, either may be NULL, | |
54 | which means the corresponding DH field is left untouched. As for DH_set0_pqg() | |
0263b992 MC |
55 | this function transfers the memory management of the key values to the DH |
56 | object, and therefore they should not be freed directly after this function has | |
57 | been called. | |
58 | ||
59 | DH_set_flags() sets the flags in the B<flags> parameter on the DH object. | |
60 | Multiple flags can be passed in one go (bitwise ORed together). Any flags that | |
61 | are already set are left set. DH_test_flags() tests to see whether the flags | |
62 | passed in the B<flags> parameter are currently set in the DH object. Multiple | |
63 | flags can be tested in one go. All flags that are currently set are returned, or | |
64 | zero if none of the flags are set. DH_clear_flags() clears the specified flags | |
65 | within the DH object. | |
66 | ||
67 | DH_get0_engine() returns a handle to the ENGINE that has been set for this DH | |
68 | object, or NULL if no such ENGINE has been set. | |
69 | ||
70 | The DH_get_length() and DH_set_length() functions get and set the optional | |
71 | length parameter associated with this DH object. If the length is non-zero then | |
72 | it is used, otherwise it is ignored. The B<length> parameter indicates the | |
73 | length of the secret exponent (private key) in bits. | |
74 | ||
4c5e6b2c RL |
75 | =head1 NOTES |
76 | ||
77 | Values retrieved with DH_get0_key() are owned by the DH object used | |
78 | in the call and may therefore I<not> be passed to DH_set0_key(). If | |
79 | needed, duplicate the received value using BN_dup() and pass the | |
80 | duplicate. The same applies to DH_get0_pqg() and DH_set0_pqg(). | |
81 | ||
0263b992 MC |
82 | =head1 RETURN VALUES |
83 | ||
84 | DH_set0_pqg() and DH_set0_key() return 1 on success or 0 on failure. | |
85 | ||
86 | DH_test_flags() returns the current state of the flags in the DH object. | |
87 | ||
88 | DH_get0_engine() returns the ENGINE set for the DH object or NULL if no ENGINE | |
89 | has been set. | |
90 | ||
91 | DH_get_length() returns the length of the secret exponent (private key) in bits, | |
92 | or zero if no such length has been explicitly set. | |
93 | ||
94 | =head1 SEE ALSO | |
95 | ||
b97fdb57 | 96 | L<DH_new(3)>, L<DH_new(3)>, L<DH_generate_parameters(3)>, L<DH_generate_key(3)>, |
0263b992 MC |
97 | L<DH_set_method(3)>, L<DH_size(3)>, L<DH_meth_new(3)> |
98 | ||
99 | =head1 HISTORY | |
100 | ||
101 | The functions described here were added in OpenSSL version 1.1.0. | |
102 | ||
e2f92610 RS |
103 | =head1 COPYRIGHT |
104 | ||
105 | Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. | |
106 | ||
107 | Licensed under the OpenSSL license (the "License"). You may not use | |
108 | this file except in compliance with the License. You can obtain a copy | |
109 | in the file LICENSE in the source distribution or at | |
110 | L<https://www.openssl.org/source/license.html>. | |
111 | ||
112 | =cut |