83 lines
3.4 KiB
Text
83 lines
3.4 KiB
Text
|
=pod
|
||
|
|
|
||
|
|
=head1 NAME
|
||
|
|
|
||
|
|
DSA_get0_pqg, DSA_set0_pgg, DSA_get0_key, DSA_set0_key, DSA_clear_flags,
|
||
|
|
DSA_test_flags, DSA_set_flags, DSA_get0_engine - Routines for getting and
|
||
|
|
setting data in a DSA object
|
||
|
|
|
||
|
|
=head1 SYNOPSIS
|
||
|
|
|
||
|
|
#include <openssl/dsa.h>
|
||
|
|
|
||
|
|
void DSA_get0_pqg(const DSA *d, BIGNUM **p, BIGNUM **q, BIGNUM **g);
|
||
|
|
int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
|
||
|
|
void DSA_get0_key(const DSA *d, BIGNUM **pub_key, BIGNUM **priv_key);
|
||
|
|
int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
|
||
|
|
void DSA_clear_flags(DSA *d, int flags);
|
||
|
|
int DSA_test_flags(const DSA *d, int flags);
|
||
|
|
void DSA_set_flags(DSA *d, int flags);
|
||
|
|
ENGINE *DSA_get0_engine(DSA *d);
|
||
|
|
|
||
|
|
=head1 DESCRIPTION
|
||
|
|
|
||
|
|
A DSA object contains the parameters B<p>, B<q> and B<g>. It also contains a
|
||
|
|
public key (B<pub_key>) and (optionally) a private key (B<priv_key>).
|
||
|
|
|
||
|
|
The B<p>, B<q> and B<g> parameters can be obtained by calling DSA_get0_pqg().
|
||
|
|
If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set
|
||
|
|
to NULL. Otherwise they are set to pointers to their respective values. These
|
||
|
|
point directly to the internal representations of the values and therefore
|
||
|
|
should not be freed directly.
|
||
|
|
|
||
|
|
The B<p>, B<q> and B<g> values can be set by calling DSA_set0_pqg() and passing
|
||
|
|
the new values for B<p>, B<q> and B<g> as parameters to the function. Calling
|
||
|
|
this function transfers the memory management of the values to the DSA object,
|
||
|
|
and therefore the values that have been passed in should not be freed directly
|
||
|
|
after this function has been called.
|
||
|
|
|
||
|
|
To get the public and private key values use the DSA_get0_key() function. A
|
||
|
|
pointer to the public key will be stored in B<*pub_key>, and a pointer to the
|
||
|
|
private key will be stored in B<*priv_key>. Either may be NULL if they have not
|
||
|
|
been set yet, although if the private key has been set then the public key must
|
||
|
|
be. The values point to the internal representation of the public key and
|
||
|
|
private key values. This memory should not be freed directly.
|
||
|
|
|
||
|
|
The public and private key values can be set using DSA_set0_key(). The public
|
||
|
|
key must always be non-NULL. The private key may be NULL. As for DSA_set0_pqg()
|
||
|
|
this function transfers the memory management of the key values to the DSA
|
||
|
|
object, and therefore they should not be freed directly after this function has
|
||
|
|
been called.
|
||
|
|
|
||
|
|
DSA_set_flags() sets the flags in the B<flags> parameter on the DSA object.
|
||
|
|
Multiple flags can be passed in one go (bitwise ORed together). Any flags that
|
||
|
|
are already set are left set. DSA_test_flags() tests to see whether the flags
|
||
|
|
passed in the B<flags> parameter are currently set in the DSA object. Multple
|
||
|
|
flags can be tested in one go. All flags that are currently set are returned, or
|
||
|
|
zero if none of the flags are set. DSA_clear_flags() clears the specified flags
|
||
|
|
within the DSA object.
|
||
|
|
|
||
|
|
DSA_get0_engine() returns a handle to the ENGINE that has been set for this DSA
|
||
|
|
object, or NULL if no such ENGINE has been set.
|
||
|
|
|
||
|
|
=head1 RETURN VALUES
|
||
|
|
|
||
|
|
DSA_set0_pqg() and DSA_set0_key() return 1 on success or 0 on failure.
|
||
|
|
|
||
|
|
DSA_test_flags() returns the current state of the flags in the DSA object.
|
||
|
|
|
||
|
|
DSA_get0_engine() returns the ENGINE set for the DSA object or NULL if no ENGINE
|
||
|
|
has been set.
|
||
|
|
|
||
|
|
=head1 SEE ALSO
|
||
|
|
|
||
|
|
L<dsa>, L<DSA_new>, L<DSA_generate_parameters>, L<DSA_generate_key>,
|
||
|
|
L<DSA_dup_DH>, L<DSA_do_sign>, L<DSA_set_method>, L<DSA_SIG_new>, L<DSA_sign>,
|
||
|
|
L<DSA_size>, L<DSA_meth_new>
|
||
|
|
|
||
|
|
=head1 HISTORY
|
||
|
|
|
||
|
|
The functions described here were added in OpenSSL version 1.1.0.
|
||
|
|
|
||
|
|
=cut
|