Add a warning stipulating how things should be coded in ossl_init_base
[openssl.git] / crypto / dso / dso_dl.c
index 32a8d41bf74986ac8ee584908e0eeeb1575be475..d80bf562c7f225223ba1a4d5b08c626c08f0dfd7 100644 (file)
-/* dso_dl.c -*- mode:C; c-file-style: "eay" -*- */
-/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
- * project 2000.
- */
-/* ====================================================================
- * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer. 
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. All advertising materials mentioning features or use of this
- *    software must display the following acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
- *
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
- *    endorse or promote products derived from this software without
- *    prior written permission. For written permission, please contact
- *    licensing@OpenSSL.org.
- *
- * 5. Products derived from this software may not be called "OpenSSL"
- *    nor may "OpenSSL" appear in their names without prior written
- *    permission of the OpenSSL Project.
- *
- * 6. Redistributions of any form whatsoever must retain the following
- *    acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
- *
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * ====================================================================
- *
- * This product includes cryptographic software written by Eric Young
- * (eay@cryptsoft.com).  This product includes software written by Tim
- * Hudson (tjh@cryptsoft.com).
+/*
+ * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  *
+ * Licensed under the OpenSSL license (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
  */
 
-#include <stdio.h>
-#include "cryptlib.h"
-#include <openssl/dso.h>
+#include "dso_locl.h"
 
-#ifndef DSO_DL
-DSO_METHOD *DSO_METHOD_dl(void)
-       {
-       return NULL;
-       }
-#else
+#ifdef DSO_DL
 
-#include <dl.h>
+# include <dl.h>
 
 /* Part of the hack in "dl_load" ... */
-#define DSO_MAX_TRANSLATED_SIZE 256
+# define DSO_MAX_TRANSLATED_SIZE 256
 
 static int dl_load(DSO *dso);
 static int dl_unload(DSO *dso);
-static void *dl_bind_var(DSO *dso, const char *symname);
 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname);
-#if 0
-static int dl_unbind_var(DSO *dso, char *symname, void *symptr);
-static int dl_unbind_func(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
-static int dl_init(DSO *dso);
-static int dl_finish(DSO *dso);
-static int dl_ctrl(DSO *dso, int cmd, long larg, void *parg);
-#endif
 static char *dl_name_converter(DSO *dso, const char *filename);
-static char *dl_merger(DSO *dso, const char *filespec1, const char *filespec2);
+static char *dl_merger(DSO *dso, const char *filespec1,
+                       const char *filespec2);
+static int dl_pathbyaddr(void *addr, char *path, int sz);
+static void *dl_globallookup(const char *name);
 
 static DSO_METHOD dso_meth_dl = {
-       "OpenSSL 'dl' shared library method",
-       dl_load,
-       dl_unload,
-       dl_bind_var,
-       dl_bind_func,
-/* For now, "unbind" doesn't exist */
-#if 0
-       NULL, /* unbind_var */
-       NULL, /* unbind_func */
-#endif
-       NULL, /* ctrl */
-       dl_name_converter,
-       dl_merger,
-       NULL, /* init */
-       NULL  /* finish */
-       };
+    "OpenSSL 'dl' shared library method",
+    dl_load,
+    dl_unload,
+    dl_bind_func,
+    NULL,                       /* ctrl */
+    dl_name_converter,
+    dl_merger,
+    NULL,                       /* init */
+    NULL,                       /* finish */
+    dl_pathbyaddr,
+    dl_globallookup
+};
 
-DSO_METHOD *DSO_METHOD_dl(void)
-       {
-       return(&dso_meth_dl);
-       }
+DSO_METHOD *DSO_METHOD_openssl(void)
+{
+    return &dso_meth_dl;
+}
 
-/* For this DSO_METHOD, our meth_data STACK will contain;
- * (i) the handle (shl_t) returned from shl_load().
- * NB: I checked on HPUX11 and shl_t is itself a pointer
- * type so the cast is safe.
+/*
+ * For this DSO_METHOD, our meth_data STACK will contain; (i) the handle
+ * (shl_t) returned from shl_load(). NB: I checked on HPUX11 and shl_t is
+ * itself a pointer type so the cast is safe.
  */
 
 static int dl_load(DSO *dso)
