1/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57/* ====================================================================
58 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com). */
108
109#ifndef OPENSSL_HEADER_EX_DATA_H
110#define OPENSSL_HEADER_EX_DATA_H
111
112#include <openssl/base.h>
113
114#include <openssl/stack.h>
115
116#if defined(__cplusplus)
117extern "C" {
118#endif
119
120
121// ex_data is a mechanism for associating arbitrary extra data with objects.
122// For each type of object that supports ex_data, different users can be
123// assigned indexes in which to store their data. Each index has callback
124// functions that are called when an object of that type is freed or
125// duplicated.
126
127
128typedef struct crypto_ex_data_st CRYPTO_EX_DATA;
129
130
131// Type-specific functions.
132//
133// Each type that supports ex_data provides three functions:
134
135#if 0 // Sample
136
137// TYPE_get_ex_new_index allocates a new index for |TYPE|. An optional
138// |free_func| argument may be provided which is called when the owning object
139// is destroyed. See |CRYPTO_EX_free| for details. The |argl| and |argp|
140// arguments are opaque values that are passed to the callback. It returns the
141// new index or a negative number on error.
142OPENSSL_EXPORT int TYPE_get_ex_new_index(long argl, void *argp,
143 CRYPTO_EX_unused *unused,
144 CRYPTO_EX_dup *dup_unused,
145 CRYPTO_EX_free *free_func);
146
147// TYPE_set_ex_data sets an extra data pointer on |t|. The |index| argument
148// should have been returned from a previous call to |TYPE_get_ex_new_index|.
149OPENSSL_EXPORT int TYPE_set_ex_data(TYPE *t, int index, void *arg);
150
151// TYPE_get_ex_data returns an extra data pointer for |t|, or NULL if no such
152// pointer exists. The |index| argument should have been returned from a
153// previous call to |TYPE_get_ex_new_index|.
154OPENSSL_EXPORT void *TYPE_get_ex_data(const TYPE *t, int index);
155
156#endif // Sample
157
158
159// Callback types.
160
161// CRYPTO_EX_free is a callback function that is called when an object of the
162// class with extra data pointers is being destroyed. For example, if this
163// callback has been passed to |SSL_get_ex_new_index| then it may be called each
164// time an |SSL*| is destroyed.
165//
166// The callback is passed the new object (i.e. the |SSL*|) in |parent|. The
167// arguments |argl| and |argp| contain opaque values that were given to
168// |CRYPTO_get_ex_new_index|. The callback should return one on success, but
169// the value is ignored.
170//
171// This callback may be called with a NULL value for |ptr| if |parent| has no
172// value set for this index. However, the callbacks may also be skipped entirely
173// if no extra data pointers are set on |parent| at all.
174typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
175 int index, long argl, void *argp);
176
177
178// Deprecated functions.
179
180// CRYPTO_cleanup_all_ex_data does nothing.
181OPENSSL_EXPORT void CRYPTO_cleanup_all_ex_data(void);
182
183// CRYPTO_EX_dup is a legacy callback function type which is ignored.
184typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
185 void **from_d, int index, long argl, void *argp);
186
187
188// Private structures.
189
190// CRYPTO_EX_unused is a placeholder for an unused callback. It is aliased to
191// int to ensure non-NULL callers fail to compile rather than fail silently.
192typedef int CRYPTO_EX_unused;
193
194struct crypto_ex_data_st {
195 STACK_OF(void) *sk;
196};
197
198
199#if defined(__cplusplus)
200} // extern C
201#endif
202
203#endif // OPENSSL_HEADER_EX_DATA_H
204