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