2 * Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include "dso_local.h"
12 #ifdef OPENSSL_SYS_VMS
14 # pragma message disable DOLLARID
17 # include <lib$routines.h>
18 # include <libfisdef.h>
22 # include "../vms_rms.h"
24 /* Some compiler options may mask the declaration of "_malloc32". */
25 # if __INITIAL_POINTER_SIZE && defined _ANSI_C_SOURCE
26 # if __INITIAL_POINTER_SIZE == 64
27 # pragma pointer_size save
28 # pragma pointer_size 32
29 void *_malloc32(__size_t);
30 # pragma pointer_size restore
31 # endif /* __INITIAL_POINTER_SIZE == 64 */
32 # endif /* __INITIAL_POINTER_SIZE && defined
35 # pragma message disable DOLLARID
37 static int vms_load(DSO *dso);
38 static int vms_unload(DSO *dso);
39 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname);
40 static char *vms_name_converter(DSO *dso, const char *filename);
41 static char *vms_merger(DSO *dso, const char *filespec1,
42 const char *filespec2);
44 static DSO_METHOD dso_meth_vms = {
45 "OpenSSL 'VMS' shared library method",
54 NULL, /* pathbyaddr */
55 NULL /* globallookup */
59 * On VMS, the only "handle" is the file name. LIB$FIND_IMAGE_SYMBOL depends
60 * on the reference to the file name being the same for all calls regarding
61 * one shared image, so we'll just store it in an instance of the following
62 * structure and put a pointer to that instance in the meth_data stack.
64 typedef struct dso_internal_st {
66 * This should contain the name only, no directory, no extension, nothing
69 struct dsc$descriptor_s filename_dsc;
70 char filename[NAMX_MAXRSS + 1];
72 * This contains whatever is not in filename, if needed. Normally not
75 struct dsc$descriptor_s imagename_dsc;
76 char imagename[NAMX_MAXRSS + 1];
79 DSO_METHOD *DSO_METHOD_openssl(void)
84 static int vms_load(DSO *dso)
87 /* See applicable comments in dso_dl.c */
88 char *filename = DSO_convert_filename(dso, NULL);
90 /* Ensure 32-bit pointer for "p", and appropriate malloc() function. */
91 # if __INITIAL_POINTER_SIZE == 64
92 # define DSO_MALLOC _malloc32
93 # pragma pointer_size save
94 # pragma pointer_size 32
95 # else /* __INITIAL_POINTER_SIZE == 64 */
96 # define DSO_MALLOC OPENSSL_malloc
97 # endif /* __INITIAL_POINTER_SIZE == 64 [else] */
99 DSO_VMS_INTERNAL *p = NULL;
101 # if __INITIAL_POINTER_SIZE == 64
102 # pragma pointer_size restore
103 # endif /* __INITIAL_POINTER_SIZE == 64 */
105 const char *sp1, *sp2; /* Search result */
106 const char *ext = NULL; /* possible extension to add */
108 if (filename == NULL) {
109 ERR_raise(ERR_LIB_DSO, DSO_R_NO_FILENAME);
114 * A file specification may look like this:
116 * node::dev:[dir-spec]name.type;ver
118 * or (for compatibility with TOPS-20):
120 * node::dev:<dir-spec>name.type;ver
122 * and the dir-spec uses '.' as separator. Also, a dir-spec
123 * may consist of several parts, with mixed use of [] and <>:
127 * We need to split the file specification into the name and
128 * the rest (both before and after the name itself).
131 * Start with trying to find the end of a dir-spec, and save the position
132 * of the byte after in sp1
134 sp1 = strrchr(filename, ']');
135 sp2 = strrchr(filename, '>');
138 if (sp2 != NULL && sp2 > sp1)
141 sp1 = strrchr(filename, ':');
145 sp1++; /* The byte after the found character */
146 /* Now, let's see if there's a type, and save the position in sp2 */
147 sp2 = strchr(sp1, '.');
149 * If there is a period and the next character is a semi-colon,
150 * we need to add an extension
152 if (sp2 != NULL && sp2[1] == ';')
155 * If we found it, that's where we'll cut. Otherwise, look for a version
156 * number and save the position in sp2
159 sp2 = strchr(sp1, ';');
163 * If there was still nothing to find, set sp2 to point at the end of the
167 sp2 = sp1 + strlen(sp1);
169 /* Check that we won't get buffer overflows */
170 if (sp2 - sp1 > FILENAME_MAX
171 || (sp1 - filename) + strlen(sp2) > FILENAME_MAX) {
172 ERR_raise(ERR_LIB_DSO, DSO_R_FILENAME_TOO_BIG);
176 p = DSO_MALLOC(sizeof(*p));
178 ERR_raise(ERR_LIB_DSO, ERR_R_MALLOC_FAILURE);
182 strncpy(p->filename, sp1, sp2 - sp1);
183 p->filename[sp2 - sp1] = '\0';
185 strncpy(p->imagename, filename, sp1 - filename);
186 p->imagename[sp1 - filename] = '\0';
188 strcat(p->imagename, ext);
192 strcat(p->imagename, sp2);
194 p->filename_dsc.dsc$w_length = strlen(p->filename);
195 p->filename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
196 p->filename_dsc.dsc$b_class = DSC$K_CLASS_S;
197 p->filename_dsc.dsc$a_pointer = p->filename;
198 p->imagename_dsc.dsc$w_length = strlen(p->imagename);
199 p->imagename_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
200 p->imagename_dsc.dsc$b_class = DSC$K_CLASS_S;
201 p->imagename_dsc.dsc$a_pointer = p->imagename;
203 if (!sk_void_push(dso->meth_data, (char *)p)) {
204 ERR_raise(ERR_LIB_DSO, DSO_R_STACK_ERROR);
208 /* Success (for now, we lie. We actually do not know...) */
209 dso->loaded_filename = filename;
214 OPENSSL_free(filename);
219 * Note that this doesn't actually unload the shared image, as there is no
220 * such thing in VMS. Next time it get loaded again, a new copy will
221 * actually be loaded.
223 static int vms_unload(DSO *dso)
227 ERR_raise(ERR_LIB_DSO, ERR_R_PASSED_NULL_PARAMETER);
230 if (sk_void_num(dso->meth_data) < 1)
232 p = (DSO_VMS_INTERNAL *)sk_void_pop(dso->meth_data);
234 ERR_raise(ERR_LIB_DSO, DSO_R_NULL_HANDLE);
243 * We must do this in a separate function because of the way the exception
244 * handler works (it makes this function return
246 static int do_find_symbol(DSO_VMS_INTERNAL *ptr,
247 struct dsc$descriptor_s *symname_dsc, void **sym,
251 * Make sure that signals are caught and returned instead of aborting the
252 * program. The exception handler gets unestablished automatically on
253 * return from this function.
255 lib$establish(lib$sig_to_ret);
257 if (ptr->imagename_dsc.dsc$w_length)
258 return lib$find_image_symbol(&ptr->filename_dsc,
260 &ptr->imagename_dsc, flags);
262 return lib$find_image_symbol(&ptr->filename_dsc,
263 symname_dsc, sym, 0, flags);
266 # ifndef LIB$M_FIS_MIXEDCASE
267 # define LIB$M_FIS_MIXEDCASE (1 << 4);
269 void vms_bind_sym(DSO *dso, const char *symname, void **sym)
271 DSO_VMS_INTERNAL *ptr;
273 struct dsc$descriptor_s symname_dsc;
275 /* Arrange 32-bit pointer to (copied) string storage, if needed. */
276 # if __INITIAL_POINTER_SIZE == 64
277 # define SYMNAME symname_32p
278 # pragma pointer_size save
279 # pragma pointer_size 32
281 # pragma pointer_size restore
282 char symname_32[NAMX_MAXRSS + 1];
283 # else /* __INITIAL_POINTER_SIZE == 64 */
284 # define SYMNAME ((char *) symname)
285 # endif /* __INITIAL_POINTER_SIZE == 64 [else] */
289 if ((dso == NULL) || (symname == NULL)) {
290 ERR_raise(ERR_LIB_DSO, ERR_R_PASSED_NULL_PARAMETER);
293 # if __INITIAL_POINTER_SIZE == 64
294 /* Copy the symbol name to storage with a 32-bit pointer. */
295 symname_32p = symname_32;
296 strcpy(symname_32p, symname);
297 # endif /* __INITIAL_POINTER_SIZE == 64 [else] */
299 symname_dsc.dsc$w_length = strlen(SYMNAME);
300 symname_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
301 symname_dsc.dsc$b_class = DSC$K_CLASS_S;
302 symname_dsc.dsc$a_pointer = SYMNAME;
304 if (sk_void_num(dso->meth_data) < 1) {
305 ERR_raise(ERR_LIB_DSO, DSO_R_STACK_ERROR);
308 ptr = (DSO_VMS_INTERNAL *)sk_void_value(dso->meth_data,
309 sk_void_num(dso->meth_data) - 1);
311 ERR_raise(ERR_LIB_DSO, DSO_R_NULL_HANDLE);
315 status = do_find_symbol(ptr, &symname_dsc, sym, LIB$M_FIS_MIXEDCASE);
317 if (!$VMS_STATUS_SUCCESS(status))
318 status = do_find_symbol(ptr, &symname_dsc, sym, 0);
320 if (!$VMS_STATUS_SUCCESS(status)) {
321 unsigned short length;
323 struct dsc$descriptor_s errstring_dsc;
325 errstring_dsc.dsc$w_length = sizeof(errstring);
326 errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
327 errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
328 errstring_dsc.dsc$a_pointer = errstring;
332 status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
334 if (!$VMS_STATUS_SUCCESS(status))
335 lib$signal(status); /* This is really bad. Abort! */
337 errstring[length] = '\0';
339 if (ptr->imagename_dsc.dsc$w_length)
340 ERR_raise_data(ERR_LIB_DSO, DSO_R_SYM_FAILURE,
341 "Symbol %s in %s (%s): %s",
342 symname, ptr->filename, ptr->imagename,
345 ERR_raise_data(ERR_LIB_DSO, DSO_R_SYM_FAILURE,
346 "Symbol %s in %s: %s",
347 symname, ptr->filename, errstring);
354 static DSO_FUNC_TYPE vms_bind_func(DSO *dso, const char *symname)
356 DSO_FUNC_TYPE sym = 0;
357 vms_bind_sym(dso, symname, (void **)&sym);
361 static char *vms_merger(DSO *dso, const char *filespec1,
362 const char *filespec2)
365 int filespec1len, filespec2len;
367 struct NAMX_STRUCT nam;
368 char esa[NAMX_MAXRSS + 1];
371 /* Arrange 32-bit pointer to (copied) string storage, if needed. */
372 # if __INITIAL_POINTER_SIZE == 64
373 # define FILESPEC1 filespec1_32p;
374 # define FILESPEC2 filespec2_32p;
375 # pragma pointer_size save
376 # pragma pointer_size 32
379 # pragma pointer_size restore
380 char filespec1_32[NAMX_MAXRSS + 1];
381 char filespec2_32[NAMX_MAXRSS + 1];
382 # else /* __INITIAL_POINTER_SIZE == 64 */
383 # define FILESPEC1 ((char *) filespec1)
384 # define FILESPEC2 ((char *) filespec2)
385 # endif /* __INITIAL_POINTER_SIZE == 64 [else] */
391 filespec1len = strlen(filespec1);
392 filespec2len = strlen(filespec2);
394 # if __INITIAL_POINTER_SIZE == 64
395 /* Copy the file names to storage with a 32-bit pointer. */
396 filespec1_32p = filespec1_32;
397 filespec2_32p = filespec2_32;
398 strcpy(filespec1_32p, filespec1);
399 strcpy(filespec2_32p, filespec2);
400 # endif /* __INITIAL_POINTER_SIZE == 64 [else] */
405 FAB_OR_NAML(fab, nam).FAB_OR_NAML_FNA = FILESPEC1;
406 FAB_OR_NAML(fab, nam).FAB_OR_NAML_FNS = filespec1len;
407 FAB_OR_NAML(fab, nam).FAB_OR_NAML_DNA = FILESPEC2;
408 FAB_OR_NAML(fab, nam).FAB_OR_NAML_DNS = filespec2len;
409 NAMX_DNA_FNA_SET(fab)
412 nam.NAMX_ESS = NAMX_MAXRSS;
413 nam.NAMX_NOP = NAM$M_SYNCHK | NAM$M_PWD;
414 SET_NAMX_NO_SHORT_UPCASE(nam);
418 status = sys$parse(&fab, 0, 0);
420 if (!$VMS_STATUS_SUCCESS(status)) {
421 unsigned short length;
423 struct dsc$descriptor_s errstring_dsc;
425 errstring_dsc.dsc$w_length = sizeof(errstring);
426 errstring_dsc.dsc$b_dtype = DSC$K_DTYPE_T;
427 errstring_dsc.dsc$b_class = DSC$K_CLASS_S;
428 errstring_dsc.dsc$a_pointer = errstring;
430 status = sys$getmsg(status, &length, &errstring_dsc, 1, 0);
432 if (!$VMS_STATUS_SUCCESS(status))
433 lib$signal(status); /* This is really bad. Abort! */
435 errstring[length] = '\0';
437 ERR_raise_data(ERR_LIB_DSO, DSO_R_FAILURE,
438 "filespec \"%s\", default \"%s\": %s",
439 filespec1, filespec2, errstring);
444 merged = OPENSSL_malloc(nam.NAMX_ESL + 1);
447 strncpy(merged, nam.NAMX_ESA, nam.NAMX_ESL);
448 merged[nam.NAMX_ESL] = '\0';
451 ERR_raise(ERR_LIB_DSO, ERR_R_MALLOC_FAILURE);
454 static char *vms_name_converter(DSO *dso, const char *filename)
456 int len = strlen(filename);
457 char *not_translated = OPENSSL_malloc(len + 1);
458 if (not_translated != NULL)
459 strcpy(not_translated, filename);
460 return not_translated;
463 #endif /* OPENSSL_SYS_VMS */