-       {
-       shl_t ptr = NULL;
-       /* We don't do any fancy retries or anything, just take the method's
-        * (or DSO's if it has the callback set) best translation of the
-        * platform-independant filename and try once with that. */
-       char *filename= DSO_convert_filename(dso, NULL);
+{
+    shl_t ptr = NULL;
+    /*
+     * We don't do any fancy retries or anything, just take the method's (or
+     * DSO's if it has the callback set) best translation of the
+     * platform-independent filename and try once with that.
+     */
+    char *filename = DSO_convert_filename(dso, NULL);
 
-       if(filename == NULL)
-               {
-               DSOerr(DSO_F_DL_LOAD,DSO_R_NO_FILENAME);
-               goto err;
-               }
-       ptr = shl_load(filename, BIND_IMMEDIATE|DYNAMIC_PATH, NULL);
-       if(ptr == NULL)
-               {
-               DSOerr(DSO_F_DL_LOAD,DSO_R_LOAD_FAILED);
-               ERR_add_error_data(4, "filename(", filename, "): ",
-                       strerror(errno));
-               goto err;
-               }
-       if(!sk_push(dso->meth_data, (char *)ptr))
-               {
-               DSOerr(DSO_F_DL_LOAD,DSO_R_STACK_ERROR);
-               goto err;
-               }
-       /* Success, stick the converted filename we've loaded under into the DSO
-        * (it also serves as the indicator that we are currently loaded). */
-       dso->loaded_filename = filename;
-       return(1);
-err:
-       /* Cleanup! */
-       if(filename != NULL)
-               OPENSSL_free(filename);
-       if(ptr != NULL)
-               shl_unload(ptr);
-       return(0);
-       }
+    if (filename == NULL) {
+        DSOerr(DSO_F_DL_LOAD, DSO_R_NO_FILENAME);
+        goto err;
+    }
+    ptr = shl_load(filename, BIND_IMMEDIATE |
+                   (dso->flags & DSO_FLAG_NO_NAME_TRANSLATION ? 0 :
+                    DYNAMIC_PATH), 0L);
+    if (ptr == NULL) {
+        char errbuf[160];
+        DSOerr(DSO_F_DL_LOAD, DSO_R_LOAD_FAILED);
+        if (openssl_strerror_r(errno, errbuf, sizeof(errbuf)))
+            ERR_add_error_data(4, "filename(", filename, "): ", errbuf);
+        goto err;
+    }
+    if (!sk_push(dso->meth_data, (char *)ptr)) {
+        DSOerr(DSO_F_DL_LOAD, DSO_R_STACK_ERROR);
+        goto err;
+    }
+    /*
+     * Success, stick the converted filename we've loaded under into the DSO
+     * (it also serves as the indicator that we are currently loaded).
+     */
+    dso->loaded_filename = filename;
+    return (1);
+ err:
+    /* Cleanup! */
+    OPENSSL_free(filename);
+    if (ptr != NULL)
+        shl_unload(ptr);
+    return (0);
+}
 
 static int dl_unload(DSO *dso)
-       {
-       shl_t ptr;
-       if(dso == NULL)
-               {
-               DSOerr(DSO_F_DL_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
-               return(0);
-               }
-       if(sk_num(dso->meth_data) < 1)
-               return(1);
-       /* Is this statement legal? */
-       ptr = (shl_t)sk_pop(dso->meth_data);
-       if(ptr == NULL)
-               {
-               DSOerr(DSO_F_DL_UNLOAD,DSO_R_NULL_HANDLE);
-               /* Should push the value back onto the stack in
-                * case of a retry. */
-               sk_push(dso->meth_data, (char *)ptr);
-               return(0);
-               }
-       shl_unload(ptr);
-       return(1);
-       }
-
-static void *dl_bind_var(DSO *dso, const char *symname)
-       {
-       shl_t ptr;
-       void *sym;
-
-       if((dso == NULL) || (symname == NULL))
-               {
-               DSOerr(DSO_F_DL_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
-               return(NULL);
-               }
-       if(sk_num(dso->meth_data) < 1)
-               {
-               DSOerr(DSO_F_DL_BIND_VAR,DSO_R_STACK_ERROR);
-               return(NULL);
-               }
-       ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
-       if(ptr == NULL)
-               {
-               DSOerr(DSO_F_DL_BIND_VAR,DSO_R_NULL_HANDLE);
-               return(NULL);
-               }
-       if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
-               {
-               DSOerr(DSO_F_DL_BIND_VAR,DSO_R_SYM_FAILURE);
-               ERR_add_error_data(4, "symname(", symname, "): ",
-                       strerror(errno));
-               return(NULL);
-               }
-       return(sym);
-       }
+{
+    shl_t ptr;
+    if (dso == NULL) {
+        DSOerr(DSO_F_DL_UNLOAD, ERR_R_PASSED_NULL_PARAMETER);
+        return (0);
+    }
+    if (sk_num(dso->meth_data) < 1)
+        return (1);
+    /* Is this statement legal? */
+    ptr = (shl_t) sk_pop(dso->meth_data);
+    if (ptr == NULL) {
+        DSOerr(DSO_F_DL_UNLOAD, DSO_R_NULL_HANDLE);
+        /*
+         * Should push the value back onto the stack in case of a retry.
+         */
+        sk_push(dso->meth_data, (char *)ptr);
+        return (0);
+    }
+    shl_unload(ptr);
+    return (1);
+}
 
 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
-       {
-       shl_t ptr;
-       void *sym;
+{
+    shl_t ptr;
+    void *sym;
 
-       if((dso == NULL) || (symname == NULL))
-               {
-               DSOerr(DSO_F_DL_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
-               return(NULL);
-               }
-       if(sk_num(dso->meth_data) < 1)
-               {
-               DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_STACK_ERROR);
-               return(NULL);
-               }
-       ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
-       if(ptr == NULL)
-               {
-               DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_NULL_HANDLE);
-               return(NULL);
-               }
-       if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
-               {
-               DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_SYM_FAILURE);
-               ERR_add_error_data(4, "symname(", symname, "): ",
-                       strerror(errno));
-               return(NULL);
-               }
-       return((DSO_FUNC_TYPE)sym);
-       }
+    if ((dso == NULL) || (symname == NULL)) {
+        DSOerr(DSO_F_DL_BIND_FUNC, ERR_R_PASSED_NULL_PARAMETER);
+        return (NULL);
+    }
+    if (sk_num(dso->meth_data) < 1) {
+        DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_STACK_ERROR);
+        return (NULL);
+    }
+    ptr = (shl_t) sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
+    if (ptr == NULL) {
+        DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_NULL_HANDLE);
+        return (NULL);
+    }
+    if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0) {
+        char errbuf[160];
+        DSOerr(DSO_F_DL_BIND_FUNC, DSO_R_SYM_FAILURE);
+        if (openssl_strerror_r(errno, errbuf, sizeof(errbuf)))
+            ERR_add_error_data(4, "symname(", symname, "): ", errbuf);
+        return (NULL);
+    }
+    return ((DSO_FUNC_TYPE)sym);
+}
 
 static char *dl_merger(DSO *dso, const char *filespec1, const char *filespec2)
