doc/man3/DSA_SIG_new.pod

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