9a1cdabf39a0ce8c342a0faded75c5e0d8f51c1d
[openssl.git] / crypto / dso / dso.h
1 /* dso.h -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58
59 #ifndef HEADER_DSO_H
60 #define HEADER_DSO_H
61
62 #include <openssl/crypto.h>
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
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
72
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
85 /* An extra flag to give if only the extension should be added as
86  * translation.  This is obviously only of importance on Unix and
87  * other operating systems where the translation also may prefix
88  * the name with something, like 'lib', and ignored everywhere else.
89  * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used
90  * at the same time. */
91 #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY      0x02
92
93 /* The following flag controls the translation of symbol names to upper
94  * case.  This is currently only being implemented for OpenVMS.
95  */
96 #define DSO_FLAG_UPCASE_SYMBOL                  0x10
97
98
99 typedef void (*DSO_FUNC_TYPE)(void);
100
101 typedef struct dso_st DSO;
102
103 /* The function prototype used for method functions (or caller-provided
104  * callbacks) that transform filenames. They are passed a DSO structure pointer
105  * (or NULL if they are to be used independantly of a DSO object) and a
106  * filename to transform. They should either return NULL (if there is an error
107  * condition) or a newly allocated string containing the transformed form that
108  * the caller will need to free with OPENSSL_free() when done. */
109 typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
110 /* The function prototype used for method functions (or caller-provided
111  * callbacks) that merge two file specifications. They are passed a
112  * DSO structure pointer (or NULL if they are to be used independantly of
113  * a DSO object) and two file specifications to merge. They should
114  * either return NULL (if there is an error condition) or a newly allocated
115  * string containing the result of merging that the caller will need
116  * to free with OPENSSL_free() when done.
117  * Here, merging means that bits and pieces are taken from each of the
118  * file specifications and added together in whatever fashion that is
119  * sensible for the DSO method in question.  The only rule that really
120  * applies is that if the two specification contain pieces of the same
121  * type, the copy from the string string takes priority.  One could see
122  * it as the first specification is the one given by the user and the
123  * second being a bunch of defaults to add on if they're missing in the
124  * first. */
125 typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
126
127 typedef struct dso_meth_st
128         {
129         const char *name;
130         /* Loads a shared library, NB: new DSO_METHODs must ensure that a
131          * successful load populates the loaded_filename field, and likewise a
132          * successful unload OPENSSL_frees and NULLs it out. */
133         int (*dso_load)(DSO *dso);
134         /* Unloads a shared library */
135         int (*dso_unload)(DSO *dso);
136         /* Binds a variable */
137         void *(*dso_bind_var)(DSO *dso, const char *symname);
138         /* Binds a function - assumes a return type of DSO_FUNC_TYPE.
139          * This should be cast to the real function prototype by the
140          * caller. Platforms that don't have compatible representations
141          * for different prototypes (this is possible within ANSI C)
142          * are highly unlikely to have shared libraries at all, let
143          * alone a DSO_METHOD implemented for them. */
144         DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname);
145
146 /* I don't think this would actually be used in any circumstances. */
147 #if 0
148         /* Unbinds a variable */
149         int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr);
150         /* Unbinds a function */
151         int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
152 #endif
153         /* The generic (yuck) "ctrl()" function. NB: Negative return
154          * values (rather than zero) indicate errors. */
155         long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg);
156         /* The default DSO_METHOD-specific function for converting filenames to
157          * a canonical native form. */
158         DSO_NAME_CONVERTER_FUNC dso_name_converter;
159         /* The default DSO_METHOD-specific function for converting filenames to
160          * a canonical native form. */
161         DSO_MERGER_FUNC dso_merger;
162
163         /* [De]Initialisation handlers. */
164         int (*init)(DSO *dso);
165         int (*finish)(DSO *dso);
166         } DSO_METHOD;
167
168 /**********************************************************************/
169 /* The low-level handle type used to refer to a loaded shared library */
170
171 struct dso_st
172         {
173         DSO_METHOD *meth;
174         /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
175          * doesn't use anything but will need to cache the filename
176          * for use in the dso_bind handler. All in all, let each
177          * method control its own destiny. "Handles" and such go in
178          * a STACK. */
179         STACK *meth_data;
180         int references;
181         int flags;
182         /* For use by applications etc ... use this for your bits'n'pieces,
183          * don't touch meth_data! */
184         CRYPTO_EX_DATA ex_data;
185         /* If this callback function pointer is set to non-NULL, then it will
186          * be used in DSO_load() in place of meth->dso_name_converter. NB: This
187          * should normally set using DSO_set_name_converter(). */
188         DSO_NAME_CONVERTER_FUNC name_converter;
189         /* If this callback function pointer is set to non-NULL, then it will
190          * be used in DSO_load() in place of meth->dso_merger. NB: This
191          * should normally set using DSO_set_merger(). */
192         DSO_MERGER_FUNC merger;
193         /* This is populated with (a copy of) the platform-independant
194          * filename used for this DSO. */
195         char *filename;
196         /* This is populated with (a copy of) the translated filename by which
197          * the DSO was actually loaded. It is NULL iff the DSO is not currently
198          * loaded. NB: This is here because the filename translation process
199          * may involve a callback being invoked more than once not only to
200          * convert to a platform-specific form, but also to try different
201          * filenames in the process of trying to perform a load. As such, this
202          * variable can be used to indicate (a) whether this DSO structure
203          * corresponds to a loaded library or not, and (b) the filename with
204          * which it was actually loaded. */
205         char *loaded_filename;
206         };
207
208
209 DSO *   DSO_new(void);
210 DSO *   DSO_new_method(DSO_METHOD *method);
211 int     DSO_free(DSO *dso);
212 int     DSO_flags(DSO *dso);
213 int     DSO_up_ref(DSO *dso);
214 long    DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
215
216 /* This function sets the DSO's name_converter callback. If it is non-NULL,
217  * then it will be used instead of the associated DSO_METHOD's function. If
218  * oldcb is non-NULL then it is set to the function pointer value being
219  * replaced. Return value is non-zero for success. */
220 int     DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
221                                 DSO_NAME_CONVERTER_FUNC *oldcb);
222 /* These functions can be used to get/set the platform-independant filename
223  * used for a DSO. NB: set will fail if the DSO is already loaded. */
224 const char *DSO_get_filename(DSO *dso);
225 int     DSO_set_filename(DSO *dso, const char *filename);
226 /* This function will invoke the DSO's name_converter callback to translate a
227  * filename, or if the callback isn't set it will instead use the DSO_METHOD's
228  * converter. If "filename" is NULL, the "filename" in the DSO itself will be
229  * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
230  * simply duplicated. NB: This function is usually called from within a
231  * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that
232  * caller-created DSO_METHODs can do the same thing. A non-NULL return value
233  * will need to be OPENSSL_free()'d. */
234 char    *DSO_convert_filename(DSO *dso, const char *filename);
235 /* This function will invoke the DSO's merger callback to merge two file
236  * specifications, or if the callback isn't set it will instead use the
237  * DSO_METHOD's merger.  A non-NULL return value will need to be
238  * OPENSSL_free()'d. */
239 char    *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
240 /* If the DSO is currently loaded, this returns the filename that it was loaded
241  * under, otherwise it returns NULL. So it is also useful as a test as to
242  * whether the DSO is currently loaded. NB: This will not necessarily return
243  * the same value as DSO_convert_filename(dso, dso->filename), because the
244  * DSO_METHOD's load function may have tried a variety of filenames (with
245  * and/or without the aid of the converters) before settling on the one it
246  * actually loaded. */
247 const char *DSO_get_loaded_filename(DSO *dso);
248
249 void    DSO_set_default_method(DSO_METHOD *meth);
250 DSO_METHOD *DSO_get_default_method(void);
251 DSO_METHOD *DSO_get_method(DSO *dso);
252 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
253
254 /* The all-singing all-dancing load function, you normally pass NULL
255  * for the first and third parameters. Use DSO_up and DSO_free for
256  * subsequent reference count handling. Any flags passed in will be set
257  * in the constructed DSO after its init() function but before the
258  * load operation. If 'dso' is non-NULL, 'flags' is ignored. */
259 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
260
261 /* This function binds to a variable inside a shared library. */
262 void *DSO_bind_var(DSO *dso, const char *symname);
263
264 /* This function binds to a function inside a shared library. */
265 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
266
267 /* This method is the default, but will beg, borrow, or steal whatever
268  * method should be the default on any particular platform (including
269  * DSO_METH_null() if necessary). */
270 DSO_METHOD *DSO_METHOD_openssl(void);
271
272 /* This method is defined for all platforms - if a platform has no
273  * DSO support then this will be the only method! */
274 DSO_METHOD *DSO_METHOD_null(void);
275
276 /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
277  * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
278  * this method. If not, this method will return NULL. */
279 DSO_METHOD *DSO_METHOD_dlfcn(void);
280
281 /* If DSO_DL is defined, the standard dl.h-style functions (shl_load, 
282  * shl_unload, shl_findsym, etc) will be used and incorporated into
283  * this method. If not, this method will return NULL. */
284 DSO_METHOD *DSO_METHOD_dl(void);
285
286 /* If WIN32 is defined, use DLLs. If not, return NULL. */
287 DSO_METHOD *DSO_METHOD_win32(void);
288
289 /* If VMS is defined, use shared images. If not, return NULL. */
290 DSO_METHOD *DSO_METHOD_vms(void);
291
292 /* BEGIN ERROR CODES */
293 /* The following lines are auto generated by the script mkerr.pl. Any changes
294  * made after this point may be overwritten when the script is next run.
295  */
296 void ERR_load_DSO_strings(void);
297
298 /* Error codes for the DSO functions. */
299
300 /* Function codes. */
301 #define DSO_F_DLFCN_BIND_FUNC                            100
302 #define DSO_F_DLFCN_BIND_VAR                             101
303 #define DSO_F_DLFCN_LOAD                                 102
304 #define DSO_F_DLFCN_MERGER                               130
305 #define DSO_F_DLFCN_NAME_CONVERTER                       123
306 #define DSO_F_DLFCN_UNLOAD                               103
307 #define DSO_F_DL_BIND_FUNC                               104
308 #define DSO_F_DL_BIND_VAR                                105
309 #define DSO_F_DL_LOAD                                    106
310 #define DSO_F_DL_MERGER                                  131
311 #define DSO_F_DL_NAME_CONVERTER                          124
312 #define DSO_F_DL_UNLOAD                                  107
313 #define DSO_F_DSO_BIND_FUNC                              108
314 #define DSO_F_DSO_BIND_VAR                               109
315 #define DSO_F_DSO_CONVERT_FILENAME                       126
316 #define DSO_F_DSO_CTRL                                   110
317 #define DSO_F_DSO_FREE                                   111
318 #define DSO_F_DSO_GET_FILENAME                           127
319 #define DSO_F_DSO_GET_LOADED_FILENAME                    128
320 #define DSO_F_DSO_LOAD                                   112
321 #define DSO_F_DSO_MERGE                                  132
322 #define DSO_F_DSO_NEW_METHOD                             113
323 #define DSO_F_DSO_SET_FILENAME                           129
324 #define DSO_F_DSO_SET_NAME_CONVERTER                     122
325 #define DSO_F_DSO_UP_REF                                 114
326 #define DSO_F_VMS_BIND_VAR                               115
327 #define DSO_F_VMS_LOAD                                   116
328 #define DSO_F_VMS_MERGER                                 133
329 #define DSO_F_VMS_UNLOAD                                 117
330 #define DSO_F_WIN32_BIND_FUNC                            118
331 #define DSO_F_WIN32_BIND_VAR                             119
332 #define DSO_F_WIN32_LOAD                                 120
333 #define DSO_F_WIN32_MERGER                               134
334 #define DSO_F_WIN32_NAME_CONVERTER                       125
335 #define DSO_F_WIN32_UNLOAD                               121
336
337 /* Reason codes. */
338 #define DSO_R_CTRL_FAILED                                100
339 #define DSO_R_DSO_ALREADY_LOADED                         110
340 #define DSO_R_EMPTY_FILE_STRUCTURE                       113
341 #define DSO_R_FAILURE                                    114
342 #define DSO_R_FILENAME_TOO_BIG                           101
343 #define DSO_R_FINISH_FAILED                              102
344 #define DSO_R_INCORRECT_FILE_SYNTAX                      115
345 #define DSO_R_LOAD_FAILED                                103
346 #define DSO_R_NAME_TRANSLATION_FAILED                    109
347 #define DSO_R_NO_FILENAME                                111
348 #define DSO_R_NO_FILE_SPECIFICATION                      116
349 #define DSO_R_NULL_HANDLE                                104
350 #define DSO_R_SET_FILENAME_FAILED                        112
351 #define DSO_R_STACK_ERROR                                105
352 #define DSO_R_SYM_FAILURE                                106
353 #define DSO_R_UNLOAD_FAILED                              107
354 #define DSO_R_UNSUPPORTED                                108
355
356 #ifdef  __cplusplus
357 }
358 #endif
359 #endif