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