Various Win32 fixes.
[openssl.git] / crypto / dso / dso_dlfcn.c
1 /* dso_dlfcn.c -*- mode:C; c-file-style: "eay" -*- */
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);
78 static int dlfcn_unload(DSO *dso);
79 static void *dlfcn_bind_var(DSO *dso, const char *symname);
80 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname);
81 #if 0
82 static int dlfcn_unbind(DSO *dso, char *symname, void *symptr);
83 static int dlfcn_init(DSO *dso);
84 static int dlfcn_finish(DSO *dso);
85 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
86 #endif
87 static char *dlfcn_name_converter(DSO *dso, const char *filename);
88 static char *dlfcn_merger(DSO *dso, const char *filespec1,
89         const char *filespec2);
90
91 static DSO_METHOD dso_meth_dlfcn = {
92         "OpenSSL 'dlfcn' shared library method",
93         dlfcn_load,
94         dlfcn_unload,
95         dlfcn_bind_var,
96         dlfcn_bind_func,
97 /* For now, "unbind" doesn't exist */
98 #if 0
99         NULL, /* unbind_var */
100         NULL, /* unbind_func */
101 #endif
102         NULL, /* ctrl */
103         dlfcn_name_converter,
104         dlfcn_merger,
105         NULL, /* init */
106         NULL  /* finish */
107         };
108
109 DSO_METHOD *DSO_METHOD_dlfcn(void)
110         {
111         return(&dso_meth_dlfcn);
112         }
113
114 /* Prior to using the dlopen() function, we should decide on the flag
115  * we send. There's a few different ways of doing this and it's a
116  * messy venn-diagram to match up which platforms support what. So
117  * as we don't have autoconf yet, I'm implementing a hack that could
118  * be hacked further relatively easily to deal with cases as we find
119  * them. Initially this is to cope with OpenBSD. */
120 #if defined(__OpenBSD__) || defined(__NetBSD__)
121 #       ifdef DL_LAZY
122 #               define DLOPEN_FLAG DL_LAZY
123 #       else
124 #               ifdef RTLD_NOW
125 #                       define DLOPEN_FLAG RTLD_NOW
126 #               else
127 #                       define DLOPEN_FLAG 0
128 #               endif
129 #       endif
130 #else
131 #       define DLOPEN_FLAG RTLD_NOW /* Hope this works everywhere else */
132 #endif
133
134 /* For this DSO_METHOD, our meth_data STACK will contain;
135  * (i) the handle (void*) returned from dlopen().
136  */
137
138 static int dlfcn_load(DSO *dso)
139         {
140         void *ptr = NULL;
141         /* See applicable comments in dso_dl.c */
142         char *filename = DSO_convert_filename(dso, NULL);
143
144         if(filename == NULL)
145                 {
146                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
147                 goto err;
148                 }
149         ptr = dlopen(filename, DLOPEN_FLAG);
150         if(ptr == NULL)
151                 {
152                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
153                 ERR_add_error_data(4, "filename(", filename, "): ", dlerror());
154                 goto err;
155                 }
156         if(!sk_push(dso->meth_data, (char *)ptr))
157                 {
158                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
159                 goto err;
160                 }
161         /* Success */
162         dso->loaded_filename = filename;
163         return(1);
164 err:
165         /* Cleanup! */
166         if(filename != NULL)
167                 OPENSSL_free(filename);
168         if(ptr != NULL)
169                 dlclose(ptr);
170         return(0);
171 }
172
173 static int dlfcn_unload(DSO *dso)
174         {
175         void *ptr;
176         if(dso == NULL)
177                 {
178                 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
179                 return(0);
180                 }
181         if(sk_num(dso->meth_data) < 1)
182                 return(1);
183         ptr = (void *)sk_pop(dso->meth_data);
184         if(ptr == NULL)
185                 {
186                 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
187                 /* Should push the value back onto the stack in
188                  * case of a retry. */
189                 sk_push(dso->meth_data, (char *)ptr);
190                 return(0);
191                 }
192         /* For now I'm not aware of any errors associated with dlclose() */
193         dlclose(ptr);
194         return(1);
195         }
196
197 static void *dlfcn_bind_var(DSO *dso, const char *symname)
198         {
199         void *ptr, *sym;
200
201         if((dso == NULL) || (symname == NULL))
202                 {
203                 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
204                 return(NULL);
205                 }
206         if(sk_num(dso->meth_data) < 1)
207                 {
208                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
209                 return(NULL);
210                 }
211         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
212         if(ptr == NULL)
213                 {
214                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_NULL_HANDLE);
215                 return(NULL);
216                 }
217         sym = dlsym(ptr, symname);
218         if(sym == NULL)
219                 {
220                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
221                 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
222                 return(NULL);
223                 }
224         return(sym);
225         }
226
227 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
228         {
229         void *ptr;
230         DSO_FUNC_TYPE sym;
231
232         if((dso == NULL) || (symname == NULL))
233                 {
234                 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
235                 return(NULL);
236                 }
237         if(sk_num(dso->meth_data) < 1)
238                 {
239                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
240                 return(NULL);
241                 }
242         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
243         if(ptr == NULL)
244                 {
245                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
246                 return(NULL);
247                 }
248         sym = (DSO_FUNC_TYPE)dlsym(ptr, symname);
249         if(sym == NULL)
250                 {
251                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
252                 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
253                 return(NULL);
254                 }
255         return(sym);
256         }
257
258 static char *dlfcn_merger(DSO *dso, const char *filespec1,
259         const char *filespec2)
260         {
261         char *merged;
262
263         if(!filespec1 && !filespec2)
264                 {
265                 DSOerr(DSO_F_DLFCN_MERGER,
266                                 ERR_R_PASSED_NULL_PARAMETER);
267                 return(NULL);
268                 }
269         /* If the first file specification is a rooted path, it rules.
270            same goes if the second file specification is missing. */
271         if (!filespec2 || filespec1[0] == '/')
272                 {
273                 merged = OPENSSL_malloc(strlen(filespec1) + 1);
274                 if(!merged)
275                         {
276                         DSOerr(DSO_F_DLFCN_MERGER,
277                                 ERR_R_MALLOC_FAILURE);
278                         return(NULL);
279                         }
280                 strcpy(merged, filespec1);
281                 }
282         /* If the first file specification is missing, the second one rules. */
283         else if (!filespec1)
284                 {
285                 merged = OPENSSL_malloc(strlen(filespec2) + 1);
286                 if(!merged)
287                         {
288                         DSOerr(DSO_F_DLFCN_MERGER,
289                                 ERR_R_MALLOC_FAILURE);
290                         return(NULL);
291                         }
292                 strcpy(merged, filespec2);
293                 }
294         else
295                 /* This part isn't as trivial as it looks.  It assumes that
296                    the second file specification really is a directory, and
297                    makes no checks whatsoever.  Therefore, the result becomes
298                    the concatenation of filespec2 followed by a slash followed
299                    by filespec1. */
300                 {
301                 int spec2len, len;
302
303                 spec2len = (filespec2 ? strlen(filespec2) : 0);
304                 len = spec2len + (filespec1 ? strlen(filespec1) : 0);
305
306                 if(filespec2 && filespec2[spec2len - 1] == '/')
307                         {
308                         spec2len--;
309                         len--;
310                         }
311                 merged = OPENSSL_malloc(len + 2);
312                 if(!merged)
313                         {
314                         DSOerr(DSO_F_DLFCN_MERGER,
315                                 ERR_R_MALLOC_FAILURE);
316                         return(NULL);
317                         }
318                 strcpy(merged, filespec2);
319                 merged[spec2len] = '/';
320                 strcpy(&merged[spec2len + 1], filespec1);
321                 }
322         return(merged);
323         }
324
325 static char *dlfcn_name_converter(DSO *dso, const char *filename)
326         {
327         char *translated;
328         int len, rsize, transform;
329
330         len = strlen(filename);
331         rsize = len + 1;
332         transform = (strstr(filename, "/") == NULL);
333         if(transform)
334                 {
335                 /* We will convert this to "%s.so" or "lib%s.so" */
336                 rsize += 3;     /* The length of ".so" */
337                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
338                         rsize += 3; /* The length of "lib" */
339                 }
340         translated = OPENSSL_malloc(rsize);
341         if(translated == NULL)
342                 {
343                 DSOerr(DSO_F_DLFCN_NAME_CONVERTER,
344                                 DSO_R_NAME_TRANSLATION_FAILED);
345                 return(NULL);
346                 }
347         if(transform)
348                 {
349                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
350                         sprintf(translated, "lib%s.so", filename);
351                 else
352                         sprintf(translated, "%s.so", filename);
353                 }
354         else
355                 sprintf(translated, "%s", filename);
356         return(translated);
357         }
358
359 #endif /* DSO_DLFCN */