4d599246c81c6c733c8be8b49359534b71b20846
[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 |
134                 (dso->flags&DSO_FLAG_NO_NAME_TRANSLATION?0:DYNAMIC_PATH), 0L);
135         if(ptr == NULL)
136                 {
137                 DSOerr(DSO_F_DL_LOAD,DSO_R_LOAD_FAILED);
138                 ERR_add_error_data(4, "filename(", filename, "): ",
139                         strerror(errno));
140                 goto err;
141                 }
142         if(!sk_push(dso->meth_data, (char *)ptr))
143                 {
144                 DSOerr(DSO_F_DL_LOAD,DSO_R_STACK_ERROR);
145                 goto err;
146                 }
147         /* Success, stick the converted filename we've loaded under into the DSO
148          * (it also serves as the indicator that we are currently loaded). */
149         dso->loaded_filename = filename;
150         return(1);
151 err:
152         /* Cleanup! */
153         if(filename != NULL)
154                 OPENSSL_free(filename);
155         if(ptr != NULL)
156                 shl_unload(ptr);
157         return(0);
158         }
159
160 static int dl_unload(DSO *dso)
161         {
162         shl_t ptr;
163         if(dso == NULL)
164                 {
165                 DSOerr(DSO_F_DL_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
166                 return(0);
167                 }
168         if(sk_num(dso->meth_data) < 1)
169                 return(1);
170         /* Is this statement legal? */
171         ptr = (shl_t)sk_pop(dso->meth_data);
172         if(ptr == NULL)
173                 {
174                 DSOerr(DSO_F_DL_UNLOAD,DSO_R_NULL_HANDLE);
175                 /* Should push the value back onto the stack in
176                  * case of a retry. */
177                 sk_push(dso->meth_data, (char *)ptr);
178                 return(0);
179                 }
180         shl_unload(ptr);
181         return(1);
182         }
183
184 static void *dl_bind_var(DSO *dso, const char *symname)
185         {
186         shl_t ptr;
187         void *sym;
188
189         if((dso == NULL) || (symname == NULL))
190                 {
191                 DSOerr(DSO_F_DL_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
192                 return(NULL);
193                 }
194         if(sk_num(dso->meth_data) < 1)
195                 {
196                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_STACK_ERROR);
197                 return(NULL);
198                 }
199         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
200         if(ptr == NULL)
201                 {
202                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_NULL_HANDLE);
203                 return(NULL);
204                 }
205         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
206                 {
207                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_SYM_FAILURE);
208                 ERR_add_error_data(4, "symname(", symname, "): ",
209                         strerror(errno));
210                 return(NULL);
211                 }
212         return(sym);
213         }
214
215 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
216         {
217         shl_t ptr;
218         void *sym;
219
220         if((dso == NULL) || (symname == NULL))
221                 {
222                 DSOerr(DSO_F_DL_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
223                 return(NULL);
224                 }
225         if(sk_num(dso->meth_data) < 1)
226                 {
227                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_STACK_ERROR);
228                 return(NULL);
229                 }
230         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
231         if(ptr == NULL)
232                 {
233                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_NULL_HANDLE);
234                 return(NULL);
235                 }
236         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
237                 {
238                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_SYM_FAILURE);
239                 ERR_add_error_data(4, "symname(", symname, "): ",
240                         strerror(errno));
241                 return(NULL);
242                 }
243         return((DSO_FUNC_TYPE)sym);
244         }
245
246 static char *dl_merger(DSO *dso, const char *filespec1, const char *filespec2)
247         {
248         char *merged;
249
250         if(!filespec1 && !filespec2)
251                 {
252                 DSOerr(DSO_F_DL_MERGER,
253                                 ERR_R_PASSED_NULL_PARAMETER);
254                 return(NULL);
255                 }
256         /* If the first file specification is a rooted path, it rules.
257            same goes if the second file specification is missing. */
258         if (!filespec2 || filespec1[0] == '/')
259                 {
260                 merged = OPENSSL_malloc(strlen(filespec1) + 1);
261                 if(!merged)
262                         {
263                         DSOerr(DSO_F_DL_MERGER,
264                                 ERR_R_MALLOC_FAILURE);
265                         return(NULL);
266                         }
267                 strcpy(merged, filespec1);
268                 }
269         /* If the first file specification is missing, the second one rules. */
270         else if (!filespec1)
271                 {
272                 merged = OPENSSL_malloc(strlen(filespec2) + 1);
273                 if(!merged)
274                         {
275                         DSOerr(DSO_F_DL_MERGER,
276                                 ERR_R_MALLOC_FAILURE);
277                         return(NULL);
278                         }
279                 strcpy(merged, filespec2);
280                 }
281         else
282                 /* This part isn't as trivial as it looks.  It assumes that
283                    the second file specification really is a directory, and
284                    makes no checks whatsoever.  Therefore, the result becomes
285                    the concatenation of filespec2 followed by a slash followed
286                    by filespec1. */
287                 {
288                 int spec2len, len;
289
290                 spec2len = (filespec2 ? strlen(filespec2) : 0);
291                 len = spec2len + (filespec1 ? strlen(filespec1) : 0);
292
293                 if(filespec2 && filespec2[spec2len - 1] == '/')
294                         {
295                         spec2len--;
296                         len--;
297                         }
298                 merged = OPENSSL_malloc(len + 2);
299                 if(!merged)
300                         {
301                         DSOerr(DSO_F_DL_MERGER,
302                                 ERR_R_MALLOC_FAILURE);
303                         return(NULL);
304                         }
305                 strcpy(merged, filespec2);
306                 merged[spec2len] = '/';
307                 strcpy(&merged[spec2len + 1], filespec1);
308                 }
309         return(merged);
310         }
311
312 /* This function is identical to the one in dso_dlfcn.c, but as it is highly
313  * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at the
314  * same time, there's no great duplicating the code. Figuring out an elegant 
315  * way to share one copy of the code would be more difficult and would not
316  * leave the implementations independant. */
317 #if defined(__hpux)
318 static const char extension[] = ".sl";
319 #else
320 static const char extension[] = ".so";
321 #endif
322 static char *dl_name_converter(DSO *dso, const char *filename)
323         {
324         char *translated;
325         int len, rsize, transform;
326
327         len = strlen(filename);
328         rsize = len + 1;
329         transform = (strstr(filename, "/") == NULL);
330                 {
331                 /* We will convert this to "%s.s?" or "lib%s.s?" */
332                 rsize += strlen(extension);/* The length of ".s?" */
333                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
334                         rsize += 3; /* The length of "lib" */
335                 }
336         translated = OPENSSL_malloc(rsize);
337         if(translated == NULL)
338                 {
339                 DSOerr(DSO_F_DL_NAME_CONVERTER,
340                                 DSO_R_NAME_TRANSLATION_FAILED); 
341                 return(NULL);   
342                 }
343         if(transform)
344                 {
345                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
346                         sprintf(translated, "lib%s%s", filename, extension);
347                 else
348                         sprintf(translated, "%s%s", filename, extension);
349                 }
350         else
351                 sprintf(translated, "%s", filename);
352         return(translated);
353         }
354
355 static int dl_pathbyaddr(void *addr,char *path,int sz)
356         {
357         struct shl_descriptor inf;
358         int i,len;
359
360         if (addr == NULL) addr = dl_pathbyaddr;
361
362         for (i=-1;shl_get_r(i,&inf)==0;i++)
363                 {
364                 if (((size_t)addr >= inf.tstart && (size_t)addr < inf.tend) ||
365                     ((size_t)addr >= inf.dstart && (size_t)addr < inf.dend))
366                         {
367                         len = (int)strlen(inf.filename);
368                         if (sz <= 0) return len+1;
369                         if (len >= sz) len=sz-1;
370                         memcpy(path,inf.filename,len);
371                         path[len++] = 0;
372                         return len;
373                         }
374                 }
375
376         return -1;
377         }
378 #endif /* DSO_DL */