crypto/dso/dso_dlfcn.c

   1 /* dso_dlfcn.c */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) 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_DLFCN
  64 DSO_METHOD *DSO_METHOD_dlfcn(void)
  65         {
  66         return NULL;
  67         }
  68 #else
  69
  70 #ifdef HAVE_DLFCN_H
  71 #include <dlfcn.h>
  72 #endif
  73
  74 /* Part of the hack in "dlfcn_load" ... */
  75 #define DSO_MAX_TRANSLATED_SIZE 256
  76
  77 static int dlfcn_load(DSO *dso);
  78 static int dlfcn_unload(DSO *dso);
  79 static void *dlfcn_bind_var(DSO *dso, const char *symname);
  80 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname);
  81 #if 0
  82 static int dlfcn_unbind(DSO *dso, char *symname, void *symptr);
  83 static int dlfcn_init(DSO *dso);
  84 static int dlfcn_finish(DSO *dso);
  85 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
  86 #endif
  87 static char *dlfcn_name_converter(DSO *dso, const char *filename);
  88
  89 static DSO_METHOD dso_meth_dlfcn = {
  90         "OpenSSL 'dlfcn' shared library method",
  91         dlfcn_load,
  92         dlfcn_unload,
  93         dlfcn_bind_var,
  94         dlfcn_bind_func,
  95 /* For now, "unbind" doesn't exist */
  96 #if 0
  97         NULL, /* unbind_var */
  98         NULL, /* unbind_func */
  99 #endif
 100         NULL, /* ctrl */
 101         dlfcn_name_converter,
 102         NULL, /* init */
 103         NULL  /* finish */
 104         };
 105
 106 DSO_METHOD *DSO_METHOD_dlfcn(void)
 107         {
 108         return(&dso_meth_dlfcn);
 109         }
 110
 111 /* Prior to using the dlopen() function, we should decide on the flag
 112  * we send. There's a few different ways of doing this and it's a
 113  * messy venn-diagram to match up which platforms support what. So
 114  * as we don't have autoconf yet, I'm implementing a hack that could
 115  * be hacked further relatively easily to deal with cases as we find
 116  * them. Initially this is to cope with OpenBSD. */
 117 #ifdef __OpenBSD__
 118 #       ifdef DL_LAZY
 119 #               define DLOPEN_FLAG DL_LAZY
 120 #       else
 121 #               ifdef RTLD_NOW
 122 #                       define DLOPEN_FLAG RTLD_NOW
 123 #               else
 124 #                       define DLOPEN_FLAG 0
 125 #               endif
 126 #       endif
 127 #else
 128 #       define DLOPEN_FLAG RTLD_NOW /* Hope this works everywhere else */
 129 #endif
 130
 131 /* For this DSO_METHOD, our meth_data STACK will contain;
 132  * (i) the handle (void*) returned from dlopen().
 133  */
 134
 135 static int dlfcn_load(DSO *dso)
 136         {
 137         void *ptr = NULL;
 138         /* See applicable comments in dso_dl.c */
 139         char *filename = DSO_convert_filename(dso, NULL);
 140
 141         if(filename == NULL)
 142                 {
 143                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
 144                 goto err;
 145                 }
 146         ptr = dlopen(filename, DLOPEN_FLAG);
 147         if(ptr == NULL)
 148                 {
 149                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
 150                 goto err;
 151                 }
 152         if(!sk_push(dso->meth_data, (char *)ptr))
 153                 {
 154                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
 155                 goto err;
 156                 }
 157         /* Success */
 158         dso->loaded_filename = filename;
 159         return(1);
 160 err:
 161         /* Cleanup! */
 162         if(filename != NULL)
 163                 OPENSSL_free(filename);
 164         if(ptr != NULL)
 165                 dlclose(ptr);
 166         return(0);
 167 }
 168
 169 static int dlfcn_unload(DSO *dso)
 170         {
 171         void *ptr;
 172         if(dso == NULL)
 173                 {
 174                 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
 175                 return(0);
 176                 }
 177         if(sk_num(dso->meth_data) < 1)
 178                 return(1);
 179         ptr = (void *)sk_pop(dso->meth_data);
 180         if(ptr == NULL)
 181                 {
 182                 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
 183                 /* Should push the value back onto the stack in
 184                  * case of a retry. */
 185                 sk_push(dso->meth_data, (char *)ptr);
 186                 return(0);
 187                 }
 188         /* For now I'm not aware of any errors associated with dlclose() */
 189         dlclose(ptr);
 190         return(1);
 191         }
 192
 193 static void *dlfcn_bind_var(DSO *dso, const char *symname)
 194         {
 195         void *ptr, *sym;
 196
 197         if((dso == NULL) || (symname == NULL))
 198                 {
 199                 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
 200                 return(NULL);
 201                 }
 202         if(sk_num(dso->meth_data) < 1)
 203                 {
 204                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
 205                 return(NULL);
 206                 }
 207         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 208         if(ptr == NULL)
 209                 {
 210                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_NULL_HANDLE);
 211                 return(NULL);
 212                 }
 213         sym = dlsym(ptr, symname);
 214         if(sym == NULL)
 215                 {
 216                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
 217                 return(NULL);
 218                 }
 219         return(sym);
 220         }
 221
 222 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
 223         {
 224         void *ptr;
 225         DSO_FUNC_TYPE sym;
 226
 227         if((dso == NULL) || (symname == NULL))
 228                 {
 229                 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
 230                 return(NULL);
 231                 }
 232         if(sk_num(dso->meth_data) < 1)
 233                 {
 234                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
 235                 return(NULL);
 236                 }
 237         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 238         if(ptr == NULL)
 239                 {
 240                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
 241                 return(NULL);
 242                 }
 243         sym = (DSO_FUNC_TYPE)dlsym(ptr, symname);
 244         if(sym == NULL)
 245                 {
 246                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
 247                 return(NULL);
 248                 }
 249         return(sym);
 250         }
 251
 252 static char *dlfcn_name_converter(DSO *dso, const char *filename)
 253         {
 254         char *translated;
 255         int len, rsize, transform;
 256
 257         len = strlen(filename);
 258         rsize = len + 1;
 259         transform = (strstr(filename, "/") == NULL);
 260         if(transform)
 261                 {
 262                 /* We will convert this to "%s.so" or "lib%s.so" */
 263                 rsize += 3;     /* The length of ".so" */
 264                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 265                         rsize += 3; /* The length of "lib" */
 266                 }
 267         translated = OPENSSL_malloc(rsize);
 268         if(translated == NULL)
 269                 {
 270                 DSOerr(DSO_F_DLFCN_NAME_CONVERTER,
 271                                 DSO_R_NAME_TRANSLATION_FAILED);
 272                 return(NULL);
 273                 }
 274         if(transform)
 275                 {
 276                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 277                         sprintf(translated, "lib%s.so", filename);
 278                 else
 279                         sprintf(translated, "%s.so", filename);
 280                 }
 281         else
 282                 sprintf(translated, "%s", filename);
 283         return(translated);
 284         }
 285
 286 #endif /* DSO_DLFCN */