93c2a29606b628cbffdbe071df984ea56909f955
[openssl.git] / crypto / dso / dso_vms.c
1 /* dso_vms.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 <string.h>
61 #include <errno.h>
62 #include <lib$routines.h>
63 #include <libfisdef.h>
64 #include <stsdef.h>
65 #include <descrip.h>
66 #include <starlet.h>
67 #include "cryptlib.h"
68 #include <openssl/dso.h>
69
70 #ifndef VMS
71 DSO_METHOD *DSO_METHOD_vms(void)
72         {
73         return NULL;
74         }
75 #else
76 #pragma message disable DOLLARID
77
78 static int vms_load(DSO *dso, const char *filename);
79 static int vms_unload(DSO *dso);
80 static void *vms_bind_var(DSO *dso, const char *symname);
81 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname);
82 #if 0
83 static int vms_unbind_var(DSO *dso, char *symname, void *symptr);
84 static int vms_unbind_func(DSO *dso, char *symname, DSO_FUNC_TYPE symptr);
85 static int vms_init(DSO *dso);
86 static int vms_finish(DSO *dso);
87 #endif
88 static long vms_ctrl(DSO *dso, int cmd, long larg, void *parg);
89
90 static DSO_METHOD dso_meth_vms = {
91         "OpenSSL 'VMS' shared library method",
92         vms_load,
93         NULL, /* unload */
94         vms_bind_var,
95         vms_bind_func,
96 /* For now, "unbind" doesn't exist */
97 #if 0
98         NULL, /* unbind_var */
99         NULL, /* unbind_func */
100 #endif
101         vms_ctrl,
102         NULL, /* init */
103         NULL  /* finish */
104         };
105
106 /* On VMS, the only "handle" is the file name.  LIB$FIND_IMAGE_SYMBOL depends
107  * on the reference to the file name being the same for all calls regarding
108  * one shared image, so we'll just store it in an instance of the following
109  * structure and put a pointer to that instance in the meth_data stack.
110  */
111 typedef struct dso_internal_st
112         {
113         /* This should contain the name only, no directory,
114          * no extension, nothing but a name. */
115         struct dsc$descriptor_s filename_dsc;
116         char filename[FILENAME_MAX+1];
117         /* This contains whatever is not in filename, if needed.
118          * Normally not defined. */
119         struct dsc$descriptor_s imagename_dsc;
120         char imagename[FILENAME_MAX+1];
121         } DSO_VMS_INTERNAL;
122
123
124 DSO_METHOD *DSO_METHOD_vms(void)
125         {
126         return(&dso_meth_vms);
127         }
128
129 static int vms_load(DSO *dso, const char *filename)
130         {
131         DSO_VMS_INTERNAL *p;
132         const char *sp1, *sp2;  /* Search result */
133
134         /* A file specification may look like this:
135          *
136          *      node::dev:[dir-spec]name.type;ver
137          *
138          * or (for compatibility with TOPS-20):
139          *
140          *      node::dev:<dir-spec>name.type;ver
141          *
142          * and the dir-spec uses '.' as separator.  Also, a dir-spec
143          * may consist of several parts, with mixed use of [] and <>:
144          *
145          *      [dir1.]<dir2>
146          *
147          * We need to split the file specification into the name and
148          * the rest (both before and after the name itself).
149          */
150         /* Start with trying to find the end of a dir-spec, and save the
151            position of the byte after in sp1 */
152         sp1 = strrchr(filename, ']');
153         sp2 = strrchr(filename, '>');
154         if (sp1 == NULL) sp1 = sp2;
155         if (sp2 != NULL && sp2 > sp1) sp1 = sp2;
156         if (sp1 == NULL) sp1 = strrchr(filename, ':');
157         if (sp1 == NULL)
158                 sp1 = filename;
159         else
160                 sp1++;          /* The byte after the found character */
161         /* Now, let's see if there's a type, and save the position in sp2 */
162         sp2 = strchr(sp1, '.');
163         /* If we found it, that's where we'll cut.  Otherwise, look for a
164            version number and save the position in sp2 */
165         if (sp2 == NULL) sp2 = strchr(sp1, ';');
166         /* If there was still nothing to find, set sp2 to point at the end of
167            the string */
168         if (sp2 == NULL) sp2 = sp1 + strlen(sp1);
169
170         /* Check that we won't get buffer overflows */
171         if (sp2 - sp1 > FILENAME_MAX
172                 || (sp1 - filename) + strlen(sp2) > FILENAME_MAX)
173                 {
174                 DSOerr(DSO_F_VMS_LOAD,DSO_R_FILENAME_TOO_BIG);
175                 return(0);
176                 }
177
178         p = (DSO_VMS_INTERNAL *)OPENSSL_malloc(sizeof(DSO_VMS_INTERNAL));
179         if(p == NULL)
180                 {
181                 DSOerr(DSO_F_VMS_LOAD,ERR_R_MALLOC_FAILURE);
182                 return(0);
183                 }
184
185         strncpy(p->filename, sp1, sp2-sp1);
186         p->filename[sp2-sp1] = '\0';
187
188         strncpy(p->imagename, filename, sp1-filename);
189         p->imagename[sp1-filename] = '\0';
190         strcat(p->imagename, sp2);
191
192         p->filename_dsc.dsc$w_length = strlen(p->filename);
193         p->filename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
194         p->filename_dsc.dsc$b_class = DSC$K_CLASS_S;
195         p->filename_dsc.dsc$a_pointer = p->filename;
196         p->imagename_dsc.dsc$w_length = strlen(p->imagename);
197         p->imagename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
198         p->imagename_dsc.dsc$b_class = DSC$K_CLASS_S;
199         p->imagename_dsc.dsc$a_pointer = p->imagename;
200
201         if(!sk_push(dso->meth_data, (char *)p))
202                 {
203                 DSOerr(DSO_F_VMS_LOAD,DSO_R_STACK_ERROR);
204                 OPENSSL_free(p);
205                 return(0);
206                 }
207         return(1);
208         }
209
210 /* Note that this doesn't actually unload the shared image, as there is no
211  * such thing in VMS.  Next time it get loaded again, a new copy will
212  * actually be loaded.
213  */
214 static int vms_unload(DSO *dso)
215         {
216         DSO_VMS_INTERNAL *p;
217         if(dso == NULL)
218                 {
219                 DSOerr(DSO_F_VMS_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
220                 return(0);
221                 }
222         if(sk_num(dso->meth_data) < 1)
223                 return(1);
224         p = (DSO_VMS_INTERNAL *)sk_pop(dso->meth_data);
225         if(p == NULL)
226                 {
227                 DSOerr(DSO_F_VMS_UNLOAD,DSO_R_NULL_HANDLE);
228                 return(0);
229                 }
230         /* Cleanup */
231         OPENSSL_free(p);
232         return(1);
233         }
234
235 /* We must do this in a separate function because of the way the exception
236    handler works (it makes this function return */
237 static int do_find_symbol(DSO_VMS_INTERNAL *ptr,
238         struct dsc$descriptor_s *symname_dsc, void **sym,
239         unsigned long flags)
240         {
241         /* Make sure that signals are caught and returned instead of
242            aborting the program.  The exception handler gets unestablished
243            automatically on return from this function.  */
244         lib$establish(lib$sig_to_ret);
245
246         if(ptr->imagename_dsc.dsc$w_length)
247                 return lib$find_image_symbol(&ptr->filename_dsc,
248                         symname_dsc, sym,
249                         &ptr->imagename_dsc, flags);
250         else
251                 return lib$find_image_symbol(&ptr->filename_dsc,
252                         symname_dsc, sym,
253                         0, flags);
254         }
255
256 static void *vms_bind_sym(DSO *dso, const char *symname)
257         {
258         DSO_VMS_INTERNAL *ptr;
259         void *sym = 0;
260         int status;
261         int flags = LIB$M_FIS_MIXEDCASE;
262         struct dsc$descriptor_s symname_dsc;
263
264         symname_dsc.dsc$w_length = strlen(symname);
265         symname_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
266         symname_dsc.dsc$b_class = DSC$K_CLASS_S;
267         symname_dsc.dsc$a_pointer = (char *)symname; /* The cast is needed */
268
269         if((dso == NULL) || (symname == NULL))
270                 {
271                 DSOerr(DSO_F_VMS_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
272                 return(NULL);
273                 }
274         if(sk_num(dso->meth_data) < 1)
275                 {
276                 DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_STACK_ERROR);
277                 return(NULL);
278                 }
279         ptr = (DSO_VMS_INTERNAL *)sk_value(dso->meth_data,
280                 sk_num(dso->meth_data) - 1);
281         if(ptr == NULL)
282                 {
283                 DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_NULL_HANDLE);
284                 return(NULL);
285                 }
286
287         if(dso->flags & DSO_FLAG_UPCASE_SYMBOL) flags = 0;
288
289         status = do_find_symbol(ptr, &symname_dsc, &sym, flags);
290
291         if(!$VMS_STATUS_SUCCESS(status))
292                 {
293                 unsigned short length;
294                 char errstring[257];
295                 struct dsc$descriptor_s errstring_dsc;
296
297                 errstring_dsc.dsc$w_length = sizeof(errstring);
298                 errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
299                 errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
300                 errstring_dsc.dsc$a_pointer = errstring;
301
302                 status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
303
304                 if (!$VMS_STATUS_SUCCESS(status))
305                         lib$signal(status); /* This is really bad.  Abort!  */
306                 else
307                         {
308                         errstring[length] = '\0';
309
310                         DSOerr(DSO_F_VMS_BIND_VAR,DSO_R_SYM_FAILURE);
311                         if (ptr->imagename_dsc.dsc$w_length)
312                                 ERR_add_error_data(9,
313                                         "Symbol ", symname,
314                                         " in ", ptr->filename,
315                                         " (", ptr->imagename, ")",
316                                         ": ", errstring);
317                         else
318                                 ERR_add_error_data(6,
319                                         "Symbol ", symname,
320                                         " in ", ptr->filename,
321                                         ": ", errstring);
322                         }
323                 return(NULL);
324                 }
325         return(sym);
326         }
327
328 static void *vms_bind_var(DSO *dso, const char *symname)
329         {
330         return vms_bind_sym(dso, symname);
331         }
332
333 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname)
334         {
335         return (DSO_FUNC_TYPE)vms_bind_sym(dso, symname);
336         }
337
338 static long vms_ctrl(DSO *dso, int cmd, long larg, void *parg)
339         {
340         if(dso == NULL)
341                 {
342                 DSOerr(DSO_F_VMS_CTRL,ERR_R_PASSED_NULL_PARAMETER);
343                 return(-1);
344                 }
345         switch(cmd)
346                 {
347         case DSO_CTRL_GET_FLAGS:
348                 return dso->flags;
349         case DSO_CTRL_SET_FLAGS:
350                 dso->flags = (int)larg;
351                 return(0);
352         case DSO_CTRL_OR_FLAGS:
353                 dso->flags |= (int)larg;
354                 return(0);
355         default:
356                 break;
357                 }
358         DSOerr(DSO_F_VMS_CTRL,DSO_R_UNKNOWN_COMMAND);
359         return(-1);
360         }
361
362 #endif /* VMS */