2 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
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
74 * By default, DSO_load() will translate the provided filename into a form
75 * typical for the platform (more specifically the DSO_METHOD) using the
76 * dso_name_converter function of the method. Eg. win32 will transform "blah"
77 * into "blah.dll", and dlfcn will transform it into "libblah.so". The
78 * behaviour can be overriden by setting the name_converter callback in the
79 * DSO object (using DSO_set_name_converter()). This callback could even
80 * utilise the DSO_METHOD's converter too if it only wants to override
81 * behaviour for one or two possible DSO methods. However, the following flag
82 * can be set in a DSO to prevent *any* native name-translation at all - eg.
83 * if the caller has prompted the user for a path to a driver library so the
84 * filename should be interpreted as-is.
86 # define DSO_FLAG_NO_NAME_TRANSLATION 0x01
88 * An extra flag to give if only the extension should be added as
89 * translation. This is obviously only of importance on Unix and other
90 * operating systems where the translation also may prefix the name with
91 * something, like 'lib', and ignored everywhere else. This flag is also
92 * ignored if DSO_FLAG_NO_NAME_TRANSLATION is used at the same time.
94 # define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02
97 * The following flag controls the translation of symbol names to upper case.
98 * This is currently only being implemented for OpenVMS.
100 # define DSO_FLAG_UPCASE_SYMBOL 0x10
103 * This flag loads the library with public symbols. Meaning: The exported
104 * symbols of this library are public to all libraries loaded after this
105 * library. At the moment only implemented in unix.
107 # define DSO_FLAG_GLOBAL_SYMBOLS 0x20
109 typedef void (*DSO_FUNC_TYPE) (void);
111 typedef struct dso_st DSO;
112 typedef struct dso_meth_st DSO_METHOD;
115 * The function prototype used for method functions (or caller-provided
116 * callbacks) that transform filenames. They are passed a DSO structure
117 * pointer (or NULL if they are to be used independently of a DSO object) and
118 * a filename to transform. They should either return NULL (if there is an
119 * error condition) or a newly allocated string containing the transformed
120 * form that the caller will need to free with OPENSSL_free() when done.
122 typedef char *(*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
124 * The function prototype used for method functions (or caller-provided
125 * callbacks) that merge two file specifications. They are passed a DSO
126 * structure pointer (or NULL if they are to be used independently of a DSO
127 * object) and two file specifications to merge. They should either return
128 * NULL (if there is an error condition) or a newly allocated string
129 * containing the result of merging that the caller will need to free with
130 * OPENSSL_free() when done. Here, merging means that bits and pieces are
131 * taken from each of the file specifications and added together in whatever
132 * fashion that is sensible for the DSO method in question. The only rule
133 * that really applies is that if the two specification contain pieces of the
134 * same type, the copy from the first string takes priority. One could see
135 * it as the first specification is the one given by the user and the second
136 * being a bunch of defaults to add on if they're missing in the first.
138 typedef char *(*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
141 DSO *DSO_new_method(DSO_METHOD *method);
142 int DSO_free(DSO *dso);
143 int DSO_flags(DSO *dso);
144 int DSO_up_ref(DSO *dso);
145 long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
148 * This function sets the DSO's name_converter callback. If it is non-NULL,
149 * then it will be used instead of the associated DSO_METHOD's function. If
150 * oldcb is non-NULL then it is set to the function pointer value being
151 * replaced. Return value is non-zero for success.
153 int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
154 DSO_NAME_CONVERTER_FUNC *oldcb);
156 * These functions can be used to get/set the platform-independent filename
157 * used for a DSO. NB: set will fail if the DSO is already loaded.
159 const char *DSO_get_filename(DSO *dso);
160 int DSO_set_filename(DSO *dso, const char *filename);
162 * This function will invoke the DSO's name_converter callback to translate a
163 * filename, or if the callback isn't set it will instead use the DSO_METHOD's
164 * converter. If "filename" is NULL, the "filename" in the DSO itself will be
165 * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
166 * simply duplicated. NB: This function is usually called from within a
167 * DSO_METHOD during the processing of a DSO_load() call, and is exposed so
168 * that caller-created DSO_METHODs can do the same thing. A non-NULL return
169 * value will need to be OPENSSL_free()'d.
171 char *DSO_convert_filename(DSO *dso, const char *filename);
173 * This function will invoke the DSO's merger callback to merge two file
174 * specifications, or if the callback isn't set it will instead use the
175 * DSO_METHOD's merger. A non-NULL return value will need to be
178 char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
180 * If the DSO is currently loaded, this returns the filename that it was
181 * loaded under, otherwise it returns NULL. So it is also useful as a test as
182 * to whether the DSO is currently loaded. NB: This will not necessarily
183 * return the same value as DSO_convert_filename(dso, dso->filename), because
184 * the DSO_METHOD's load function may have tried a variety of filenames (with
185 * and/or without the aid of the converters) before settling on the one it
188 const char *DSO_get_loaded_filename(DSO *dso);
190 void DSO_set_default_method(DSO_METHOD *meth);
191 DSO_METHOD *DSO_get_default_method(void);
192 DSO_METHOD *DSO_get_method(DSO *dso);
193 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
196 * The all-singing all-dancing load function, you normally pass NULL for the
197 * first and third parameters. Use DSO_up and DSO_free for subsequent
198 * reference count handling. Any flags passed in will be set in the
199 * constructed DSO after its init() function but before the load operation.
200 * If 'dso' is non-NULL, 'flags' is ignored.
202 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
204 /* This function binds to a variable inside a shared library. */
205 void *DSO_bind_var(DSO *dso, const char *symname);
207 /* This function binds to a function inside a shared library. */
208 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
211 * This method is the default, but will beg, borrow, or steal whatever method
212 * should be the default on any particular platform (including
213 * DSO_METH_null() if necessary).
215 DSO_METHOD *DSO_METHOD_openssl(void);
218 * This function writes null-terminated pathname of DSO module containing
219 * 'addr' into 'sz' large caller-provided 'path' and returns the number of
220 * characters [including trailing zero] written to it. If 'sz' is 0 or
221 * negative, 'path' is ignored and required amount of charachers [including
222 * trailing zero] to accommodate pathname is returned. If 'addr' is NULL, then
223 * pathname of cryptolib itself is returned. Negative or zero return value
226 int DSO_pathbyaddr(void *addr, char *path, int sz);
229 * This function should be used with caution! It looks up symbols in *all*
230 * loaded modules and if module gets unloaded by somebody else attempt to
231 * dereference the pointer is doomed to have fatal consequences. Primary
232 * usage for this function is to probe *core* system functionality, e.g.
233 * check if getnameinfo(3) is available at run-time without bothering about
234 * OS-specific details such as libc.so.versioning or where does it actually
235 * reside: in libc itself or libsocket.
237 void *DSO_global_lookup(const char *name);
239 /* BEGIN ERROR CODES */
241 * The following lines are auto generated by the script mkerr.pl. Any changes
242 * made after this point may be overwritten when the script is next run.
244 void ERR_load_DSO_strings(void);
246 /* Error codes for the DSO functions. */
248 /* Function codes. */
249 # define DSO_F_BEOS_BIND_FUNC 144
250 # define DSO_F_BEOS_BIND_VAR 145
251 # define DSO_F_BEOS_LOAD 146
252 # define DSO_F_BEOS_NAME_CONVERTER 147
253 # define DSO_F_BEOS_UNLOAD 148
254 # define DSO_F_DLFCN_BIND_FUNC 100
255 # define DSO_F_DLFCN_BIND_VAR 101
256 # define DSO_F_DLFCN_LOAD 102
257 # define DSO_F_DLFCN_MERGER 130
258 # define DSO_F_DLFCN_NAME_CONVERTER 123
259 # define DSO_F_DLFCN_UNLOAD 103
260 # define DSO_F_DL_BIND_FUNC 104
261 # define DSO_F_DL_BIND_VAR 105
262 # define DSO_F_DL_LOAD 106
263 # define DSO_F_DL_MERGER 131
264 # define DSO_F_DL_NAME_CONVERTER 124
265 # define DSO_F_DL_UNLOAD 107
266 # define DSO_F_DSO_BIND_FUNC 108
267 # define DSO_F_DSO_BIND_VAR 109
268 # define DSO_F_DSO_CONVERT_FILENAME 126
269 # define DSO_F_DSO_CTRL 110
270 # define DSO_F_DSO_FREE 111
271 # define DSO_F_DSO_GET_FILENAME 127
272 # define DSO_F_DSO_GET_LOADED_FILENAME 128
273 # define DSO_F_DSO_GLOBAL_LOOKUP 139
274 # define DSO_F_DSO_LOAD 112
275 # define DSO_F_DSO_MERGE 132
276 # define DSO_F_DSO_NEW_METHOD 113
277 # define DSO_F_DSO_PATHBYADDR 140
278 # define DSO_F_DSO_SET_FILENAME 129
279 # define DSO_F_DSO_SET_NAME_CONVERTER 122
280 # define DSO_F_DSO_UP_REF 114
281 # define DSO_F_GLOBAL_LOOKUP_FUNC 138
282 # define DSO_F_PATHBYADDR 137
283 # define DSO_F_VMS_BIND_SYM 115
284 # define DSO_F_VMS_LOAD 116
285 # define DSO_F_VMS_MERGER 133
286 # define DSO_F_VMS_UNLOAD 117
287 # define DSO_F_WIN32_BIND_FUNC 118
288 # define DSO_F_WIN32_BIND_VAR 119
289 # define DSO_F_WIN32_GLOBALLOOKUP 142
290 # define DSO_F_WIN32_GLOBALLOOKUP_FUNC 143
291 # define DSO_F_WIN32_JOINER 135
292 # define DSO_F_WIN32_LOAD 120
293 # define DSO_F_WIN32_MERGER 134
294 # define DSO_F_WIN32_NAME_CONVERTER 125
295 # define DSO_F_WIN32_PATHBYADDR 141
296 # define DSO_F_WIN32_SPLITTER 136
297 # define DSO_F_WIN32_UNLOAD 121
300 # define DSO_R_CTRL_FAILED 100
301 # define DSO_R_DSO_ALREADY_LOADED 110
302 # define DSO_R_EMPTY_FILE_STRUCTURE 113
303 # define DSO_R_FAILURE 114
304 # define DSO_R_FILENAME_TOO_BIG 101
305 # define DSO_R_FINISH_FAILED 102
306 # define DSO_R_INCORRECT_FILE_SYNTAX 115
307 # define DSO_R_LOAD_FAILED 103
308 # define DSO_R_NAME_TRANSLATION_FAILED 109
309 # define DSO_R_NO_FILENAME 111
310 # define DSO_R_NO_FILE_SPECIFICATION 116
311 # define DSO_R_NULL_HANDLE 104
312 # define DSO_R_SET_FILENAME_FAILED 112
313 # define DSO_R_STACK_ERROR 105
314 # define DSO_R_SYM_FAILURE 106
315 # define DSO_R_UNLOAD_FAILED 107
316 # define DSO_R_UNSUPPORTED 108