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