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