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