summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/X509_STORE_CTX_get_error.3
diff options
context:
space:
mode:
authorschwarze <>2021-07-22 14:30:38 +0000
committerschwarze <>2021-07-22 14:30:38 +0000
commitfbd27065ffc27d490c363b3babac8a57cc51ba7a (patch)
tree8ffc5d1fe1b1ac730149291e978c927f29d91b17 /src/lib/libcrypto/man/X509_STORE_CTX_get_error.3
parentadff88ee2a38aece8bcaf0ba0c293488832d928f (diff)
downloadopenbsd-fbd27065ffc27d490c363b3babac8a57cc51ba7a.tar.gz
openbsd-fbd27065ffc27d490c363b3babac8a57cc51ba7a.tar.bz2
openbsd-fbd27065ffc27d490c363b3babac8a57cc51ba7a.zip
Move X509_STORE_CTX_get0_cert(3) to the X509_STORE_CTX_new(3) manual.
OpenSSL documents it in X509_STORE_CTX_get_error(3), but it is misplaced there. It has nothing to do with accessing status or error information but merely retrieves a pointer to the certificate that the users wants to validate. It is a companion function to X509_STORE_CTX_init(3), X509_STORE_CTX_set_cert(3), X509_STORE_CTX_get0_store(3), and X509_STORE_CTX_get0_untrusted(3). While here: 1. Clarify how the new, init, verify, cleanup, and free calls interact, and who owns the memory involved, because this is all really confusing from the user perspective. 2. Clarify how X509_STORE_CTX_init(3), X509_STORE_CTX_set_cert(3), and X509_STORE_CTX_set_chain(3) partially override each other. 3. Move X509_STORE_CTX_set0_untrusted(3) to the proper place because it is the same as X509_STORE_CTX_set_chain(3). 4. Add a few missing words and improve some wordings.
Diffstat (limited to 'src/lib/libcrypto/man/X509_STORE_CTX_get_error.3')
-rw-r--r--src/lib/libcrypto/man/X509_STORE_CTX_get_error.323
1 files changed, 6 insertions, 17 deletions
diff --git a/src/lib/libcrypto/man/X509_STORE_CTX_get_error.3 b/src/lib/libcrypto/man/X509_STORE_CTX_get_error.3
index 3294658ac6..6192c0d2fc 100644
--- a/src/lib/libcrypto/man/X509_STORE_CTX_get_error.3
+++ b/src/lib/libcrypto/man/X509_STORE_CTX_get_error.3
@@ -1,13 +1,13 @@
1.\" $OpenBSD: X509_STORE_CTX_get_error.3,v 1.14 2021/07/21 15:03:45 schwarze Exp $ 1.\" $OpenBSD: X509_STORE_CTX_get_error.3,v 1.15 2021/07/22 14:30:38 schwarze Exp $
2.\" full merge up to: 2.\" full merge up to:
3.\" OpenSSL crypto/X509_STORE_CTX_get_error f0e0fd51 Apr 14 23:59:26 2016 -0400 3.\" OpenSSL crypto/X509_STORE_CTX_get_error f0e0fd51 Apr 14 23:59:26 2016 -0400
4.\" selective merge up to: 4.\" selective merge up to:
5.\" OpenSSL man3/X509_STORE_CTX_get_error 24a535ea Sep 22 13:14:20 2020 +0100 5.\" OpenSSL man3/X509_STORE_CTX_get_error 24a535ea Sep 22 13:14:20 2020 +0100
6.\" OpenSSL man3/X509_STORE_CTX_new 24a535ea Sep 22 13:14:20 2020 +0100 6.\" OpenSSL man3/X509_STORE_CTX_new 24a535ea Sep 22 13:14:20 2020 +0100
7.\" 7.\"
8.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 8.\" This file was written by Dr. Stephen Henson <steve@openssl.org>
9.\" Copyright (c) 2009, 2013, 2015, 2016 The OpenSSL Project. 9.\" and Rich Salz <rsalz@openssl.org>.
10.\" All rights reserved. 10.\" Copyright (c) 2009, 2016 The OpenSSL Project. All rights reserved.
11.\" 11.\"
12.\" Redistribution and use in source and binary forms, with or without 12.\" Redistribution and use in source and binary forms, with or without
13.\" modification, are permitted provided that the following conditions 13.\" modification, are permitted provided that the following conditions
@@ -53,7 +53,7 @@
53.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 53.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54.\" OF THE POSSIBILITY OF SUCH DAMAGE. 54.\" OF THE POSSIBILITY OF SUCH DAMAGE.
55.\" 55.\"
56.Dd $Mdocdate: July 21 2021 $ 56.Dd $Mdocdate: July 22 2021 $
57.Dt X509_STORE_CTX_GET_ERROR 3 57.Dt X509_STORE_CTX_GET_ERROR 3
58.Os 58.Os
59.Sh NAME 59.Sh NAME
@@ -61,7 +61,6 @@
61.Nm X509_STORE_CTX_set_error , 61.Nm X509_STORE_CTX_set_error ,
62.Nm X509_STORE_CTX_get_error_depth , 62.Nm X509_STORE_CTX_get_error_depth ,
63.Nm X509_STORE_CTX_get_current_cert , 63.Nm X509_STORE_CTX_get_current_cert ,
64.Nm X509_STORE_CTX_get0_cert ,
65.Nm X509_STORE_CTX_get0_chain , 64.Nm X509_STORE_CTX_get0_chain ,
66.Nm X509_STORE_CTX_get_chain , 65.Nm X509_STORE_CTX_get_chain ,
67.Nm X509_STORE_CTX_get1_chain , 66.Nm X509_STORE_CTX_get1_chain ,
@@ -86,10 +85,6 @@
86.Fo X509_STORE_CTX_get_current_cert 85.Fo X509_STORE_CTX_get_current_cert
87.Fa "X509_STORE_CTX *ctx" 86.Fa "X509_STORE_CTX *ctx"
88.Fc 87.Fc
89.Ft X509 *
90.Fo X509_STORE_CTX_get0_cert
91.Fa "X509_STORE_CTX *ctx"
92.Fc
93.Ft STACK_OF(X509) * 88.Ft STACK_OF(X509) *
94.Fo X509_STORE_CTX_get0_chain 89.Fo X509_STORE_CTX_get0_chain
95.Fa "X509_STORE_CTX *ctx" 90.Fa "X509_STORE_CTX *ctx"
@@ -195,10 +190,6 @@ returns the certificate which caused the error or
195.Dv NULL 190.Dv NULL
196if no certificate is relevant to the error. 191if no certificate is relevant to the error.
197.Pp 192.Pp
198.Fn X509_STORE_CTX_get0_cert
199retrieves an internal pointer to the certificate being verified by
200.Fa ctx .
201.Pp
202.Fn X509_STORE_CTX_get0_chain , 193.Fn X509_STORE_CTX_get0_chain ,
203.Fn X509_STORE_CTX_get_chain , 194.Fn X509_STORE_CTX_get_chain ,
204and 195and
@@ -399,8 +390,6 @@ first appeared in SSLeay 0.8.0 and have been available since
399first appeared in OpenSSL 0.9.5 and has been available since 390first appeared in OpenSSL 0.9.5 and has been available since
400.Ox 2.7 . 391.Ox 2.7 .
401.Pp 392.Pp
402.Fn X509_STORE_CTX_get0_cert
403and
404.Fn X509_STORE_CTX_get0_chain 393.Fn X509_STORE_CTX_get0_chain
405first appeared in OpenSSL 1.1.0 and have been available since 394first appeared in OpenSSL 1.1.0 and has been available since
406.Ox 6.3 . 395.Ox 6.3 .