diff options
author | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2018-05-27 09:07:07 +0200 |
---|---|---|
committer | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2018-05-28 19:11:22 +0200 |
commit | 5777254b7aa71ba14582912509c07ff9027a55eb (patch) | |
tree | 2cfc7369648ca251a728f0f0a79dd5488643836b /doc | |
parent | e37d4a6704cf0c8b0a0a6601eff82ca65d16d4a3 (diff) |
DH: fix: add simple getters for commonly used struct members
amends 6db7fadf0975
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6290)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/DH_get0_pqg.pod | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/man3/DH_get0_pqg.pod b/doc/man3/DH_get0_pqg.pod index 6b25556ef7..00e8ef573a 100644 --- a/doc/man3/DH_get0_pqg.pod +++ b/doc/man3/DH_get0_pqg.pod @@ -41,6 +41,8 @@ If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set to NULL. Otherwise they are set to pointers to their respective values. These point directly to the internal representations of the values and therefore should not be freed directly. +Any of the out parameters B<p>, B<q>, and B<g> can be NULL, in which case no +value will be returned for that parameter. The B<p>, B<q> and B<g> values can be set by calling DH_set0_pqg() and passing the new values for B<p>, B<q> and B<g> as parameters to the function. Calling @@ -54,6 +56,8 @@ private key will be stored in B<*priv_key>. Either may be NULL if they have not been set yet, although if the private key has been set then the public key must be. The values point to the internal representation of the public key and private key values. This memory should not be freed directly. +Any of the out parameters B<pub_key> and B<priv_key> can be NULL, in which case +no value will be returned for that parameter. The public and private key values can be set using DH_set0_key(). Either parameter may be NULL, which means the corresponding DH field is left @@ -93,7 +97,7 @@ duplicate. The same applies to DH_get0_pqg() and DH_set0_pqg(). DH_set0_pqg() and DH_set0_key() return 1 on success or 0 on failure. DH_get0_p(), DH_get0_q(), DH_get0_g(), DH_get0_priv_key(), and DH_get0_pub_key() -return the respective value. +return the respective value, or NULL if it is unset. DH_test_flags() returns the current state of the flags in the DH object. |