On VMS, the norm is still that symbols are uppercased, so for now it's better
[openssl.git] / crypto / dso / dso_lib.c
1 /* dso_lib.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 <openssl/crypto.h>
61 #include "cryptlib.h"
62 #include <openssl/dso.h>
63
64 static DSO_METHOD *default_DSO_meth = NULL;
65
66 DSO *DSO_new(void)
67         {
68         return(DSO_new_method(NULL));
69         }
70
71 void DSO_set_default_method(DSO_METHOD *meth)
72         {
73         default_DSO_meth = meth;
74         }
75
76 DSO_METHOD *DSO_get_default_method(void)
77         {
78         return(default_DSO_meth);
79         }
80
81 DSO_METHOD *DSO_get_method(DSO *dso)
82         {
83         return(dso->meth);
84         }
85
86 DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth)
87         {
88         DSO_METHOD *mtmp;
89         mtmp = dso->meth;
90         dso->meth = meth;
91         return(mtmp);
92         }
93
94 DSO *DSO_new_method(DSO_METHOD *meth)
95         {
96         DSO *ret;
97
98         if(default_DSO_meth == NULL)
99                 /* We default to DSO_METH_openssl() which in turn defaults
100                  * to stealing the "best available" method. Will fallback
101                  * to DSO_METH_null() in the worst case. */
102                 default_DSO_meth = DSO_METHOD_openssl();
103         ret = (DSO *)OPENSSL_malloc(sizeof(DSO));
104         if(ret == NULL)
105                 {
106                 DSOerr(DSO_F_DSO_NEW_METHOD,ERR_R_MALLOC_FAILURE);
107                 return(NULL);
108                 }
109         memset(ret, 0, sizeof(DSO));
110         ret->meth_data = sk_new_null();
111         if(ret->meth_data == NULL)
112                 {
113                 /* sk_new doesn't generate any errors so we do */
114                 DSOerr(DSO_F_DSO_NEW_METHOD,ERR_R_MALLOC_FAILURE);
115                 OPENSSL_free(ret);
116                 return(NULL);
117                 }
118         if(meth == NULL)
119                 ret->meth = default_DSO_meth;
120         else
121                 ret->meth = meth;
122         ret->references = 1;
123         if((ret->meth->init != NULL) && !ret->meth->init(ret))
124                 {
125                 OPENSSL_free(ret);
126                 ret=NULL;
127                 }
128         return(ret);
129         }
130
131 int DSO_free(DSO *dso)
132         {
133         int i;
134  
135         if(dso == NULL)
136                 {
137                 DSOerr(DSO_F_DSO_FREE,ERR_R_PASSED_NULL_PARAMETER);
138                 return(0);
139                 }
140  
141         i=CRYPTO_add(&dso->references,-1,CRYPTO_LOCK_DSO);
142 #ifdef REF_PRINT
143         REF_PRINT("DSO",dso);
144 #endif
145         if(i > 0) return(1);
146 #ifdef REF_CHECK
147         if(i < 0)
148                 {
149                 fprintf(stderr,"DSO_free, bad reference count\n");
150                 abort();
151                 }
152 #endif
153
154         if((dso->meth->dso_unload != NULL) && !dso->meth->dso_unload(dso))
155                 {
156                 DSOerr(DSO_F_DSO_FREE,DSO_R_UNLOAD_FAILED);
157                 return(0);
158                 }
159  
160         if((dso->meth->finish != NULL) && !dso->meth->finish(dso))
161                 {
162                 DSOerr(DSO_F_DSO_FREE,DSO_R_FINISH_FAILED);
163                 return(0);
164                 }
165         
166         sk_free(dso->meth_data);
167         if(dso->filename != NULL)
168                 OPENSSL_free(dso->filename);
169         if(dso->loaded_filename != NULL)
170                 OPENSSL_free(dso->loaded_filename);
171  
172         OPENSSL_free(dso);
173         return(1);
174         }
175
176 int DSO_flags(DSO *dso)
177         {
178         return((dso == NULL) ? 0 : dso->flags);
179         }
180
181
182 int DSO_up_ref(DSO *dso)
183         {
184         if (dso == NULL)
185                 {
186                 DSOerr(DSO_F_DSO_UP_REF,ERR_R_PASSED_NULL_PARAMETER);
187                 return(0);
188                 }
189
190         CRYPTO_add(&dso->references,1,CRYPTO_LOCK_DSO);
191         return(1);
192         }
193
194 DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags)
195         {
196         DSO *ret;
197         int allocated = 0;
198
199         if(dso == NULL)
200                 {
201                 ret = DSO_new_method(meth);
202                 if(ret == NULL)
203                         {
204                         DSOerr(DSO_F_DSO_LOAD,ERR_R_MALLOC_FAILURE);
205                         goto err;
206                         }
207                 allocated = 1;
208                 }
209         else
210                 ret = dso;
211         /* Don't load if we're currently already loaded */
212         if(ret->filename != NULL)
213                 {
214                 DSOerr(DSO_F_DSO_LOAD,DSO_R_DSO_ALREADY_LOADED);
215                 goto err;
216                 }
217         /* filename can only be NULL if we were passed a dso that already has
218          * one set. */
219         if(filename != NULL)
220                 if(!DSO_set_filename(ret, filename))
221                         {
222                         DSOerr(DSO_F_DSO_LOAD,DSO_R_SET_FILENAME_FAILED);
223                         goto err;
224                         }
225         filename = ret->filename;
226         if(filename == NULL)
227                 {
228                 DSOerr(DSO_F_DSO_LOAD,DSO_R_NO_FILENAME);
229                 goto err;
230                 }
231         /* Bleurgh ... have to check for negative return values for
232          * errors. <grimace> */
233         if(DSO_ctrl(ret, DSO_CTRL_SET_FLAGS, flags, NULL) < 0)
234                 {
235                 DSOerr(DSO_F_DSO_LOAD,DSO_R_CTRL_FAILED);
236                 goto err;
237                 }
238         if(ret->meth->dso_load == NULL)
239                 {
240                 DSOerr(DSO_F_DSO_LOAD,DSO_R_UNSUPPORTED);
241                 goto err;
242                 }
243         if(!ret->meth->dso_load(ret))
244                 {
245                 DSOerr(DSO_F_DSO_LOAD,DSO_R_LOAD_FAILED);
246                 goto err;
247                 }
248         /* Load succeeded */
249         return(ret);
250 err:
251         if(allocated)
252                 DSO_free(ret);
253         return(NULL);
254         }
255
256 void *DSO_bind_var(DSO *dso, const char *symname)
257         {
258         void *ret = NULL;
259
260         if((dso == NULL) || (symname == NULL))
261                 {
262                 DSOerr(DSO_F_DSO_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
263                 return(NULL);
264                 }
265         if(dso->meth->dso_bind_var == NULL)
266                 {
267                 DSOerr(DSO_F_DSO_BIND_VAR,DSO_R_UNSUPPORTED);
268                 return(NULL);
269                 }
270         if((ret = dso->meth->dso_bind_var(dso, symname)) == NULL)
271                 {
272                 DSOerr(DSO_F_DSO_BIND_VAR,DSO_R_SYM_FAILURE);
273                 return(NULL);
274                 }
275         /* Success */
276         return(ret);
277         }
278
279 DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname)
280         {
281         DSO_FUNC_TYPE ret = NULL;
282
283         if((dso == NULL) || (symname == NULL))
284                 {
285                 DSOerr(DSO_F_DSO_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
286                 return(NULL);
287                 }
288         if(dso->meth->dso_bind_func == NULL)
289                 {
290                 DSOerr(DSO_F_DSO_BIND_FUNC,DSO_R_UNSUPPORTED);
291                 return(NULL);
292                 }
293         if((ret = dso->meth->dso_bind_func(dso, symname)) == NULL)
294                 {
295                 DSOerr(DSO_F_DSO_BIND_FUNC,DSO_R_SYM_FAILURE);
296                 return(NULL);
297                 }
298         /* Success */
299         return(ret);
300         }
301
302 /* I don't really like these *_ctrl functions very much to be perfectly
303  * honest. For one thing, I think I have to return a negative value for
304  * any error because possible DSO_ctrl() commands may return values
305  * such as "size"s that can legitimately be zero (making the standard
306  * "if(DSO_cmd(...))" form that works almost everywhere else fail at
307  * odd times. I'd prefer "output" values to be passed by reference and
308  * the return value as success/failure like usual ... but we conform
309  * when we must... :-) */
310 long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg)
311         {
312         if(dso == NULL)
313                 {
314                 DSOerr(DSO_F_DSO_CTRL,ERR_R_PASSED_NULL_PARAMETER);
315                 return(-1);
316                 }
317         /* We should intercept certain generic commands and only pass control
318          * to the method-specific ctrl() function if it's something we don't
319          * handle. */
320         switch(cmd)
321                 {
322         case DSO_CTRL_GET_FLAGS:
323                 return dso->flags;
324         case DSO_CTRL_SET_FLAGS:
325                 dso->flags = (int)larg;
326                 return(0);
327         case DSO_CTRL_OR_FLAGS:
328                 dso->flags |= (int)larg;
329                 return(0);
330         default:
331                 break;
332                 }
333         if((dso->meth == NULL) || (dso->meth->dso_ctrl == NULL))
334                 {
335                 DSOerr(DSO_F_DSO_CTRL,DSO_R_UNSUPPORTED);
336                 return(-1);
337                 }
338         return(dso->meth->dso_ctrl(dso,cmd,larg,parg));
339         }
340
341 int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb,
342                         DSO_NAME_CONVERTER_FUNC *oldcb)
343         {
344         if(dso == NULL)
345                 {
346                 DSOerr(DSO_F_DSO_SET_NAME_CONVERTER,
347                                 ERR_R_PASSED_NULL_PARAMETER);
348                 return(0);
349                 }
350         if(oldcb)
351                 *oldcb = dso->name_converter;
352         dso->name_converter = cb;
353         return(1);
354         }
355
356 const char *DSO_get_filename(DSO *dso)
357         {
358         if(dso == NULL)
359                 {
360                 DSOerr(DSO_F_DSO_GET_FILENAME,ERR_R_PASSED_NULL_PARAMETER);
361                 return(NULL);
362                 }
363         return(dso->filename);
364         }
365
366 int DSO_set_filename(DSO *dso, const char *filename)
367         {
368         char *copied;
369
370         if((dso == NULL) || (filename == NULL))
371                 {
372                 DSOerr(DSO_F_DSO_SET_FILENAME,ERR_R_PASSED_NULL_PARAMETER);
373                 return(0);
374                 }
375         if(dso->loaded_filename)
376                 {
377                 DSOerr(DSO_F_DSO_SET_FILENAME,DSO_R_DSO_ALREADY_LOADED);
378                 return(0);
379                 }
380         /* We'll duplicate filename */
381         copied = OPENSSL_malloc(strlen(filename) + 1);
382         if(copied == NULL)
383                 {
384                 DSOerr(DSO_F_DSO_SET_FILENAME,ERR_R_MALLOC_FAILURE);
385                 return(0);
386                 }
387         strcpy(copied, filename);
388         if(dso->filename)
389                 OPENSSL_free(dso->filename);
390         dso->filename = copied;
391         return(1);
392         }
393
394 char *DSO_convert_filename(DSO *dso, const char *filename)
395         {
396         char *result = NULL;
397
398         if(dso == NULL)
399                 {
400                 DSOerr(DSO_F_DSO_CONVERT_FILENAME,ERR_R_PASSED_NULL_PARAMETER);
401                 return(NULL);
402                 }
403         if(filename == NULL)
404                 filename = dso->filename;
405         if(filename == NULL)
406                 {
407                 DSOerr(DSO_F_DSO_CONVERT_FILENAME,DSO_R_NO_FILENAME);
408                 return(NULL);
409                 }
410         if((dso->flags & DSO_FLAG_NO_NAME_TRANSLATION) == 0)
411                 {
412                 if(dso->name_converter != NULL)
413                         result = dso->name_converter(dso, filename);
414                 else if(dso->meth->dso_name_converter != NULL)
415                         result = dso->meth->dso_name_converter(dso, filename);
416                 }
417         if(result == NULL)
418                 {
419                 result = OPENSSL_malloc(strlen(filename) + 1);
420                 if(result == NULL)
421                         {
422                         DSOerr(DSO_F_DSO_CONVERT_FILENAME,
423                                         ERR_R_MALLOC_FAILURE);
424                         return(NULL);
425                         }
426                 strcpy(result, filename);
427                 }
428         return(result);
429         }
430
431 const char *DSO_get_loaded_filename(DSO *dso)
432         {
433         if(dso == NULL)
434                 {
435                 DSOerr(DSO_F_DSO_GET_LOADED_FILENAME,
436                                 ERR_R_PASSED_NULL_PARAMETER);
437                 return(NULL);
438                 }
439         return(dso->loaded_filename);
440         }