00001 /* dso.h -*- mode:C; c-file-style: "eay" -*- */ 00002 /* Written by Geoff Thorpe ([email protected]) for the OpenSSL 00003 * project 2000. 00004 */ 00005 /* ==================================================================== 00006 * Copyright (c) 2000 The OpenSSL Project. All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions 00010 * are met: 00011 * 00012 * 1. Redistributions of source code must retain the above copyright 00013 * notice, this list of conditions and the following disclaimer. 00014 * 00015 * 2. Redistributions in binary form must reproduce the above copyright 00016 * notice, this list of conditions and the following disclaimer in 00017 * the documentation and/or other materials provided with the 00018 * distribution. 00019 * 00020 * 3. All advertising materials mentioning features or use of this 00021 * software must display the following acknowledgment: 00022 * "This product includes software developed by the OpenSSL Project 00023 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 00024 * 00025 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 00026 * endorse or promote products derived from this software without 00027 * prior written permission. For written permission, please contact 00028 * [email protected] 00029 * 00030 * 5. Products derived from this software may not be called "OpenSSL" 00031 * nor may "OpenSSL" appear in their names without prior written 00032 * permission of the OpenSSL Project. 00033 * 00034 * 6. Redistributions of any form whatsoever must retain the following 00035 * acknowledgment: 00036 * "This product includes software developed by the OpenSSL Project 00037 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 00038 * 00039 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 00040 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00041 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00042 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 00043 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00044 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 00045 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00046 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00047 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 00048 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00049 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 00050 * OF THE POSSIBILITY OF SUCH DAMAGE. 00051 * ==================================================================== 00052 * 00053 * This product includes cryptographic software written by Eric Young 00054 * ([email protected]). This product includes software written by Tim 00055 * Hudson ([email protected]). 00056 * 00057 */ 00058 /* 00059 © Portions copyright (c) 2006 Nokia Corporation. All rights reserved. 00060 */ 00061 00062 #ifndef HEADER_DSO_H 00063 #define HEADER_DSO_H 00064 00065 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN)) 00066 #define SYMBIAN 00067 #endif 00068 00069 #ifdef SYMBIAN 00070 #include <e32def.h> 00071 #endif 00072 #include <openssl/crypto.h> 00073 00074 #ifdef __cplusplus 00075 extern "C" { 00076 #endif 00077 00078 /* These values are used as commands to DSO_ctrl() */ 00079 #define DSO_CTRL_GET_FLAGS 1 00080 #define DSO_CTRL_SET_FLAGS 2 00081 #define DSO_CTRL_OR_FLAGS 3 00082 00083 /* By default, DSO_load() will translate the provided filename into a form 00084 * typical for the platform (more specifically the DSO_METHOD) using the 00085 * dso_name_converter function of the method. Eg. win32 will transform "blah" 00086 * into "blah.dll", and dlfcn will transform it into "libblah.so". The 00087 * behaviour can be overriden by setting the name_converter callback in the DSO 00088 * object (using DSO_set_name_converter()). This callback could even utilise 00089 * the DSO_METHOD's converter too if it only wants to override behaviour for 00090 * one or two possible DSO methods. However, the following flag can be set in a 00091 * DSO to prevent *any* native name-translation at all - eg. if the caller has 00092 * prompted the user for a path to a driver library so the filename should be 00093 * interpreted as-is. */ 00094 #define DSO_FLAG_NO_NAME_TRANSLATION 0x01 00095 /* An extra flag to give if only the extension should be added as 00096 * translation. This is obviously only of importance on Unix and 00097 * other operating systems where the translation also may prefix 00098 * the name with something, like 'lib', and ignored everywhere else. 00099 * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used 00100 * at the same time. */ 00101 #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02 00102 00103 /* The following flag controls the translation of symbol names to upper 00104 * case. This is currently only being implemented for OpenVMS. 00105 */ 00106 #define DSO_FLAG_UPCASE_SYMBOL 0x10 00107 00108 /* This flag loads the library with public symbols. 00109 * Meaning: The exported symbols of this library are public 00110 * to all libraries loaded after this library. 00111 * At the moment only implemented in unix. 00112 */ 00113 #define DSO_FLAG_GLOBAL_SYMBOLS 0x20 00114 00115 00116 typedef void (*DSO_FUNC_TYPE)(void); 00117 00118 typedef struct dso_st DSO; 00119 00120 /* The function prototype used for method functions (or caller-provided 00121 * callbacks) that transform filenames. They are passed a DSO structure pointer 00122 * (or NULL if they are to be used independantly of a DSO object) and a 00123 * filename to transform. They should either return NULL (if there is an error 00124 * condition) or a newly allocated string containing the transformed form that 00125 * the caller will need to free with OPENSSL_free() when done. */ 00126 typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *); 00127 /* The function prototype used for method functions (or caller-provided 00128 * callbacks) that merge two file specifications. They are passed a 00129 * DSO structure pointer (or NULL if they are to be used independantly of 00130 * a DSO object) and two file specifications to merge. They should 00131 * either return NULL (if there is an error condition) or a newly allocated 00132 * string containing the result of merging that the caller will need 00133 * to free with OPENSSL_free() when done. 00134 * Here, merging means that bits and pieces are taken from each of the 00135 * file specifications and added together in whatever fashion that is 00136 * sensible for the DSO method in question. The only rule that really 00137 * applies is that if the two specification contain pieces of the same 00138 * type, the copy from the string string takes priority. One could see 00139 * it as the first specification is the one given by the user and the 00140 * second being a bunch of defaults to add on if they're missing in the 00141 * first. */ 00142 typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *); 00143 00144 typedef struct dso_meth_st 00145 { 00146 const char *name; 00147 /* Loads a shared library, NB: new DSO_METHODs must ensure that a 00148 * successful load populates the loaded_filename field, and likewise a 00149 * successful unload OPENSSL_frees and NULLs it out. */ 00150 int (*dso_load)(DSO *dso); 00151 /* Unloads a shared library */ 00152 int (*dso_unload)(DSO *dso); 00153 /* Binds a variable */ 00154 void *(*dso_bind_var)(DSO *dso, const char *symname); 00155 /* Binds a function - assumes a return type of DSO_FUNC_TYPE. 00156 * This should be cast to the real function prototype by the 00157 * caller. Platforms that don't have compatible representations 00158 * for different prototypes (this is possible within ANSI C) 00159 * are highly unlikely to have shared libraries at all, let 00160 * alone a DSO_METHOD implemented for them. */ 00161 DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname); 00162 00163 /* I don't think this would actually be used in any circumstances. */ 00164 #if 0 00165 /* Unbinds a variable */ 00166 int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr); 00167 /* Unbinds a function */ 00168 int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr); 00169 #endif 00170 /* The generic (yuck) "ctrl()" function. NB: Negative return 00171 * values (rather than zero) indicate errors. */ 00172 long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg); 00173 /* The default DSO_METHOD-specific function for converting filenames to 00174 * a canonical native form. */ 00175 DSO_NAME_CONVERTER_FUNC dso_name_converter; 00176 /* The default DSO_METHOD-specific function for converting filenames to 00177 * a canonical native form. */ 00178 DSO_MERGER_FUNC dso_merger; 00179 00180 /* [De]Initialisation handlers. */ 00181 int (*init)(DSO *dso); 00182 int (*finish)(DSO *dso); 00183 } DSO_METHOD; 00184 00185 /**********************************************************************/ 00186 /* The low-level handle type used to refer to a loaded shared library */ 00187 00188 struct dso_st 00189 { 00190 DSO_METHOD *meth; 00191 /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS 00192 * doesn't use anything but will need to cache the filename 00193 * for use in the dso_bind handler. All in all, let each 00194 * method control its own destiny. "Handles" and such go in 00195 * a STACK. */ 00196 STACK *meth_data; 00197 int references; 00198 int flags; 00199 /* For use by applications etc ... use this for your bits'n'pieces, 00200 * don't touch meth_data! */ 00201 CRYPTO_EX_DATA ex_data; 00202 /* If this callback function pointer is set to non-NULL, then it will 00203 * be used in DSO_load() in place of meth->dso_name_converter. NB: This 00204 * should normally set using DSO_set_name_converter(). */ 00205 DSO_NAME_CONVERTER_FUNC name_converter; 00206 /* If this callback function pointer is set to non-NULL, then it will 00207 * be used in DSO_load() in place of meth->dso_merger. NB: This 00208 * should normally set using DSO_set_merger(). */ 00209 DSO_MERGER_FUNC merger; 00210 /* This is populated with (a copy of) the platform-independant 00211 * filename used for this DSO. */ 00212 char *filename; 00213 /* This is populated with (a copy of) the translated filename by which 00214 * the DSO was actually loaded. It is NULL iff the DSO is not currently 00215 * loaded. NB: This is here because the filename translation process 00216 * may involve a callback being invoked more than once not only to 00217 * convert to a platform-specific form, but also to try different 00218 * filenames in the process of trying to perform a load. As such, this 00219 * variable can be used to indicate (a) whether this DSO structure 00220 * corresponds to a loaded library or not, and (b) the filename with 00221 * which it was actually loaded. */ 00222 char *loaded_filename; 00223 }; 00224 00225 00226 IMPORT_C DSO * DSO_new(void); 00227 IMPORT_C DSO * DSO_new_method(DSO_METHOD *method); 00228 IMPORT_C int DSO_free(DSO *dso); 00229 IMPORT_C int DSO_flags(DSO *dso); 00230 IMPORT_C int DSO_up_ref(DSO *dso); 00231 IMPORT_C long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg); 00232 00233 /* This function sets the DSO's name_converter callback. If it is non-NULL, 00234 * then it will be used instead of the associated DSO_METHOD's function. If 00235 * oldcb is non-NULL then it is set to the function pointer value being 00236 * replaced. Return value is non-zero for success. */ 00237 IMPORT_C int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb, 00238 DSO_NAME_CONVERTER_FUNC *oldcb); 00239 /* These functions can be used to get/set the platform-independant filename 00240 * used for a DSO. NB: set will fail if the DSO is already loaded. */ 00241 IMPORT_C const char *DSO_get_filename(DSO *dso); 00242 IMPORT_C int DSO_set_filename(DSO *dso, const char *filename); 00243 /* This function will invoke the DSO's name_converter callback to translate a 00244 * filename, or if the callback isn't set it will instead use the DSO_METHOD's 00245 * converter. If "filename" is NULL, the "filename" in the DSO itself will be 00246 * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is 00247 * simply duplicated. NB: This function is usually called from within a 00248 * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that 00249 * caller-created DSO_METHODs can do the same thing. A non-NULL return value 00250 * will need to be OPENSSL_free()'d. */ 00251 IMPORT_C char *DSO_convert_filename(DSO *dso, const char *filename); 00252 /* This function will invoke the DSO's merger callback to merge two file 00253 * specifications, or if the callback isn't set it will instead use the 00254 * DSO_METHOD's merger. A non-NULL return value will need to be 00255 * OPENSSL_free()'d. */ 00256 IMPORT_C char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2); 00257 /* If the DSO is currently loaded, this returns the filename that it was loaded 00258 * under, otherwise it returns NULL. So it is also useful as a test as to 00259 * whether the DSO is currently loaded. NB: This will not necessarily return 00260 * the same value as DSO_convert_filename(dso, dso->filename), because the 00261 * DSO_METHOD's load function may have tried a variety of filenames (with 00262 * and/or without the aid of the converters) before settling on the one it 00263 * actually loaded. */ 00264 IMPORT_C const char *DSO_get_loaded_filename(DSO *dso); 00265 00266 IMPORT_C void DSO_set_default_method(DSO_METHOD *meth); 00267 IMPORT_C DSO_METHOD *DSO_get_default_method(void); 00268 IMPORT_C DSO_METHOD *DSO_get_method(DSO *dso); 00269 IMPORT_C DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth); 00270 00271 /* The all-singing all-dancing load function, you normally pass NULL 00272 * for the first and third parameters. Use DSO_up and DSO_free for 00273 * subsequent reference count handling. Any flags passed in will be set 00274 * in the constructed DSO after its init() function but before the 00275 * load operation. If 'dso' is non-NULL, 'flags' is ignored. */ 00276 IMPORT_C DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags); 00277 00278 /* This function binds to a variable inside a shared library. */ 00279 IMPORT_C void *DSO_bind_var(DSO *dso, const char *symname); 00280 00281 /* This function binds to a function inside a shared library. */ 00282 IMPORT_C DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname); 00283 00284 /* This method is the default, but will beg, borrow, or steal whatever 00285 * method should be the default on any particular platform (including 00286 * DSO_METH_null() if necessary). */ 00287 IMPORT_C DSO_METHOD *DSO_METHOD_openssl(void); 00288 00289 /* This method is defined for all platforms - if a platform has no 00290 * DSO support then this will be the only method! */ 00291 IMPORT_C DSO_METHOD *DSO_METHOD_null(void); 00292 00293 /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions 00294 * (dlopen, dlclose, dlsym, etc) will be used and incorporated into 00295 * this method. If not, this method will return NULL. */ 00296 IMPORT_C DSO_METHOD *DSO_METHOD_dlfcn(void); 00297 00298 /* If DSO_DL is defined, the standard dl.h-style functions (shl_load, 00299 * shl_unload, shl_findsym, etc) will be used and incorporated into 00300 * this method. If not, this method will return NULL. */ 00301 IMPORT_C DSO_METHOD *DSO_METHOD_dl(void); 00302 00303 00304 /* BEGIN ERROR CODES */ 00305 /* The following lines are auto generated by the script mkerr.pl. Any changes 00306 * made after this point may be overwritten when the script is next run. 00307 */ 00308 IMPORT_C void ERR_load_DSO_strings(void); 00309 00310 /* Error codes for the DSO functions. */ 00311 00312 /* Function codes. */ 00313 #define DSO_F_DLFCN_BIND_FUNC 100 00314 #define DSO_F_DLFCN_BIND_VAR 101 00315 #define DSO_F_DLFCN_LOAD 102 00316 #define DSO_F_DLFCN_MERGER 130 00317 #define DSO_F_DLFCN_NAME_CONVERTER 123 00318 #define DSO_F_DLFCN_UNLOAD 103 00319 #define DSO_F_DL_BIND_FUNC 104 00320 #define DSO_F_DL_BIND_VAR 105 00321 #define DSO_F_DL_LOAD 106 00322 #define DSO_F_DL_MERGER 131 00323 #define DSO_F_DL_NAME_CONVERTER 124 00324 #define DSO_F_DL_UNLOAD 107 00325 #define DSO_F_DSO_BIND_FUNC 108 00326 #define DSO_F_DSO_BIND_VAR 109 00327 #define DSO_F_DSO_CONVERT_FILENAME 126 00328 #define DSO_F_DSO_CTRL 110 00329 #define DSO_F_DSO_FREE 111 00330 #define DSO_F_DSO_GET_FILENAME 127 00331 #define DSO_F_DSO_GET_LOADED_FILENAME 128 00332 #define DSO_F_DSO_LOAD 112 00333 #define DSO_F_DSO_MERGE 132 00334 #define DSO_F_DSO_NEW_METHOD 113 00335 #define DSO_F_DSO_SET_FILENAME 129 00336 #define DSO_F_DSO_SET_NAME_CONVERTER 122 00337 #define DSO_F_DSO_UP_REF 114 00338 #define DSO_F_VMS_BIND_SYM 115 00339 #define DSO_F_VMS_LOAD 116 00340 #define DSO_F_VMS_MERGER 133 00341 #define DSO_F_VMS_UNLOAD 117 00342 #define DSO_F_WIN32_BIND_FUNC 118 00343 #define DSO_F_WIN32_BIND_VAR 119 00344 #define DSO_F_WIN32_JOINER 135 00345 #define DSO_F_WIN32_LOAD 120 00346 #define DSO_F_WIN32_MERGER 134 00347 #define DSO_F_WIN32_NAME_CONVERTER 125 00348 #define DSO_F_WIN32_SPLITTER 136 00349 #define DSO_F_WIN32_UNLOAD 121 00350 00351 /* Reason codes. */ 00352 #define DSO_R_CTRL_FAILED 100 00353 #define DSO_R_DSO_ALREADY_LOADED 110 00354 #define DSO_R_EMPTY_FILE_STRUCTURE 113 00355 #define DSO_R_FAILURE 114 00356 #define DSO_R_FILENAME_TOO_BIG 101 00357 #define DSO_R_FINISH_FAILED 102 00358 #define DSO_R_INCORRECT_FILE_SYNTAX 115 00359 #define DSO_R_LOAD_FAILED 103 00360 #define DSO_R_NAME_TRANSLATION_FAILED 109 00361 #define DSO_R_NO_FILENAME 111 00362 #define DSO_R_NO_FILE_SPECIFICATION 116 00363 #define DSO_R_NULL_HANDLE 104 00364 #define DSO_R_SET_FILENAME_FAILED 112 00365 #define DSO_R_STACK_ERROR 105 00366 #define DSO_R_SYM_FAILURE 106 00367 #define DSO_R_UNLOAD_FAILED 107 00368 #define DSO_R_UNSUPPORTED 108 00369 00370 #ifdef __cplusplus 00371 } 00372 #endif 00373 #endif