DH_new_by_nid.pod 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. =pod
  2. =head1 NAME
  3. DH_new_by_nid, DH_get_nid - create or get DH named parameters
  4. =head1 SYNOPSIS
  5. #include <openssl/dh.h>
  6. DH *DH_new_by_nid(int nid);
  7. Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  8. B<OPENSSL_API_COMPAT> with a suitable version value, see
  9. L<openssl_user_macros(7)>:
  10. int DH_get_nid(const DH *dh);
  11. =head1 DESCRIPTION
  12. DH_new_by_nid() creates and returns a DH structure containing named parameters
  13. B<nid>. Currently B<nid> must be B<NID_ffdhe2048>, B<NID_ffdhe3072>,
  14. B<NID_ffdhe4096>, B<NID_ffdhe6144>, B<NID_ffdhe8192>,
  15. B<NID_modp_1536>, B<NID_modp_2048>, B<NID_modp_3072>,
  16. B<NID_modp_4096>, B<NID_modp_6144> or B<NID_modp_8192>.
  17. DH_get_nid() determines if the parameters contained in B<dh> match
  18. any named safe prime group. It returns the NID corresponding to the matching
  19. parameters or B<NID_undef> if there is no match.
  20. This function is deprecated.
  21. =head1 RETURN VALUES
  22. DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
  23. DH_get_nid() returns the NID of the matching set of parameters for p and g
  24. and optionally q, otherwise it returns B<NID_undef> if there is no match.
  25. =head1 HISTORY
  26. The DH_get_nid() function was deprecated in OpenSSL 3.0.
  27. =head1 COPYRIGHT
  28. Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
  29. Licensed under the Apache License 2.0 (the "License"). You may not use
  30. this file except in compliance with the License. You can obtain a copy
  31. in the file LICENSE in the source distribution or at
  32. L<https://www.openssl.org/source/license.html>.
  33. =cut