1.\"	$OpenBSD: SSL_SESSION_get_ex_new_index.3,v 1.3 2018/03/21 08:06:34 schwarze Exp $
2.\"	OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400
3.\"
4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5.\" Copyright (c) 2001, 2005 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: March 21 2018 $
52.Dt SSL_SESSION_GET_EX_NEW_INDEX 3
53.Os
54.Sh NAME
55.Nm SSL_SESSION_get_ex_new_index ,
56.Nm SSL_SESSION_set_ex_data ,
57.Nm SSL_SESSION_get_ex_data
58.Nd internal application specific data functions
59.Sh SYNOPSIS
60.In openssl/ssl.h
61.Ft int
62.Fo SSL_SESSION_get_ex_new_index
63.Fa "long argl"
64.Fa "void *argp"
65.Fa "CRYPTO_EX_new *new_func"
66.Fa "CRYPTO_EX_dup *dup_func"
67.Fa "CRYPTO_EX_free *free_func"
68.Fc
69.Ft int
70.Fn SSL_SESSION_set_ex_data "SSL_SESSION *session" "int idx" "void *arg"
71.Ft void *
72.Fn SSL_SESSION_get_ex_data "const SSL_SESSION *session" "int idx"
73.Bd -literal
74 typedef int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
75                int idx, long argl, void *argp);
76 typedef void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
77                int idx, long argl, void *argp);
78 typedef int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
79                int idx, long argl, void *argp);
80.Ed
81.Sh DESCRIPTION
82Several OpenSSL structures can have application specific data attached to them.
83These functions are used internally by OpenSSL to manipulate
84application-specific data attached to a specific structure.
85.Pp
86.Fn SSL_SESSION_get_ex_new_index
87is used to register a new index for application-specific data.
88.Pp
89.Fn SSL_SESSION_set_ex_data
90is used to store application data at
91.Fa arg
92for
93.Fa idx
94into the
95.Fa session
96object.
97.Pp
98.Fn SSL_SESSION_get_ex_data
99is used to retrieve the information for
100.Fa idx
101from
102.Fa session .
103.Pp
104A detailed description for the
105.Fn *_get_ex_new_index
106functionality
107can be found in
108.Xr RSA_get_ex_new_index 3 .
109The
110.Fn *_get_ex_data
111and
112.Fn *_set_ex_data
113functionality is described in
114.Xr CRYPTO_set_ex_data 3 .
115.Sh WARNINGS
116The application data is only maintained for sessions held in memory.
117The application data is not included when dumping the session with
118.Xr i2d_SSL_SESSION 3
119(and all functions indirectly calling the dump functions like
120.Xr PEM_write_SSL_SESSION 3
121and
122.Xr PEM_write_bio_SSL_SESSION 3 )
123and can therefore not be restored.
124.Sh SEE ALSO
125.Xr CRYPTO_set_ex_data 3 ,
126.Xr RSA_get_ex_new_index 3 ,
127.Xr ssl 3
128.Sh HISTORY
129.Fn SSL_SESSION_get_ex_new_index ,
130.Fn SSL_SESSION_set_ex_data ,
131and
132.Fn SSL_SESSION_get_ex_data
133first appeared in SSLeay 0.9.0 and have been available since
134.Ox 2.4 .
135