Improve X509V3_get0_uids() documentation
authortb <tb@openbsd.org>
Wed, 15 May 2024 21:15:28 +0000 (21:15 +0000)
committertb <tb@openbsd.org>
Wed, 15 May 2024 21:15:28 +0000 (21:15 +0000)
Use less horrcble variable names and make it explicit that both output
arguments are allowed to be NULL.

lib/libcrypto/man/X509V3_get_d2i.3

index 6c40619..f9d1e46 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: X509V3_get_d2i.3,v 1.22 2024/05/12 17:44:11 tb Exp $
+.\" $OpenBSD: X509V3_get_d2i.3,v 1.23 2024/05/15 21:15:28 tb Exp $
 .\" full merge up to: OpenSSL ff7fbfd5 Nov 2 11:52:01 2015 +0000
 .\" selective merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
 .\"
@@ -49,7 +49,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: May 12 2024 $
+.Dd $Mdocdate: May 15 2024 $
 .Dt X509V3_GET_D2I 3
 .Os
 .Sh NAME
 .Ft void
 .Fo X509_get0_uids
 .Fa "const X509 *x"
-.Fa "const ASN1_BIT_STRING **piuid"
-.Fa "const ASN1_BIT_STRING **psuid"
+.Fa "const ASN1_BIT_STRING **issuerUID"
+.Fa "const ASN1_BIT_STRING **subjectUID"
 .Fc
 .Sh DESCRIPTION
 .Fn X509V3_get_d2i
@@ -312,14 +312,22 @@ It is possible to determine the precise reason by checking the value of
 .Pf * Fa crit .
 .Pp
 .Fn X509_get0_uids
-sets
-.Fa *piuid
-and
-.Fa *psuid
-to the issuer and subject unique identifiers of certificate
+returns the issuer and subject unique identifiers of the certificate
 .Fa x
-or NULL if the fields are not present.
-These fields are rarely used.
+in
+.Pf * Fa issuerUID
+and
+.Pf * Fa subjectUID .
+If a unique identifier field is not present in
+.Fa x ,
+.Dv NULL
+is returned.
+Either one of
+.Fa issuerUID
+and
+.Fa subjectUID
+can be
+.Dv NULL .
 .Sh SUPPORTED EXTENSIONS
 The following sections contain a list of all supported extensions
 including their name and NID.