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