DSA_generate_key.pod 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. =pod
  2. =head1 NAME
  3. DSA_generate_key - generate DSA key pair
  4. =head1 SYNOPSIS
  5. #include <openssl/dsa.h>
  6. The following functions have been deprecated since OpenSSL 3.0, and can be
  7. hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  8. see L<openssl_user_macros(7)>:
  9. int DSA_generate_key(DSA *a);
  10. =head1 DESCRIPTION
  11. All of the functions described on this page are deprecated.
  12. Applications should instead use L<EVP_PKEY_keygen_init(3)> and
  13. L<EVP_PKEY_keygen(3)> as described in L<EVP_PKEY-DSA(7)>.
  14. DSA_generate_key() expects B<a> to contain DSA parameters. It generates
  15. a new key pair and stores it in B<a-E<gt>pub_key> and B<a-E<gt>priv_key>.
  16. The random generator must be seeded prior to calling DSA_generate_key().
  17. If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
  18. external circumstances (see L<RAND(7)>), the operation will fail.
  19. =head1 RETURN VALUES
  20. DSA_generate_key() returns 1 on success, 0 otherwise.
  21. The error codes can be obtained by L<ERR_get_error(3)>.
  22. =head1 SEE ALSO
  23. L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
  24. L<DSA_generate_parameters_ex(3)>
  25. =head1 HISTORY
  26. This function was deprecated in OpenSSL 3.0.
  27. =head1 COPYRIGHT
  28. Copyright 2000-2021 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