dso.h revision 68651
1/* dso.h */ 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 65extern "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/* These flags control the translation of file-names from canonical to 74 * native. Eg. in the CryptoSwift support, the "dl" and "dlfcn" 75 * methods will translate "swift" -> "libswift.so" whereas the "win32" 76 * method will translate "swift" -> "swift.dll". NB: Until I can figure 77 * out how to be more "conventional" with this, the methods will only 78 * honour this flag if it looks like it was passed a file without any 79 * path and if the filename is small enough. 80 */ 81#define DSO_FLAG_NAME_TRANSLATION 0x01 82 83/* The following flag controls the translation of symbol names to upper 84 * case. This is currently only being implemented for OpenVMS. 85 */ 86#define DSO_FLAG_UPCASE_SYMBOL 0x02 87 88 89typedef void (*DSO_FUNC_TYPE)(void); 90 91typedef struct dso_st DSO; 92 93typedef struct dso_meth_st 94 { 95 const char *name; 96 /* Loads a shared library */ 97 int (*dso_load)(DSO *dso, const char *filename); 98 /* Unloads a shared library */ 99 int (*dso_unload)(DSO *dso); 100 /* Binds a variable */ 101 void *(*dso_bind_var)(DSO *dso, const char *symname); 102 /* Binds a function - assumes a return type of DSO_FUNC_TYPE. 103 * This should be cast to the real function prototype by the 104 * caller. Platforms that don't have compatible representations 105 * for different prototypes (this is possible within ANSI C) 106 * are highly unlikely to have shared libraries at all, let 107 * alone a DSO_METHOD implemented for them. */ 108 DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname); 109 110/* I don't think this would actually be used in any circumstances. */ 111#if 0 112 /* Unbinds a variable */ 113 int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr); 114 /* Unbinds a function */ 115 int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr); 116#endif 117 /* The generic (yuck) "ctrl()" function. NB: Negative return 118 * values (rather than zero) indicate errors. */ 119 long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg); 120 121 /* [De]Initialisation handlers. */ 122 int (*init)(DSO *dso); 123 int (*finish)(DSO *dso); 124 } DSO_METHOD; 125 126/**********************************************************************/ 127/* The low-level handle type used to refer to a loaded shared library */ 128 129struct dso_st 130 { 131 DSO_METHOD *meth; 132 /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS 133 * doesn't use anything but will need to cache the filename 134 * for use in the dso_bind handler. All in all, let each 135 * method control its own destiny. "Handles" and such go in 136 * a STACK. */ 137 STACK *meth_data; 138 int references; 139 int flags; 140 /* For use by applications etc ... use this for your bits'n'pieces, 141 * don't touch meth_data! */ 142 CRYPTO_EX_DATA ex_data; 143 }; 144 145 146DSO * DSO_new(void); 147DSO * DSO_new_method(DSO_METHOD *method); 148int DSO_free(DSO *dso); 149int DSO_flags(DSO *dso); 150int DSO_up(DSO *dso); 151long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg); 152 153void DSO_set_default_method(DSO_METHOD *meth); 154DSO_METHOD *DSO_get_default_method(void); 155DSO_METHOD *DSO_get_method(DSO *dso); 156DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth); 157 158/* The all-singing all-dancing load function, you normally pass NULL 159 * for the first and third parameters. Use DSO_up and DSO_free for 160 * subsequent reference count handling. Any flags passed in will be set 161 * in the constructed DSO after its init() function but before the 162 * load operation. This will be done with; 163 * DSO_ctrl(dso, DSO_CTRL_SET_FLAGS, flags, NULL); */ 164DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags); 165 166/* This function binds to a variable inside a shared library. */ 167void *DSO_bind_var(DSO *dso, const char *symname); 168 169/* This function binds to a function inside a shared library. */ 170DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname); 171 172/* This method is the default, but will beg, borrow, or steal whatever 173 * method should be the default on any particular platform (including 174 * DSO_METH_null() if necessary). */ 175DSO_METHOD *DSO_METHOD_openssl(void); 176 177/* This method is defined for all platforms - if a platform has no 178 * DSO support then this will be the only method! */ 179DSO_METHOD *DSO_METHOD_null(void); 180 181/* If DSO_DLFCN is defined, the standard dlfcn.h-style functions 182 * (dlopen, dlclose, dlsym, etc) will be used and incorporated into 183 * this method. If not, this method will return NULL. */ 184DSO_METHOD *DSO_METHOD_dlfcn(void); 185 186/* If DSO_DL is defined, the standard dl.h-style functions (shl_load, 187 * shl_unload, shl_findsym, etc) will be used and incorporated into 188 * this method. If not, this method will return NULL. */ 189DSO_METHOD *DSO_METHOD_dl(void); 190 191/* If WIN32 is defined, use DLLs. If not, return NULL. */ 192DSO_METHOD *DSO_METHOD_win32(void); 193 194/* If VMS is defined, use shared images. If not, return NULL. */ 195DSO_METHOD *DSO_METHOD_vms(void); 196 197void ERR_load_DSO_strings(void); 198 199/* BEGIN ERROR CODES */ 200/* The following lines are auto generated by the script mkerr.pl. Any changes 201 * made after this point may be overwritten when the script is next run. 202 */ 203 204/* Error codes for the DSO functions. */ 205 206/* Function codes. */ 207#define DSO_F_DLFCN_BIND_FUNC 100 208#define DSO_F_DLFCN_BIND_VAR 101 209#define DSO_F_DLFCN_CTRL 102 210#define DSO_F_DLFCN_LOAD 103 211#define DSO_F_DLFCN_UNLOAD 104 212#define DSO_F_DL_BIND_FUNC 105 213#define DSO_F_DL_BIND_VAR 106 214#define DSO_F_DL_CTRL 107 215#define DSO_F_DL_LOAD 108 216#define DSO_F_DL_UNLOAD 109 217#define DSO_F_DSO_BIND_FUNC 110 218#define DSO_F_DSO_BIND_VAR 111 219#define DSO_F_DSO_CTRL 112 220#define DSO_F_DSO_FREE 113 221#define DSO_F_DSO_LOAD 114 222#define DSO_F_DSO_NEW_METHOD 115 223#define DSO_F_DSO_UP 116 224#define DSO_F_VMS_BIND_VAR 122 225#define DSO_F_VMS_CTRL 123 226#define DSO_F_VMS_LOAD 124 227#define DSO_F_VMS_UNLOAD 125 228#define DSO_F_WIN32_BIND_FUNC 117 229#define DSO_F_WIN32_BIND_VAR 118 230#define DSO_F_WIN32_CTRL 119 231#define DSO_F_WIN32_LOAD 120 232#define DSO_F_WIN32_UNLOAD 121 233 234/* Reason codes. */ 235#define DSO_R_CTRL_FAILED 100 236#define DSO_R_FILENAME_TOO_BIG 109 237#define DSO_R_FINISH_FAILED 101 238#define DSO_R_LOAD_FAILED 102 239#define DSO_R_NULL_HANDLE 103 240#define DSO_R_STACK_ERROR 104 241#define DSO_R_SYM_FAILURE 105 242#define DSO_R_UNKNOWN_COMMAND 106 243#define DSO_R_UNLOAD_FAILED 107 244#define DSO_R_UNSUPPORTED 108 245 246#ifdef __cplusplus 247} 248#endif 249#endif 250 251