include/internal/dso.h

   1 /*
   2  * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_DSO_H
  11 # define HEADER_DSO_H
  12
  13 # include <openssl/crypto.h>
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /* These values are used as commands to DSO_ctrl() */
  20 # define DSO_CTRL_GET_FLAGS      1
  21 # define DSO_CTRL_SET_FLAGS      2
  22 # define DSO_CTRL_OR_FLAGS       3
  23
  24 /*
  25  * By default, DSO_load() will translate the provided filename into a form
  26  * typical for the platform using the dso_name_converter function of the
  27  * method. Eg. win32 will transform "blah" into "blah.dll", and dlfcn will
  28  * transform it into "libblah.so". This callback could even utilise the
  29  * DSO_METHOD's converter too if it only wants to override behaviour for
  30  * one or two possible DSO methods. However, the following flag can be
  31  * set in a DSO to prevent *any* native name-translation at all - eg. if
  32  * the caller has prompted the user for a path to a driver library so the
  33  * filename should be interpreted as-is.
  34  */
  35 # define DSO_FLAG_NO_NAME_TRANSLATION            0x01
  36 /*
  37  * An extra flag to give if only the extension should be added as
  38  * translation.  This is obviously only of importance on Unix and other
  39  * operating systems where the translation also may prefix the name with
  40  * something, like 'lib', and ignored everywhere else. This flag is also
  41  * ignored if DSO_FLAG_NO_NAME_TRANSLATION is used at the same time.
  42  */
  43 # define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY      0x02
  44
  45 /*
  46  * The following flag controls the translation of symbol names to upper case.
  47  * This is currently only being implemented for OpenVMS.
  48  */
  49 # define DSO_FLAG_UPCASE_SYMBOL                  0x10
  50
  51 /*
  52  * This flag loads the library with public symbols. Meaning: The exported
  53  * symbols of this library are public to all libraries loaded after this
  54  * library. At the moment only implemented in unix.
  55  */
  56 # define DSO_FLAG_GLOBAL_SYMBOLS                 0x20
  57
  58 typedef void (*DSO_FUNC_TYPE) (void);
  59
  60 typedef struct dso_st DSO;
  61 typedef struct dso_meth_st DSO_METHOD;
  62
  63 /*
  64  * The function prototype used for method functions (or caller-provided
  65  * callbacks) that transform filenames. They are passed a DSO structure
  66  * pointer (or NULL if they are to be used independently of a DSO object) and
  67  * a filename to transform. They should either return NULL (if there is an
  68  * error condition) or a newly allocated string containing the transformed
  69  * form that the caller will need to free with OPENSSL_free() when done.
  70  */
  71 typedef char *(*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
  72 /*
  73  * The function prototype used for method functions (or caller-provided
  74  * callbacks) that merge two file specifications. They are passed a DSO
  75  * structure pointer (or NULL if they are to be used independently of a DSO
  76  * object) and two file specifications to merge. They should either return
  77  * NULL (if there is an error condition) or a newly allocated string
  78  * containing the result of merging that the caller will need to free with
  79  * OPENSSL_free() when done. Here, merging means that bits and pieces are
  80  * taken from each of the file specifications and added together in whatever
  81  * fashion that is sensible for the DSO method in question.  The only rule
  82  * that really applies is that if the two specification contain pieces of the
  83  * same type, the copy from the first string takes priority.  One could see
  84  * it as the first specification is the one given by the user and the second
  85  * being a bunch of defaults to add on if they're missing in the first.
  86  */
  87 typedef char *(*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
  88
  89 DSO *DSO_new(void);
  90 int DSO_free(DSO *dso);
  91 int DSO_flags(DSO *dso);
  92 int DSO_up_ref(DSO *dso);
  93 long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
  94
  95 /*
  96  * These functions can be used to get/set the platform-independent filename
  97  * used for a DSO. NB: set will fail if the DSO is already loaded.
  98  */
  99 const char *DSO_get_filename(DSO *dso);
 100 int DSO_set_filename(DSO *dso, const char *filename);
 101 /*
 102  * This function will invoke the DSO's name_converter callback to translate a
 103  * filename, or if the callback isn't set it will instead use the DSO_METHOD's
 104  * converter. If "filename" is NULL, the "filename" in the DSO itself will be
 105  * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
 106  * simply duplicated. NB: This function is usually called from within a
 107  * DSO_METHOD during the processing of a DSO_load() call, and is exposed so
 108  * that caller-created DSO_METHODs can do the same thing. A non-NULL return
 109  * value will need to be OPENSSL_free()'d.
 110  */
 111 char *DSO_convert_filename(DSO *dso, const char *filename);
 112 /*
 113  * This function will invoke the DSO's merger callback to merge two file
 114  * specifications, or if the callback isn't set it will instead use the
 115  * DSO_METHOD's merger.  A non-NULL return value will need to be
 116  * OPENSSL_free()'d.
 117  */
 118 char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
 119
 120 /*
 121  * The all-singing all-dancing load function, you normally pass NULL for the
 122  * first and third parameters. Use DSO_up_ref and DSO_free for subsequent
 123  * reference count handling. Any flags passed in will be set in the
 124  * constructed DSO after its init() function but before the load operation.
 125  * If 'dso' is non-NULL, 'flags' is ignored.
 126  */
 127 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
 128
 129 /* This function binds to a function inside a shared library. */
 130 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
 131
 132 /*
 133  * This method is the default, but will beg, borrow, or steal whatever method
 134  * should be the default on any particular platform (including
 135  * DSO_METH_null() if necessary).
 136  */
 137 DSO_METHOD *DSO_METHOD_openssl(void);
 138
 139 /*
 140  * This function should be used with caution! It looks up symbols in *all*
 141  * loaded modules and if module gets unloaded by somebody else attempt to
 142  * dereference the pointer is doomed to have fatal consequences. Primary
 143  * usage for this function is to probe *core* system functionality, e.g.
 144  * check if getnameinfo(3) is available at run-time without bothering about
 145  * OS-specific details such as libc.so.versioning or where does it actually
 146  * reside: in libc itself or libsocket.
 147  */
 148 void *DSO_global_lookup(const char *name);
 149
 150 /* BEGIN ERROR CODES */
 151 /*
 152  * The following lines are auto generated by the script mkerr.pl. Any changes
 153  * made after this point may be overwritten when the script is next run.
 154  */
 155
 156 void ERR_load_DSO_strings(void);
 157
 158 /* Error codes for the DSO functions. */
 159
 160 /* Function codes. */
 161 # define DSO_F_DLFCN_BIND_FUNC                            100
 162 # define DSO_F_DLFCN_LOAD                                 102
 163 # define DSO_F_DLFCN_MERGER                               130
 164 # define DSO_F_DLFCN_NAME_CONVERTER                       123
 165 # define DSO_F_DLFCN_UNLOAD                               103
 166 # define DSO_F_DL_BIND_FUNC                               104
 167 # define DSO_F_DL_LOAD                                    106
 168 # define DSO_F_DL_MERGER                                  131
 169 # define DSO_F_DL_NAME_CONVERTER                          124
 170 # define DSO_F_DL_UNLOAD                                  107
 171 # define DSO_F_DSO_BIND_FUNC                              108
 172 # define DSO_F_DSO_CONVERT_FILENAME                       126
 173 # define DSO_F_DSO_CTRL                                   110
 174 # define DSO_F_DSO_FREE                                   111
 175 # define DSO_F_DSO_GET_FILENAME                           127
 176 # define DSO_F_DSO_GLOBAL_LOOKUP                          139
 177 # define DSO_F_DSO_LOAD                                   112
 178 # define DSO_F_DSO_MERGE                                  132
 179 # define DSO_F_DSO_NEW_METHOD                             113
 180 # define DSO_F_DSO_SET_FILENAME                           129
 181 # define DSO_F_DSO_UP_REF                                 114
 182 # define DSO_F_VMS_BIND_SYM                               115
 183 # define DSO_F_VMS_LOAD                                   116
 184 # define DSO_F_VMS_MERGER                                 133
 185 # define DSO_F_VMS_UNLOAD                                 117
 186 # define DSO_F_WIN32_BIND_FUNC                            101
 187 # define DSO_F_WIN32_GLOBALLOOKUP                         142
 188 # define DSO_F_WIN32_JOINER                               135
 189 # define DSO_F_WIN32_LOAD                                 120
 190 # define DSO_F_WIN32_MERGER                               134
 191 # define DSO_F_WIN32_NAME_CONVERTER                       125
 192 # define DSO_F_WIN32_SPLITTER                             136
 193 # define DSO_F_WIN32_UNLOAD                               121
 194
 195 /* Reason codes. */
 196 # define DSO_R_CTRL_FAILED                                100
 197 # define DSO_R_DSO_ALREADY_LOADED                         110
 198 # define DSO_R_EMPTY_FILE_STRUCTURE                       113
 199 # define DSO_R_FAILURE                                    114
 200 # define DSO_R_FILENAME_TOO_BIG                           101
 201 # define DSO_R_FINISH_FAILED                              102
 202 # define DSO_R_INCORRECT_FILE_SYNTAX                      115
 203 # define DSO_R_LOAD_FAILED                                103
 204 # define DSO_R_NAME_TRANSLATION_FAILED                    109
 205 # define DSO_R_NO_FILENAME                                111
 206 # define DSO_R_NULL_HANDLE                                104
 207 # define DSO_R_SET_FILENAME_FAILED                        112
 208 # define DSO_R_STACK_ERROR                                105
 209 # define DSO_R_SYM_FAILURE                                106
 210 # define DSO_R_UNLOAD_FAILED                              107
 211 # define DSO_R_UNSUPPORTED                                108
 212
 213 # ifdef  __cplusplus
 214 }
 215 # endif
 216 #endif