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