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
  69 typedef struct dso_st DSO;
  70
  71 typedef struct dso_meth_st
  72         {
  73         const char *name;
  74         /* Loads a shared library */
  75         int (*dso_load)(DSO *dso, char *filename);
  76         /* Unloads a shared library */
  77         int (*dso_unload)(DSO *dso);
  78         /* Binds a function, variable, or whatever */
  79         int (*dso_bind)(DSO *dso, char *symname, void **symptr);
  80
  81 /* I don't think this would actually be used in any circumstances. */
  82 #if 0
  83         /* Unbinds a symbol */
  84         int (*dso_unbind)(DSO *dso, char *symname, void *symptr);
  85 #endif
  86
  87         int (*init)(DSO *dso);
  88         int (*finish)(DSO *dso);
  89         } DSO_METHOD;
  90
  91 /**********************************************************************/
  92 /* The low-level handle type used to refer to a loaded shared library */
  93
  94 struct dso_st
  95         {
  96         DSO_METHOD *meth;
  97         /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
  98          * doesn't use anything but will need to cache the filename
  99          * for use in the dso_bind handler. All in all, let each
 100          * method control its own destiny. "Handles" and such go in
 101          * a STACK. */
 102         STACK *meth_data;
 103         int references;
 104         int flags;
 105         /* For use by applications etc ... use this for your bits'n'pieces,
 106          * don't touch meth_data! */
 107         CRYPTO_EX_DATA ex_data;
 108         };
 109
 110
 111 DSO *   DSO_new(void);
 112 DSO *   DSO_new_method(DSO_METHOD *method);
 113 int     DSO_free(DSO *dso);
 114 int     DSO_flags(DSO *dso);
 115 int     DSO_up(DSO *dso);
 116
 117 void DSO_set_default_method(DSO_METHOD *meth);
 118 DSO_METHOD *DSO_get_default_method(void);
 119 DSO_METHOD *DSO_get_method(DSO *dso);
 120 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
 121
 122 /* The all-singing all-dancing load function, you normally pass NULL
 123  * for the last two parameters. Use DSO_up and DSO_free for reference
 124  * count handling. */
 125 DSO *DSO_load(DSO *dso, char *filename, DSO_METHOD *meth);
 126
 127 /* This function binds to a function, variable, whatever inside a
 128  * shared library. */
 129 void *DSO_bind(DSO *dso, char *symname);
 130
 131 /* This method is the default, but will beg, borrow, or steal whatever
 132  * method should be the default on any particular platform (including
 133  * DSO_METH_null() if necessary). */
 134 DSO_METHOD *DSO_METHOD_openssl(void);
 135
 136 /* This method is defined for all platforms - if a platform has no
 137  * DSO support then this will be the only method! */
 138 DSO_METHOD *DSO_METHOD_null(void);
 139
 140 /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
 141  * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
 142  * this method. If not, this method will return NULL. */
 143 DSO_METHOD *DSO_METHOD_dlfcn(void);
 144
 145 /* If DSO_DL is defined, the standard dl.h-style functions (shl_load,
 146  * shl_unload, shl_findsym, etc) will be used and incorporated into
 147  * this method. If not, this method will return NULL. */
 148 DSO_METHOD *DSO_METHOD_dl(void);
 149
 150 /* If WIN32 is defined, use DLLs. If not, return NULL. */
 151 DSO_METHOD *DSO_METHOD_win32(void);
 152
 153 void ERR_load_DSO_strings(void);
 154
 155 /* BEGIN ERROR CODES */
 156 /* The following lines are auto generated by the script mkerr.pl. Any changes
 157  * made after this point may be overwritten when the script is next run.
 158  */
 159
 160 /* Error codes for the DSO functions. */
 161
 162 /* Function codes. */
 163 #define DSO_F_DLFCN_BIND                                 100
 164 #define DSO_F_DLFCN_LOAD                                 101
 165 #define DSO_F_DLFCN_UNLOAD                               102
 166 #define DSO_F_DL_BIND                                    103
 167 #define DSO_F_DL_LOAD                                    104
 168 #define DSO_F_DL_UNLOAD                                  105
 169 #define DSO_F_DSO_BIND                                   106
 170 #define DSO_F_DSO_FREE                                   107
 171 #define DSO_F_DSO_LOAD                                   108
 172 #define DSO_F_DSO_NEW_METHOD                             109
 173 #define DSO_F_DSO_UP                                     110
 174 #define DSO_F_WIN32_BIND                                 111
 175 #define DSO_F_WIN32_LOAD                                 112
 176 #define DSO_F_WIN32_UNLOAD                               113
 177
 178 /* Reason codes. */
 179 #define DSO_R_FINISH_FAILED                              100
 180 #define DSO_R_LOAD_FAILED                                101
 181 #define DSO_R_NULL_HANDLE                                102
 182 #define DSO_R_STACK_ERROR                                103
 183 #define DSO_R_SYM_FAILURE                                104
 184 #define DSO_R_UNLOAD_FAILED                              105
 185 #define DSO_R_UNSUPPORTED                                106
 186
 187 #ifdef  __cplusplus
 188 }
 189 #endif
 190 #endif
 191