1=pod 2 3=head1 NAME 4 5DSA_get0_pqg, DSA_set0_pqg, DSA_get0_key, DSA_set0_key, 6DSA_get0_p, DSA_get0_q, DSA_get0_g, 7DSA_get0_pub_key, DSA_get0_priv_key, 8DSA_clear_flags, DSA_test_flags, DSA_set_flags, 9DSA_get0_engine - Routines for getting and 10setting data in a DSA object 11 12=head1 SYNOPSIS 13 14 #include <openssl/dsa.h> 15 16The following functions have been deprecated since OpenSSL 3.0, and can be 17hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, 18see L<openssl_user_macros(7)>: 19 20 void DSA_get0_pqg(const DSA *d, 21 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); 22 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g); 23 void DSA_get0_key(const DSA *d, 24 const BIGNUM **pub_key, const BIGNUM **priv_key); 25 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key); 26 const BIGNUM *DSA_get0_p(const DSA *d); 27 const BIGNUM *DSA_get0_q(const DSA *d); 28 const BIGNUM *DSA_get0_g(const DSA *d); 29 const BIGNUM *DSA_get0_pub_key(const DSA *d); 30 const BIGNUM *DSA_get0_priv_key(const DSA *d); 31 void DSA_clear_flags(DSA *d, int flags); 32 int DSA_test_flags(const DSA *d, int flags); 33 void DSA_set_flags(DSA *d, int flags); 34 ENGINE *DSA_get0_engine(DSA *d); 35 36=head1 DESCRIPTION 37 38All of the functions described on this page are deprecated. 39Applications should instead use L<EVP_PKEY_get_bn_param(3)>. 40 41A DSA object contains the parameters B<p>, B<q> and B<g>. It also contains a 42public key (B<pub_key>) and (optionally) a private key (B<priv_key>). 43 44The B<p>, B<q> and B<g> parameters can be obtained by calling DSA_get0_pqg(). 45If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set 46to NULL. Otherwise they are set to pointers to their respective values. These 47point directly to the internal representations of the values and therefore 48should not be freed directly. 49 50The B<p>, B<q> and B<g> values can be set by calling DSA_set0_pqg() and passing 51the new values for B<p>, B<q> and B<g> as parameters to the function. Calling 52this function transfers the memory management of the values to the DSA object, 53and therefore the values that have been passed in should not be freed directly 54after this function has been called. 55 56To get the public and private key values use the DSA_get0_key() function. A 57pointer to the public key will be stored in B<*pub_key>, and a pointer to the 58private key will be stored in B<*priv_key>. Either may be NULL if they have not 59been set yet, although if the private key has been set then the public key must 60be. The values point to the internal representation of the public key and 61private key values. This memory should not be freed directly. 62 63The public and private key values can be set using DSA_set0_key(). The public 64key must be non-NULL the first time this function is called on a given DSA 65object. The private key may be NULL. On subsequent calls, either may be NULL, 66which means the corresponding DSA field is left untouched. As for DSA_set0_pqg() 67this function transfers the memory management of the key values to the DSA 68object, and therefore they should not be freed directly after this function has 69been called. 70 71Any of the values B<p>, B<q>, B<g>, B<priv_key>, and B<pub_key> can also be 72retrieved separately by the corresponding function DSA_get0_p(), DSA_get0_q(), 73DSA_get0_g(), DSA_get0_priv_key(), and DSA_get0_pub_key(), respectively. 74 75DSA_set_flags() sets the flags in the B<flags> parameter on the DSA object. 76Multiple flags can be passed in one go (bitwise ORed together). Any flags that 77are already set are left set. DSA_test_flags() tests to see whether the flags 78passed in the B<flags> parameter are currently set in the DSA object. Multiple 79flags can be tested in one go. All flags that are currently set are returned, or 80zero if none of the flags are set. DSA_clear_flags() clears the specified flags 81within the DSA object. 82 83DSA_get0_engine() returns a handle to the ENGINE that has been set for this DSA 84object, or NULL if no such ENGINE has been set. 85 86=head1 NOTES 87 88Values retrieved with DSA_get0_key() are owned by the DSA object used 89in the call and may therefore I<not> be passed to DSA_set0_key(). If 90needed, duplicate the received value using BN_dup() and pass the 91duplicate. The same applies to DSA_get0_pqg() and DSA_set0_pqg(). 92 93=head1 RETURN VALUES 94 95DSA_set0_pqg() and DSA_set0_key() return 1 on success or 0 on failure. 96 97DSA_test_flags() returns the current state of the flags in the DSA object. 98 99DSA_get0_engine() returns the ENGINE set for the DSA object or NULL if no ENGINE 100has been set. 101 102=head1 SEE ALSO 103 104L<EVP_PKEY_get_bn_param(3)>, 105L<DSA_new(3)>, L<DSA_new(3)>, L<DSA_generate_parameters(3)>, L<DSA_generate_key(3)>, 106L<DSA_dup_DH(3)>, L<DSA_do_sign(3)>, L<DSA_set_method(3)>, L<DSA_SIG_new(3)>, 107L<DSA_sign(3)>, L<DSA_size(3)>, L<DSA_meth_new(3)> 108 109=head1 HISTORY 110 111The functions described here were added in OpenSSL 1.1.0 and deprecated in 112OpenSSL 3.0. 113 114=head1 COPYRIGHT 115 116Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. 117 118Licensed under the Apache License 2.0 (the "License"). You may not use 119this file except in compliance with the License. You can obtain a copy 120in the file LICENSE in the source distribution or at 121L<https://www.openssl.org/source/license.html>. 122 123=cut 124
