xref: /openssl/doc/man3/DSA_SIG_new.pod (revision 7ed6de99)
1=pod
2
3=head1 NAME
4
5DSA_SIG_get0, DSA_SIG_set0,
6DSA_SIG_new, DSA_SIG_free - allocate and free DSA signature objects
7
8=head1 SYNOPSIS
9
10 #include <openssl/dsa.h>
11
12 DSA_SIG *DSA_SIG_new(void);
13 void DSA_SIG_free(DSA_SIG *a);
14 void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
15 int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
16
17=head1 DESCRIPTION
18
19DSA_SIG_new() allocates an empty B<DSA_SIG> structure.
20
21DSA_SIG_free() frees the B<DSA_SIG> structure and its components. The
22values are erased before the memory is returned to the system.
23If the argument is NULL, nothing is done.
24
25DSA_SIG_get0() returns internal pointers to the B<r> and B<s> values contained
26in B<sig>.
27
28The B<r> and B<s> values can be set by calling DSA_SIG_set0() and passing the
29new values for B<r> and B<s> as parameters to the function. Calling this
30function transfers the memory management of the values to the DSA_SIG object,
31and therefore the values that have been passed in should not be freed directly
32after this function has been called.
33
34=head1 RETURN VALUES
35
36If the allocation fails, DSA_SIG_new() returns B<NULL> and sets an
37error code that can be obtained by
38L<ERR_get_error(3)>. Otherwise it returns a pointer
39to the newly allocated structure.
40
41DSA_SIG_free() returns no value.
42
43DSA_SIG_set0() returns 1 on success or 0 on failure.
44
45=head1 SEE ALSO
46
47L<EVP_PKEY_new(3)>, L<EVP_PKEY_free(3)>, L<EVP_PKEY_get_bn_param(3)>,
48L<ERR_get_error(3)>
49
50=head1 COPYRIGHT
51
52Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.
53
54Licensed under the Apache License 2.0 (the "License").  You may not use
55this file except in compliance with the License.  You can obtain a copy
56in the file LICENSE in the source distribution or at
57L<https://www.openssl.org/source/license.html>.
58
59=cut
60