Currently the DSO_METHOD interface has one entry point to bind all
[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 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 #endif
86 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
87
88 static DSO_METHOD dso_meth_dlfcn = {
89         "OpenSSL 'dlfcn' shared library method",
90         dlfcn_load,
91         dlfcn_unload,
92         dlfcn_bind_var,
93         dlfcn_bind_func,
94 /* For now, "unbind" doesn't exist */
95 #if 0
96         NULL, /* unbind_var */
97         NULL, /* unbind_func */
98 #endif
99         dlfcn_ctrl,
100         NULL, /* init */
101         NULL  /* finish */
102         };
103
104 DSO_METHOD *DSO_METHOD_dlfcn(void)
105         {
106         return(&dso_meth_dlfcn);
107         }
108
109 /* For this DSO_METHOD, our meth_data STACK will contain;
110  * (i) the handle (void*) returned from dlopen().
111  */
112
113 static int dlfcn_load(DSO *dso, const char *filename)
114         {
115         void *ptr;
116         char translated[DSO_MAX_TRANSLATED_SIZE];
117         int len;
118
119         /* NB: This is a hideous hack, but I'm not yet sure what
120          * to replace it with. This attempts to convert any filename,
121          * that looks like it has no path information, into a
122          * translated form, e. "blah" -> "libblah.so" */
123         len = strlen(filename);
124         if((dso->flags & DSO_FLAG_NAME_TRANSLATION) &&
125                         (len + 6 < DSO_MAX_TRANSLATED_SIZE) &&
126                         (strstr(filename, "/") == NULL))
127                 {
128                 sprintf(translated, "lib%s.so", filename);
129                 ptr = dlopen(translated, RTLD_NOW);
130                 }
131         else
132                 {
133                 ptr = dlopen(filename, RTLD_NOW);
134                 }
135         if(ptr == NULL)
136                 {
137                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
138                 return(0);
139                 }
140         if(!sk_push(dso->meth_data, (char *)ptr))
141                 {
142                 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
143                 dlclose(ptr);
144                 return(0);
145                 }
146         return(1);
147         }
148
149 static int dlfcn_unload(DSO *dso)
150         {
151         void *ptr;
152         if(dso == NULL)
153                 {
154                 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
155                 return(0);
156                 }
157         if(sk_num(dso->meth_data) < 1)
158                 return(1);
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 void *dlfcn_bind_var(DSO *dso, const char *symname)
174         {
175         void *ptr, *sym;
176
177         if((dso == NULL) || (symname == NULL))
178                 {
179                 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
180                 return(NULL);
181                 }
182         if(sk_num(dso->meth_data) < 1)
183                 {
184                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
185                 return(NULL);
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_VAR,DSO_R_NULL_HANDLE);
191                 return(NULL);
192                 }
193         sym = dlsym(ptr, symname);
194         if(sym == NULL)
195                 {
196                 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
197                 return(NULL);
198                 }
199         return(sym);
200         }
201
202 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
203         {
204         void *ptr;
205         DSO_FUNC_TYPE sym;
206
207         if((dso == NULL) || (symname == NULL))
208                 {
209                 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
210                 return(NULL);
211                 }
212         if(sk_num(dso->meth_data) < 1)
213                 {
214                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
215                 return(NULL);
216                 }
217         ptr = (void *)sk_value(dso->meth_data, sk_num(dso->meth_data) - 1);
218         if(ptr == NULL)
219                 {
220                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
221                 return(NULL);
222                 }
223         sym = (DSO_FUNC_TYPE)dlsym(ptr, symname);
224         if(sym == NULL)
225                 {
226                 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
227                 return(NULL);
228                 }
229         return(sym);
230         }
231
232 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg)
233         {
234         if(dso == NULL)
235                 {
236                 DSOerr(DSO_F_DLFCN_CTRL,ERR_R_PASSED_NULL_PARAMETER);
237                 return(-1);
238                 }
239         switch(cmd)
240                 {
241         case DSO_CTRL_GET_FLAGS:
242                 return dso->flags;
243         case DSO_CTRL_SET_FLAGS:
244                 dso->flags = (int)larg;
245                 return(0);
246         case DSO_CTRL_OR_FLAGS:
247                 dso->flags |= (int)larg;
248                 return(0);
249         default:
250                 break;
251                 }
252         DSOerr(DSO_F_DLFCN_CTRL,DSO_R_UNKNOWN_COMMAND);
253         return(-1);
254         }
255
256 #endif /* DSO_DLFCN */