crypto/dso/dso_dlfcn.c

   1 /* dso_dlfcn.c -*- mode:C; c-file-style: "eay" -*- */
   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 static char *dlfcn_merger(DSO *dso, const char *filespec1,
  89         const char *filespec2);
  90
  91 static DSO_METHOD dso_meth_dlfcn = {
  92         "OpenSSL 'dlfcn' shared library method",
  93         dlfcn_load,
  94         dlfcn_unload,
  95         dlfcn_bind_var,
  96         dlfcn_bind_func,
  97 /* For now, "unbind" doesn't exist */
  98 #if 0
  99         NULL, /* unbind_var */
 100         NULL, /* unbind_func */
 101 #endif
 102         NULL, /* ctrl */
 103         dlfcn_name_converter,
 104         dlfcn_merger,
 105         NULL, /* init */
 106         NULL  /* finish */
 107         };
 108
 109 DSO_METHOD *DSO_METHOD_dlfcn(void)
 110         {
 111         return(&dso_meth_dlfcn);
 112         }
 113
 114 /* Prior to using the dlopen() function, we should decide on the flag
 115  * we send. There's a few different ways of doing this and it's a
 116  * messy venn-diagram to match up which platforms support what. So
 117  * as we don't have autoconf yet, I'm implementing a hack that could
 118  * be hacked further relatively easily to deal with cases as we find
 119  * them. Initially this is to cope with OpenBSD. */
 120 #if defined(__OpenBSD__) || defined(__NetBSD__)
 121 #       ifdef DL_LAZY
 122 #               define DLOPEN_FLAG DL_LAZY
 123 #       else
 124 #               ifdef RTLD_NOW
 125 #                       define DLOPEN_FLAG RTLD_NOW
 126 #               else
 127 #                       define DLOPEN_FLAG 0
 128 #               endif
 129 #       endif
 130 #else
 131 #       define DLOPEN_FLAG RTLD_NOW /* Hope this works everywhere else */
 132 #endif
 133
 134 /* For this DSO_METHOD, our meth_data STACK will contain;
 135  * (i) the handle (void*) returned from dlopen().
 136  */
 137
 138 static int dlfcn_load(DSO *dso)
 139         {
 140         void *ptr = NULL;
 141         /* See applicable comments in dso_dl.c */
 142         char *filename = DSO_convert_filename(dso, NULL);
 143         int flags = DLOPEN_FLAG;
 144
 145         if(filename == NULL)
 146                 {
 147                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
 148                 goto err;
 149                 }
 150
 151 #ifdef RTLD_GLOBAL
 152         if (dso->flags & DSO_FLAG_GLOBAL_SYMBOLS)
 153                 flags |= RTLD_GLOBAL;
 154 #endif
 155         ptr = dlopen(filename, flags);
 156         if(ptr == NULL)
 157                 {
 158                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
 159                 ERR_add_error_data(4, "filename(", filename, "): ", dlerror());
 160                 goto err;
 161                 }
 162         if(!sk_push(dso->meth_data, (char *)ptr))
 163                 {
 164                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
 165                 goto err;
 166                 }
 167         /* Success */
 168         dso->loaded_filename = filename;
 169         return(1);
 170 err:
 171         /* Cleanup! */
 172         if(filename != NULL)
 173                 OPENSSL_free(filename);
 174         if(ptr != NULL)
 175                 dlclose(ptr);
 176         return(0);
 177 }
 178
 179 static int dlfcn_unload(DSO *dso)
 180         {
 181         void *ptr;
 182         if(dso == NULL)
 183                 {
 184                 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
 185                 return(0);
 186                 }
 187         if(sk_num(dso->meth_data) < 1)
 188                 return(1);
 189         ptr = (void *)sk_pop(dso->meth_data);
 190         if(ptr == NULL)
 191                 {
 192                 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
 193                 /* Should push the value back onto the stack in
 194                  * case of a retry. */
 195                 sk_push(dso->meth_data, (char *)ptr);
 196                 return(0);
 197                 }
 198         /* For now I'm not aware of any errors associated with dlclose() */
 199         dlclose(ptr);
 200         return(1);
 201         }
 202
 203 static void *dlfcn_bind_var(DSO *dso, const char *symname)
 204         {
 205         void *ptr, *sym;
 206
 207         if((dso == NULL) || (symname == NULL))
 208                 {
 209                 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
 210                 return(NULL);
 211                 }
 212         if(sk_num(dso->meth_data) < 1)
 213                 {
 214                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
 215                 return(NULL);
 216                 }
 217         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 218         if(ptr == NULL)
 219                 {
 220                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_NULL_HANDLE);
 221                 return(NULL);
 222                 }
 223         sym = dlsym(ptr, symname);
 224         if(sym == NULL)
 225                 {
 226                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
 227                 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
 228                 return(NULL);
 229                 }
 230         return(sym);
 231         }
 232
 233 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
 234         {
 235         void *ptr;
 236         DSO_FUNC_TYPE sym;
 237
 238         if((dso == NULL) || (symname == NULL))
 239                 {
 240                 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
 241                 return(NULL);
 242                 }
 243         if(sk_num(dso->meth_data) < 1)
 244                 {
 245                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
 246                 return(NULL);
 247                 }
 248         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 249         if(ptr == NULL)
 250                 {
 251                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
 252                 return(NULL);
 253                 }
 254         sym = (DSO_FUNC_TYPE)dlsym(ptr, symname);
 255         if(sym == NULL)
 256                 {
 257                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
 258                 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
 259                 return(NULL);
 260                 }
 261         return(sym);
 262         }
 263
 264 static char *dlfcn_merger(DSO *dso, const char *filespec1,
 265         const char *filespec2)
 266         {
 267         char *merged;
 268
 269         if(!filespec1 && !filespec2)
 270                 {
 271                 DSOerr(DSO_F_DLFCN_MERGER,
 272                                 ERR_R_PASSED_NULL_PARAMETER);
 273                 return(NULL);
 274                 }
 275         /* If the first file specification is a rooted path, it rules.
 276            same goes if the second file specification is missing. */
 277         if (!filespec2 || filespec1[0] == '/')
 278                 {
 279                 merged = OPENSSL_malloc(strlen(filespec1) + 1);
 280                 if(!merged)
 281                         {
 282                         DSOerr(DSO_F_DLFCN_MERGER,
 283                                 ERR_R_MALLOC_FAILURE);
 284                         return(NULL);
 285                         }
 286                 strcpy(merged, filespec1);
 287                 }
 288         /* If the first file specification is missing, the second one rules. */
 289         else if (!filespec1)
 290                 {
 291                 merged = OPENSSL_malloc(strlen(filespec2) + 1);
 292                 if(!merged)
 293                         {
 294                         DSOerr(DSO_F_DLFCN_MERGER,
 295                                 ERR_R_MALLOC_FAILURE);
 296                         return(NULL);
 297                         }
 298                 strcpy(merged, filespec2);
 299                 }
 300         else
 301                 /* This part isn't as trivial as it looks.  It assumes that
 302                    the second file specification really is a directory, and
 303                    makes no checks whatsoever.  Therefore, the result becomes
 304                    the concatenation of filespec2 followed by a slash followed
 305                    by filespec1. */
 306                 {
 307                 int spec2len, len;
 308
 309                 spec2len = (filespec2 ? strlen(filespec2) : 0);
 310                 len = spec2len + (filespec1 ? strlen(filespec1) : 0);
 311
 312                 if(filespec2 && filespec2[spec2len - 1] == '/')
 313                         {
 314                         spec2len--;
 315                         len--;
 316                         }
 317                 merged = OPENSSL_malloc(len + 2);
 318                 if(!merged)
 319                         {
 320                         DSOerr(DSO_F_DLFCN_MERGER,
 321                                 ERR_R_MALLOC_FAILURE);
 322                         return(NULL);
 323                         }
 324                 strcpy(merged, filespec2);
 325                 merged[spec2len] = '/';
 326                 strcpy(&merged[spec2len + 1], filespec1);
 327                 }
 328         return(merged);
 329         }
 330
 331 static char *dlfcn_name_converter(DSO *dso, const char *filename)
 332         {
 333         char *translated;
 334         int len, rsize, transform;
 335
 336         len = strlen(filename);
 337         rsize = len + 1;
 338         transform = (strstr(filename, "/") == NULL);
 339         if(transform)
 340                 {
 341                 /* We will convert this to "%s.so" or "lib%s.so" */
 342                 rsize += 3;     /* The length of ".so" */
 343                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 344                         rsize += 3; /* The length of "lib" */
 345                 }
 346         translated = OPENSSL_malloc(rsize);
 347         if(translated == NULL)
 348                 {
 349                 DSOerr(DSO_F_DLFCN_NAME_CONVERTER,
 350                                 DSO_R_NAME_TRANSLATION_FAILED);
 351                 return(NULL);
 352                 }
 353         if(transform)
 354                 {
 355                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 356                         sprintf(translated, "lib%s.so", filename);
 357                 else
 358                         sprintf(translated, "%s.so", filename);
 359                 }
 360         else
 361                 sprintf(translated, "%s", filename);
 362         return(translated);
 363         }
 364
 365 #endif /* DSO_DLFCN */