Eneboo - Documentación para desarrolladores
src/libdigidoc/openssl/crypto/dso/dso.h
Ir a la documentación de este archivo.
00001 /* dso.h -*- mode:C; c-file-style: "eay" -*- */
00002 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
00003  * project 2000.
00004  */
00005 /* ====================================================================
00006  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. All advertising materials mentioning features or use of this
00021  *    software must display the following acknowledgment:
00022  *    "This product includes software developed by the OpenSSL Project
00023  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
00024  *
00025  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
00026  *    endorse or promote products derived from this software without
00027  *    prior written permission. For written permission, please contact
00028  *    licensing@OpenSSL.org.
00029  *
00030  * 5. Products derived from this software may not be called "OpenSSL"
00031  *    nor may "OpenSSL" appear in their names without prior written
00032  *    permission of the OpenSSL Project.
00033  *
00034  * 6. Redistributions of any form whatsoever must retain the following
00035  *    acknowledgment:
00036  *    "This product includes software developed by the OpenSSL Project
00037  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
00038  *
00039  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
00040  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00041  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00042  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
00043  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00044  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00045  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00046  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00047  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
00048  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00049  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
00050  * OF THE POSSIBILITY OF SUCH DAMAGE.
00051  * ====================================================================
00052  *
00053  * This product includes cryptographic software written by Eric Young
00054  * (eay@cryptsoft.com).  This product includes software written by Tim
00055  * Hudson (tjh@cryptsoft.com).
00056  *
00057  */
00058 
00059 #ifndef HEADER_DSO_H
00060 #define HEADER_DSO_H
00061 
00062 #include <openssl/crypto.h>
00063 
00064 #ifdef __cplusplus
00065 extern "C" {
00066 #endif
00067 
00068 /* These values are used as commands to DSO_ctrl() */
00069 #define DSO_CTRL_GET_FLAGS      1
00070 #define DSO_CTRL_SET_FLAGS      2
00071 #define DSO_CTRL_OR_FLAGS       3
00072 
00073 /* By default, DSO_load() will translate the provided filename into a form
00074  * typical for the platform (more specifically the DSO_METHOD) using the
00075  * dso_name_converter function of the method. Eg. win32 will transform "blah"
00076  * into "blah.dll", and dlfcn will transform it into "libblah.so". The
00077  * behaviour can be overriden by setting the name_converter callback in the DSO
00078  * object (using DSO_set_name_converter()). This callback could even utilise
00079  * the DSO_METHOD's converter too if it only wants to override behaviour for
00080  * one or two possible DSO methods. However, the following flag can be set in a
00081  * DSO to prevent *any* native name-translation at all - eg. if the caller has
00082  * prompted the user for a path to a driver library so the filename should be
00083  * interpreted as-is. */
00084 #define DSO_FLAG_NO_NAME_TRANSLATION            0x01
00085 /* An extra flag to give if only the extension should be added as
00086  * translation.  This is obviously only of importance on Unix and
00087  * other operating systems where the translation also may prefix
00088  * the name with something, like 'lib', and ignored everywhere else.
00089  * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used
00090  * at the same time. */
00091 #define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY      0x02
00092 
00093 /* The following flag controls the translation of symbol names to upper
00094  * case.  This is currently only being implemented for OpenVMS.
00095  */
00096 #define DSO_FLAG_UPCASE_SYMBOL                  0x10
00097 
00098 /* This flag loads the library with public symbols.
00099  * Meaning: The exported symbols of this library are public
00100  * to all libraries loaded after this library.
00101  * At the moment only implemented in unix.
00102  */
00103 #define DSO_FLAG_GLOBAL_SYMBOLS                 0x20
00104 
00105 
00106 typedef void (*DSO_FUNC_TYPE)(void);
00107 
00108 typedef struct dso_st DSO;
00109 
00110 /* The function prototype used for method functions (or caller-provided
00111  * callbacks) that transform filenames. They are passed a DSO structure pointer
00112  * (or NULL if they are to be used independantly of a DSO object) and a
00113  * filename to transform. They should either return NULL (if there is an error
00114  * condition) or a newly allocated string containing the transformed form that
00115  * the caller will need to free with OPENSSL_free() when done. */
00116 typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *);
00117 /* The function prototype used for method functions (or caller-provided
00118  * callbacks) that merge two file specifications. They are passed a
00119  * DSO structure pointer (or NULL if they are to be used independantly of
00120  * a DSO object) and two file specifications to merge. They should
00121  * either return NULL (if there is an error condition) or a newly allocated
00122  * string containing the result of merging that the caller will need
00123  * to free with OPENSSL_free() when done.
00124  * Here, merging means that bits and pieces are taken from each of the
00125  * file specifications and added together in whatever fashion that is
00126  * sensible for the DSO method in question.  The only rule that really
00127  * applies is that if the two specification contain pieces of the same
00128  * type, the copy from the first string takes priority.  One could see
00129  * it as the first specification is the one given by the user and the
00130  * second being a bunch of defaults to add on if they're missing in the
00131  * first. */
00132 typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *);
00133 
00134 typedef struct dso_meth_st
00135         {
00136         const char *name;
00137         /* Loads a shared library, NB: new DSO_METHODs must ensure that a
00138          * successful load populates the loaded_filename field, and likewise a
00139          * successful unload OPENSSL_frees and NULLs it out. */
00140         int (*dso_load)(DSO *dso);
00141         /* Unloads a shared library */
00142         int (*dso_unload)(DSO *dso);
00143         /* Binds a variable */
00144         void *(*dso_bind_var)(DSO *dso, const char *symname);
00145         /* Binds a function - assumes a return type of DSO_FUNC_TYPE.
00146          * This should be cast to the real function prototype by the
00147          * caller. Platforms that don't have compatible representations
00148          * for different prototypes (this is possible within ANSI C)
00149          * are highly unlikely to have shared libraries at all, let
00150          * alone a DSO_METHOD implemented for them. */
00151         DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname);
00152 
00153 /* I don't think this would actually be used in any circumstances. */
00154 #if 0
00155         /* Unbinds a variable */
00156         int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr);
00157         /* Unbinds a function */
00158         int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
00159 #endif
00160         /* The generic (yuck) "ctrl()" function. NB: Negative return
00161          * values (rather than zero) indicate errors. */
00162         long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg);
00163         /* The default DSO_METHOD-specific function for converting filenames to
00164          * a canonical native form. */
00165         DSO_NAME_CONVERTER_FUNC dso_name_converter;
00166         /* The default DSO_METHOD-specific function for converting filenames to
00167          * a canonical native form. */
00168         DSO_MERGER_FUNC dso_merger;
00169 
00170         /* [De]Initialisation handlers. */
00171         int (*init)(DSO *dso);
00172         int (*finish)(DSO *dso);
00173         } DSO_METHOD;
00174 
00175 /**********************************************************************/
00176 /* The low-level handle type used to refer to a loaded shared library */
00177 
00178 struct dso_st
00179         {
00180         DSO_METHOD *meth;
00181         /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS
00182          * doesn't use anything but will need to cache the filename
00183          * for use in the dso_bind handler. All in all, let each
00184          * method control its own destiny. "Handles" and such go in
00185          * a STACK. */
00186         STACK *meth_data;
00187         int references;
00188         int flags;
00189         /* For use by applications etc ... use this for your bits'n'pieces,
00190          * don't touch meth_data! */
00191         CRYPTO_EX_DATA ex_data;
00192         /* If this callback function pointer is set to non-NULL, then it will
00193          * be used in DSO_load() in place of meth->dso_name_converter. NB: This
00194          * should normally set using DSO_set_name_converter(). */
00195         DSO_NAME_CONVERTER_FUNC name_converter;
00196         /* If this callback function pointer is set to non-NULL, then it will
00197          * be used in DSO_load() in place of meth->dso_merger. NB: This
00198          * should normally set using DSO_set_merger(). */
00199         DSO_MERGER_FUNC merger;
00200         /* This is populated with (a copy of) the platform-independant
00201          * filename used for this DSO. */
00202         char *filename;
00203         /* This is populated with (a copy of) the translated filename by which
00204          * the DSO was actually loaded. It is NULL iff the DSO is not currently
00205          * loaded. NB: This is here because the filename translation process
00206          * may involve a callback being invoked more than once not only to
00207          * convert to a platform-specific form, but also to try different
00208          * filenames in the process of trying to perform a load. As such, this
00209          * variable can be used to indicate (a) whether this DSO structure
00210          * corresponds to a loaded library or not, and (b) the filename with
00211          * which it was actually loaded. */
00212         char *loaded_filename;
00213         };
00214 
00215 
00216 DSO *   DSO_new(void);
00217 DSO *   DSO_new_method(DSO_METHOD *method);
00218 int     DSO_free(DSO *dso);
00219 int     DSO_flags(DSO *dso);
00220 int     DSO_up_ref(DSO *dso);
00221 long    DSO_ctrl(DSO *dso, int cmd, long larg, void *parg);
00222 
00223 /* This function sets the DSO's name_converter callback. If it is non-NULL,
00224  * then it will be used instead of the associated DSO_METHOD's function. If
00225  * oldcb is non-NULL then it is set to the function pointer value being
00226  * replaced. Return value is non-zero for success. */
00227 int     DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
00228                                 DSO_NAME_CONVERTER_FUNC *oldcb);
00229 /* These functions can be used to get/set the platform-independant filename
00230  * used for a DSO. NB: set will fail if the DSO is already loaded. */
00231 const char *DSO_get_filename(DSO *dso);
00232 int     DSO_set_filename(DSO *dso, const char *filename);
00233 /* This function will invoke the DSO's name_converter callback to translate a
00234  * filename, or if the callback isn't set it will instead use the DSO_METHOD's
00235  * converter. If "filename" is NULL, the "filename" in the DSO itself will be
00236  * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is
00237  * simply duplicated. NB: This function is usually called from within a
00238  * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that
00239  * caller-created DSO_METHODs can do the same thing. A non-NULL return value
00240  * will need to be OPENSSL_free()'d. */
00241 char    *DSO_convert_filename(DSO *dso, const char *filename);
00242 /* This function will invoke the DSO's merger callback to merge two file
00243  * specifications, or if the callback isn't set it will instead use the
00244  * DSO_METHOD's merger.  A non-NULL return value will need to be
00245  * OPENSSL_free()'d. */
00246 char    *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2);
00247 /* If the DSO is currently loaded, this returns the filename that it was loaded
00248  * under, otherwise it returns NULL. So it is also useful as a test as to
00249  * whether the DSO is currently loaded. NB: This will not necessarily return
00250  * the same value as DSO_convert_filename(dso, dso->filename), because the
00251  * DSO_METHOD's load function may have tried a variety of filenames (with
00252  * and/or without the aid of the converters) before settling on the one it
00253  * actually loaded. */
00254 const char *DSO_get_loaded_filename(DSO *dso);
00255 
00256 void    DSO_set_default_method(DSO_METHOD *meth);
00257 DSO_METHOD *DSO_get_default_method(void);
00258 DSO_METHOD *DSO_get_method(DSO *dso);
00259 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth);
00260 
00261 /* The all-singing all-dancing load function, you normally pass NULL
00262  * for the first and third parameters. Use DSO_up and DSO_free for
00263  * subsequent reference count handling. Any flags passed in will be set
00264  * in the constructed DSO after its init() function but before the
00265  * load operation. If 'dso' is non-NULL, 'flags' is ignored. */
00266 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags);
00267 
00268 /* This function binds to a variable inside a shared library. */
00269 void *DSO_bind_var(DSO *dso, const char *symname);
00270 
00271 /* This function binds to a function inside a shared library. */
00272 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname);
00273 
00274 /* This method is the default, but will beg, borrow, or steal whatever
00275  * method should be the default on any particular platform (including
00276  * DSO_METH_null() if necessary). */
00277 DSO_METHOD *DSO_METHOD_openssl(void);
00278 
00279 /* This method is defined for all platforms - if a platform has no
00280  * DSO support then this will be the only method! */
00281 DSO_METHOD *DSO_METHOD_null(void);
00282 
00283 /* If DSO_DLFCN is defined, the standard dlfcn.h-style functions
00284  * (dlopen, dlclose, dlsym, etc) will be used and incorporated into
00285  * this method. If not, this method will return NULL. */
00286 DSO_METHOD *DSO_METHOD_dlfcn(void);
00287 
00288 /* If DSO_DL is defined, the standard dl.h-style functions (shl_load, 
00289  * shl_unload, shl_findsym, etc) will be used and incorporated into
00290  * this method. If not, this method will return NULL. */
00291 DSO_METHOD *DSO_METHOD_dl(void);
00292 
00293 /* If WIN32 is defined, use DLLs. If not, return NULL. */
00294 DSO_METHOD *DSO_METHOD_win32(void);
00295 
00296 /* If VMS is defined, use shared images. If not, return NULL. */
00297 DSO_METHOD *DSO_METHOD_vms(void);
00298 
00299 /* BEGIN ERROR CODES */
00300 /* The following lines are auto generated by the script mkerr.pl. Any changes
00301  * made after this point may be overwritten when the script is next run.
00302  */
00303 void ERR_load_DSO_strings(void);
00304 
00305 /* Error codes for the DSO functions. */
00306 
00307 /* Function codes. */
00308 #define DSO_F_DLFCN_BIND_FUNC                            100
00309 #define DSO_F_DLFCN_BIND_VAR                             101
00310 #define DSO_F_DLFCN_LOAD                                 102
00311 #define DSO_F_DLFCN_MERGER                               130
00312 #define DSO_F_DLFCN_NAME_CONVERTER                       123
00313 #define DSO_F_DLFCN_UNLOAD                               103
00314 #define DSO_F_DL_BIND_FUNC                               104
00315 #define DSO_F_DL_BIND_VAR                                105
00316 #define DSO_F_DL_LOAD                                    106
00317 #define DSO_F_DL_MERGER                                  131
00318 #define DSO_F_DL_NAME_CONVERTER                          124
00319 #define DSO_F_DL_UNLOAD                                  107
00320 #define DSO_F_DSO_BIND_FUNC                              108
00321 #define DSO_F_DSO_BIND_VAR                               109
00322 #define DSO_F_DSO_CONVERT_FILENAME                       126
00323 #define DSO_F_DSO_CTRL                                   110
00324 #define DSO_F_DSO_FREE                                   111
00325 #define DSO_F_DSO_GET_FILENAME                           127
00326 #define DSO_F_DSO_GET_LOADED_FILENAME                    128
00327 #define DSO_F_DSO_LOAD                                   112
00328 #define DSO_F_DSO_MERGE                                  132
00329 #define DSO_F_DSO_NEW_METHOD                             113
00330 #define DSO_F_DSO_SET_FILENAME                           129
00331 #define DSO_F_DSO_SET_NAME_CONVERTER                     122
00332 #define DSO_F_DSO_UP_REF                                 114
00333 #define DSO_F_VMS_BIND_SYM                               115
00334 #define DSO_F_VMS_LOAD                                   116
00335 #define DSO_F_VMS_MERGER                                 133
00336 #define DSO_F_VMS_UNLOAD                                 117
00337 #define DSO_F_WIN32_BIND_FUNC                            118
00338 #define DSO_F_WIN32_BIND_VAR                             119
00339 #define DSO_F_WIN32_JOINER                               135
00340 #define DSO_F_WIN32_LOAD                                 120
00341 #define DSO_F_WIN32_MERGER                               134
00342 #define DSO_F_WIN32_NAME_CONVERTER                       125
00343 #define DSO_F_WIN32_SPLITTER                             136
00344 #define DSO_F_WIN32_UNLOAD                               121
00345 
00346 /* Reason codes. */
00347 #define DSO_R_CTRL_FAILED                                100
00348 #define DSO_R_DSO_ALREADY_LOADED                         110
00349 #define DSO_R_EMPTY_FILE_STRUCTURE                       113
00350 #define DSO_R_FAILURE                                    114
00351 #define DSO_R_FILENAME_TOO_BIG                           101
00352 #define DSO_R_FINISH_FAILED                              102
00353 #define DSO_R_INCORRECT_FILE_SYNTAX                      115
00354 #define DSO_R_LOAD_FAILED                                103
00355 #define DSO_R_NAME_TRANSLATION_FAILED                    109
00356 #define DSO_R_NO_FILENAME                                111
00357 #define DSO_R_NO_FILE_SPECIFICATION                      116
00358 #define DSO_R_NULL_HANDLE                                104
00359 #define DSO_R_SET_FILENAME_FAILED                        112
00360 #define DSO_R_STACK_ERROR                                105
00361 #define DSO_R_SYM_FAILURE                                106
00362 #define DSO_R_UNLOAD_FAILED                              107
00363 #define DSO_R_UNSUPPORTED                                108
00364 
00365 #ifdef  __cplusplus
00366 }
00367 #endif
00368 #endif
 Todo Clases Namespaces Archivos Funciones Variables 'typedefs' Enumeraciones Valores de enumeraciones Propiedades Amigas 'defines'