Documentation the changed {RSA,DSA,DH}_set0_* functionality change
[openssl.git] / doc / crypto / DSA_get0_pqg.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_get0_pqg, DSA_set0_pqg, DSA_get0_key, DSA_set0_key, DSA_clear_flags,
6 DSA_test_flags, DSA_set_flags, DSA_get0_engine - Routines for getting and
7 setting data in a DSA object
8
9 =head1 SYNOPSIS
10
11  #include <openssl/dsa.h>
12
13  void DSA_get0_pqg(const DSA *d, BIGNUM **p, BIGNUM **q, BIGNUM **g);
14  int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
15  void DSA_get0_key(const DSA *d, BIGNUM **pub_key, BIGNUM **priv_key);
16  int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
17  void DSA_clear_flags(DSA *d, int flags);
18  int DSA_test_flags(const DSA *d, int flags);
19  void DSA_set_flags(DSA *d, int flags);
20  ENGINE *DSA_get0_engine(DSA *d);
21
22 =head1 DESCRIPTION
23
24 A DSA object contains the parameters B<p>, B<q> and B<g>. It also contains a
25 public key (B<pub_key>) and (optionally) a private key (B<priv_key>).
26
27 The B<p>, B<q> and B<g> parameters can be obtained by calling DSA_get0_pqg().
28 If the parameters have not yet been set then B<*p>, B<*q> and B<*g> will be set
29 to NULL. Otherwise they are set to pointers to their respective values. These
30 point directly to the internal representations of the values and therefore
31 should not be freed directly.
32
33 The B<p>, B<q> and B<g> values can be set by calling DSA_set0_pqg() and passing
34 the new values for B<p>, B<q> and B<g> as parameters to the function. Calling
35 this function transfers the memory management of the values to the DSA object,
36 and therefore the values that have been passed in should not be freed directly
37 after this function has been called.
38
39 To get the public and private key values use the DSA_get0_key() function. A
40 pointer to the public key will be stored in B<*pub_key>, and a pointer to the
41 private key will be stored in B<*priv_key>. Either may be NULL if they have not
42 been set yet, although if the private key has been set then the public key must
43 be. The values point to the internal representation of the public key and
44 private key values. This memory should not be freed directly.
45
46 The public and private key values can be set using DSA_set0_key(). The public
47 key must be non-NULL the first time this function is called on a given DSA
48 object. The private key may be NULL.  On subsequent calls, either may be NULL,
49 which means the corresponding DSA field is left untouched. As for DSA_set0_pqg()
50 this function transfers the memory management of the key values to the DSA
51 object, and therefore they should not be freed directly after this function has
52 been called.
53
54 DSA_set_flags() sets the flags in the B<flags> parameter on the DSA object.
55 Multiple flags can be passed in one go (bitwise ORed together). Any flags that
56 are already set are left set. DSA_test_flags() tests to see whether the flags
57 passed in the B<flags> parameter are currently set in the DSA object. Multiple
58 flags can be tested in one go. All flags that are currently set are returned, or
59 zero if none of the flags are set. DSA_clear_flags() clears the specified flags
60 within the DSA object.
61
62 DSA_get0_engine() returns a handle to the ENGINE that has been set for this DSA
63 object, or NULL if no such ENGINE has been set.
64
65 =head1 NOTES
66
67 Values retrieved with DSA_get0_key() are owned by the DSA object used
68 in the call and may therefore I<not> be passed to DSA_set0_key().  If
69 needed, duplicate the received value using BN_dup() and pass the
70 duplicate.  The same applies to DSA_get0_pqg() and DSA_set0_pqg().
71
72 =head1 RETURN VALUES
73
74 DSA_set0_pqg() and DSA_set0_key() return 1 on success or 0 on failure.
75
76 DSA_test_flags() returns the current state of the flags in the DSA object.
77
78 DSA_get0_engine() returns the ENGINE set for the DSA object or NULL if no ENGINE
79 has been set.
80
81 =head1 SEE ALSO
82
83 L<dsa(3)>, L<DSA_new(3)>, L<DSA_generate_parameters(3)>, L<DSA_generate_key(3)>,
84 L<DSA_dup_DH(3)>, L<DSA_do_sign(3)>, L<DSA_set_method(3)>, L<DSA_SIG_new(3)>,
85 L<DSA_sign(3)>, L<DSA_size(3)>, L<DSA_meth_new(3)>
86
87 =head1 HISTORY
88
89 The functions described here were added in OpenSSL version 1.1.0.
90
91 =cut