crypto/dso/dso_dl.c

   1 /* dso_dl.c */
   2 /* Written by Richard Levitte (levitte@openssl.org) 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
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/dso.h>
  62
  63 #ifndef DSO_DL
  64 DSO_METHOD *DSO_METHOD_dl(void)
  65        {
  66        return NULL;
  67        }
  68 #else
  69
  70 #include <dl.h>
  71
  72 /* Part of the hack in "dl_load" ... */
  73 #define DSO_MAX_TRANSLATED_SIZE 256
  74
  75 static int dl_load(DSO *dso);
  76 static int dl_unload(DSO *dso);
  77 static void *dl_bind_var(DSO *dso, const char *symname);
  78 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname);
  79 #if 0
  80 static int dl_unbind_var(DSO *dso, char *symname, void *symptr);
  81 static int dl_unbind_func(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
  82 static int dl_init(DSO *dso);
  83 static int dl_finish(DSO *dso);
  84 static int dl_ctrl(DSO *dso, int cmd, long larg, void *parg);
  85 #endif
  86 static char *dl_name_converter(DSO *dso, const char *filename);
  87
  88 static DSO_METHOD dso_meth_dl = {
  89         "OpenSSL 'dl' shared library method",
  90         dl_load,
  91         dl_unload,
  92         dl_bind_var,
  93         dl_bind_func,
  94 /* For now, "unbind" doesn't exist */
  95 #if 0
  96         NULL, /* unbind_var */
  97         NULL, /* unbind_func */
  98 #endif
  99         NULL, /* ctrl */
 100         dl_name_converter,
 101         NULL, /* init */
 102         NULL  /* finish */
 103         };
 104
 105 DSO_METHOD *DSO_METHOD_dl(void)
 106         {
 107         return(&dso_meth_dl);
 108         }
 109
 110 /* For this DSO_METHOD, our meth_data STACK will contain;
 111  * (i) the handle (shl_t) returned from shl_load().
 112  * NB: I checked on HPUX11 and shl_t is itself a pointer
 113  * type so the cast is safe.
 114  */
 115
 116 static int dl_load(DSO *dso)
 117         {
 118         shl_t ptr = NULL;
 119         /* We don't do any fancy retries or anything, just take the method's
 120          * (or DSO's if it has the callback set) best translation of the
 121          * platform-independant filename and try once with that. */
 122         char *filename= DSO_convert_filename(dso, NULL);
 123
 124         if(filename == NULL)
 125                 {
 126                 DSOerr(DSO_F_DL_LOAD,DSO_R_NO_FILENAME);
 127                 goto err;
 128                 }
 129         ptr = shl_load(filename, BIND_IMMEDIATE, NULL);
 130         if(ptr == NULL)
 131                 {
 132                 DSOerr(DSO_F_DL_LOAD,DSO_R_LOAD_FAILED);
 133                 goto err;
 134                 }
 135         if(!sk_push(dso->meth_data, (char *)ptr))
 136                 {
 137                 DSOerr(DSO_F_DL_LOAD,DSO_R_STACK_ERROR);
 138                 goto err;
 139                 }
 140         /* Success, stick the converted filename we've loaded under into the DSO
 141          * (it also serves as the indicator that we are currently loaded). */
 142         dso->loaded_filename = filename;
 143         return(1);
 144 err:
 145         /* Cleanup! */
 146         if(filename != NULL)
 147                 OPENSSL_free(filename);
 148         if(ptr != NULL)
 149                 shl_unload(ptr);
 150         return(0);
 151         }
 152
 153 static int dl_unload(DSO *dso)
 154         {
 155         shl_t ptr;
 156         if(dso == NULL)
 157                 {
 158                 DSOerr(DSO_F_DL_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
 159                 return(0);
 160                 }
 161         if(sk_num(dso->meth_data) < 1)
 162                 return(1);
 163         /* Is this statement legal? */
 164         ptr = (shl_t)sk_pop(dso->meth_data);
 165         if(ptr == NULL)
 166                 {
 167                 DSOerr(DSO_F_DL_UNLOAD,DSO_R_NULL_HANDLE);
 168                 /* Should push the value back onto the stack in
 169                  * case of a retry. */
 170                 sk_push(dso->meth_data, (char *)ptr);
 171                 return(0);
 172                 }
 173         shl_unload(ptr);
 174         return(1);
 175         }
 176
 177 static void *dl_bind_var(DSO *dso, const char *symname)
 178         {
 179         shl_t ptr;
 180         void *sym;
 181
 182         if((dso == NULL) || (symname == NULL))
 183                 {
 184                 DSOerr(DSO_F_DL_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
 185                 return(NULL);
 186                 }
 187         if(sk_num(dso->meth_data) < 1)
 188                 {
 189                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_STACK_ERROR);
 190                 return(NULL);
 191                 }
 192         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 193         if(ptr == NULL)
 194                 {
 195                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_NULL_HANDLE);
 196                 return(NULL);
 197                 }
 198         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
 199                 {
 200                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_SYM_FAILURE);
 201                 return(NULL);
 202                 }
 203         return(sym);
 204         }
 205
 206 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
 207         {
 208         shl_t ptr;
 209         void *sym;
 210
 211         if((dso == NULL) || (symname == NULL))
 212                 {
 213                 DSOerr(DSO_F_DL_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
 214                 return(NULL);
 215                 }
 216         if(sk_num(dso->meth_data) < 1)
 217                 {
 218                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_STACK_ERROR);
 219                 return(NULL);
 220                 }
 221         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 222         if(ptr == NULL)
 223                 {
 224                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_NULL_HANDLE);
 225                 return(NULL);
 226                 }
 227         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
 228                 {
 229                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_SYM_FAILURE);
 230                 return(NULL);
 231                 }
 232         return((DSO_FUNC_TYPE)sym);
 233         }
 234
 235 /* This function is identical to the one in dso_dlfcn.c, but as it is highly
 236  * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at the
 237  * same time, there's no great duplicating the code. Figuring out an elegant way
 238  * to share one copy of the code would be more difficult and would not leave the
 239  * implementations independant. */
 240 static char *dl_name_converter(DSO *dso, const char *filename)
 241         {
 242         char *translated;
 243         int len, transform;
 244
 245         len = strlen(filename);
 246         transform = (strstr(filename, "/") == NULL);
 247         if(transform)
 248                 /* We will convert this to "lib%s.so" */
 249                 translated = OPENSSL_malloc(len + 7);
 250         else
 251                 /* We will simply duplicate filename */
 252                 translated = OPENSSL_malloc(len + 1);
 253         if(translated == NULL)
 254                 {
 255                 DSOerr(DSO_F_DL_NAME_CONVERTER,
 256                                 DSO_R_NAME_TRANSLATION_FAILED);
 257                 return(NULL);
 258                 }
 259         if(transform)
 260                 sprintf(translated, "lib%s.so", filename);
 261         else
 262                 sprintf(translated, "%s", filename);
 263         return(translated);
 264         }
 265
 266 #endif /* DSO_DL */