Add documentation for following DH and DH_METHOD opacity
[openssl.git] / doc / crypto / dh.pod
index ce6a11089534fc42feec8e31364d55abe1b360f9..b1eaa480b7e281c5f2980391ebe92ca34fa3fd3c 100644 (file)
@@ -38,25 +38,15 @@ The generation of shared DH parameters is described in
 L<DH_generate_parameters(3)>; L<DH_generate_key(3)> describes how
 to perform a key agreement.
 
-The B<DH> structure consists of several BIGNUM components.
-
- struct
-        {
-        BIGNUM *p;             // prime number (shared)
-        BIGNUM *g;             // generator of Z_p (shared)
-        BIGNUM *priv_key;      // private DH value x
-        BIGNUM *pub_key;       // public DH value g^x
-        // ...
-        };
- DH
+The B<DH> structure consists of several BIGNUM components. The prime B<p>, the
+generate B<g>, the Private key B<priv_key> and the public key B<pub_key>.
+Optionally there may also be an additional parameter B<q>.
 
 Note that DH keys may use non-standard B<DH_METHOD> implementations,
 either directly or by the use of B<ENGINE> modules. In some cases (eg. an
 ENGINE providing support for hardware-embedded keys), these BIGNUM values
 will not be used by the implementation or may be used for alternative data
-storage. For this reason, applications should generally avoid using DH
-structure elements directly and instead use API functions to query or
-modify keys.
+storage.
 
 =head1 SEE ALSO
 
@@ -65,7 +55,7 @@ L<rand(3)>, L<rsa(3)>, L<engine(3)>,
 L<DH_set_method(3)>, L<DH_new(3)>,
 L<DH_get_ex_new_index(3)>,
 L<DH_generate_parameters(3)>,
-L<DH_compute_key(3)>, L<d2i_DHparams(3)>,
+L<DH_compute_key(3)>, L<DH_get0_pqg(3)>, L<DH_meth_new(3)>, L<d2i_DHparams(3)>,
 L<RSA_print(3)> 
 
 =cut