In x509.h rev. 1.29 2018/02/17 15:50:42, jsing@ provided
authorschwarze <schwarze@openbsd.org>
Mon, 19 Feb 2018 08:20:26 +0000 (08:20 +0000)
committerschwarze <schwarze@openbsd.org>
Mon, 19 Feb 2018 08:20:26 +0000 (08:20 +0000)
X509_get0_signature(3).  Merge the documentation from OpenSSL.
Rename the file from X509_get_signature_nid.3 to X509_get0_signature.3
for consistency because we are not losing any history yet.

lib/libcrypto/man/Makefile
lib/libcrypto/man/X509_get0_signature.3 [new file with mode: 0644]
lib/libcrypto/man/X509_get_signature_nid.3 [deleted file]

index 431285c..8d15d61 100644 (file)
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.131 2018/02/17 23:24:38 schwarze Exp $
+# $OpenBSD: Makefile,v 1.132 2018/02/19 08:20:26 schwarze Exp $
 
 .include <bsd.own.mk>
 
@@ -241,10 +241,10 @@ MAN=      \
        X509_digest.3 \
        X509_get_pubkey.3 \
        X509_get_serialNumber.3 \
-       X509_get_signature_nid.3 \
        X509_get_subject_name.3 \
        X509_get_version.3 \
        X509_get0_notBefore.3 \
+       X509_get0_signature.3 \
        X509_new.3 \
        X509_sign.3 \
        X509_verify_cert.3 \
diff --git a/lib/libcrypto/man/X509_get0_signature.3 b/lib/libcrypto/man/X509_get0_signature.3
new file mode 100644 (file)
index 0000000..4c6c3f1
--- /dev/null
@@ -0,0 +1,105 @@
+.\" $OpenBSD: X509_get0_signature.3,v 1.1 2018/02/19 08:20:26 schwarze Exp $
+.\" selective merge up to:
+.\" OpenSSL man3/X509_get0_signature 2f7a2520 Apr 25 17:28:08 2017 +0100
+.\"
+.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
+.\" Copyright (c) 2015 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
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\"    software must display the following acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\"    endorse or promote products derived from this software without
+.\"    prior written permission. For written permission, please contact
+.\"    openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\"    nor may "OpenSSL" appear in their names without prior written
+.\"    permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\"    acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: February 19 2018 $
+.Dt X509_GET0_SIGNATURE 3
+.Os
+.Sh NAME
+.Nm X509_get0_signature ,
+.Nm X509_get_signature_nid
+.Nd signature information
+.Sh SYNOPSIS
+.In openssl/x509.h
+.Ft void
+.Fo X509_get0_signature
+.Fa "const ASN1_BIT_STRING **psig"
+.Fa "const X509_ALGOR **palg"
+.Fa "const X509 *x"
+.Fc
+.Ft int
+.Fo X509_get_signature_nid
+.Fa "const X509 *x"
+.Fc
+.Sh DESCRIPTION
+.Fn X509_get0_signature
+sets
+.Pf * Fa psig
+to the signature of
+.Fa x
+and
+.Pf * Fa palg
+to the signature algorithm of
+.Fa x .
+The values returned are internal pointers
+that must not be freed by the caller.
+.Pp
+.Fn X509_get_signature_nid
+returns the NID corresponding to the signature algorithm of
+.Fa x .
+.Pp
+These functions provide lower level access to the signature
+for cases where an application wishes to analyse or generate a
+signature in a form where
+.Xr X509_sign 3
+is not appropriate, for example in a non-standard or unsupported format.
+.Sh SEE ALSO
+.Xr OBJ_obj2nid 3 ,
+.Xr X509_get_pubkey 3 ,
+.Xr X509_get_subject_name 3 ,
+.Xr X509_get_version 3 ,
+.Xr X509_new 3 ,
+.Xr X509_sign 3 ,
+.Xr X509_verify_cert 3
+.Sh HISTORY
+.Fn X509_get0_signature
+and
+.Fn X509_get_signature_nid
+first appeared in OpenSSL 1.0.2.
diff --git a/lib/libcrypto/man/X509_get_signature_nid.3 b/lib/libcrypto/man/X509_get_signature_nid.3
deleted file mode 100644 (file)
index 837b392..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-.\" $OpenBSD: X509_get_signature_nid.3,v 1.1 2018/02/14 18:50:47 schwarze Exp $
-.\" selective merge up to:
-.\" OpenSSL man3/X509_get0_signature 2f7a2520 Apr 25 17:28:08 2017 +0100
-.\"
-.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
-.\" Copyright (c) 2015 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
-.\" are met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
-.\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in
-.\"    the documentation and/or other materials provided with the
-.\"    distribution.
-.\"
-.\" 3. All advertising materials mentioning features or use of this
-.\"    software must display the following acknowledgment:
-.\"    "This product includes software developed by the OpenSSL Project
-.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
-.\"
-.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
-.\"    endorse or promote products derived from this software without
-.\"    prior written permission. For written permission, please contact
-.\"    openssl-core@openssl.org.
-.\"
-.\" 5. Products derived from this software may not be called "OpenSSL"
-.\"    nor may "OpenSSL" appear in their names without prior written
-.\"    permission of the OpenSSL Project.
-.\"
-.\" 6. Redistributions of any form whatsoever must retain the following
-.\"    acknowledgment:
-.\"    "This product includes software developed by the OpenSSL Project
-.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
-.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-.\" OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd $Mdocdate: February 14 2018 $
-.Dt X509_GET_SIGNATURE_NID 3
-.Os
-.Sh NAME
-.Nm X509_get_signature_nid
-.Nd signature information
-.Sh SYNOPSIS
-.In openssl/x509.h
-.Ft int
-.Fo X509_get_signature_nid
-.Fa "const X509 *x"
-.Fc
-.Sh DESCRIPTION
-.Fn X509_get_signature_nid
-returns the NID corresponding to the signature algorithm of
-.Fa x .
-.Sh SEE ALSO
-.Xr OBJ_obj2nid 3 ,
-.Xr X509_get_pubkey 3 ,
-.Xr X509_get_subject_name 3 ,
-.Xr X509_get_version 3 ,
-.Xr X509_new 3 ,
-.Xr X509_sign 3 ,
-.Xr X509_verify_cert 3
-.Sh HISTORY
-.Fn X509_get_signature_nid
-first appeared in OpenSSL 1.0.2.