In dsa.h rev. 1.28 2018/02/20 17:48:35, tb@ provided

DSA_SIG_get0(3) and DSA_SIG_set0(3).
Merge the documentation from OpenSSL, tweaked by me.

diff --git a/lib/libcrypto/man/DSA_SIG_new.3 b/lib/libcrypto/man/DSA_SIG_new.3
index 4b114f4..c3bd639 100644 (file)
--- a/lib/libcrypto/man/DSA_SIG_new.3
+++ b/lib/libcrypto/man/DSA_SIG_new.3
@@ -1,8 +1,10 @@
-.\"    $OpenBSD: DSA_SIG_new.3,v 1.4 2016/12/10 22:47:49 schwarze Exp $
-.\"    OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400
+.\" $OpenBSD: DSA_SIG_new.3,v 1.5 2018/02/24 13:51:50 schwarze Exp $
+.\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
 .\"
-.\" This file was written by Ulf Moeller <ulf@openssl.org>.
-.\" Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
+.\" This file was written by Ulf Moeller <ulf@openssl.org>,
+.\" Dr. Stephen Henson <steve@openssl.org>, and
+.\" TJ Saunders <tj@castaglia.org>.
+.\" Copyright (c) 2000, 2016 The OpenSSL Project.  All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -48,24 +50,38 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 10 2016 $
+.Dd $Mdocdate: February 24 2018 $
 .Dt DSA_SIG_NEW 3
 .Os
 .Sh NAME
 .Nm DSA_SIG_new ,
-.Nm DSA_SIG_free
-.Nd allocate and free DSA signature objects
+.Nm DSA_SIG_free ,
+.Nm DSA_SIG_get0 ,
+.Nm DSA_SIG_set0
+.Nd manipulate DSA signature objects
 .Sh SYNOPSIS
 .In openssl/dsa.h
 .Ft DSA_SIG *
 .Fn DSA_SIG_new void
 .Ft void
 .Fo DSA_SIG_free
-.Fa "DSA_SIG *a"
+.Fa "DSA_SIG *sig"
+.Fc
+.Ft void
+.Fo DSA_SIG_get0
+.Fa "const DSA_SIG *sig"
+.Fa "const BIGNUM **r"
+.Fa "const BIGNUM **s"
+.Fc
+.Ft int
+.Fo DSA_SIG_set0
+.Fa "DSA_SIG *sig"
+.Fa "BIGNUM *r"
+.Fa "BIGNUM *s"
 .Fc
 .Sh DESCRIPTION
 .Fn DSA_SIG_new
-allocates and initializes a
+allocates an empty
 .Vt DSA_SIG
 structure.
 .Pp
@@ -75,10 +91,28 @@ frees the
 structure and its components.
 The values are erased before the memory is returned to the system.
 If
-.Fa a
+.Fa sig
 is a
 .Dv NULL
 pointer, no action occurs.
+.Pp
+.Fn DSA_SIG_get0
+retrieves internal pointers to the
+.Fa r
+and
+.Fa s
+values contained in
+.Fa sig .
+.Pp
+The
+.Fa r
+and
+.Fa s
+values can be set by calling
+.Fn DSA_SIG_set0 .
+Calling this function transfers the memory management of the values to
+.Fa sig ,
+and therefore they should not be freed by the caller.
 .Sh RETURN VALUES
 If the allocation fails,
 .Fn DSA_SIG_new
@@ -87,6 +121,9 @@ returns
 and sets an error code that can be obtained by
 .Xr ERR_get_error 3 .
 Otherwise it returns a pointer to the newly allocated structure.
+.Pp
+.Fn DSA_SIG_set0
+returns 1 on success or 0 on failure.
 .Sh SEE ALSO
 .Xr DSA_do_sign 3 ,
 .Xr DSA_new 3 ,