DSA_SIG_new.pod 1.7 KB

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