-       {
-       char *merged;
+{
+    char *merged;
 
-       if(!filespec1 && !filespec2)
-               {
-               DSOerr(DSO_F_DL_MERGER,
-                               ERR_R_PASSED_NULL_PARAMETER);
-               return(NULL);
-               }
-       /* If the first file specification is a rooted path, it rules.
-          same goes if the second file specification is missing. */
-       if (!filespec2 || filespec1[0] == '/')
-               {
-               merged = OPENSSL_malloc(strlen(filespec1) + 1);
-               if(!merged)
-                       {
-                       DSOerr(DSO_F_DL_MERGER,
-                               ERR_R_MALLOC_FAILURE);
-                       return(NULL);
-                       }
-               strcpy(merged, filespec1);
-               }
-       /* If the first file specification is missing, the second one rules. */
-       else if (!filespec1)
-               {
-               merged = OPENSSL_malloc(strlen(filespec2) + 1);
-               if(!merged)
-                       {
-                       DSOerr(DSO_F_DL_MERGER,
-                               ERR_R_MALLOC_FAILURE);
-                       return(NULL);
-                       }
-               strcpy(merged, filespec2);
-               }
-       else
-               /* This part isn't as trivial as it looks.  It assumes that
-                  the second file specification really is a directory, and
-                  makes no checks whatsoever.  Therefore, the result becomes
-                  the concatenation of filespec2 followed by a slash followed
-                  by filespec1. */
-               {
-               int spec2len, len;
+    if (!filespec1 && !filespec2) {
+        DSOerr(DSO_F_DL_MERGER, ERR_R_PASSED_NULL_PARAMETER);
+        return (NULL);
+    }
+    /*
+     * If the first file specification is a rooted path, it rules. same goes
+     * if the second file specification is missing.
+     */
+    if (!filespec2 || filespec1[0] == '/') {
+        merged = OPENSSL_strdup(filespec1);
+        if (merged == NULL) {
+            DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
+            return (NULL);
+        }
+    }
+    /*
+     * If the first file specification is missing, the second one rules.
+     */
+    else if (!filespec1) {
+        merged = OPENSSL_strdup(filespec2);
+        if (merged == NULL) {
+            DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
+            return (NULL);
+        }
+    } else
+        /*
+         * This part isn't as trivial as it looks.  It assumes that the
+         * second file specification really is a directory, and makes no
+         * checks whatsoever.  Therefore, the result becomes the
+         * concatenation of filespec2 followed by a slash followed by
+         * filespec1.
+         */
+    {
+        int spec2len, len;
 
-               spec2len = (filespec2 ? strlen(filespec2) : 0);
-               len = spec2len + (filespec1 ? strlen(filespec1) : 0);
+        spec2len = (filespec2 ? strlen(filespec2) : 0);
+        len = spec2len + (filespec1 ? strlen(filespec1) : 0);
 
-               if(filespec2 && filespec2[spec2len - 1] == '/')
-                       {
-                       spec2len--;
-                       len--;
-                       }
-               merged = OPENSSL_malloc(len + 2);
-               if(!merged)
-                       {
-                       DSOerr(DSO_F_DL_MERGER,
-                               ERR_R_MALLOC_FAILURE);
-                       return(NULL);
-                       }
-               strcpy(merged, filespec2);
-               merged[spec2len] = '/';
-               strcpy(&merged[spec2len + 1], filespec1);
-               }
-       return(merged);
-       }
+        if (spec2len && filespec2[spec2len - 1] == '/') {
+            spec2len--;
+            len--;
+        }
+        merged = OPENSSL_malloc(len + 2);
+        if (merged == NULL) {
+            DSOerr(DSO_F_DL_MERGER, ERR_R_MALLOC_FAILURE);
+            return (NULL);
+        }
+        strcpy(merged, filespec2);
+        merged[spec2len] = '/';
+        strcpy(&merged[spec2len + 1], filespec1);
+    }
+    return (merged);
+}
 
