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