DH_new_by_nid.pod 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. =pod
  2. =head1 NAME
  3. DH_new_by_nid, DH_get_nid - get or find DH named parameters
  4. =head1 SYNOPSIS
  5. #include <openssl/dh.h>
  6. DH *DH_new_by_nid(int nid);
  7. int *DH_get_nid(const DH *dh);
  8. =head1 DESCRIPTION
  9. DH_new_by_nid() creates and returns a DH structure containing named parameters
  10. B<nid>. Currently B<nid> must be B<NID_ffdhe2048>, B<NID_ffdhe3072>,
  11. B<NID_ffdhe4096>, B<NID_ffdhe6144> or B<NID_ffdhe8192>.
  12. DH_get_nid() determines if the parameters contained in B<dh> match
  13. any named set. It returns the NID corresponding to the matching parameters or
  14. B<NID_undef> if there is no match.
  15. =head1 RETURN VALUES
  16. DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
  17. DH_get_nid() returns the NID of the matching set of parameters or
  18. B<NID_undef> if there is no match.
  19. =head1 COPYRIGHT
  20. Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
  21. Licensed under the OpenSSL license (the "License"). You may not use
  22. this file except in compliance with the License. You can obtain a copy
  23. in the file LICENSE in the source distribution or at
  24. L<https://www.openssl.org/source/license.html>.
  25. =cut