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