Deprecate the low level DSA functions.
[openssl.git] / doc / man3 / DSA_size.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_size, DSA_bits, DSA_security_bits - get DSA signature size, key bits or security bits
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dsa.h>
10
11 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
12 B<OPENSSL_API_COMPAT> with a suitable version value, see
13 L<openssl_user_macros(7)>:
14
15  int DSA_size(const DSA *dsa);
16  int DSA_bits(const DSA *dsa);
17  int DSA_security_bits(const DSA *dsa);
18
19 =head1 DESCRIPTION
20
21 All of the functions described on this page are deprecated.
22 Applications should instead use L<EVP_PKEY_bits(3)>,
23 L<EVP_PKEY_security_bits(3)> and L<EVP_PKEY_size(3)>.
24
25 DSA_size() returns the maximum size of an ASN.1 encoded DSA signature
26 for key B<dsa> in bytes. It can be used to determine how much memory must
27 be allocated for a DSA signature.
28
29 B<dsa-E<gt>q> must not be B<NULL>.
30
31 DSA_bits() returns the number of bits in key B<dsa>: this is the number
32 of bits in the B<p> parameter.
33
34 DSA_security_bits() returns the number of security bits of the given B<dsa>
35 key. See L<BN_security_bits(3)>.
36
37 =head1 RETURN VALUES
38
39 DSA_size() returns the signature size in bytes.
40
41 DSA_bits() returns the number of bits in the key.
42
43 =head1 SEE ALSO
44
45 L<EVP_PKEY_bits(3)>,
46 L<EVP_PKEY_security_bits(3)>,
47 L<EVP_PKEY_size(3)>,
48 L<DSA_new(3)>, L<DSA_sign(3)>
49
50 =head1 HISTORY
51
52 All of these functions were deprecated in OpenSSL 3.0.
53
54 =head1 COPYRIGHT
55
56 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
57
58 Licensed under the Apache License 2.0 (the "License").  You may not use
59 this file except in compliance with the License.  You can obtain a copy
60 in the file LICENSE in the source distribution or at
61 L<https://www.openssl.org/source/license.html>.
62
63 =cut