.\"	$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>.
.\" Copyright (c) 2009, 2014 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: 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_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
.Ft int
.Fo X509_STORE_CTX_get_ex_new_index
.Fa "long argl"
.Fa "void *argp"
.Fa "CRYPTO_EX_new *new_func"
.Fa "CRYPTO_EX_dup *dup_func"
.Fa "CRYPTO_EX_free *free_func"
.Fc
.Ft int
.Fo X509_STORE_CTX_set_ex_data
.Fa "X509_STORE_CTX *d"
.Fa "int idx"
.Fa "void *arg"
.Fc
.Ft void *
.Fo X509_STORE_CTX_get_ex_data
.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
structures.
Their usage is identical to that of
.Xr RSA_get_ex_new_index 3 ,
.Xr RSA_set_ex_data 3 ,
and
.Xr RSA_get_ex_data 3 .
.Pp
This mechanism is used internally by the
.Xr ssl 3
library to store the
.Vt SSL
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
in SSLeay 0.9.0.
All these functions have been available since
.Ox 2.4 .