williamr@2: /* dso.h -*- mode:C; c-file-style: "eay" -*- */ williamr@2: /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL williamr@2: * project 2000. williamr@2: */ williamr@2: /* ==================================================================== williamr@2: * Copyright (c) 2000 The OpenSSL Project. All rights reserved. williamr@2: * williamr@2: * Redistribution and use in source and binary forms, with or without williamr@2: * modification, are permitted provided that the following conditions williamr@2: * are met: williamr@2: * williamr@2: * 1. Redistributions of source code must retain the above copyright williamr@2: * notice, this list of conditions and the following disclaimer. williamr@2: * williamr@2: * 2. Redistributions in binary form must reproduce the above copyright williamr@2: * notice, this list of conditions and the following disclaimer in williamr@2: * the documentation and/or other materials provided with the williamr@2: * distribution. williamr@2: * williamr@2: * 3. All advertising materials mentioning features or use of this williamr@2: * software must display the following acknowledgment: williamr@2: * "This product includes software developed by the OpenSSL Project williamr@2: * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" williamr@2: * williamr@2: * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to williamr@2: * endorse or promote products derived from this software without williamr@2: * prior written permission. For written permission, please contact williamr@2: * licensing@OpenSSL.org. williamr@2: * williamr@2: * 5. Products derived from this software may not be called "OpenSSL" williamr@2: * nor may "OpenSSL" appear in their names without prior written williamr@2: * permission of the OpenSSL Project. williamr@2: * williamr@2: * 6. Redistributions of any form whatsoever must retain the following williamr@2: * acknowledgment: williamr@2: * "This product includes software developed by the OpenSSL Project williamr@2: * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" williamr@2: * williamr@2: * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY williamr@2: * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE williamr@2: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR williamr@2: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR williamr@2: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, williamr@2: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT williamr@2: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; williamr@2: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) williamr@2: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, williamr@2: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) williamr@2: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED williamr@2: * OF THE POSSIBILITY OF SUCH DAMAGE. williamr@2: * ==================================================================== williamr@2: * williamr@2: * This product includes cryptographic software written by Eric Young williamr@2: * (eay@cryptsoft.com). This product includes software written by Tim williamr@2: * Hudson (tjh@cryptsoft.com). williamr@2: * williamr@2: */ williamr@2: /* williamr@2: © Portions copyright (c) 2006 Nokia Corporation. All rights reserved. williamr@2: */ williamr@2: williamr@2: #ifndef HEADER_DSO_H williamr@2: #define HEADER_DSO_H williamr@2: williamr@2: #if (defined(__SYMBIAN32__) && !defined(SYMBIAN)) williamr@2: #define SYMBIAN williamr@2: #endif williamr@2: williamr@2: #ifdef SYMBIAN williamr@2: #include williamr@2: #endif williamr@2: #include williamr@2: williamr@2: #ifdef __cplusplus williamr@2: extern "C" { williamr@2: #endif williamr@2: williamr@2: /* These values are used as commands to DSO_ctrl() */ williamr@2: #define DSO_CTRL_GET_FLAGS 1 williamr@2: #define DSO_CTRL_SET_FLAGS 2 williamr@2: #define DSO_CTRL_OR_FLAGS 3 williamr@2: williamr@2: /* By default, DSO_load() will translate the provided filename into a form williamr@2: * typical for the platform (more specifically the DSO_METHOD) using the williamr@2: * dso_name_converter function of the method. Eg. win32 will transform "blah" williamr@2: * into "blah.dll", and dlfcn will transform it into "libblah.so". The williamr@2: * behaviour can be overriden by setting the name_converter callback in the DSO williamr@2: * object (using DSO_set_name_converter()). This callback could even utilise williamr@2: * the DSO_METHOD's converter too if it only wants to override behaviour for williamr@2: * one or two possible DSO methods. However, the following flag can be set in a williamr@2: * DSO to prevent *any* native name-translation at all - eg. if the caller has williamr@2: * prompted the user for a path to a driver library so the filename should be williamr@2: * interpreted as-is. */ williamr@2: #define DSO_FLAG_NO_NAME_TRANSLATION 0x01 williamr@2: /* An extra flag to give if only the extension should be added as williamr@2: * translation. This is obviously only of importance on Unix and williamr@2: * other operating systems where the translation also may prefix williamr@2: * the name with something, like 'lib', and ignored everywhere else. williamr@2: * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used williamr@2: * at the same time. */ williamr@2: #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02 williamr@2: williamr@2: /* The following flag controls the translation of symbol names to upper williamr@2: * case. This is currently only being implemented for OpenVMS. williamr@2: */ williamr@2: #define DSO_FLAG_UPCASE_SYMBOL 0x10 williamr@2: williamr@2: /* This flag loads the library with public symbols. williamr@2: * Meaning: The exported symbols of this library are public williamr@2: * to all libraries loaded after this library. williamr@2: * At the moment only implemented in unix. williamr@2: */ williamr@2: #define DSO_FLAG_GLOBAL_SYMBOLS 0x20 williamr@2: williamr@2: williamr@2: typedef void (*DSO_FUNC_TYPE)(void); williamr@2: williamr@2: typedef struct dso_st DSO; williamr@2: williamr@2: /* The function prototype used for method functions (or caller-provided williamr@2: * callbacks) that transform filenames. They are passed a DSO structure pointer williamr@2: * (or NULL if they are to be used independantly of a DSO object) and a williamr@2: * filename to transform. They should either return NULL (if there is an error williamr@2: * condition) or a newly allocated string containing the transformed form that williamr@2: * the caller will need to free with OPENSSL_free() when done. */ williamr@2: typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *); williamr@2: /* The function prototype used for method functions (or caller-provided williamr@2: * callbacks) that merge two file specifications. They are passed a williamr@2: * DSO structure pointer (or NULL if they are to be used independantly of williamr@2: * a DSO object) and two file specifications to merge. They should williamr@2: * either return NULL (if there is an error condition) or a newly allocated williamr@2: * string containing the result of merging that the caller will need williamr@2: * to free with OPENSSL_free() when done. williamr@2: * Here, merging means that bits and pieces are taken from each of the williamr@2: * file specifications and added together in whatever fashion that is williamr@2: * sensible for the DSO method in question. The only rule that really williamr@2: * applies is that if the two specification contain pieces of the same williamr@2: * type, the copy from the first string takes priority. One could see williamr@2: * it as the first specification is the one given by the user and the williamr@2: * second being a bunch of defaults to add on if they're missing in the williamr@2: * first. */ williamr@2: typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *); williamr@2: williamr@2: typedef struct dso_meth_st williamr@2: { williamr@2: const char *name; williamr@2: /* Loads a shared library, NB: new DSO_METHODs must ensure that a williamr@2: * successful load populates the loaded_filename field, and likewise a williamr@2: * successful unload OPENSSL_frees and NULLs it out. */ williamr@2: int (*dso_load)(DSO *dso); williamr@2: /* Unloads a shared library */ williamr@2: int (*dso_unload)(DSO *dso); williamr@2: /* Binds a variable */ williamr@2: void *(*dso_bind_var)(DSO *dso, const char *symname); williamr@2: /* Binds a function - assumes a return type of DSO_FUNC_TYPE. williamr@2: * This should be cast to the real function prototype by the williamr@2: * caller. Platforms that don't have compatible representations williamr@2: * for different prototypes (this is possible within ANSI C) williamr@2: * are highly unlikely to have shared libraries at all, let williamr@2: * alone a DSO_METHOD implemented for them. */ williamr@2: DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname); williamr@2: williamr@2: /* I don't think this would actually be used in any circumstances. */ williamr@2: #if 0 williamr@2: /* Unbinds a variable */ williamr@2: int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr); williamr@2: /* Unbinds a function */ williamr@2: int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr); williamr@2: #endif williamr@2: /* The generic (yuck) "ctrl()" function. NB: Negative return williamr@2: * values (rather than zero) indicate errors. */ williamr@2: long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg); williamr@2: /* The default DSO_METHOD-specific function for converting filenames to williamr@2: * a canonical native form. */ williamr@2: DSO_NAME_CONVERTER_FUNC dso_name_converter; williamr@2: /* The default DSO_METHOD-specific function for converting filenames to williamr@2: * a canonical native form. */ williamr@2: DSO_MERGER_FUNC dso_merger; williamr@2: williamr@2: /* [De]Initialisation handlers. */ williamr@2: int (*init)(DSO *dso); williamr@2: int (*finish)(DSO *dso); williamr@2: } DSO_METHOD; williamr@2: williamr@2: /**********************************************************************/ williamr@2: /* The low-level handle type used to refer to a loaded shared library */ williamr@2: williamr@2: struct dso_st williamr@2: { williamr@2: DSO_METHOD *meth; williamr@2: /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS williamr@2: * doesn't use anything but will need to cache the filename williamr@2: * for use in the dso_bind handler. All in all, let each williamr@2: * method control its own destiny. "Handles" and such go in williamr@2: * a STACK. */ williamr@2: STACK *meth_data; williamr@2: int references; williamr@2: int flags; williamr@2: /* For use by applications etc ... use this for your bits'n'pieces, williamr@2: * don't touch meth_data! */ williamr@2: CRYPTO_EX_DATA ex_data; williamr@2: /* If this callback function pointer is set to non-NULL, then it will williamr@2: * be used in DSO_load() in place of meth->dso_name_converter. NB: This williamr@2: * should normally set using DSO_set_name_converter(). */ williamr@2: DSO_NAME_CONVERTER_FUNC name_converter; williamr@2: /* If this callback function pointer is set to non-NULL, then it will williamr@2: * be used in DSO_load() in place of meth->dso_merger. NB: This williamr@2: * should normally set using DSO_set_merger(). */ williamr@2: DSO_MERGER_FUNC merger; williamr@2: /* This is populated with (a copy of) the platform-independant williamr@2: * filename used for this DSO. */ williamr@2: char *filename; williamr@2: /* This is populated with (a copy of) the translated filename by which williamr@2: * the DSO was actually loaded. It is NULL iff the DSO is not currently williamr@2: * loaded. NB: This is here because the filename translation process williamr@2: * may involve a callback being invoked more than once not only to williamr@2: * convert to a platform-specific form, but also to try different williamr@2: * filenames in the process of trying to perform a load. As such, this williamr@2: * variable can be used to indicate (a) whether this DSO structure williamr@2: * corresponds to a loaded library or not, and (b) the filename with williamr@2: * which it was actually loaded. */ williamr@2: char *loaded_filename; williamr@2: }; williamr@2: williamr@2: williamr@2: IMPORT_C DSO * DSO_new(void); williamr@2: IMPORT_C DSO * DSO_new_method(DSO_METHOD *method); williamr@2: IMPORT_C int DSO_free(DSO *dso); williamr@2: IMPORT_C int DSO_flags(DSO *dso); williamr@2: IMPORT_C int DSO_up_ref(DSO *dso); williamr@2: IMPORT_C long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg); williamr@2: williamr@2: /* This function sets the DSO's name_converter callback. If it is non-NULL, williamr@2: * then it will be used instead of the associated DSO_METHOD's function. If williamr@2: * oldcb is non-NULL then it is set to the function pointer value being williamr@2: * replaced. Return value is non-zero for success. */ williamr@2: IMPORT_C int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb, williamr@2: DSO_NAME_CONVERTER_FUNC *oldcb); williamr@2: /* These functions can be used to get/set the platform-independant filename williamr@2: * used for a DSO. NB: set will fail if the DSO is already loaded. */ williamr@2: IMPORT_C const char *DSO_get_filename(DSO *dso); williamr@2: IMPORT_C int DSO_set_filename(DSO *dso, const char *filename); williamr@2: /* This function will invoke the DSO's name_converter callback to translate a williamr@2: * filename, or if the callback isn't set it will instead use the DSO_METHOD's williamr@2: * converter. If "filename" is NULL, the "filename" in the DSO itself will be williamr@2: * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is williamr@2: * simply duplicated. NB: This function is usually called from within a williamr@2: * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that williamr@2: * caller-created DSO_METHODs can do the same thing. A non-NULL return value williamr@2: * will need to be OPENSSL_free()'d. */ williamr@2: IMPORT_C char *DSO_convert_filename(DSO *dso, const char *filename); williamr@2: /* This function will invoke the DSO's merger callback to merge two file williamr@2: * specifications, or if the callback isn't set it will instead use the williamr@2: * DSO_METHOD's merger. A non-NULL return value will need to be williamr@2: * OPENSSL_free()'d. */ williamr@2: IMPORT_C char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2); williamr@2: /* If the DSO is currently loaded, this returns the filename that it was loaded williamr@2: * under, otherwise it returns NULL. So it is also useful as a test as to williamr@2: * whether the DSO is currently loaded. NB: This will not necessarily return williamr@2: * the same value as DSO_convert_filename(dso, dso->filename), because the williamr@2: * DSO_METHOD's load function may have tried a variety of filenames (with williamr@2: * and/or without the aid of the converters) before settling on the one it williamr@2: * actually loaded. */ williamr@2: IMPORT_C const char *DSO_get_loaded_filename(DSO *dso); williamr@2: williamr@2: IMPORT_C void DSO_set_default_method(DSO_METHOD *meth); williamr@2: IMPORT_C DSO_METHOD *DSO_get_default_method(void); williamr@2: IMPORT_C DSO_METHOD *DSO_get_method(DSO *dso); williamr@2: IMPORT_C DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth); williamr@2: williamr@2: /* The all-singing all-dancing load function, you normally pass NULL williamr@2: * for the first and third parameters. Use DSO_up and DSO_free for williamr@2: * subsequent reference count handling. Any flags passed in will be set williamr@2: * in the constructed DSO after its init() function but before the williamr@2: * load operation. If 'dso' is non-NULL, 'flags' is ignored. */ williamr@2: IMPORT_C DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags); williamr@2: williamr@2: /* This function binds to a variable inside a shared library. */ williamr@2: IMPORT_C void *DSO_bind_var(DSO *dso, const char *symname); williamr@2: williamr@2: /* This function binds to a function inside a shared library. */ williamr@2: IMPORT_C DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname); williamr@2: williamr@2: /* This method is the default, but will beg, borrow, or steal whatever williamr@2: * method should be the default on any particular platform (including williamr@2: * DSO_METH_null() if necessary). */ williamr@2: IMPORT_C DSO_METHOD *DSO_METHOD_openssl(void); williamr@2: williamr@2: /* This method is defined for all platforms - if a platform has no williamr@2: * DSO support then this will be the only method! */ williamr@2: IMPORT_C DSO_METHOD *DSO_METHOD_null(void); williamr@2: williamr@2: /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions williamr@2: * (dlopen, dlclose, dlsym, etc) will be used and incorporated into williamr@2: * this method. If not, this method will return NULL. */ williamr@2: IMPORT_C DSO_METHOD *DSO_METHOD_dlfcn(void); williamr@2: williamr@2: /* If DSO_DL is defined, the standard dl.h-style functions (shl_load, williamr@2: * shl_unload, shl_findsym, etc) will be used and incorporated into williamr@2: * this method. If not, this method will return NULL. */ williamr@2: IMPORT_C DSO_METHOD *DSO_METHOD_dl(void); williamr@2: williamr@2: williamr@2: /* BEGIN ERROR CODES */ williamr@2: /* The following lines are auto generated by the script mkerr.pl. Any changes williamr@2: * made after this point may be overwritten when the script is next run. williamr@2: */ williamr@2: IMPORT_C void ERR_load_DSO_strings(void); williamr@2: williamr@2: /* Error codes for the DSO functions. */ williamr@2: williamr@2: /* Function codes. */ williamr@2: #define DSO_F_DLFCN_BIND_FUNC 100 williamr@2: #define DSO_F_DLFCN_BIND_VAR 101 williamr@2: #define DSO_F_DLFCN_LOAD 102 williamr@2: #define DSO_F_DLFCN_MERGER 130 williamr@2: #define DSO_F_DLFCN_NAME_CONVERTER 123 williamr@2: #define DSO_F_DLFCN_UNLOAD 103 williamr@2: #define DSO_F_DL_BIND_FUNC 104 williamr@2: #define DSO_F_DL_BIND_VAR 105 williamr@2: #define DSO_F_DL_LOAD 106 williamr@2: #define DSO_F_DL_MERGER 131 williamr@2: #define DSO_F_DL_NAME_CONVERTER 124 williamr@2: #define DSO_F_DL_UNLOAD 107 williamr@2: #define DSO_F_DSO_BIND_FUNC 108 williamr@2: #define DSO_F_DSO_BIND_VAR 109 williamr@2: #define DSO_F_DSO_CONVERT_FILENAME 126 williamr@2: #define DSO_F_DSO_CTRL 110 williamr@2: #define DSO_F_DSO_FREE 111 williamr@2: #define DSO_F_DSO_GET_FILENAME 127 williamr@2: #define DSO_F_DSO_GET_LOADED_FILENAME 128 williamr@2: #define DSO_F_DSO_LOAD 112 williamr@2: #define DSO_F_DSO_MERGE 132 williamr@2: #define DSO_F_DSO_NEW_METHOD 113 williamr@2: #define DSO_F_DSO_SET_FILENAME 129 williamr@2: #define DSO_F_DSO_SET_NAME_CONVERTER 122 williamr@2: #define DSO_F_DSO_UP_REF 114 williamr@2: #define DSO_F_VMS_BIND_SYM 115 williamr@2: #define DSO_F_VMS_LOAD 116 williamr@2: #define DSO_F_VMS_MERGER 133 williamr@2: #define DSO_F_VMS_UNLOAD 117 williamr@2: #define DSO_F_WIN32_BIND_FUNC 118 williamr@2: #define DSO_F_WIN32_BIND_VAR 119 williamr@2: #define DSO_F_WIN32_JOINER 135 williamr@2: #define DSO_F_WIN32_LOAD 120 williamr@2: #define DSO_F_WIN32_MERGER 134 williamr@2: #define DSO_F_WIN32_NAME_CONVERTER 125 williamr@2: #define DSO_F_WIN32_SPLITTER 136 williamr@2: #define DSO_F_WIN32_UNLOAD 121 williamr@2: williamr@2: /* Reason codes. */ williamr@2: #define DSO_R_CTRL_FAILED 100 williamr@2: #define DSO_R_DSO_ALREADY_LOADED 110 williamr@2: #define DSO_R_EMPTY_FILE_STRUCTURE 113 williamr@2: #define DSO_R_FAILURE 114 williamr@2: #define DSO_R_FILENAME_TOO_BIG 101 williamr@2: #define DSO_R_FINISH_FAILED 102 williamr@2: #define DSO_R_INCORRECT_FILE_SYNTAX 115 williamr@2: #define DSO_R_LOAD_FAILED 103 williamr@2: #define DSO_R_NAME_TRANSLATION_FAILED 109 williamr@2: #define DSO_R_NO_FILENAME 111 williamr@2: #define DSO_R_NO_FILE_SPECIFICATION 116 williamr@2: #define DSO_R_NULL_HANDLE 104 williamr@2: #define DSO_R_SET_FILENAME_FAILED 112 williamr@2: #define DSO_R_STACK_ERROR 105 williamr@2: #define DSO_R_SYM_FAILURE 106 williamr@2: #define DSO_R_UNLOAD_FAILED 107 williamr@2: #define DSO_R_UNSUPPORTED 108 williamr@2: williamr@2: #ifdef __cplusplus williamr@2: } williamr@2: #endif williamr@2: #endif