document X509_STORE_CTX_set_app_data(3) and X509_STORE_CTX_get_app_data(3)

Author: schwarze

src/lib/libcrypto/man/X509_STORE_CTX_get_ex_new_index.3

@@ -1,4 +1,4 @@
-.\"	$OpenBSD: X509_STORE_CTX_get_ex_new_index.3,v 1.5 2019/06/06 01:06:59 schwarze Exp $
+.\"	$OpenBSD: X509_STORE_CTX_get_ex_new_index.3,v 1.6 2021/07/29 08:32:13 schwarze Exp $
 .\"	OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400
 .\"
 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,13 +48,15 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: June 6 2019 $
+.Dd $Mdocdate: July 29 2021 $
 .Dt X509_STORE_CTX_GET_EX_NEW_INDEX 3
 .Os
 .Sh NAME
 .Nm X509_STORE_CTX_get_ex_new_index ,
 .Nm X509_STORE_CTX_set_ex_data ,
-.Nm X509_STORE_CTX_get_ex_data
+.Nm X509_STORE_CTX_get_ex_data ,
+.Nm X509_STORE_CTX_set_app_data ,
+.Nm X509_STORE_CTX_get_app_data
 .Nd add application specific data to X509_STORE_CTX structures
 .Sh SYNOPSIS
 .In openssl/x509_vfy.h
@@ -77,6 +79,15 @@
 .Fa "X509_STORE_CTX *d"
 .Fa "int idx"
 .Fc
+.Ft int
+.Fo X509_STORE_CTX_set_app_data
+.Fa "X509_STORE_CTX *d"
+.Fa "void *arg"
+.Fc
+.Ft void *
+.Fo X509_STORE_CTX_get_app_data
+.Fa "X509_STORE_CTX *d"
+.Fc
 .Sh DESCRIPTION
 These functions handle application specific data in
 .Vt X509_STORE_CTX
@@ -94,13 +105,49 @@ library to store the
 structure associated with a verification operation in an
 .Vt X509_STORE_CTX
 structure.
+.Pp
+.Fn X509_STORE_CTX_set_app_data
+and
+.Fn X509_STORE_CTX_get_app_data
+are macros calling
+.Fn X509_STORE_CTX_set_ex_data
+and
+.Fn X509_STORE_CTX_get_ex_data ,
+respectively, with an
+.Fa idx
+of 0.
+.Sh RETURN VALUES
+.Fn X509_STORE_CTX_get_ex_new_index
+returns a new index or \-1 on failure.
+.Pp
+.Fn X509_STORE_CTX_set_ex_data
+and
+.Fn X509_STORE_CTX_set_app_data
+return 1 on success or 0 on failure.
+.Pp
+.Fn X509_STORE_CTX_get_ex_data
+and
+.Fn X509_STORE_CTX_get_app_data
+return the application data or
+.Dv NULL
+on failure.
+.Dv NULL
+may also be valid application data, but currently these functions
+can only fail if given an invalid
+.Fa idx
+argument.
 .Sh SEE ALSO
 .Xr RSA_get_ex_new_index 3 ,
 .Xr X509_STORE_CTX_new 3
 .Sh HISTORY
+.Fn X509_STORE_CTX_set_app_data
+and
+.Fn X509_STORE_CTX_get_app_data
+first appeared in SSLeay 0.8.0 and
 .Fn X509_STORE_CTX_get_ex_new_index ,
 .Fn X509_STORE_CTX_set_ex_data ,
 and
 .Fn X509_STORE_CTX_get_ex_data
-first appeared in SSLeay 0.9.0 and have been available since
+in SSLeay 0.9.0.
+All these functions have been available since
 .Ox 2.4 .