dso.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. /* dso.h -*- mode:C; c-file-style: "eay" -*- */
  2. /*
  3. * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
  4. * 2000.
  5. */
  6. /* ====================================================================
  7. * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. *
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. *
  16. * 2. Redistributions in binary form must reproduce the above copyright
  17. * notice, this list of conditions and the following disclaimer in
  18. * the documentation and/or other materials provided with the
  19. * distribution.
  20. *
  21. * 3. All advertising materials mentioning features or use of this
  22. * software must display the following acknowledgment:
  23. * "This product includes software developed by the OpenSSL Project
  24. * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25. *
  26. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27. * endorse or promote products derived from this software without
  28. * prior written permission. For written permission, please contact
  29. * licensing@OpenSSL.org.
  30. *
  31. * 5. Products derived from this software may not be called "OpenSSL"
  32. * nor may "OpenSSL" appear in their names without prior written
  33. * permission of the OpenSSL Project.
  34. *
  35. * 6. Redistributions of any form whatsoever must retain the following
  36. * acknowledgment:
  37. * "This product includes software developed by the OpenSSL Project
  38. * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51. * OF THE POSSIBILITY OF SUCH DAMAGE.
  52. * ====================================================================
  53. *
  54. * This product includes cryptographic software written by Eric Young
  55. * (eay@cryptsoft.com). This product includes software written by Tim
  56. * Hudson (tjh@cryptsoft.com).
  57. *
  58. */
  59. #ifndef HEADER_DSO_H
  60. # define HEADER_DSO_H
  61. # include <openssl/crypto.h>
  62. #ifdef __cplusplus
  63. extern "C" {
  64. #endif
  65. /* These values are used as commands to DSO_ctrl() */
  66. # define DSO_CTRL_GET_FLAGS 1
  67. # define DSO_CTRL_SET_FLAGS 2
  68. # define DSO_CTRL_OR_FLAGS 3
  69. /*
  70. * By default, DSO_load() will translate the provided filename into a form
  71. * typical for the platform (more specifically the DSO_METHOD) using the
  72. * dso_name_converter function of the method. Eg. win32 will transform "blah"
  73. * into "blah.dll", and dlfcn will transform it into "libblah.so". The
  74. * behaviour can be overriden by setting the name_converter callback in the
  75. * DSO object (using DSO_set_name_converter()). This callback could even
  76. * utilise the DSO_METHOD's converter too if it only wants to override
  77. * behaviour for one or two possible DSO methods. However, the following flag
  78. * can be set in a DSO to prevent *any* native name-translation at all - eg.
  79. * if the caller has prompted the user for a path to a driver library so the
  80. * filename should be interpreted as-is.
  81. */
  82. # define DSO_FLAG_NO_NAME_TRANSLATION 0x01
  83. /*
  84. * An extra flag to give if only the extension should be added as
  85. * translation. This is obviously only of importance on Unix and other
  86. * operating systems where the translation also may prefix the name with
  87. * something, like 'lib', and ignored everywhere else. This flag is also
  88. * ignored if DSO_FLAG_NO_NAME_TRANSLATION is used at the same time.
  89. */
  90. # define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02
  91. /*
  92. * The following flag controls the translation of symbol names to upper case.
  93. * This is currently only being implemented for OpenVMS.
  94. */
  95. # define DSO_FLAG_UPCASE_SYMBOL 0x10
  96. /*
  97. * This flag loads the library with public symbols. Meaning: The exported
  98. * symbols of this library are public to all libraries loaded after this
  99. * library. At the moment only implemented in unix.
  100. */
  101. # define DSO_FLAG_GLOBAL_SYMBOLS 0x20
  102. typedef void (*DSO_FUNC_TYPE) (void);
  103. typedef struct dso_st DSO;
  104. /*
  105. * The function prototype used for method functions (or caller-provided
  106. * callbacks) that transform filenames. They are passed a DSO structure
  107. * pointer (or NULL if they are to be used independantly of a DSO object) and
  108. * a filename to transform. They should either return NULL (if there is an
  109. * error condition) or a newly allocated string containing the transformed
  110. * form that the caller will need to free with OPENSSL_free() when done.
  111. */
  112. typedef char *(*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
  113. /*
  114. * The function prototype used for method functions (or caller-provided
  115. * callbacks) that merge two file specifications. They are passed a DSO
  116. * structure pointer (or NULL if they are to be used independantly of a DSO
  117. * object) and two file specifications to merge. They should either return
  118. * NULL (if there is an error condition) or a newly allocated string
  119. * containing the result of merging that the caller will need to free with
  120. * OPENSSL_free() when done. Here, merging means that bits and pieces are
  121. * taken from each of the file specifications and added together in whatever
  122. * fashion that is sensible for the DSO method in question. The only rule
  123. * that really applies is that if the two specification contain pieces of the
  124. * same type, the copy from the first string takes priority. One could see
  125. * it as the first specification is the one given by the user and the second
  126. * being a bunch of defaults to add on if they're missing in the first.
  127. */
  128. typedef char *(*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
  129. typedef struct dso_meth_st {
  130. const char *name;
  131. /*
  132. * Loads a shared library, NB: new DSO_METHODs must ensure that a
  133. * successful load populates the loaded_filename field, and likewise a
  134. * successful unload OPENSSL_frees and NULLs it out.
  135. */
  136. int (*dso_load) (DSO *dso);
  137. /* Unloads a shared library */
  138. int (*dso_unload) (DSO *dso);
  139. /* Binds a variable */
  140. void *(*dso_bind_var) (DSO *dso, const char *symname);
  141. /*
  142. * Binds a function - assumes a return type of DSO_FUNC_TYPE. This should
  143. * be cast to the real function prototype by the caller. Platforms that
  144. * don't have compatible representations for different prototypes (this
  145. * is possible within ANSI C) are highly unlikely to have shared
  146. * libraries at all, let alone a DSO_METHOD implemented for them.
  147. */
  148. DSO_FUNC_TYPE (*dso_bind_func) (DSO *dso, const char *symname);
  149. /* I don't think this would actually be used in any circumstances. */
  150. # if 0
  151. /* Unbinds a variable */
  152. int (*dso_unbind_var) (DSO *dso, char *symname, void *symptr);
  153. /* Unbinds a function */
  154. int (*dso_unbind_func) (DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
  155. # endif
  156. /*
  157. * The generic (yuck) "ctrl()" function. NB: Negative return values
  158. * (rather than zero) indicate errors.
  159. */
  160. long (*dso_ctrl) (DSO *dso, int cmd, long larg, void *parg);
  161. /*
  162. * The default DSO_METHOD-specific function for converting filenames to a
  163. * canonical native form.
  164. */
  165. DSO_NAME_CONVERTER_FUNC dso_name_converter;
  166. /*
  167. * The default DSO_METHOD-specific function for converting filenames to a
  168. * canonical native form.
  169. */
  170. DSO_MERGER_FUNC dso_merger;
  171. /* [De]Initialisation handlers. */
  172. int (*init) (DSO *dso);
  173. int (*finish) (DSO *dso);
  174. } DSO_METHOD;
  175. /**********************************************************************/
  176. /* The low-level handle type used to refer to a loaded shared library */
  177. struct dso_st {
  178. DSO_METHOD *meth;
  179. /*
  180. * Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS doesn't use
  181. * anything but will need to cache the filename for use in the dso_bind
  182. * handler. All in all, let each method control its own destiny.
  183. * "Handles" and such go in a STACK.
  184. */
  185. STACK *meth_data;
  186. int references;
  187. int flags;
  188. /*
  189. * For use by applications etc ... use this for your bits'n'pieces, don't
  190. * touch meth_data!
  191. */
  192. CRYPTO_EX_DATA ex_data;
  193. /*
  194. * If this callback function pointer is set to non-NULL, then it will be
  195. * used in DSO_load() in place of meth->dso_name_converter. NB: This
  196. * should normally set using DSO_set_name_converter().
  197. */
  198. DSO_NAME_CONVERTER_FUNC name_converter;
  199. /*
  200. * If this callback function pointer is set to non-NULL, then it will be
  201. * used in DSO_load() in place of meth->dso_merger. NB: This should
  202. * normally set using DSO_set_merger().
  203. */
  204. DSO_MERGER_FUNC merger;
  205. /*
  206. * This is populated with (a copy of) the platform-independant filename
  207. * used for this DSO.
  208. */
  209. char *filename;
  210. /*
  211. * This is populated with (a copy of) the translated filename by which
  212. * the DSO was actually loaded. It is NULL iff the DSO is not currently
  213. * loaded. NB: This is here because the filename translation process may
  214. * involve a callback being invoked more than once not only to convert to
  215. * a platform-specific form, but also to try different filenames in the
  216. * process of trying to perform a load. As such, this variable can be
  217. * used to indicate (a) whether this DSO structure corresponds to a
  218. * loaded library or not, and (b) the filename with which it was actually
  219. * loaded.
  220. */
  221. char *loaded_filename;
  222. };
  223. DSO *DSO_new(void);
  224. DSO *DSO_new_method(DSO_METHOD *method);
  225. int DSO_free(DSO *dso);
  226. int DSO_flags(DSO *dso);
  227. int DSO_up_ref(DSO *dso);
  228. long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
  229. /*
  230. * This function sets the DSO's name_converter callback. If it is non-NULL,
  231. * then it will be used instead of the associated DSO_METHOD's function. If
  232. * oldcb is non-NULL then it is set to the function pointer value being
  233. * replaced. Return value is non-zero for success.
  234. */
  235. int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
  236. DSO_NAME_CONVERTER_FUNC *oldcb);
  237. /*
  238. * These functions can be used to get/set the platform-independant filename
  239. * used for a DSO. NB: set will fail if the DSO is already loaded.
  240. */
  241. const char *DSO_get_filename(DSO *dso);
  242. int DSO_set_filename(DSO *dso, const char *filename);
  243. /*
  244. * This function will invoke the DSO's name_converter callback to translate a
  245. * filename, or if the callback isn't set it will instead use the DSO_METHOD's
  246. * converter. If "filename" is NULL, the "filename" in the DSO itself will be
  247. * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
  248. * simply duplicated. NB: This function is usually called from within a
  249. * DSO_METHOD during the processing of a DSO_load() call, and is exposed so
  250. * that caller-created DSO_METHODs can do the same thing. A non-NULL return
  251. * value will need to be OPENSSL_free()'d.
  252. */
  253. char *DSO_convert_filename(DSO *dso, const char *filename);
  254. /*
  255. * This function will invoke the DSO's merger callback to merge two file
  256. * specifications, or if the callback isn't set it will instead use the
  257. * DSO_METHOD's merger. A non-NULL return value will need to be
  258. * OPENSSL_free()'d.
  259. */
  260. char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
  261. /*
  262. * If the DSO is currently loaded, this returns the filename that it was
  263. * loaded under, otherwise it returns NULL. So it is also useful as a test as
  264. * to whether the DSO is currently loaded. NB: This will not necessarily
  265. * return the same value as DSO_convert_filename(dso, dso->filename), because
  266. * the DSO_METHOD's load function may have tried a variety of filenames (with
  267. * and/or without the aid of the converters) before settling on the one it
  268. * actually loaded.
  269. */
  270. const char *DSO_get_loaded_filename(DSO *dso);
  271. void DSO_set_default_method(DSO_METHOD *meth);
  272. DSO_METHOD *DSO_get_default_method(void);
  273. DSO_METHOD *DSO_get_method(DSO *dso);
  274. DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
  275. /*
  276. * The all-singing all-dancing load function, you normally pass NULL for the
  277. * first and third parameters. Use DSO_up and DSO_free for subsequent
  278. * reference count handling. Any flags passed in will be set in the
  279. * constructed DSO after its init() function but before the load operation.
  280. * If 'dso' is non-NULL, 'flags' is ignored.
  281. */
  282. DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
  283. /* This function binds to a variable inside a shared library. */
  284. void *DSO_bind_var(DSO *dso, const char *symname);
  285. /* This function binds to a function inside a shared library. */
  286. DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
  287. /*
  288. * This method is the default, but will beg, borrow, or steal whatever method
  289. * should be the default on any particular platform (including
  290. * DSO_METH_null() if necessary).
  291. */
  292. DSO_METHOD *DSO_METHOD_openssl(void);
  293. /*
  294. * This method is defined for all platforms - if a platform has no DSO
  295. * support then this will be the only method!
  296. */
  297. DSO_METHOD *DSO_METHOD_null(void);
  298. /*
  299. * If DSO_DLFCN is defined, the standard dlfcn.h-style functions (dlopen,
  300. * dlclose, dlsym, etc) will be used and incorporated into this method. If
  301. * not, this method will return NULL.
  302. */
  303. DSO_METHOD *DSO_METHOD_dlfcn(void);
  304. /*
  305. * If DSO_DL is defined, the standard dl.h-style functions (shl_load,
  306. * shl_unload, shl_findsym, etc) will be used and incorporated into this
  307. * method. If not, this method will return NULL.
  308. */
  309. DSO_METHOD *DSO_METHOD_dl(void);
  310. /* If WIN32 is defined, use DLLs. If not, return NULL. */
  311. DSO_METHOD *DSO_METHOD_win32(void);
  312. /* If VMS is defined, use shared images. If not, return NULL. */
  313. DSO_METHOD *DSO_METHOD_vms(void);
  314. /* BEGIN ERROR CODES */
  315. /*
  316. * The following lines are auto generated by the script mkerr.pl. Any changes
  317. * made after this point may be overwritten when the script is next run.
  318. */
  319. void ERR_load_DSO_strings(void);
  320. /* Error codes for the DSO functions. */
  321. /* Function codes. */
  322. # define DSO_F_DLFCN_BIND_FUNC 100
  323. # define DSO_F_DLFCN_BIND_VAR 101
  324. # define DSO_F_DLFCN_LOAD 102
  325. # define DSO_F_DLFCN_MERGER 130
  326. # define DSO_F_DLFCN_NAME_CONVERTER 123
  327. # define DSO_F_DLFCN_UNLOAD 103
  328. # define DSO_F_DL_BIND_FUNC 104
  329. # define DSO_F_DL_BIND_VAR 105
  330. # define DSO_F_DL_LOAD 106
  331. # define DSO_F_DL_MERGER 131
  332. # define DSO_F_DL_NAME_CONVERTER 124
  333. # define DSO_F_DL_UNLOAD 107
  334. # define DSO_F_DSO_BIND_FUNC 108
  335. # define DSO_F_DSO_BIND_VAR 109
  336. # define DSO_F_DSO_CONVERT_FILENAME 126
  337. # define DSO_F_DSO_CTRL 110
  338. # define DSO_F_DSO_FREE 111
  339. # define DSO_F_DSO_GET_FILENAME 127
  340. # define DSO_F_DSO_GET_LOADED_FILENAME 128
  341. # define DSO_F_DSO_LOAD 112
  342. # define DSO_F_DSO_MERGE 132
  343. # define DSO_F_DSO_NEW_METHOD 113
  344. # define DSO_F_DSO_SET_FILENAME 129
  345. # define DSO_F_DSO_SET_NAME_CONVERTER 122
  346. # define DSO_F_DSO_UP_REF 114
  347. # define DSO_F_VMS_BIND_SYM 115
  348. # define DSO_F_VMS_LOAD 116
  349. # define DSO_F_VMS_MERGER 133
  350. # define DSO_F_VMS_UNLOAD 117
  351. # define DSO_F_WIN32_BIND_FUNC 118
  352. # define DSO_F_WIN32_BIND_VAR 119
  353. # define DSO_F_WIN32_JOINER 135
  354. # define DSO_F_WIN32_LOAD 120
  355. # define DSO_F_WIN32_MERGER 134
  356. # define DSO_F_WIN32_NAME_CONVERTER 125
  357. # define DSO_F_WIN32_SPLITTER 136
  358. # define DSO_F_WIN32_UNLOAD 121
  359. /* Reason codes. */
  360. # define DSO_R_CTRL_FAILED 100
  361. # define DSO_R_DSO_ALREADY_LOADED 110
  362. # define DSO_R_EMPTY_FILE_STRUCTURE 113
  363. # define DSO_R_FAILURE 114
  364. # define DSO_R_FILENAME_TOO_BIG 101
  365. # define DSO_R_FINISH_FAILED 102
  366. # define DSO_R_INCORRECT_FILE_SYNTAX 115
  367. # define DSO_R_LOAD_FAILED 103
  368. # define DSO_R_NAME_TRANSLATION_FAILED 109
  369. # define DSO_R_NO_FILENAME 111
  370. # define DSO_R_NO_FILE_SPECIFICATION 116
  371. # define DSO_R_NULL_HANDLE 104
  372. # define DSO_R_SET_FILENAME_FAILED 112
  373. # define DSO_R_STACK_ERROR 105
  374. # define DSO_R_SYM_FAILURE 106
  375. # define DSO_R_UNLOAD_FAILED 107
  376. # define DSO_R_UNSUPPORTED 108
  377. #ifdef __cplusplus
  378. }
  379. #endif
  380. #endif