From 1bfa49e8d29f738ee5af179ad9aa12ee59dc6938 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Wed, 10 Jun 2020 11:43:08 +0000 Subject: [PATCH 18/87] document PKCS7_get_signer_info(3) --- src/lib/libcrypto/man/Makefile | 3 +- src/lib/libcrypto/man/PKCS7_get_signer_info.3 | 62 +++++++++++++++++++ src/lib/libcrypto/man/PKCS7_new.3 | 6 +- src/lib/libcrypto/man/PKCS7_sign.3 | 5 +- src/lib/libcrypto/man/PKCS7_sign_add_signer.3 | 7 ++- 5 files changed, 75 insertions(+), 8 deletions(-) create mode 100644 src/lib/libcrypto/man/PKCS7_get_signer_info.3 diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index 7effea837..05b1a54c8 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.166 2020/06/04 10:24:27 schwarze Exp $ +# $OpenBSD: Makefile,v 1.167 2020/06/10 11:43:07 schwarze Exp $ .include @@ -220,6 +220,7 @@ MAN= \ PKCS7_decrypt.3 \ PKCS7_encrypt.3 \ PKCS7_final.3 \ + PKCS7_get_signer_info.3 \ PKCS7_new.3 \ PKCS7_set_content.3 \ PKCS7_set_type.3 \ diff --git a/src/lib/libcrypto/man/PKCS7_get_signer_info.3 b/src/lib/libcrypto/man/PKCS7_get_signer_info.3 new file mode 100644 index 000000000..280f373ea --- /dev/null +++ b/src/lib/libcrypto/man/PKCS7_get_signer_info.3 @@ -0,0 +1,62 @@ +.\" $OpenBSD: PKCS7_get_signer_info.3,v 1.1 2020/06/10 11:43:08 schwarze Exp $ +.\" +.\" Copyright (c) 2020 Ingo Schwarze +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: June 10 2020 $ +.Dt PKCS7_GET_SIGNER_INFO 3 +.Os +.Sh NAME +.Nm PKCS7_get_signer_info +.Nd retrieve signerInfos from a SignedData object +.Sh SYNOPSIS +.In openssl/pkcs7.h +.Ft STACK_OF(PKCS7_SIGNER_INFO) * +.Fn PKCS7_get_signer_info "PKCS7 *p7" +.Sh DESCRIPTION +This function retrieves the set of +.Vt SignerInfo +structures from the +.Fa signerInfos +field of +.Fa p7 . +.Pp +These can subsequently be manipulated with the functions documented in +.Xr PKCS7_add_attribute 3 . +.Sh RETURN VALUES +.Fn PKCS7_get_signer_info +returns an internal pointer to a +.Vt STACK_OF(PKCS7_SIGNER_INFO) +object or +.Dv NULL +on failure. +It fails if +.Fa p7 +is +.Dv NULL , +if it has no content, +or if it is of a type other than +.Vt SignedData +or +.Vt SignedAndEnvelopedData . +.Sh SEE ALSO +.Xr PKCS7_add_attribute 3 , +.Xr PKCS7_final 3 , +.Xr PKCS7_new 3 , +.Xr PKCS7_sign 3 , +.Xr PKCS7_sign_add_signer 3 +.Sh HISTORY +.Fn PKCS7_get_signer_info +first appeared in SSLeay 0.8.1 and has been available since +.Ox 2.4 . diff --git a/src/lib/libcrypto/man/PKCS7_new.3 b/src/lib/libcrypto/man/PKCS7_new.3 index c5eebe96d..151261a31 100644 --- a/src/lib/libcrypto/man/PKCS7_new.3 +++ b/src/lib/libcrypto/man/PKCS7_new.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: PKCS7_new.3,v 1.11 2020/06/04 10:24:27 schwarze Exp $ +.\" $OpenBSD: PKCS7_new.3,v 1.12 2020/06/10 11:43:08 schwarze Exp $ .\" .\" Copyright (c) 2016 Ingo Schwarze .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 4 2020 $ +.Dd $Mdocdate: June 10 2020 $ .Dt PKCS7_NEW 3 .Os .Sh NAME @@ -251,6 +251,8 @@ frees .Xr PKCS7_dataInit 3 , .Xr PKCS7_decrypt 3 , .Xr PKCS7_encrypt 3 , +.Xr PKCS7_final 3 , +.Xr PKCS7_get_signer_info 3 , .Xr PKCS7_ISSUER_AND_SERIAL_digest 3 , .Xr PKCS7_set_content 3 , .Xr PKCS7_set_type 3 , diff --git a/src/lib/libcrypto/man/PKCS7_sign.3 b/src/lib/libcrypto/man/PKCS7_sign.3 index c9b13680c..37257e60f 100644 --- a/src/lib/libcrypto/man/PKCS7_sign.3 +++ b/src/lib/libcrypto/man/PKCS7_sign.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: PKCS7_sign.3,v 1.12 2020/06/04 10:24:27 schwarze Exp $ +.\" $OpenBSD: PKCS7_sign.3,v 1.13 2020/06/10 11:43:08 schwarze Exp $ .\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 .\" .\" This file was written by Dr. Stephen Henson . @@ -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: June 4 2020 $ +.Dd $Mdocdate: June 10 2020 $ .Dt PKCS7_SIGN 3 .Os .Sh NAME @@ -233,6 +233,7 @@ The error can be obtained from .Xr PKCS7_add_attribute 3 , .Xr PKCS7_encrypt 3 , .Xr PKCS7_final 3 , +.Xr PKCS7_get_signer_info 3 , .Xr PKCS7_new 3 , .Xr PKCS7_sign_add_signer 3 , .Xr PKCS7_verify 3 diff --git a/src/lib/libcrypto/man/PKCS7_sign_add_signer.3 b/src/lib/libcrypto/man/PKCS7_sign_add_signer.3 index 28d327fef..195d6388c 100644 --- a/src/lib/libcrypto/man/PKCS7_sign_add_signer.3 +++ b/src/lib/libcrypto/man/PKCS7_sign_add_signer.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: PKCS7_sign_add_signer.3,v 1.12 2020/06/04 10:24:27 schwarze Exp $ +.\" $OpenBSD: PKCS7_sign_add_signer.3,v 1.13 2020/06/10 11:43:08 schwarze Exp $ .\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 .\" .\" This file was written by Dr. Stephen Henson . @@ -49,12 +49,12 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: June 4 2020 $ +.Dd $Mdocdate: June 10 2020 $ .Dt PKCS7_SIGN_ADD_SIGNER 3 .Os .Sh NAME .Nm PKCS7_sign_add_signer -.Nd add a signer PKCS7 signed data structure +.Nd add a signer to a SignedData structure .Sh SYNOPSIS .In openssl/pkcs7.h .Ft PKCS7_SIGNER_INFO * @@ -178,6 +178,7 @@ In some cases of failure, the reason can be determined with .Xr EVP_DigestInit 3 , .Xr PKCS7_add_attribute 3 , .Xr PKCS7_final 3 , +.Xr PKCS7_get_signer_info 3 , .Xr PKCS7_new 3 , .Xr PKCS7_sign 3 .Sh HISTORY -- 2.17.1