1DSA_GET0_PQG(3ossl)                 OpenSSL                DSA_GET0_PQG(3ossl)
2
3
4

NAME

6       DSA_get0_pqg, DSA_set0_pqg, DSA_get0_key, DSA_set0_key, DSA_get0_p,
7       DSA_get0_q, DSA_get0_g, DSA_get0_pub_key, DSA_get0_priv_key,
8       DSA_clear_flags, DSA_test_flags, DSA_set_flags, DSA_get0_engine -
9       Routines for getting and setting data in a DSA object
10

SYNOPSIS

12        #include <openssl/dsa.h>
13
14       The following functions have been deprecated since OpenSSL 3.0, and can
15       be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
16       version value, see openssl_user_macros(7):
17
18        void DSA_get0_pqg(const DSA *d,
19                          const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
20        int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
21        void DSA_get0_key(const DSA *d,
22                          const BIGNUM **pub_key, const BIGNUM **priv_key);
23        int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
24        const BIGNUM *DSA_get0_p(const DSA *d);
25        const BIGNUM *DSA_get0_q(const DSA *d);
26        const BIGNUM *DSA_get0_g(const DSA *d);
27        const BIGNUM *DSA_get0_pub_key(const DSA *d);
28        const BIGNUM *DSA_get0_priv_key(const DSA *d);
29        void DSA_clear_flags(DSA *d, int flags);
30        int DSA_test_flags(const DSA *d, int flags);
31        void DSA_set_flags(DSA *d, int flags);
32        ENGINE *DSA_get0_engine(DSA *d);
33

DESCRIPTION

35       All of the functions described on this page are deprecated.
36       Applications should instead use EVP_PKEY_get_bn_param(3).
37
38       A DSA object contains the parameters p, q and g. It also contains a
39       public key (pub_key) and (optionally) a private key (priv_key).
40
41       The p, q and g parameters can be obtained by calling DSA_get0_pqg().
42       If the parameters have not yet been set then *p, *q and *g will be set
43       to NULL. Otherwise they are set to pointers to their respective values.
44       These point directly to the internal representations of the values and
45       therefore should not be freed directly.
46
47       The p, q and g values can be set by calling DSA_set0_pqg() and passing
48       the new values for p, q and g as parameters to the function. Calling
49       this function transfers the memory management of the values to the DSA
50       object, and therefore the values that have been passed in should not be
51       freed directly after this function has been called.
52
53       To get the public and private key values use the DSA_get0_key()
54       function. A pointer to the public key will be stored in *pub_key, and a
55       pointer to the private key will be stored in *priv_key. Either may be
56       NULL if they have not been set yet, although if the private key has
57       been set then the public key must be. The values point to the internal
58       representation of the public key and private key values. This memory
59       should not be freed directly.
60
61       The public and private key values can be set using DSA_set0_key(). The
62       public key must be non-NULL the first time this function is called on a
63       given DSA object. The private key may be NULL.  On subsequent calls,
64       either may be NULL, which means the corresponding DSA field is left
65       untouched. As for DSA_set0_pqg() this function transfers the memory
66       management of the key values to the DSA object, and therefore they
67       should not be freed directly after this function has been called.
68
69       Any of the values p, q, g, priv_key, and pub_key can also be retrieved
70       separately by the corresponding function DSA_get0_p(), DSA_get0_q(),
71       DSA_get0_g(), DSA_get0_priv_key(), and DSA_get0_pub_key(),
72       respectively.
73
74       DSA_set_flags() sets the flags in the flags parameter on the DSA
75       object.  Multiple flags can be passed in one go (bitwise ORed
76       together). Any flags that are already set are left set.
77       DSA_test_flags() tests to see whether the flags passed in the flags
78       parameter are currently set in the DSA object. Multiple flags can be
79       tested in one go. All flags that are currently set are returned, or
80       zero if none of the flags are set. DSA_clear_flags() clears the
81       specified flags within the DSA object.
82
83       DSA_get0_engine() returns a handle to the ENGINE that has been set for
84       this DSA object, or NULL if no such ENGINE has been set.
85

NOTES

87       Values retrieved with DSA_get0_key() are owned by the DSA object used
88       in the call and may therefore not be passed to DSA_set0_key().  If
89       needed, duplicate the received value using BN_dup() and pass the
90       duplicate.  The same applies to DSA_get0_pqg() and DSA_set0_pqg().
91

RETURN VALUES

93       DSA_set0_pqg() and DSA_set0_key() return 1 on success or 0 on failure.
94
95       DSA_test_flags() returns the current state of the flags in the DSA
96       object.
97
98       DSA_get0_engine() returns the ENGINE set for the DSA object or NULL if
99       no ENGINE has been set.
100

SEE ALSO

102       EVP_PKEY_get_bn_param(3), DSA_new(3), DSA_new(3),
103       DSA_generate_parameters(3), DSA_generate_key(3), DSA_dup_DH(3),
104       DSA_do_sign(3), DSA_set_method(3), DSA_SIG_new(3), DSA_sign(3),
105       DSA_size(3), DSA_meth_new(3)
106

HISTORY

108       The functions described here were added in OpenSSL 1.1.0 and deprecated
109       in OpenSSL 3.0.
110

112       Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
113
114       Licensed under the Apache License 2.0 (the "License").  You may not use
115       this file except in compliance with the License.  You can obtain a copy
116       in the file LICENSE in the source distribution or at
117       <https://www.openssl.org/source/license.html>.
118
119
120
1213.0.9                             2023-07-27               DSA_GET0_PQG(3ossl)
Impressum