crypto/dso/dso_dl.c

   1 /*
   2  * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
   3  * 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 "internal/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 static char *dl_name_converter(DSO *dso, const char *filename);
  80 static char *dl_merger(DSO *dso, const char *filespec1,
  81                        const char *filespec2);
  82 static int dl_pathbyaddr(void *addr, char *path, int sz);
  83 static void *dl_globallookup(const char *name);
  84
  85 static DSO_METHOD dso_meth_dl = {
  86     "OpenSSL 'dl' shared library method",
  87     dl_load,
  88     dl_unload,
  89     dl_bind_var,
  90     dl_bind_func,
  91     NULL,                       /* ctrl */
  92     dl_name_converter,
  93     dl_merger,
  94     NULL,                       /* init */
  95     NULL,                       /* finish */
  96     dl_pathbyaddr,
  97     dl_globallookup
  98 };
  99
 100 DSO_METHOD *DSO_METHOD_dl(void)
 101 {
 102     return (&dso_meth_dl);
 103 }
 104
 105 /*
 106  * For this DSO_METHOD, our meth_data STACK will contain; (i) the handle
 107  * (shl_t) returned from shl_load(). NB: I checked on HPUX11 and shl_t is
 108  * itself a pointer type so the cast is safe.
 109  */
 110
 111 static int dl_load(DSO *dso)
 112 {
 113     shl_t ptr = NULL;
 114     /*
 115      * We don't do any fancy retries or anything, just take the method's (or
 116      * DSO's if it has the callback set) best translation of the
 117      * platform-independent filename and try once with that.
 118      */
 119     char *filename = DSO_convert_filename(dso, NULL);
 120
 121     if (filename == NULL) {
 122         DSOerr(DSO_F_DL_LOAD, DSO_R_NO_FILENAME);
 123         goto err;
 124     }
 125     ptr = shl_load(filename, BIND_IMMEDIATE |
 126                    (dso->flags & DSO_FLAG_NO_NAME_TRANSLATION ? 0 :
 127                     DYNAMIC_PATH), 0L);
 128     if (ptr == NULL) {
 129         DSOerr(DSO_F_DL_LOAD, DSO_R_LOAD_FAILED);
 130         ERR_add_error_data(4, "filename(", filename, "): ", strerror(errno));
 131         goto err;
 132     }
 133     if (!sk_push(dso->meth_data, (char *)ptr)) {
 134         DSOerr(DSO_F_DL_LOAD, DSO_R_STACK_ERROR);
 135         goto err;
 136     }
 137     /*
 138      * Success, stick the converted filename we've loaded under into the DSO
 139      * (it also serves as the indicator that we are currently loaded).
 140      */
 141     dso->loaded_filename = filename;
 142     return (1);
 143  err:
 144     /* Cleanup! */
 145     OPENSSL_free(filename);
 146     if (ptr != NULL)
 147         shl_unload(ptr);
 148     return (0);
 149 }
 150
 151 static int dl_unload(DSO *dso)
 152 {
 153     shl_t ptr;
 154     if (dso == NULL) {
 155         DSOerr(DSO_F_DL_UNLOAD, ERR_R_PASSED_NULL_PARAMETER);
 156         return (0);
 157     }
 158     if (sk_num(dso->meth_data) < 1)
 159         return (1);
 160     /* Is this statement legal? */
 161     ptr = (shl_t) sk_pop(dso->meth_data);
 162     if (ptr == NULL) {
 163         DSOerr(DSO_F_DL_UNLOAD, DSO_R_NULL_HANDLE);
 164         /*
 165          * Should push the value back onto the stack in case of a retry.
 166          */
 167         sk_push(dso->meth_data, (char *)ptr);
 168         return (0);
 169     }
 170     shl_unload(ptr);
 171     return (1);
 172 }
 173
 174 static void *dl_bind_var(DSO *dso, const char *symname)
 175 {
 176     shl_t ptr;
 177     void *sym;
 178
 179     if ((dso == NULL) || (symname == NULL)) {
 180         DSOerr(DSO_F_DL_BIND_VAR, ERR_R_PASSED_NULL_PARAMETER);
 181         return (NULL);
 182     }
 183     if (sk_num(dso->meth_data) < 1) {
 184         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_STACK_ERROR);
 185         return (NULL);
 186     }
 187     ptr = (shl_t) sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 188     if (ptr == NULL) {
 189         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_NULL_HANDLE);
 190         return (NULL);
 191     }
 192     if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0) {
 193         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_SYM_FAILURE);
 194         ERR_add_error_data(4, "symname(", symname, "): ", strerror(errno));
 195         return (NULL);
 196     }
 197     return (sym);
 198 }
 199
 200 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
 201 {
 202     shl_t ptr;
 203     void *sym;
 204
 205     if ((dso == NULL) || (symname == NULL)) {
 206         DSOerr(DSO_F_DL_BIND_FUNC, ERR_R_PASSED_NULL_PARAMETER);
 207         return (NULL);
 208     }
 209     if (sk_num(dso->meth_data) < 1) {
 210         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_STACK_ERROR);
 211         return (NULL);
 212     }
 213     ptr = (shl_t) sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 214     if (ptr == NULL) {
 215         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_NULL_HANDLE);
 216         return (NULL);
 217     }
 218     if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0) {
 219         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_SYM_FAILURE);
 220         ERR_add_error_data(4, "symname(", symname, "): ", strerror(errno));
 221         return (NULL);
 222     }
 223     return ((DSO_FUNC_TYPE)sym);
 224 }
 225
 226 static char *dl_merger(DSO *dso, const char *filespec1, const char *filespec2)
 227 {
 228     char *merged;
 229
 230     if (!filespec1 && !filespec2) {
 231         DSOerr(DSO_F_DL_MERGER, ERR_R_PASSED_NULL_PARAMETER);
 232         return (NULL);
 233     }
 234     /*
 235      * If the first file specification is a rooted path, it rules. same goes
 236      * if the second file specification is missing.
 237      */
 238     if (!filespec2 || filespec1[0] == '/') {
 239         merged = OPENSSL_malloc(strlen(filespec1) + 1);
 240         if (merged == NULL) {
 241             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 242             return (NULL);
 243         }
 244         strcpy(merged, filespec1);
 245     }
 246     /*
 247      * If the first file specification is missing, the second one rules.
 248      */
 249     else if (!filespec1) {
 250         merged = OPENSSL_malloc(strlen(filespec2) + 1);
 251         if (merged == NULL) {
 252             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 253             return (NULL);
 254         }
 255         strcpy(merged, filespec2);
 256     } else
 257         /*
 258          * This part isn't as trivial as it looks.  It assumes that the
 259          * second file specification really is a directory, and makes no
 260          * checks whatsoever.  Therefore, the result becomes the
 261          * concatenation of filespec2 followed by a slash followed by
 262          * filespec1.
 263          */
 264     {
 265         int spec2len, len;
 266
 267         spec2len = (filespec2 ? strlen(filespec2) : 0);
 268         len = spec2len + (filespec1 ? strlen(filespec1) : 0);
 269
 270         if (filespec2 && filespec2[spec2len - 1] == '/') {
 271             spec2len--;
 272             len--;
 273         }
 274         merged = OPENSSL_malloc(len + 2);
 275         if (merged == NULL) {
 276             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 277             return (NULL);
 278         }
 279         strcpy(merged, filespec2);
 280         merged[spec2len] = '/';
 281         strcpy(&merged[spec2len + 1], filespec1);
 282     }
 283     return (merged);
 284 }
 285
 286 /*
 287  * This function is identical to the one in dso_dlfcn.c, but as it is highly
 288  * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at
 289  * the same time, there's no great duplicating the code. Figuring out an
 290  * elegant way to share one copy of the code would be more difficult and
 291  * would not leave the implementations independent.
 292  */
 293 # if defined(__hpux)
 294 static const char extension[] = ".sl";
 295 # else
 296 static const char extension[] = ".so";
 297 # endif
 298 static char *dl_name_converter(DSO *dso, const char *filename)
 299 {
 300     char *translated;
 301     int len, rsize, transform;
 302
 303     len = strlen(filename);
 304     rsize = len + 1;
 305     transform = (strstr(filename, "/") == NULL);
 306     {
 307         /* We will convert this to "%s.s?" or "lib%s.s?" */
 308         rsize += strlen(extension); /* The length of ".s?" */
 309         if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 310             rsize += 3;         /* The length of "lib" */
 311     }
 312     translated = OPENSSL_malloc(rsize);
 313     if (translated == NULL) {
 314         DSOerr(DSO_F_DL_NAME_CONVERTER, DSO_R_NAME_TRANSLATION_FAILED);
 315         return (NULL);
 316     }
 317     if (transform) {
 318         if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 319             sprintf(translated, "lib%s%s", filename, extension);
 320         else
 321             sprintf(translated, "%s%s", filename, extension);
 322     } else
 323         sprintf(translated, "%s", filename);
 324     return (translated);
 325 }
 326
 327 static int dl_pathbyaddr(void *addr, char *path, int sz)
 328 {
 329     struct shl_descriptor inf;
 330     int i, len;
 331
 332     if (addr == NULL) {
 333         union {
 334             int (*f) (void *, char *, int);
 335             void *p;
 336         } t = {
 337             dl_pathbyaddr
 338         };
 339         addr = t.p;
 340     }
 341
 342     for (i = -1; shl_get_r(i, &inf) == 0; i++) {
 343         if (((size_t)addr >= inf.tstart && (size_t)addr < inf.tend) ||
 344             ((size_t)addr >= inf.dstart && (size_t)addr < inf.dend)) {
 345             len = (int)strlen(inf.filename);
 346             if (sz <= 0)
 347                 return len + 1;
 348             if (len >= sz)
 349                 len = sz - 1;
 350             memcpy(path, inf.filename, len);
 351             path[len++] = 0;
 352             return len;
 353         }
 354     }
 355
 356     return -1;
 357 }
 358
 359 static void *dl_globallookup(const char *name)
 360 {
 361     void *ret;
 362     shl_t h = NULL;
 363
 364     return shl_findsym(&h, name, TYPE_UNDEFINED, &ret) ? NULL : ret;
 365 }
 366 #endif                          /* DSO_DL */