On VMS, the norm is still that symbols are uppercased, so for now it's better
[openssl.git] / crypto / dso / dso_dl.c
1 /* dso_dl.c */
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
88 static DSO_METHOD dso_meth_dl = {
89         "OpenSSL 'dl' shared library method",
90         dl_load,
91         dl_unload,
92         dl_bind_var,
93         dl_bind_func,
94 /* For now, "unbind" doesn't exist */
95 #if 0
96         NULL, /* unbind_var */
97         NULL, /* unbind_func */
98 #endif
99         NULL, /* ctrl */
100         dl_name_converter,
101         NULL, /* init */
102         NULL  /* finish */
103         };
104
105 DSO_METHOD *DSO_METHOD_dl(void)
106         {
107         return(&dso_meth_dl);
108         }
109
110 /* For this DSO_METHOD, our meth_data STACK will contain;
111  * (i) the handle (shl_t) returned from shl_load().
112  * NB: I checked on HPUX11 and shl_t is itself a pointer
113  * type so the cast is safe.
114  */
115
116 static int dl_load(DSO *dso)
117         {
118         shl_t ptr = NULL;
119         /* We don't do any fancy retries or anything, just take the method's
120          * (or DSO's if it has the callback set) best translation of the
121          * platform-independant filename and try once with that. */
122         char *filename= DSO_convert_filename(dso, NULL);
123
124         if(filename == NULL)
125                 {
126                 DSOerr(DSO_F_DL_LOAD,DSO_R_NO_FILENAME);
127                 goto err;
128                 }
129         ptr = shl_load(filename, BIND_IMMEDIATE|DYNAMIC_PATH, NULL);
130         if(ptr == NULL)
131                 {
132                 DSOerr(DSO_F_DL_LOAD,DSO_R_LOAD_FAILED);
133                 ERR_add_error_data(4, "filename(", filename, "): ",
134                         strerror(errno));
135                 goto err;
136                 }
137         if(!sk_push(dso->meth_data, (char *)ptr))
138                 {
139                 DSOerr(DSO_F_DL_LOAD,DSO_R_STACK_ERROR);
140                 goto err;
141                 }
142         /* Success, stick the converted filename we've loaded under into the DSO
143          * (it also serves as the indicator that we are currently loaded). */
144         dso->loaded_filename = filename;
145         return(1);
146 err:
147         /* Cleanup! */
148         if(filename != NULL)
149                 OPENSSL_free(filename);
150         if(ptr != NULL)
151                 shl_unload(ptr);
152         return(0);
153         }
154
155 static int dl_unload(DSO *dso)
156         {
157         shl_t ptr;
158         if(dso == NULL)
159                 {
160                 DSOerr(DSO_F_DL_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
161                 return(0);
162                 }
163         if(sk_num(dso->meth_data) < 1)
164                 return(1);
165         /* Is this statement legal? */
166         ptr = (shl_t)sk_pop(dso->meth_data);
167         if(ptr == NULL)
168                 {
169                 DSOerr(DSO_F_DL_UNLOAD,DSO_R_NULL_HANDLE);
170                 /* Should push the value back onto the stack in
171                  * case of a retry. */
172                 sk_push(dso->meth_data, (char *)ptr);
173                 return(0);
174                 }
175         shl_unload(ptr);
176         return(1);
177         }
178
179 static void *dl_bind_var(DSO *dso, const char *symname)
180         {
181         shl_t ptr;
182         void *sym;
183
184         if((dso == NULL) || (symname == NULL))
185                 {
186                 DSOerr(DSO_F_DL_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
187                 return(NULL);
188                 }
189         if(sk_num(dso->meth_data) < 1)
190                 {
191                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_STACK_ERROR);
192                 return(NULL);
193                 }
194         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
195         if(ptr == NULL)
196                 {
197                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_NULL_HANDLE);
198                 return(NULL);
199                 }
200         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
201                 {
202                 DSOerr(DSO_F_DL_BIND_VAR,DSO_R_SYM_FAILURE);
203                 ERR_add_error_data(4, "symname(", symname, "): ",
204                         strerror(errno));
205                 return(NULL);
206                 }
207         return(sym);
208         }
209
210 static DSO_FUNC_TYPE dl_bind_func(DSO *dso, const char *symname)
211         {
212         shl_t ptr;
213         void *sym;
214
215         if((dso == NULL) || (symname == NULL))
216                 {
217                 DSOerr(DSO_F_DL_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
218                 return(NULL);
219                 }
220         if(sk_num(dso->meth_data) < 1)
221                 {
222                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_STACK_ERROR);
223                 return(NULL);
224                 }
225         ptr = (shl_t)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
226         if(ptr == NULL)
227                 {
228                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_NULL_HANDLE);
229                 return(NULL);
230                 }
231         if (shl_findsym(&ptr, symname, TYPE_UNDEFINED, &sym) < 0)
232                 {
233                 DSOerr(DSO_F_DL_BIND_FUNC,DSO_R_SYM_FAILURE);
234                 ERR_add_error_data(4, "symname(", symname, "): ",
235                         strerror(errno));
236                 return(NULL);
237                 }
238         return((DSO_FUNC_TYPE)sym);
239         }
240
241 /* This function is identical to the one in dso_dlfcn.c, but as it is highly
242  * unlikely that both the "dl" *and* "dlfcn" variants are being compiled at the
243  * same time, there's no great duplicating the code. Figuring out an elegant 
244  * way to share one copy of the code would be more difficult and would not
245  * leave the implementations independant. */
246 #if defined(__hpux)
247 static const char extension[] = ".sl";
248 #else
249 static const char extension[] = ".so";
250 #endif
251 static char *dl_name_converter(DSO *dso, const char *filename)
252         {
253         char *translated;
254         int len, rsize, transform;
255
256         len = strlen(filename);
257         rsize = len + 1;
258         transform = (strstr(filename, "/") == NULL);
259                 {
260                 /* We will convert this to "%s.s?" or "lib%s.s?" */
261                 rsize += strlen(extension);/* The length of ".s?" */
262                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
263                         rsize += 3; /* The length of "lib" */
264                 }
265         translated = OPENSSL_malloc(rsize);
266         if(translated == NULL)
267                 {
268                 DSOerr(DSO_F_DL_NAME_CONVERTER,
269                                 DSO_R_NAME_TRANSLATION_FAILED); 
270                 return(NULL);   
271                 }
272         if(transform)
273                 {
274                 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
275                         sprintf(translated, "lib%s%s", filename, extension);
276                 else
277                         sprintf(translated, "%s%s", filename, extension);
278                 }
279         else
280                 sprintf(translated, "%s", filename);
281         return(translated);
282         }
283
284 #endif /* DSO_DL */