summaryrefslogtreecommitdiffstats
path: root/crypto/dso/dso.h
diff options
context:
space:
mode:
authorGeoff Thorpe <geoff@openssl.org>2000-04-04 21:57:11 +0000
committerGeoff Thorpe <geoff@openssl.org>2000-04-04 21:57:11 +0000
commit8f4fac7f965b4604bc71be4bd486a8641c0504ab (patch)
tree9994f9cd3c12be7a390c1c7b11aad884e93cc8e0 /crypto/dso/dso.h
parent02859fb74ac980303994dd46c28e0cd2211aba12 (diff)
This is a set of startup code for the DSO support, it's not yet linked into
the build process (an upcoming commit no doubt), and is very much *new* code - what that means is that it compiles ok - usually. It certainly doesn't mean it runs well or even properly yet. Please don't muck round with this unless you're looking to help out and hunt bugs. :-) Currently this code doesn't have any support for controlling the "load" behaviour (eg. paths, filename translations, etc). That'll be handled using DSO_ctrl() and various flags, once we work out a sensible set of flags.
Diffstat (limited to 'crypto/dso/dso.h')
-rw-r--r--crypto/dso/dso.h191
1 files changed, 191 insertions, 0 deletions
diff --git a/crypto/dso/dso.h b/crypto/dso/dso.h
new file mode 100644
index 0000000000..5f86eb3ff8
--- /dev/null
+++ b/crypto/dso/dso.h
@@ -0,0 +1,191 @@
+/* dso.h */
+/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
+ * project 2000.
+ */
+/* ====================================================================
+ * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this
+ * software must display the following acknowledgment:
+ * "This product includes software developed by the OpenSSL Project
+ * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ * endorse or promote products derived from this software without
+ * prior written permission. For written permission, please contact
+ * licensing@OpenSSL.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ * nor may "OpenSSL" appear in their names without prior written
+ * permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ * acknowledgment:
+ * "This product includes software developed by the OpenSSL Project
+ * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com). This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
+ *
+ */
+
+#ifndef HEADER_DSO_H
+#define HEADER_DSO_H
+
+#include <openssl/crypto.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+typedef struct dso_st DSO;
+
+typedef struct dso_meth_st
+ {
+ const char *name;
+ /* Loads a shared library */
+ int (*dso_load)(DSO *dso, char *filename);
+ /* Unloads a shared library */
+ int (*dso_unload)(DSO *dso);
+ /* Binds a function, variable, or whatever */
+ int (*dso_bind)(DSO *dso, char *symname, void **symptr);
+
+/* I don't think this would actually be used in any circumstances. */
+#if 0
+ /* Unbinds a symbol */
+ int (*dso_unbind)(DSO *dso, char *symname, void *symptr);
+#endif
+
+ int (*init)(DSO *dso);
+ int (*finish)(DSO *dso);
+ } DSO_METHOD;
+
+/**********************************************************************/
+/* The low-level handle type used to refer to a loaded shared library */
+
+struct dso_st
+ {
+ DSO_METHOD *meth;
+ /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
+ * doesn't use anything but will need to cache the filename
+ * for use in the dso_bind handler. All in all, let each
+ * method control its own destiny. "Handles" and such go in
+ * a STACK. */
+ STACK *meth_data;
+ int references;
+ int flags;
+ /* For use by applications etc ... use this for your bits'n'pieces,
+ * don't touch meth_data! */
+ CRYPTO_EX_DATA ex_data;
+ };
+
+
+DSO * DSO_new(void);
+DSO * DSO_new_method(DSO_METHOD *method);
+int DSO_free(DSO *dso);
+int DSO_flags(DSO *dso);
+int DSO_up(DSO *dso);
+
+void DSO_set_default_method(DSO_METHOD *meth);
+DSO_METHOD *DSO_get_default_method(void);
+DSO_METHOD *DSO_get_method(DSO *dso);
+DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
+
+/* The all-singing all-dancing load function, you normally pass NULL
+ * for the last two parameters. Use DSO_up and DSO_free for reference
+ * count handling. */
+DSO *DSO_load(DSO *dso, char *filename, DSO_METHOD *meth);
+
+/* This function binds to a function, variable, whatever inside a
+ * shared library. */
+void *DSO_bind(DSO *dso, char *symname);
+
+/* This method is the default, but will beg, borrow, or steal whatever
+ * method should be the default on any particular platform (including
+ * DSO_METH_null() if necessary). */
+DSO_METHOD *DSO_METHOD_openssl(void);
+
+/* This method is defined for all platforms - if a platform has no
+ * DSO support then this will be the only method! */
+DSO_METHOD *DSO_METHOD_null(void);
+
+/* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
+ * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
+ * this method. If not, this method will return NULL. */
+DSO_METHOD *DSO_METHOD_dlfcn(void);
+
+/* If DSO_DL is defined, the standard dl.h-style functions (shl_load,
+ * shl_unload, shl_findsym, etc) will be used and incorporated into
+ * this method. If not, this method will return NULL. */
+DSO_METHOD *DSO_METHOD_dl(void);
+
+/* If WIN32 is defined, use DLLs. If not, return NULL. */
+DSO_METHOD *DSO_METHOD_win32(void);
+
+void ERR_load_DSO_strings(void);
+
+/* BEGIN ERROR CODES */
+/* The following lines are auto generated by the script mkerr.pl. Any changes
+ * made after this point may be overwritten when the script is next run.
+ */
+
+/* Error codes for the DSO functions. */
+
+/* Function codes. */
+#define DSO_F_DLFCN_BIND 100
+#define DSO_F_DLFCN_LOAD 101
+#define DSO_F_DLFCN_UNLOAD 102
+#define DSO_F_DL_BIND 103
+#define DSO_F_DL_LOAD 104
+#define DSO_F_DL_UNLOAD 105
+#define DSO_F_DSO_BIND 106
+#define DSO_F_DSO_FREE 107
+#define DSO_F_DSO_LOAD 108
+#define DSO_F_DSO_NEW_METHOD 109
+#define DSO_F_DSO_UP 110
+#define DSO_F_WIN32_BIND 111
+#define DSO_F_WIN32_LOAD 112
+#define DSO_F_WIN32_UNLOAD 113
+
+/* Reason codes. */
+#define DSO_R_FINISH_FAILED 100
+#define DSO_R_LOAD_FAILED 101
+#define DSO_R_NULL_HANDLE 102
+#define DSO_R_STACK_ERROR 103
+#define DSO_R_SYM_FAILURE 104
+#define DSO_R_UNLOAD_FAILED 105
+#define DSO_R_UNSUPPORTED 106
+
+#ifdef __cplusplus
+}
+#endif
+#endif
+