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