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