dso.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:16k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* dso.h -*- mode:C; c-file-style: "eay" -*- */
  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. #ifndef HEADER_DSO_H
  59. #define HEADER_DSO_H
  60. #include <openssl/crypto.h>
  61. #ifdef __cplusplus
  62. extern "C" {
  63. #endif
  64. /* These values are used as commands to DSO_ctrl() */
  65. #define DSO_CTRL_GET_FLAGS 1
  66. #define DSO_CTRL_SET_FLAGS 2
  67. #define DSO_CTRL_OR_FLAGS 3
  68. /* By default, DSO_load() will translate the provided filename into a form
  69.  * typical for the platform (more specifically the DSO_METHOD) using the
  70.  * dso_name_converter function of the method. Eg. win32 will transform "blah"
  71.  * into "blah.dll", and dlfcn will transform it into "libblah.so". The
  72.  * behaviour can be overriden by setting the name_converter callback in the DSO
  73.  * object (using DSO_set_name_converter()). This callback could even utilise
  74.  * the DSO_METHOD's converter too if it only wants to override behaviour for
  75.  * one or two possible DSO methods. However, the following flag can be set in a
  76.  * DSO to prevent *any* native name-translation at all - eg. if the caller has
  77.  * prompted the user for a path to a driver library so the filename should be
  78.  * interpreted as-is. */
  79. #define DSO_FLAG_NO_NAME_TRANSLATION 0x01
  80. /* An extra flag to give if only the extension should be added as
  81.  * translation.  This is obviously only of importance on Unix and
  82.  * other operating systems where the translation also may prefix
  83.  * the name with something, like 'lib', and ignored everywhere else.
  84.  * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used
  85.  * at the same time. */
  86. #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02
  87. /* The following flag controls the translation of symbol names to upper
  88.  * case.  This is currently only being implemented for OpenVMS.
  89.  */
  90. #define DSO_FLAG_UPCASE_SYMBOL 0x10
  91. /* This flag loads the library with public symbols.
  92.  * Meaning: The exported symbols of this library are public
  93.  * to all libraries loaded after this library.
  94.  * At the moment only implemented in unix.
  95.  */
  96. #define DSO_FLAG_GLOBAL_SYMBOLS 0x20
  97. typedef void (*DSO_FUNC_TYPE)(void);
  98. typedef struct dso_st DSO;
  99. /* The function prototype used for method functions (or caller-provided
  100.  * callbacks) that transform filenames. They are passed a DSO structure pointer
  101.  * (or NULL if they are to be used independantly of a DSO object) and a
  102.  * filename to transform. They should either return NULL (if there is an error
  103.  * condition) or a newly allocated string containing the transformed form that
  104.  * the caller will need to free with OPENSSL_free() when done. */
  105. typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
  106. /* The function prototype used for method functions (or caller-provided
  107.  * callbacks) that merge two file specifications. They are passed a
  108.  * DSO structure pointer (or NULL if they are to be used independantly of
  109.  * a DSO object) and two file specifications to merge. They should
  110.  * either return NULL (if there is an error condition) or a newly allocated
  111.  * string containing the result of merging that the caller will need
  112.  * to free with OPENSSL_free() when done.
  113.  * Here, merging means that bits and pieces are taken from each of the
  114.  * file specifications and added together in whatever fashion that is
  115.  * sensible for the DSO method in question.  The only rule that really
  116.  * applies is that if the two specification contain pieces of the same
  117.  * type, the copy from the first string takes priority.  One could see
  118.  * it as the first specification is the one given by the user and the
  119.  * second being a bunch of defaults to add on if they're missing in the
  120.  * first. */
  121. typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
  122. typedef struct dso_meth_st
  123. {
  124. const char *name;
  125. /* Loads a shared library, NB: new DSO_METHODs must ensure that a
  126.  * successful load populates the loaded_filename field, and likewise a
  127.  * successful unload OPENSSL_frees and NULLs it out. */
  128. int (*dso_load)(DSO *dso);
  129. /* Unloads a shared library */
  130. int (*dso_unload)(DSO *dso);
  131. /* Binds a variable */
  132. void *(*dso_bind_var)(DSO *dso, const char *symname);
  133. /* Binds a function - assumes a return type of DSO_FUNC_TYPE.
  134.  * This should be cast to the real function prototype by the
  135.  * caller. Platforms that don't have compatible representations
  136.  * for different prototypes (this is possible within ANSI C)
  137.  * are highly unlikely to have shared libraries at all, let
  138.  * alone a DSO_METHOD implemented for them. */
  139. DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname);
  140. /* I don't think this would actually be used in any circumstances. */
  141. #if 0
  142. /* Unbinds a variable */
  143. int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr);
  144. /* Unbinds a function */
  145. int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
  146. #endif
  147. /* The generic (yuck) "ctrl()" function. NB: Negative return
  148.  * values (rather than zero) indicate errors. */
  149. long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg);
  150. /* The default DSO_METHOD-specific function for converting filenames to
  151.  * a canonical native form. */
  152. DSO_NAME_CONVERTER_FUNC dso_name_converter;
  153. /* The default DSO_METHOD-specific function for converting filenames to
  154.  * a canonical native form. */
  155. DSO_MERGER_FUNC dso_merger;
  156. /* [De]Initialisation handlers. */
  157. int (*init)(DSO *dso);
  158. int (*finish)(DSO *dso);
  159. } DSO_METHOD;
  160. /**********************************************************************/
  161. /* The low-level handle type used to refer to a loaded shared library */
  162. struct dso_st
  163. {
  164. DSO_METHOD *meth;
  165. /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
  166.  * doesn't use anything but will need to cache the filename
  167.  * for use in the dso_bind handler. All in all, let each
  168.  * method control its own destiny. "Handles" and such go in
  169.  * a STACK. */
  170. STACK *meth_data;
  171. int references;
  172. int flags;
  173. /* For use by applications etc ... use this for your bits'n'pieces,
  174.  * don't touch meth_data! */
  175. CRYPTO_EX_DATA ex_data;
  176. /* If this callback function pointer is set to non-NULL, then it will
  177.  * be used in DSO_load() in place of meth->dso_name_converter. NB: This
  178.  * should normally set using DSO_set_name_converter(). */
  179. DSO_NAME_CONVERTER_FUNC name_converter;
  180. /* If this callback function pointer is set to non-NULL, then it will
  181.  * be used in DSO_load() in place of meth->dso_merger. NB: This
  182.  * should normally set using DSO_set_merger(). */
  183. DSO_MERGER_FUNC merger;
  184. /* This is populated with (a copy of) the platform-independant
  185.  * filename used for this DSO. */
  186. char *filename;
  187. /* This is populated with (a copy of) the translated filename by which
  188.  * the DSO was actually loaded. It is NULL iff the DSO is not currently
  189.  * loaded. NB: This is here because the filename translation process
  190.  * may involve a callback being invoked more than once not only to
  191.  * convert to a platform-specific form, but also to try different
  192.  * filenames in the process of trying to perform a load. As such, this
  193.  * variable can be used to indicate (a) whether this DSO structure
  194.  * corresponds to a loaded library or not, and (b) the filename with
  195.  * which it was actually loaded. */
  196. char *loaded_filename;
  197. };
  198. DSO * DSO_new(void);
  199. DSO * DSO_new_method(DSO_METHOD *method);
  200. int DSO_free(DSO *dso);
  201. int DSO_flags(DSO *dso);
  202. int DSO_up_ref(DSO *dso);
  203. long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
  204. /* This function sets the DSO's name_converter callback. If it is non-NULL,
  205.  * then it will be used instead of the associated DSO_METHOD's function. If
  206.  * oldcb is non-NULL then it is set to the function pointer value being
  207.  * replaced. Return value is non-zero for success. */
  208. int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
  209. DSO_NAME_CONVERTER_FUNC *oldcb);
  210. /* These functions can be used to get/set the platform-independant filename
  211.  * used for a DSO. NB: set will fail if the DSO is already loaded. */
  212. const char *DSO_get_filename(DSO *dso);
  213. int DSO_set_filename(DSO *dso, const char *filename);
  214. /* This function will invoke the DSO's name_converter callback to translate a
  215.  * filename, or if the callback isn't set it will instead use the DSO_METHOD's
  216.  * converter. If "filename" is NULL, the "filename" in the DSO itself will be
  217.  * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
  218.  * simply duplicated. NB: This function is usually called from within a
  219.  * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that
  220.  * caller-created DSO_METHODs can do the same thing. A non-NULL return value
  221.  * will need to be OPENSSL_free()'d. */
  222. char *DSO_convert_filename(DSO *dso, const char *filename);
  223. /* This function will invoke the DSO's merger callback to merge two file
  224.  * specifications, or if the callback isn't set it will instead use the
  225.  * DSO_METHOD's merger.  A non-NULL return value will need to be
  226.  * OPENSSL_free()'d. */
  227. char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
  228. /* If the DSO is currently loaded, this returns the filename that it was loaded
  229.  * under, otherwise it returns NULL. So it is also useful as a test as to
  230.  * whether the DSO is currently loaded. NB: This will not necessarily return
  231.  * the same value as DSO_convert_filename(dso, dso->filename), because the
  232.  * DSO_METHOD's load function may have tried a variety of filenames (with
  233.  * and/or without the aid of the converters) before settling on the one it
  234.  * actually loaded. */
  235. const char *DSO_get_loaded_filename(DSO *dso);
  236. void DSO_set_default_method(DSO_METHOD *meth);
  237. DSO_METHOD *DSO_get_default_method(void);
  238. DSO_METHOD *DSO_get_method(DSO *dso);
  239. DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
  240. /* The all-singing all-dancing load function, you normally pass NULL
  241.  * for the first and third parameters. Use DSO_up and DSO_free for
  242.  * subsequent reference count handling. Any flags passed in will be set
  243.  * in the constructed DSO after its init() function but before the
  244.  * load operation. If 'dso' is non-NULL, 'flags' is ignored. */
  245. DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
  246. /* This function binds to a variable inside a shared library. */
  247. void *DSO_bind_var(DSO *dso, const char *symname);
  248. /* This function binds to a function inside a shared library. */
  249. DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
  250. /* This method is the default, but will beg, borrow, or steal whatever
  251.  * method should be the default on any particular platform (including
  252.  * DSO_METH_null() if necessary). */
  253. DSO_METHOD *DSO_METHOD_openssl(void);
  254. /* This method is defined for all platforms - if a platform has no
  255.  * DSO support then this will be the only method! */
  256. DSO_METHOD *DSO_METHOD_null(void);
  257. /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
  258.  * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
  259.  * this method. If not, this method will return NULL. */
  260. DSO_METHOD *DSO_METHOD_dlfcn(void);
  261. /* If DSO_DL is defined, the standard dl.h-style functions (shl_load, 
  262.  * shl_unload, shl_findsym, etc) will be used and incorporated into
  263.  * this method. If not, this method will return NULL. */
  264. DSO_METHOD *DSO_METHOD_dl(void);
  265. /* If WIN32 is defined, use DLLs. If not, return NULL. */
  266. DSO_METHOD *DSO_METHOD_win32(void);
  267. /* If VMS is defined, use shared images. If not, return NULL. */
  268. DSO_METHOD *DSO_METHOD_vms(void);
  269. /* BEGIN ERROR CODES */
  270. /* The following lines are auto generated by the script mkerr.pl. Any changes
  271.  * made after this point may be overwritten when the script is next run.
  272.  */
  273. void ERR_load_DSO_strings(void);
  274. /* Error codes for the DSO functions. */
  275. /* Function codes. */
  276. #define DSO_F_DLFCN_BIND_FUNC  100
  277. #define DSO_F_DLFCN_BIND_VAR  101
  278. #define DSO_F_DLFCN_LOAD  102
  279. #define DSO_F_DLFCN_MERGER  130
  280. #define DSO_F_DLFCN_NAME_CONVERTER  123
  281. #define DSO_F_DLFCN_UNLOAD  103
  282. #define DSO_F_DL_BIND_FUNC  104
  283. #define DSO_F_DL_BIND_VAR  105
  284. #define DSO_F_DL_LOAD  106
  285. #define DSO_F_DL_MERGER  131
  286. #define DSO_F_DL_NAME_CONVERTER  124
  287. #define DSO_F_DL_UNLOAD  107
  288. #define DSO_F_DSO_BIND_FUNC  108
  289. #define DSO_F_DSO_BIND_VAR  109
  290. #define DSO_F_DSO_CONVERT_FILENAME  126
  291. #define DSO_F_DSO_CTRL  110
  292. #define DSO_F_DSO_FREE  111
  293. #define DSO_F_DSO_GET_FILENAME  127
  294. #define DSO_F_DSO_GET_LOADED_FILENAME  128
  295. #define DSO_F_DSO_LOAD  112
  296. #define DSO_F_DSO_MERGE  132
  297. #define DSO_F_DSO_NEW_METHOD  113
  298. #define DSO_F_DSO_SET_FILENAME  129
  299. #define DSO_F_DSO_SET_NAME_CONVERTER  122
  300. #define DSO_F_DSO_UP_REF  114
  301. #define DSO_F_VMS_BIND_SYM  115
  302. #define DSO_F_VMS_LOAD  116
  303. #define DSO_F_VMS_MERGER  133
  304. #define DSO_F_VMS_UNLOAD  117
  305. #define DSO_F_WIN32_BIND_FUNC  118
  306. #define DSO_F_WIN32_BIND_VAR  119
  307. #define DSO_F_WIN32_JOINER  135
  308. #define DSO_F_WIN32_LOAD  120
  309. #define DSO_F_WIN32_MERGER  134
  310. #define DSO_F_WIN32_NAME_CONVERTER  125
  311. #define DSO_F_WIN32_SPLITTER  136
  312. #define DSO_F_WIN32_UNLOAD  121
  313. /* Reason codes. */
  314. #define DSO_R_CTRL_FAILED  100
  315. #define DSO_R_DSO_ALREADY_LOADED  110
  316. #define DSO_R_EMPTY_FILE_STRUCTURE  113
  317. #define DSO_R_FAILURE  114
  318. #define DSO_R_FILENAME_TOO_BIG  101
  319. #define DSO_R_FINISH_FAILED  102
  320. #define DSO_R_INCORRECT_FILE_SYNTAX  115
  321. #define DSO_R_LOAD_FAILED  103
  322. #define DSO_R_NAME_TRANSLATION_FAILED  109
  323. #define DSO_R_NO_FILENAME  111
  324. #define DSO_R_NO_FILE_SPECIFICATION  116
  325. #define DSO_R_NULL_HANDLE  104
  326. #define DSO_R_SET_FILENAME_FAILED  112
  327. #define DSO_R_STACK_ERROR  105
  328. #define DSO_R_SYM_FAILURE  106
  329. #define DSO_R_UNLOAD_FAILED  107
  330. #define DSO_R_UNSUPPORTED  108
  331. #ifdef  __cplusplus
  332. }
  333. #endif
  334. #endif