-/* This function is identical to the one in dso_dlfcn.c, but as it is highly
- * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at the
- * same time, there's no great duplicating the code. Figuring out an elegant 
- * way to share one copy of the code would be more difficult and would not
- * leave the implementations independant. */
-#if defined(__hpux)
-static const char extension[] = ".sl";
-#else
-static const char extension[] = ".so";
-#endif
+/*
+ * This function is identical to the one in dso_dlfcn.c, but as it is highly
+ * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at
+ * the same time, there's no great duplicating the code. Figuring out an
+ * elegant way to share one copy of the code would be more difficult and
+ * would not leave the implementations independent.
+ */
 static char *dl_name_converter(DSO *dso, const char *filename)
-       {
-       char *translated;
-       int len, rsize, transform;
+{
+    char *translated;
+    int len, rsize, transform;
+
+    len = strlen(filename);
+    rsize = len + 1;
+    transform = (strstr(filename, "/") == NULL);
+    {
+        /* We will convert this to "%s.s?" or "lib%s.s?" */
+        rsize += strlen(DSO_EXTENSION); /* The length of ".s?" */
+        if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
+            rsize += 3;         /* The length of "lib" */
+    }
+    translated = OPENSSL_malloc(rsize);
+    if (translated == NULL) {
+        DSOerr(DSO_F_DL_NAME_CONVERTER, DSO_R_NAME_TRANSLATION_FAILED);
+        return (NULL);
+    }
+    if (transform) {
+        if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
+            sprintf(translated, "lib%s%s", filename, DSO_EXTENSION);
+        else
+            sprintf(translated, "%s%s", filename, DSO_EXTENSION);
+    } else
+        sprintf(translated, "%s", filename);
+    return (translated);
+}
+
+static int dl_pathbyaddr(void *addr, char *path, int sz)
+{
+    struct shl_descriptor inf;
+    int i, len;
+
+    if (addr == NULL) {
+        union {
+            int (*f) (void *, char *, int);
+            void *p;
+        } t = {
+            dl_pathbyaddr
+        };
+        addr = t.p;
+    }
+
+    for (i = -1; shl_get_r(i, &inf) == 0; i++) {
+        if (((size_t)addr >= inf.tstart && (size_t)addr < inf.tend) ||
+            ((size_t)addr >= inf.dstart && (size_t)addr < inf.dend)) {
+            len = (int)strlen(inf.filename);
+            if (sz <= 0)
+                return len + 1;
+            if (len >= sz)
+                len = sz - 1;
+            memcpy(path, inf.filename, len);
+            path[len++] = 0;
+            return len;
+        }
+    }
+
+    return -1;
+}
 
-       len = strlen(filename);
-       rsize = len + 1;
-       transform = (strstr(filename, "/") == NULL);
-               {
-               /* We will convert this to "%s.s?" or "lib%s.s?" */
-               rsize += strlen(extension);/* The length of ".s?" */
-               if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
-                       rsize += 3; /* The length of "lib" */
-               }
-       translated = OPENSSL_malloc(rsize);
-       if(translated == NULL)
-               {
-               DSOerr(DSO_F_DL_NAME_CONVERTER,
-                               DSO_R_NAME_TRANSLATION_FAILED); 
-               return(NULL);   
-               }
-       if(transform)
-               {
-               if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
-                       sprintf(translated, "lib%s%s", filename, extension);
-               else
-                       sprintf(translated, "%s%s", filename, extension);
-               }
-       else
-               sprintf(translated, "%s", filename);
-       return(translated);
-       }
+static void *dl_globallookup(const char *name)
+{
+    void *ret;
+    shl_t h = NULL;
 
-#endif /* DSO_DL */
+    return shl_findsym(&h, name, TYPE_UNDEFINED, &ret) ? NULL : ret;
+}
+#endif                          /* DSO_DL */