5b8dc9198d7981bd3814ab6729cfec90af226b13
[openssl.git] / crypto / dso / dso_vms.c
1 /*
2  * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
3  * 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 "dso_locl.h"
60
61 #ifdef OPENSSL_SYS_VMS
62
63 # pragma message disable DOLLARID
64 # include <errno.h>
65 # include <rms.h>
66 # include <lib$routines.h>
67 # include <stsdef.h>
68 # include <descrip.h>
69 # include <starlet.h>
70 # include "../vms_rms.h"
71
72 /* Some compiler options may mask the declaration of "_malloc32". */
73 # if __INITIAL_POINTER_SIZE && defined _ANSI_C_SOURCE
74 #  if __INITIAL_POINTER_SIZE == 64
75 #   pragma pointer_size save
76 #   pragma pointer_size 32
77 void *_malloc32(__size_t);
78 #   pragma pointer_size restore
79 #  endif                        /* __INITIAL_POINTER_SIZE == 64 */
80 # endif                         /* __INITIAL_POINTER_SIZE && defined
81                                  * _ANSI_C_SOURCE */
82
83 # pragma message disable DOLLARID
84
85 static int vms_load(DSO *dso);
86 static int vms_unload(DSO *dso);
87 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname);
88 static char *vms_name_converter(DSO *dso, const char *filename);
89 static char *vms_merger(DSO *dso, const char *filespec1,
90                         const char *filespec2);
91
92 static DSO_METHOD dso_meth_vms = {
93     "OpenSSL 'VMS' shared library method",
94     vms_load,
95     NULL,                       /* unload */
96     vms_bind_func,
97     NULL,                       /* ctrl */
98     vms_name_converter,
99     vms_merger,
100     NULL,                       /* init */
101     NULL                        /* finish */
102 };
103
104 /*
105  * On VMS, the only "handle" is the file name.  LIB$FIND_IMAGE_SYMBOL depends
106  * on the reference to the file name being the same for all calls regarding
107  * one shared image, so we'll just store it in an instance of the following
108  * structure and put a pointer to that instance in the meth_data stack.
109  */
110 typedef struct dso_internal_st {
111     /*
112      * This should contain the name only, no directory, no extension, nothing
113      * but a name.
114      */
115     struct dsc$descriptor_s filename_dsc;
116     char filename[NAMX_MAXRSS + 1];
117     /*
118      * This contains whatever is not in filename, if needed. Normally not
119      * defined.
120      */
121     struct dsc$descriptor_s imagename_dsc;
122     char imagename[NAMX_MAXRSS + 1];
123 } DSO_VMS_INTERNAL;
124
125 DSO_METHOD *DSO_METHOD_openssl(void)
126 {
127     return &dso_meth_vms;
128 }
129
130 static int vms_load(DSO *dso)
131 {
132     void *ptr = NULL;
133     /* See applicable comments in dso_dl.c */
134     char *filename = DSO_convert_filename(dso, NULL);
135
136 /* Ensure 32-bit pointer for "p", and appropriate malloc() function. */
137 # if __INITIAL_POINTER_SIZE == 64
138 #  define DSO_MALLOC _malloc32
139 #  pragma pointer_size save
140 #  pragma pointer_size 32
141 # else                          /* __INITIAL_POINTER_SIZE == 64 */
142 #  define DSO_MALLOC OPENSSL_malloc
143 # endif                         /* __INITIAL_POINTER_SIZE == 64 [else] */
144
145     DSO_VMS_INTERNAL *p = NULL;
146
147 # if __INITIAL_POINTER_SIZE == 64
148 #  pragma pointer_size restore
149 # endif                         /* __INITIAL_POINTER_SIZE == 64 */
150
151     const char *sp1, *sp2;      /* Search result */
152     const char *ext = NULL;     /* possible extension to add */
153
154     if (filename == NULL) {
155         DSOerr(DSO_F_VMS_LOAD, DSO_R_NO_FILENAME);
156         goto err;
157     }
158
159     /*-
160      * A file specification may look like this:
161      *
162      *      node::dev:[dir-spec]name.type;ver
163      *
164      * or (for compatibility with TOPS-20):
165      *
166      *      node::dev:<dir-spec>name.type;ver
167      *
168      * and the dir-spec uses '.' as separator.  Also, a dir-spec
169      * may consist of several parts, with mixed use of [] and <>:
170      *
171      *      [dir1.]<dir2>
172      *
173      * We need to split the file specification into the name and
174      * the rest (both before and after the name itself).
175      */
176     /*
177      * Start with trying to find the end of a dir-spec, and save the position
178      * of the byte after in sp1
179      */
180     sp1 = strrchr(filename, ']');
181     sp2 = strrchr(filename, '>');
182     if (sp1 == NULL)
183         sp1 = sp2;
184     if (sp2 != NULL && sp2 > sp1)
185         sp1 = sp2;
186     if (sp1 == NULL)
187         sp1 = strrchr(filename, ':');
188     if (sp1 == NULL)
189         sp1 = filename;
190     else
191         sp1++;                  /* The byte after the found character */
192     /* Now, let's see if there's a type, and save the position in sp2 */
193     sp2 = strchr(sp1, '.');
194     /*
195      * If there is a period and the next character is a semi-colon,
196      * we need to add an extension
197      */
198     if (sp2 != NULL && sp2[1] == ';')
199         ext = ".EXE";
200     /*
201      * If we found it, that's where we'll cut.  Otherwise, look for a version
202      * number and save the position in sp2
203      */
204     if (sp2 == NULL) {
205         sp2 = strchr(sp1, ';');
206         ext = ".EXE";
207     }
208     /*
209      * If there was still nothing to find, set sp2 to point at the end of the
210      * string
211      */
212     if (sp2 == NULL)
213         sp2 = sp1 + strlen(sp1);
214
215     /* Check that we won't get buffer overflows */
216     if (sp2 - sp1 > FILENAME_MAX
217         || (sp1 - filename) + strlen(sp2) > FILENAME_MAX) {
218         DSOerr(DSO_F_VMS_LOAD, DSO_R_FILENAME_TOO_BIG);
219         goto err;
220     }
221
222     p = DSO_MALLOC(sizeof(*p));
223     if (p == NULL) {
224         DSOerr(DSO_F_VMS_LOAD, ERR_R_MALLOC_FAILURE);
225         goto err;
226     }
227
228     strncpy(p->filename, sp1, sp2 - sp1);
229     p->filename[sp2 - sp1] = '\0';
230
231     strncpy(p->imagename, filename, sp1 - filename);
232     p->imagename[sp1 - filename] = '\0';
233     if (ext) {
234         strcat(p->imagename, ext);
235         if (*sp2 == '.')
236             sp2++;
237     }
238     strcat(p->imagename, sp2);
239
240     p->filename_dsc.dsc$w_length = strlen(p->filename);
241     p->filename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
242     p->filename_dsc.dsc$b_class = DSC$K_CLASS_S;
243     p->filename_dsc.dsc$a_pointer = p->filename;
244     p->imagename_dsc.dsc$w_length = strlen(p->imagename);
245     p->imagename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
246     p->imagename_dsc.dsc$b_class = DSC$K_CLASS_S;
247     p->imagename_dsc.dsc$a_pointer = p->imagename;
248
249     if (!sk_void_push(dso->meth_data, (char *)p)) {
250         DSOerr(DSO_F_VMS_LOAD, DSO_R_STACK_ERROR);
251         goto err;
252     }
253
254     /* Success (for now, we lie.  We actually do not know...) */
255     dso->loaded_filename = filename;
256     return (1);
257  err:
258     /* Cleanup! */
259     OPENSSL_free(p);
260     OPENSSL_free(filename);
261     return (0);
262 }
263
264 /*
265  * Note that this doesn't actually unload the shared image, as there is no
266  * such thing in VMS.  Next time it get loaded again, a new copy will
267  * actually be loaded.
268  */
269 static int vms_unload(DSO *dso)
270 {
271     DSO_VMS_INTERNAL *p;
272     if (dso == NULL) {
273         DSOerr(DSO_F_VMS_UNLOAD, ERR_R_PASSED_NULL_PARAMETER);
274         return (0);
275     }
276     if (sk_void_num(dso->meth_data) < 1)
277         return (1);
278     p = (DSO_VMS_INTERNAL *)sk_void_pop(dso->meth_data);
279     if (p == NULL) {
280         DSOerr(DSO_F_VMS_UNLOAD, DSO_R_NULL_HANDLE);
281         return (0);
282     }
283     /* Cleanup */
284     OPENSSL_free(p);
285     return (1);
286 }
287
288 /*
289  * We must do this in a separate function because of the way the exception
290  * handler works (it makes this function return
291  */
292 static int do_find_symbol(DSO_VMS_INTERNAL *ptr,
293                           struct dsc$descriptor_s *symname_dsc, void **sym,
294                           unsigned long flags)
295 {
296     /*
297      * Make sure that signals are caught and returned instead of aborting the
298      * program.  The exception handler gets unestablished automatically on
299      * return from this function.
300      */
301     lib$establish(lib$sig_to_ret);
302
303     if (ptr->imagename_dsc.dsc$w_length)
304         return lib$find_image_symbol(&ptr->filename_dsc,
305                                      symname_dsc, sym,
306                                      &ptr->imagename_dsc, flags);
307     else
308         return lib$find_image_symbol(&ptr->filename_dsc,
309                                      symname_dsc, sym, 0, flags);
310 }
311
312 void vms_bind_sym(DSO *dso, const char *symname, void **sym)
313 {
314     DSO_VMS_INTERNAL *ptr;
315     int status;
316 # if 0
317     int flags = (1 << 4);       /* LIB$M_FIS_MIXEDCASE, but this symbol isn't
318                                  * defined in VMS older than 7.0 or so */
319 # else
320     int flags = 0;
321 # endif
322     struct dsc$descriptor_s symname_dsc;
323
324 /* Arrange 32-bit pointer to (copied) string storage, if needed. */
325 # if __INITIAL_POINTER_SIZE == 64
326 #  define SYMNAME symname_32p
327 #  pragma pointer_size save
328 #  pragma pointer_size 32
329     char *symname_32p;
330 #  pragma pointer_size restore
331     char symname_32[NAMX_MAXRSS + 1];
332 # else                          /* __INITIAL_POINTER_SIZE == 64 */
333 #  define SYMNAME ((char *) symname)
334 # endif                         /* __INITIAL_POINTER_SIZE == 64 [else] */
335
336     *sym = NULL;
337
338     if ((dso == NULL) || (symname == NULL)) {
339         DSOerr(DSO_F_VMS_BIND_SYM, ERR_R_PASSED_NULL_PARAMETER);
340         return;
341     }
342 # if __INITIAL_POINTER_SIZE == 64
343     /* Copy the symbol name to storage with a 32-bit pointer. */
344     symname_32p = symname_32;
345     strcpy(symname_32p, symname);
346 # endif                         /* __INITIAL_POINTER_SIZE == 64 [else] */
347
348     symname_dsc.dsc$w_length = strlen(SYMNAME);
349     symname_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
350     symname_dsc.dsc$b_class = DSC$K_CLASS_S;
351     symname_dsc.dsc$a_pointer = SYMNAME;
352
353     if (sk_void_num(dso->meth_data) < 1) {
354         DSOerr(DSO_F_VMS_BIND_SYM, DSO_R_STACK_ERROR);
355         return;
356     }
357     ptr = (DSO_VMS_INTERNAL *)sk_void_value(dso->meth_data,
358                                             sk_void_num(dso->meth_data) - 1);
359     if (ptr == NULL) {
360         DSOerr(DSO_F_VMS_BIND_SYM, DSO_R_NULL_HANDLE);
361         return;
362     }
363
364     if (dso->flags & DSO_FLAG_UPCASE_SYMBOL)
365         flags = 0;
366
367     status = do_find_symbol(ptr, &symname_dsc, sym, flags);
368
369     if (!$VMS_STATUS_SUCCESS(status)) {
370         unsigned short length;
371         char errstring[257];
372         struct dsc$descriptor_s errstring_dsc;
373
374         errstring_dsc.dsc$w_length = sizeof(errstring);
375         errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
376         errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
377         errstring_dsc.dsc$a_pointer = errstring;
378
379         *sym = NULL;
380
381         status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
382
383         if (!$VMS_STATUS_SUCCESS(status))
384             lib$signal(status); /* This is really bad.  Abort! */
385         else {
386             errstring[length] = '\0';
387
388             DSOerr(DSO_F_VMS_BIND_SYM, DSO_R_SYM_FAILURE);
389             if (ptr->imagename_dsc.dsc$w_length)
390                 ERR_add_error_data(9,
391                                    "Symbol ", symname,
392                                    " in ", ptr->filename,
393                                    " (", ptr->imagename, ")",
394                                    ": ", errstring);
395             else
396                 ERR_add_error_data(6,
397                                    "Symbol ", symname,
398                                    " in ", ptr->filename, ": ", errstring);
399         }
400         return;
401     }
402     return;
403 }
404
405 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname)
406 {
407     DSO_FUNC_TYPE sym = 0;
408     vms_bind_sym(dso, symname, (void **)&sym);
409     return sym;
410 }
411
412 static char *vms_merger(DSO *dso, const char *filespec1,
413                         const char *filespec2)
414 {
415     int status;
416     int filespec1len, filespec2len;
417     struct FAB fab;
418     struct NAMX_STRUCT nam;
419     char esa[NAMX_MAXRSS + 1];
420     char *merged;
421
422 /* Arrange 32-bit pointer to (copied) string storage, if needed. */
423 # if __INITIAL_POINTER_SIZE == 64
424 #  define FILESPEC1 filespec1_32p;
425 #  define FILESPEC2 filespec2_32p;
426 #  pragma pointer_size save
427 #  pragma pointer_size 32
428     char *filespec1_32p;
429     char *filespec2_32p;
430 #  pragma pointer_size restore
431     char filespec1_32[NAMX_MAXRSS + 1];
432     char filespec2_32[NAMX_MAXRSS + 1];
433 # else                          /* __INITIAL_POINTER_SIZE == 64 */
434 #  define FILESPEC1 ((char *) filespec1)
435 #  define FILESPEC2 ((char *) filespec2)
436 # endif                         /* __INITIAL_POINTER_SIZE == 64 [else] */
437
438     if (!filespec1)
439         filespec1 = "";
440     if (!filespec2)
441         filespec2 = "";
442     filespec1len = strlen(filespec1);
443     filespec2len = strlen(filespec2);
444
445 # if __INITIAL_POINTER_SIZE == 64
446     /* Copy the file names to storage with a 32-bit pointer. */
447     filespec1_32p = filespec1_32;
448     filespec2_32p = filespec2_32;
449     strcpy(filespec1_32p, filespec1);
450     strcpy(filespec2_32p, filespec2);
451 # endif                         /* __INITIAL_POINTER_SIZE == 64 [else] */
452
453     fab = cc$rms_fab;
454     nam = CC_RMS_NAMX;
455
456     FAB_OR_NAML(fab, nam).FAB_OR_NAML_FNA = FILESPEC1;
457     FAB_OR_NAML(fab, nam).FAB_OR_NAML_FNS = filespec1len;
458     FAB_OR_NAML(fab, nam).FAB_OR_NAML_DNA = FILESPEC2;
459     FAB_OR_NAML(fab, nam).FAB_OR_NAML_DNS = filespec2len;
460     NAMX_DNA_FNA_SET(fab)
461
462         nam.NAMX_ESA = esa;
463     nam.NAMX_ESS = NAMX_MAXRSS;
464     nam.NAMX_NOP = NAM$M_SYNCHK | NAM$M_PWD;
465     SET_NAMX_NO_SHORT_UPCASE(nam);
466
467     fab.FAB_NAMX = &nam;
468
469     status = sys$parse(&fab, 0, 0);
470
471     if (!$VMS_STATUS_SUCCESS(status)) {
472         unsigned short length;
473         char errstring[257];
474         struct dsc$descriptor_s errstring_dsc;
475
476         errstring_dsc.dsc$w_length = sizeof(errstring);
477         errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
478         errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
479         errstring_dsc.dsc$a_pointer = errstring;
480
481         status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
482
483         if (!$VMS_STATUS_SUCCESS(status))
484             lib$signal(status); /* This is really bad.  Abort! */
485         else {
486             errstring[length] = '\0';
487
488             DSOerr(DSO_F_VMS_MERGER, DSO_R_FAILURE);
489             ERR_add_error_data(7,
490                                "filespec \"", filespec1, "\", ",
491                                "defaults \"", filespec2, "\": ", errstring);
492         }
493         return (NULL);
494     }
495
496     merged = OPENSSL_malloc(nam.NAMX_ESL + 1);
497     if (merged == NULL)
498         goto malloc_err;
499     strncpy(merged, nam.NAMX_ESA, nam.NAMX_ESL);
500     merged[nam.NAMX_ESL] = '\0';
501     return (merged);
502  malloc_err:
503     DSOerr(DSO_F_VMS_MERGER, ERR_R_MALLOC_FAILURE);
504 }
505
506 static char *vms_name_converter(DSO *dso, const char *filename)
507 {
508     int len = strlen(filename);
509     char *not_translated = OPENSSL_malloc(len + 1);
510     if (not_translated != NULL)
511         strcpy(not_translated, filename);
512     return (not_translated);
513 }
514
515 #endif                          /* OPENSSL_SYS_VMS */