crypto/dso/dso.h

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