xref: /freebsd/crypto/openssl/doc/man3/DSA_SIG_new.pod (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
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.
23
24DSA_SIG_get0() returns internal pointers to the B<r> and B<s> values contained
25in B<sig>.
26
27The B<r> and B<s> values can be set by calling DSA_SIG_set0() and passing the
28new values for B<r> and B<s> as parameters to the function. Calling this
29function transfers the memory management of the values to the DSA_SIG object,
30and therefore the values that have been passed in should not be freed directly
31after this function has been called.
32
33=head1 RETURN VALUES
34
35If the allocation fails, DSA_SIG_new() returns B<NULL> and sets an
36error code that can be obtained by
37L<ERR_get_error(3)>. Otherwise it returns a pointer
38to the newly allocated structure.
39
40DSA_SIG_free() returns no value.
41
42DSA_SIG_set0() returns 1 on success or 0 on failure.
43
44=head1 SEE ALSO
45
46L<EVP_PKEY_new(3)>, L<EVP_PKEY_free(3)>, L<EVP_PKEY_get_bn_param(3)>,
47L<ERR_get_error(3)>
48
49=head1 COPYRIGHT
50
51Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
52
53Licensed under the Apache License 2.0 (the "License").  You may not use
54this file except in compliance with the License.  You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut
59