crypto/dso/dso_dl.c

   1 /* dso_dl.c -*- mode:C; c-file-style: "eay" -*- */
   2 /*
   3  * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
   4  * 2000.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61 #include "internal/cryptlib.h"
  62 #include <openssl/dso.h>
  63
  64 #ifndef DSO_DL
  65 DSO_METHOD *DSO_METHOD_dl(void)
  66 {
  67     return NULL;
  68 }
  69 #else
  70
  71 # include <dl.h>
  72
  73 /* Part of the hack in "dl_load" ... */
  74 # define DSO_MAX_TRANSLATED_SIZE 256
  75
  76 static int dl_load(DSO *dso);
  77 static int dl_unload(DSO *dso);
  78 static void *dl_bind_var(DSO *dso, const char *symname);
  79 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname);
  80 static char *dl_name_converter(DSO *dso, const char *filename);
  81 static char *dl_merger(DSO *dso, const char *filespec1,
  82                        const char *filespec2);
  83 static int dl_pathbyaddr(void *addr, char *path, int sz);
  84 static void *dl_globallookup(const char *name);
  85
  86 static DSO_METHOD dso_meth_dl = {
  87     "OpenSSL 'dl' shared library method",
  88     dl_load,
  89     dl_unload,
  90     dl_bind_var,
  91     dl_bind_func,
  92     NULL,                       /* ctrl */
  93     dl_name_converter,
  94     dl_merger,
  95     NULL,                       /* init */
  96     NULL,                       /* finish */
  97     dl_pathbyaddr,
  98     dl_globallookup
  99 };
 100
 101 DSO_METHOD *DSO_METHOD_dl(void)
 102 {
 103     return (&dso_meth_dl);
 104 }
 105
 106 /*
 107  * For this DSO_METHOD, our meth_data STACK will contain; (i) the handle
 108  * (shl_t) returned from shl_load(). NB: I checked on HPUX11 and shl_t is
 109  * itself a pointer type so the cast is safe.
 110  */
 111
 112 static int dl_load(DSO *dso)
 113 {
 114     shl_t ptr = NULL;
 115     /*
 116      * We don't do any fancy retries or anything, just take the method's (or
 117      * DSO's if it has the callback set) best translation of the
 118      * platform-independent filename and try once with that.
 119      */
 120     char *filename = DSO_convert_filename(dso, NULL);
 121
 122     if (filename == NULL) {
 123         DSOerr(DSO_F_DL_LOAD, DSO_R_NO_FILENAME);
 124         goto err;
 125     }
 126     ptr = shl_load(filename, BIND_IMMEDIATE |
 127                    (dso->flags & DSO_FLAG_NO_NAME_TRANSLATION ? 0 :
 128                     DYNAMIC_PATH), 0L);
 129     if (ptr == NULL) {
 130         DSOerr(DSO_F_DL_LOAD, DSO_R_LOAD_FAILED);
 131         ERR_add_error_data(4, "filename(", filename, "): ", strerror(errno));
 132         goto err;
 133     }
 134     if (!sk_push(dso->meth_data, (char *)ptr)) {
 135         DSOerr(DSO_F_DL_LOAD, DSO_R_STACK_ERROR);
 136         goto err;
 137     }
 138     /*
 139      * Success, stick the converted filename we've loaded under into the DSO
 140      * (it also serves as the indicator that we are currently loaded).
 141      */
 142     dso->loaded_filename = filename;
 143     return (1);
 144  err:
 145     /* Cleanup! */
 146     OPENSSL_free(filename);
 147     if (ptr != NULL)
 148         shl_unload(ptr);
 149     return (0);
 150 }
 151
 152 static int dl_unload(DSO *dso)
 153 {
 154     shl_t ptr;
 155     if (dso == NULL) {
 156         DSOerr(DSO_F_DL_UNLOAD, ERR_R_PASSED_NULL_PARAMETER);
 157         return (0);
 158     }
 159     if (sk_num(dso->meth_data) < 1)
 160         return (1);
 161     /* Is this statement legal? */
 162     ptr = (shl_t) sk_pop(dso->meth_data);
 163     if (ptr == NULL) {
 164         DSOerr(DSO_F_DL_UNLOAD, DSO_R_NULL_HANDLE);
 165         /*
 166          * Should push the value back onto the stack in case of a retry.
 167          */
 168         sk_push(dso->meth_data, (char *)ptr);
 169         return (0);
 170     }
 171     shl_unload(ptr);
 172     return (1);
 173 }
 174
 175 static void *dl_bind_var(DSO *dso, const char *symname)
 176 {
 177     shl_t ptr;
 178     void *sym;
 179
 180     if ((dso == NULL) || (symname == NULL)) {
 181         DSOerr(DSO_F_DL_BIND_VAR, ERR_R_PASSED_NULL_PARAMETER);
 182         return (NULL);
 183     }
 184     if (sk_num(dso->meth_data) < 1) {
 185         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_STACK_ERROR);
 186         return (NULL);
 187     }
 188     ptr = (shl_t) sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 189     if (ptr == NULL) {
 190         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_NULL_HANDLE);
 191         return (NULL);
 192     }
 193     if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0) {
 194         DSOerr(DSO_F_DL_BIND_VAR, DSO_R_SYM_FAILURE);
 195         ERR_add_error_data(4, "symname(", symname, "): ", strerror(errno));
 196         return (NULL);
 197     }
 198     return (sym);
 199 }
 200
 201 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
 202 {
 203     shl_t ptr;
 204     void *sym;
 205
 206     if ((dso == NULL) || (symname == NULL)) {
 207         DSOerr(DSO_F_DL_BIND_FUNC, ERR_R_PASSED_NULL_PARAMETER);
 208         return (NULL);
 209     }
 210     if (sk_num(dso->meth_data) < 1) {
 211         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_STACK_ERROR);
 212         return (NULL);
 213     }
 214     ptr = (shl_t) sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
 215     if (ptr == NULL) {
 216         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_NULL_HANDLE);
 217         return (NULL);
 218     }
 219     if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0) {
 220         DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_SYM_FAILURE);
 221         ERR_add_error_data(4, "symname(", symname, "): ", strerror(errno));
 222         return (NULL);
 223     }
 224     return ((DSO_FUNC_TYPE)sym);
 225 }
 226
 227 static char *dl_merger(DSO *dso, const char *filespec1, const char *filespec2)
 228 {
 229     char *merged;
 230
 231     if (!filespec1 && !filespec2) {
 232         DSOerr(DSO_F_DL_MERGER, ERR_R_PASSED_NULL_PARAMETER);
 233         return (NULL);
 234     }
 235     /*
 236      * If the first file specification is a rooted path, it rules. same goes
 237      * if the second file specification is missing.
 238      */
 239     if (!filespec2 || filespec1[0] == '/') {
 240         merged = OPENSSL_malloc(strlen(filespec1) + 1);
 241         if (!merged) {
 242             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 243             return (NULL);
 244         }
 245         strcpy(merged, filespec1);
 246     }
 247     /*
 248      * If the first file specification is missing, the second one rules.
 249      */
 250     else if (!filespec1) {
 251         merged = OPENSSL_malloc(strlen(filespec2) + 1);
 252         if (!merged) {
 253             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 254             return (NULL);
 255         }
 256         strcpy(merged, filespec2);
 257     } else
 258         /*
 259          * This part isn't as trivial as it looks.  It assumes that the
 260          * second file specification really is a directory, and makes no
 261          * checks whatsoever.  Therefore, the result becomes the
 262          * concatenation of filespec2 followed by a slash followed by
 263          * filespec1.
 264          */
 265     {
 266         int spec2len, len;
 267
 268         spec2len = (filespec2 ? strlen(filespec2) : 0);
 269         len = spec2len + (filespec1 ? strlen(filespec1) : 0);
 270
 271         if (filespec2 && filespec2[spec2len - 1] == '/') {
 272             spec2len--;
 273             len--;
 274         }
 275         merged = OPENSSL_malloc(len + 2);
 276         if (!merged) {
 277             DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
 278             return (NULL);
 279         }
 280         strcpy(merged, filespec2);
 281         merged[spec2len] = '/';
 282         strcpy(&merged[spec2len + 1], filespec1);
 283     }
 284     return (merged);
 285 }
 286
 287 /*
 288  * This function is identical to the one in dso_dlfcn.c, but as it is highly
 289  * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at
 290  * the same time, there's no great duplicating the code. Figuring out an
 291  * elegant way to share one copy of the code would be more difficult and
 292  * would not leave the implementations independent.
 293  */
 294 # if defined(__hpux)
 295 static const char extension[] = ".sl";
 296 # else
 297 static const char extension[] = ".so";
 298 # endif
 299 static char *dl_name_converter(DSO *dso, const char *filename)
 300 {
 301     char *translated;
 302     int len, rsize, transform;
 303
 304     len = strlen(filename);
 305     rsize = len + 1;
 306     transform = (strstr(filename, "/") == NULL);
 307     {
 308         /* We will convert this to "%s.s?" or "lib%s.s?" */
 309         rsize += strlen(extension); /* The length of ".s?" */
 310         if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 311             rsize += 3;         /* The length of "lib" */
 312     }
 313     translated = OPENSSL_malloc(rsize);
 314     if (translated == NULL) {
 315         DSOerr(DSO_F_DL_NAME_CONVERTER, DSO_R_NAME_TRANSLATION_FAILED);
 316         return (NULL);
 317     }
 318     if (transform) {
 319         if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
 320             sprintf(translated, "lib%s%s", filename, extension);
 321         else
 322             sprintf(translated, "%s%s", filename, extension);
 323     } else
 324         sprintf(translated, "%s", filename);
 325     return (translated);
 326 }
 327
 328 static int dl_pathbyaddr(void *addr, char *path, int sz)
 329 {
 330     struct shl_descriptor inf;
 331     int i, len;
 332
 333     if (addr == NULL) {
 334         union {
 335             int (*f) (void *, char *, int);
 336             void *p;
 337         } t = {
 338             dl_pathbyaddr
 339         };
 340         addr = t.p;
 341     }
 342
 343     for (i = -1; shl_get_r(i, &inf) == 0; i++) {
 344         if (((size_t)addr >= inf.tstart && (size_t)addr < inf.tend) ||
 345             ((size_t)addr >= inf.dstart && (size_t)addr < inf.dend)) {
 346             len = (int)strlen(inf.filename);
 347             if (sz <= 0)
 348                 return len + 1;
 349             if (len >= sz)
 350                 len = sz - 1;
 351             memcpy(path, inf.filename, len);
 352             path[len++] = 0;
 353             return len;
 354         }
 355     }
 356
 357     return -1;
 358 }
 359
 360 static void *dl_globallookup(const char *name)
 361 {
 362     void *ret;
 363     shl_t h = NULL;
 364
 365     return shl_findsym(&h, name, TYPE_UNDEFINED, &ret) ? NULL : ret;
 366 }
 367 #endif                          /* DSO_DL */