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