1 /* dso.h -*- mode:C; c-file-style: "eay" -*- */
\r
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
\r
5 /* ====================================================================
\r
6 * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
\r
8 * Redistribution and use in source and binary forms, with or without
\r
9 * modification, are permitted provided that the following conditions
\r
12 * 1. Redistributions of source code must retain the above copyright
\r
13 * notice, this list of conditions and the following disclaimer.
\r
15 * 2. Redistributions in binary form must reproduce the above copyright
\r
16 * notice, this list of conditions and the following disclaimer in
\r
17 * the documentation and/or other materials provided with the
\r
20 * 3. All advertising materials mentioning features or use of this
\r
21 * software must display the following acknowledgment:
\r
22 * "This product includes software developed by the OpenSSL Project
\r
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
\r
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
\r
26 * endorse or promote products derived from this software without
\r
27 * prior written permission. For written permission, please contact
\r
28 * licensing@OpenSSL.org.
\r
30 * 5. Products derived from this software may not be called "OpenSSL"
\r
31 * nor may "OpenSSL" appear in their names without prior written
\r
32 * permission of the OpenSSL Project.
\r
34 * 6. Redistributions of any form whatsoever must retain the following
\r
36 * "This product includes software developed by the OpenSSL Project
\r
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
\r
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
\r
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
\r
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
\r
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
\r
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
\r
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
\r
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
\r
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\r
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
\r
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
\r
51 * ====================================================================
\r
53 * This product includes cryptographic software written by Eric Young
\r
54 * (eay@cryptsoft.com). This product includes software written by Tim
\r
55 * Hudson (tjh@cryptsoft.com).
\r
59 #ifndef HEADER_DSO_H
\r
60 #define HEADER_DSO_H
\r
62 #include <openssl/crypto.h>
\r
68 /* These values are used as commands to DSO_ctrl() */
\r
69 #define DSO_CTRL_GET_FLAGS 1
\r
70 #define DSO_CTRL_SET_FLAGS 2
\r
71 #define DSO_CTRL_OR_FLAGS 3
\r
73 /* By default, DSO_load() will translate the provided filename into a form
\r
74 * typical for the platform (more specifically the DSO_METHOD) using the
\r
75 * dso_name_converter function of the method. Eg. win32 will transform "blah"
\r
76 * into "blah.dll", and dlfcn will transform it into "libblah.so". The
\r
77 * behaviour can be overriden by setting the name_converter callback in the DSO
\r
78 * object (using DSO_set_name_converter()). This callback could even utilise
\r
79 * the DSO_METHOD's converter too if it only wants to override behaviour for
\r
80 * one or two possible DSO methods. However, the following flag can be set in a
\r
81 * DSO to prevent *any* native name-translation at all - eg. if the caller has
\r
82 * prompted the user for a path to a driver library so the filename should be
\r
83 * interpreted as-is. */
\r
84 #define DSO_FLAG_NO_NAME_TRANSLATION 0x01
\r
85 /* An extra flag to give if only the extension should be added as
\r
86 * translation. This is obviously only of importance on Unix and
\r
87 * other operating systems where the translation also may prefix
\r
88 * the name with something, like 'lib', and ignored everywhere else.
\r
89 * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used
\r
90 * at the same time. */
\r
91 #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02
\r
93 /* The following flag controls the translation of symbol names to upper
\r
94 * case. This is currently only being implemented for OpenVMS.
\r
96 #define DSO_FLAG_UPCASE_SYMBOL 0x10
\r
98 /* This flag loads the library with public symbols.
\r
99 * Meaning: The exported symbols of this library are public
\r
100 * to all libraries loaded after this library.
\r
101 * At the moment only implemented in unix.
\r
103 #define DSO_FLAG_GLOBAL_SYMBOLS 0x20
\r
106 typedef void (*DSO_FUNC_TYPE)(void);
\r
108 typedef struct dso_st DSO;
\r
110 /* The function prototype used for method functions (or caller-provided
\r
111 * callbacks) that transform filenames. They are passed a DSO structure pointer
\r
112 * (or NULL if they are to be used independantly of a DSO object) and a
\r
113 * filename to transform. They should either return NULL (if there is an error
\r
114 * condition) or a newly allocated string containing the transformed form that
\r
115 * the caller will need to free with OPENSSL_free() when done. */
\r
116 typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
\r
117 /* The function prototype used for method functions (or caller-provided
\r
118 * callbacks) that merge two file specifications. They are passed a
\r
119 * DSO structure pointer (or NULL if they are to be used independantly of
\r
120 * a DSO object) and two file specifications to merge. They should
\r
121 * either return NULL (if there is an error condition) or a newly allocated
\r
122 * string containing the result of merging that the caller will need
\r
123 * to free with OPENSSL_free() when done.
\r
124 * Here, merging means that bits and pieces are taken from each of the
\r
125 * file specifications and added together in whatever fashion that is
\r
126 * sensible for the DSO method in question. The only rule that really
\r
127 * applies is that if the two specification contain pieces of the same
\r
128 * type, the copy from the string string takes priority. One could see
\r
129 * it as the first specification is the one given by the user and the
\r
130 * second being a bunch of defaults to add on if they're missing in the
\r
132 typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
\r
134 typedef struct dso_meth_st
\r
137 /* Loads a shared library, NB: new DSO_METHODs must ensure that a
\r
138 * successful load populates the loaded_filename field, and likewise a
\r
139 * successful unload OPENSSL_frees and NULLs it out. */
\r
140 int (*dso_load)(DSO *dso);
\r
141 /* Unloads a shared library */
\r
142 int (*dso_unload)(DSO *dso);
\r
143 /* Binds a variable */
\r
144 void *(*dso_bind_var)(DSO *dso, const char *symname);
\r
145 /* Binds a function - assumes a return type of DSO_FUNC_TYPE.
\r
146 * This should be cast to the real function prototype by the
\r
147 * caller. Platforms that don't have compatible representations
\r
148 * for different prototypes (this is possible within ANSI C)
\r
149 * are highly unlikely to have shared libraries at all, let
\r
150 * alone a DSO_METHOD implemented for them. */
\r
151 DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname);
\r
153 /* I don't think this would actually be used in any circumstances. */
\r
155 /* Unbinds a variable */
\r
156 int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr);
\r
157 /* Unbinds a function */
\r
158 int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
\r
160 /* The generic (yuck) "ctrl()" function. NB: Negative return
\r
161 * values (rather than zero) indicate errors. */
\r
162 long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg);
\r
163 /* The default DSO_METHOD-specific function for converting filenames to
\r
164 * a canonical native form. */
\r
165 DSO_NAME_CONVERTER_FUNC dso_name_converter;
\r
166 /* The default DSO_METHOD-specific function for converting filenames to
\r
167 * a canonical native form. */
\r
168 DSO_MERGER_FUNC dso_merger;
\r
170 /* [De]Initialisation handlers. */
\r
171 int (*init)(DSO *dso);
\r
172 int (*finish)(DSO *dso);
\r
175 /**********************************************************************/
\r
176 /* The low-level handle type used to refer to a loaded shared library */
\r
181 /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
\r
182 * doesn't use anything but will need to cache the filename
\r
183 * for use in the dso_bind handler. All in all, let each
\r
184 * method control its own destiny. "Handles" and such go in
\r
189 /* For use by applications etc ... use this for your bits'n'pieces,
\r
190 * don't touch meth_data! */
\r
191 CRYPTO_EX_DATA ex_data;
\r
192 /* If this callback function pointer is set to non-NULL, then it will
\r
193 * be used in DSO_load() in place of meth->dso_name_converter. NB: This
\r
194 * should normally set using DSO_set_name_converter(). */
\r
195 DSO_NAME_CONVERTER_FUNC name_converter;
\r
196 /* If this callback function pointer is set to non-NULL, then it will
\r
197 * be used in DSO_load() in place of meth->dso_merger. NB: This
\r
198 * should normally set using DSO_set_merger(). */
\r
199 DSO_MERGER_FUNC merger;
\r
200 /* This is populated with (a copy of) the platform-independant
\r
201 * filename used for this DSO. */
\r
203 /* This is populated with (a copy of) the translated filename by which
\r
204 * the DSO was actually loaded. It is NULL iff the DSO is not currently
\r
205 * loaded. NB: This is here because the filename translation process
\r
206 * may involve a callback being invoked more than once not only to
\r
207 * convert to a platform-specific form, but also to try different
\r
208 * filenames in the process of trying to perform a load. As such, this
\r
209 * variable can be used to indicate (a) whether this DSO structure
\r
210 * corresponds to a loaded library or not, and (b) the filename with
\r
211 * which it was actually loaded. */
\r
212 char *loaded_filename;
\r
216 DSO * DSO_new(void);
\r
217 DSO * DSO_new_method(DSO_METHOD *method);
\r
218 int DSO_free(DSO *dso);
\r
219 int DSO_flags(DSO *dso);
\r
220 int DSO_up_ref(DSO *dso);
\r
221 long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
\r
223 /* This function sets the DSO's name_converter callback. If it is non-NULL,
\r
224 * then it will be used instead of the associated DSO_METHOD's function. If
\r
225 * oldcb is non-NULL then it is set to the function pointer value being
\r
226 * replaced. Return value is non-zero for success. */
\r
227 int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
\r
228 DSO_NAME_CONVERTER_FUNC *oldcb);
\r
229 /* These functions can be used to get/set the platform-independant filename
\r
230 * used for a DSO. NB: set will fail if the DSO is already loaded. */
\r
231 const char *DSO_get_filename(DSO *dso);
\r
232 int DSO_set_filename(DSO *dso, const char *filename);
\r
233 /* This function will invoke the DSO's name_converter callback to translate a
\r
234 * filename, or if the callback isn't set it will instead use the DSO_METHOD's
\r
235 * converter. If "filename" is NULL, the "filename" in the DSO itself will be
\r
236 * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
\r
237 * simply duplicated. NB: This function is usually called from within a
\r
238 * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that
\r
239 * caller-created DSO_METHODs can do the same thing. A non-NULL return value
\r
240 * will need to be OPENSSL_free()'d. */
\r
241 char *DSO_convert_filename(DSO *dso, const char *filename);
\r
242 /* This function will invoke the DSO's merger callback to merge two file
\r
243 * specifications, or if the callback isn't set it will instead use the
\r
244 * DSO_METHOD's merger. A non-NULL return value will need to be
\r
245 * OPENSSL_free()'d. */
\r
246 char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
\r
247 /* If the DSO is currently loaded, this returns the filename that it was loaded
\r
248 * under, otherwise it returns NULL. So it is also useful as a test as to
\r
249 * whether the DSO is currently loaded. NB: This will not necessarily return
\r
250 * the same value as DSO_convert_filename(dso, dso->filename), because the
\r
251 * DSO_METHOD's load function may have tried a variety of filenames (with
\r
252 * and/or without the aid of the converters) before settling on the one it
\r
253 * actually loaded. */
\r
254 const char *DSO_get_loaded_filename(DSO *dso);
\r
256 void DSO_set_default_method(DSO_METHOD *meth);
\r
257 DSO_METHOD *DSO_get_default_method(void);
\r
258 DSO_METHOD *DSO_get_method(DSO *dso);
\r
259 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
\r
261 /* The all-singing all-dancing load function, you normally pass NULL
\r
262 * for the first and third parameters. Use DSO_up and DSO_free for
\r
263 * subsequent reference count handling. Any flags passed in will be set
\r
264 * in the constructed DSO after its init() function but before the
\r
265 * load operation. If 'dso' is non-NULL, 'flags' is ignored. */
\r
266 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
\r
268 /* This function binds to a variable inside a shared library. */
\r
269 void *DSO_bind_var(DSO *dso, const char *symname);
\r
271 /* This function binds to a function inside a shared library. */
\r
272 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
\r
274 /* This method is the default, but will beg, borrow, or steal whatever
\r
275 * method should be the default on any particular platform (including
\r
276 * DSO_METH_null() if necessary). */
\r
277 DSO_METHOD *DSO_METHOD_openssl(void);
\r
279 /* This method is defined for all platforms - if a platform has no
\r
280 * DSO support then this will be the only method! */
\r
281 DSO_METHOD *DSO_METHOD_null(void);
\r
283 /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
\r
284 * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
\r
285 * this method. If not, this method will return NULL. */
\r
286 DSO_METHOD *DSO_METHOD_dlfcn(void);
\r
288 /* If DSO_DL is defined, the standard dl.h-style functions (shl_load,
\r
289 * shl_unload, shl_findsym, etc) will be used and incorporated into
\r
290 * this method. If not, this method will return NULL. */
\r
291 DSO_METHOD *DSO_METHOD_dl(void);
\r
293 /* If WIN32 is defined, use DLLs. If not, return NULL. */
\r
294 DSO_METHOD *DSO_METHOD_win32(void);
\r
296 /* If VMS is defined, use shared images. If not, return NULL. */
\r
297 DSO_METHOD *DSO_METHOD_vms(void);
\r
299 /* BEGIN ERROR CODES */
\r
300 /* The following lines are auto generated by the script mkerr.pl. Any changes
\r
301 * made after this point may be overwritten when the script is next run.
\r
303 void ERR_load_DSO_strings(void);
\r
305 /* Error codes for the DSO functions. */
\r
307 /* Function codes. */
\r
308 #define DSO_F_DLFCN_BIND_FUNC 100
\r
309 #define DSO_F_DLFCN_BIND_VAR 101
\r
310 #define DSO_F_DLFCN_LOAD 102
\r
311 #define DSO_F_DLFCN_MERGER 130
\r
312 #define DSO_F_DLFCN_NAME_CONVERTER 123
\r
313 #define DSO_F_DLFCN_UNLOAD 103
\r
314 #define DSO_F_DL_BIND_FUNC 104
\r
315 #define DSO_F_DL_BIND_VAR 105
\r
316 #define DSO_F_DL_LOAD 106
\r
317 #define DSO_F_DL_MERGER 131
\r
318 #define DSO_F_DL_NAME_CONVERTER 124
\r
319 #define DSO_F_DL_UNLOAD 107
\r
320 #define DSO_F_DSO_BIND_FUNC 108
\r
321 #define DSO_F_DSO_BIND_VAR 109
\r
322 #define DSO_F_DSO_CONVERT_FILENAME 126
\r
323 #define DSO_F_DSO_CTRL 110
\r
324 #define DSO_F_DSO_FREE 111
\r
325 #define DSO_F_DSO_GET_FILENAME 127
\r
326 #define DSO_F_DSO_GET_LOADED_FILENAME 128
\r
327 #define DSO_F_DSO_LOAD 112
\r
328 #define DSO_F_DSO_MERGE 132
\r
329 #define DSO_F_DSO_NEW_METHOD 113
\r
330 #define DSO_F_DSO_SET_FILENAME 129
\r
331 #define DSO_F_DSO_SET_NAME_CONVERTER 122
\r
332 #define DSO_F_DSO_UP_REF 114
\r
333 #define DSO_F_VMS_BIND_SYM 115
\r
334 #define DSO_F_VMS_LOAD 116
\r
335 #define DSO_F_VMS_MERGER 133
\r
336 #define DSO_F_VMS_UNLOAD 117
\r
337 #define DSO_F_WIN32_BIND_FUNC 118
\r
338 #define DSO_F_WIN32_BIND_VAR 119
\r
339 #define DSO_F_WIN32_JOINER 135
\r
340 #define DSO_F_WIN32_LOAD 120
\r
341 #define DSO_F_WIN32_MERGER 134
\r
342 #define DSO_F_WIN32_NAME_CONVERTER 125
\r
343 #define DSO_F_WIN32_SPLITTER 136
\r
344 #define DSO_F_WIN32_UNLOAD 121
\r
346 /* Reason codes. */
\r
347 #define DSO_R_CTRL_FAILED 100
\r
348 #define DSO_R_DSO_ALREADY_LOADED 110
\r
349 #define DSO_R_EMPTY_FILE_STRUCTURE 113
\r
350 #define DSO_R_FAILURE 114
\r
351 #define DSO_R_FILENAME_TOO_BIG 101
\r
352 #define DSO_R_FINISH_FAILED 102
\r
353 #define DSO_R_INCORRECT_FILE_SYNTAX 115
\r
354 #define DSO_R_LOAD_FAILED 103
\r
355 #define DSO_R_NAME_TRANSLATION_FAILED 109
\r
356 #define DSO_R_NO_FILENAME 111
\r
357 #define DSO_R_NO_FILE_SPECIFICATION 116
\r
358 #define DSO_R_NULL_HANDLE 104
\r
359 #define DSO_R_SET_FILENAME_FAILED 112
\r
360 #define DSO_R_STACK_ERROR 105
\r
361 #define DSO_R_SYM_FAILURE 106
\r
362 #define DSO_R_UNLOAD_FAILED 107
\r
363 #define DSO_R_UNSUPPORTED 108
\r
projects / lab.git / blob