From: tb <tb@openbsd.org>
Date: Sat, 23 Oct 2021 15:27:46 +0000 (+0000)
Subject: Import documentation for X509_SIG_get{0,m} from OpenSSL. Will be linked
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=d8fe5f044d08540fe178ae18fcf9c48ad462cce5;p=openbsd

Import documentation for X509_SIG_get{0,m} from OpenSSL. Will be linked
to the build after the bump.

tweak & lgtm schwarze
---

diff --git a/lib/libssl/man/X509_SIG_get0.3 b/lib/libssl/man/X509_SIG_get0.3
new file mode 100644
index 00000000000..a05c9c25b7a
--- /dev/null
+++ b/lib/libssl/man/X509_SIG_get0.3
@@ -0,0 +1,90 @@
+.\" $OpenBSD: X509_SIG_get0.3,v 1.1 2021/10/23 15:27:46 tb Exp $
+.\" full merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800
+.\"
+.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
+.\" Copyright (c) 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
+.\" 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: October 23 2021 $
+.Dt X509_SIG_GET0 3
+.Os
+.Sh NAME
+.Nm X509_SIG_get0 ,
+.Nm X509_SIG_getm
+.Nd DigestInfo functions
+.Sh SYNOPSIS
+.In openssl/x509.h
+.Ft void
+.Fo X509_SIG_get0
+.Fa "const X509_SIG *sig"
+.Fa "const X509_ALGOR **palg"
+.Fa "const ASN1_OCTET_STRING **pdigest"
+.Fc
+.Ft void
+.Fo X509_SIG_getm
+.Fa "X509_SIG *sig"
+.Fa "X509_ALGOR **palg"
+.Fa "ASN1_OCTET_STRING **pdigest"
+.Fc
+.Sh DESCRIPTION
+.Fn X509_SIG_get0
+returns pointers to the algorithm identifier and digest value in
+.Fa sig .
+.Fn X509_SIG_getm
+is identical to
+.Fn X509_SIG_get0 ,
+except the pointers returned are not constant and can be modified,
+for example to initialise them.
+.Sh SEE ALSO
+.Xr d2i_X509 3 ,
+.Xr X509_SIG_new 3
+.Sh HISTORY
+.Fn X509_SIG_get0
+and
+.Fn X509_SIG_getm
+first appeared in OpenSSL 1.1.0 and have been available since
+.Ox 7.1 .