This change facilitates name translation for shared libraries. The
[openssl.git] / crypto / dso / dso_dlfcn.c
1 /* dso_dlfcn.c */
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, const char *filename);
78 static int dlfcn_unload(DSO *dso);
79 static int dlfcn_bind(DSO *dso, const char *symname, void **symptr);
80 #if 0
81 static int dlfcn_unbind(DSO *dso, char *symname, void *symptr);
82 static int dlfcn_init(DSO *dso);
83 static int dlfcn_finish(DSO *dso);
84 #endif
85 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
86
87 static DSO_METHOD dso_meth_dlfcn = {
88         "OpenSSL 'dlfcn' shared library method",
89         dlfcn_load,
90         dlfcn_unload,
91         dlfcn_bind,
92 /* For now, "unbind" doesn't exist */
93 #if 0
94         NULL, /* unbind */
95 #endif
96         dlfcn_ctrl,
97         NULL, /* init */
98         NULL  /* finish */
99         };
100
101 DSO_METHOD *DSO_METHOD_dlfcn(void)
102         {
103         return(&dso_meth_dlfcn);
104         }
105
106 /* For this DSO_METHOD, our meth_data STACK will contain;
107  * (i) the handle (void*) returned from dlopen().
108  */
109
110 static int dlfcn_load(DSO *dso, const char *filename)
111         {
112         void *ptr;
113         char translated[DSO_MAX_TRANSLATED_SIZE];
114         int len;
115
116         /* NB: This is a hideous hack, but I'm not yet sure what
117          * to replace it with. This attempts to convert any filename,
118          * that looks like it has no path information, into a
119          * translated form, e. "blah" -> "libblah.so" */
120         len = strlen(filename);
121         if((dso->flags & DSO_FLAG_NAME_TRANSLATION) &&
122                         (len + 6 < DSO_MAX_TRANSLATED_SIZE) &&
123                         (strstr(filename, "/") == NULL))
124                 {
125                 sprintf(translated, "lib%s.so", filename);
126                 ptr = dlopen(translated, RTLD_NOW);
127                 }
128         else
129                 {
130                 ptr = dlopen(filename, RTLD_NOW);
131                 }
132         if(ptr == NULL)
133                 {
134                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
135                 return(0);
136                 }
137         if(!sk_push(dso->meth_data, (char *)ptr))
138                 {
139                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
140                 dlclose(ptr);
141                 return(0);
142                 }
143         return(1);
144         }
145
146 static int dlfcn_unload(DSO *dso)
147         {
148         void *ptr;
149         if(dso == NULL)
150                 {
151                 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
152                 return(0);
153                 }
154         if(sk_num(dso->meth_data) < 1)
155                 {
156                 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_STACK_ERROR);
157                 return(0);
158                 }
159         ptr = (void *)sk_pop(dso->meth_data);
160         if(ptr == NULL)
161                 {
162                 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
163                 /* Should push the value back onto the stack in
164                  * case of a retry. */
165                 sk_push(dso->meth_data, (char *)ptr);
166                 return(0);
167                 }
168         /* For now I'm not aware of any errors associated with dlclose() */
169         dlclose(ptr);
170         return(1);
171         }
172
173 static int dlfcn_bind(DSO *dso, const char *symname, void **symptr)
174         {
175         void *ptr, *sym;
176
177         if((dso == NULL) || (symptr == NULL) || (symname == NULL))
178                 {
179                 DSOerr(DSO_F_DLFCN_BIND,ERR_R_PASSED_NULL_PARAMETER);
180                 return(0);
181                 }
182         if(sk_num(dso->meth_data) < 1)
183                 {
184                 DSOerr(DSO_F_DLFCN_BIND,DSO_R_STACK_ERROR);
185                 return(0);
186                 }
187         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
188         if(ptr == NULL)
189                 {
190                 DSOerr(DSO_F_DLFCN_BIND,DSO_R_NULL_HANDLE);
191                 return(0);
192                 }
193         sym = dlsym(ptr, symname);
194         if(sym == NULL)
195                 {
196                 DSOerr(DSO_F_DLFCN_BIND,DSO_R_SYM_FAILURE);
197                 return(0);
198                 }
199         *symptr = sym;
200         return(1);
201         }
202
203 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg)
204         {
205         if(dso == NULL)
206                 {
207                 DSOerr(DSO_F_DLFCN_CTRL,ERR_R_PASSED_NULL_PARAMETER);
208                 return(-1);
209                 }
210         switch(cmd)
211                 {
212         case DSO_CTRL_GET_FLAGS:
213                 return dso->flags;
214         case DSO_CTRL_SET_FLAGS:
215                 dso->flags = (int)larg;
216                 return(0);
217         case DSO_CTRL_OR_FLAGS:
218                 dso->flags |= (int)larg;
219                 return(0);
220         default:
221                 break;
222                 }
223         DSOerr(DSO_F_DLFCN_CTRL,DSO_R_UNKNOWN_COMMAND);
224         return(-1);
225         }
226
227 #endif /* DSO_DLFCN */