summaryrefslogtreecommitdiffstats
path: root/doc/man3/DSA_generate_key.pod
diff options
context:
space:
mode:
authorShane Lontis <shane.lontis@oracle.com>2021-03-16 09:39:19 +1000
committerShane Lontis <shane.lontis@oracle.com>2021-03-30 09:45:07 +1000
commite52b421575c279b36617b7cc9dfed8c54518a928 (patch)
treeea7a2d9d0c7ba9e95b20f160feda41f1c0c5e063 /doc/man3/DSA_generate_key.pod
parent203c18f14aab47a1f9f0a18a5119997761184557 (diff)
Update deprecated API's in the documentation.
The reported issue related to EC_KEY deprecations Fixes #14545 Searches were done in the pod files for all libcrypto.num entries containing DEPRECATEDIN_3_0 to find additional missing entries. Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14564)
Diffstat (limited to 'doc/man3/DSA_generate_key.pod')
-rw-r--r--doc/man3/DSA_generate_key.pod14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/man3/DSA_generate_key.pod b/doc/man3/DSA_generate_key.pod
index 079c2fef18..65cc29ddda 100644
--- a/doc/man3/DSA_generate_key.pod
+++ b/doc/man3/DSA_generate_key.pod
@@ -8,10 +8,18 @@ DSA_generate_key - generate DSA key pair
#include <openssl/dsa.h>
+Deprecated since OpenSSL 3.0, can be hidden entirely by defining
+B<OPENSSL_API_COMPAT> with a suitable version value, see
+L<openssl_user_macros(7)>:
+
int DSA_generate_key(DSA *a);
=head1 DESCRIPTION
+All of the functions described on this page are deprecated.
+Applications should instead use L<EVP_PKEY_keygen_init(3)> and
+L<EVP_PKEY_keygen(3)> as described in L<EVP_PKEY-DSA(7)>.
+
DSA_generate_key() expects B<a> to contain DSA parameters. It generates
a new key pair and stores it in B<a-E<gt>pub_key> and B<a-E<gt>priv_key>.
@@ -29,9 +37,13 @@ The error codes can be obtained by L<ERR_get_error(3)>.
L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
L<DSA_generate_parameters_ex(3)>
+=head1 HISTORY
+
+This function was deprecated in OpenSSL 3.0.
+
=head1 COPYRIGHT
-Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy