crypto/bio/bss_file.c

   1 /* crypto/bio/bss_file.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 /*
  60  * 03-Dec-1997  rdenny@dc3.com  Fix bug preventing use of stdin/stdout
  61  *              with binary data (e.g. asn1parse -inform DER < xxx) under
  62  *              Windows
  63  */
  64
  65 #ifndef HEADER_BSS_FILE_C
  66 #define HEADER_BSS_FILE_C
  67
  68 #if defined(__linux) || defined(__sun) || defined(__hpux)
  69 /* Following definition aliases fopen to fopen64 on above mentioned
  70  * platforms. This makes it possible to open and sequentially access
  71  * files larger than 2GB from 32-bit application. It does not allow to
  72  * traverse them beyond 2GB with fseek/ftell, but on the other hand *no*
  73  * 32-bit platform permits that, not with fseek/ftell. Not to mention
  74  * that breaking 2GB limit for seeking would require surgery to *our*
  75  * API. But sequential access suffices for practical cases when you
  76  * can run into large files, such as fingerprinting, so we can let API
  77  * alone. For reference, the list of 32-bit platforms which allow for
  78  * sequential access of large files without extra "magic" comprise *BSD,
  79  * Darwin, IRIX...
  80  */
  81 #ifndef _FILE_OFFSET_BITS
  82 #define _FILE_OFFSET_BITS 64
  83 #endif
  84 #endif
  85
  86 #include <stdio.h>
  87 #include <errno.h>
  88 #include "cryptlib.h"
  89 #include "bio_lcl.h"
  90 #include <openssl/err.h>
  91
  92 #if !defined(OPENSSL_NO_STDIO)
  93
  94 static int MS_CALLBACK file_write(BIO *h, const char *buf, int num);
  95 static int MS_CALLBACK file_read(BIO *h, char *buf, int size);
  96 static int MS_CALLBACK file_puts(BIO *h, const char *str);
  97 static int MS_CALLBACK file_gets(BIO *h, char *str, int size);
  98 static long MS_CALLBACK file_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  99 static int MS_CALLBACK file_new(BIO *h);
 100 static int MS_CALLBACK file_free(BIO *data);
 101 static BIO_METHOD methods_filep=
 102         {
 103         BIO_TYPE_FILE,
 104         "FILE pointer",
 105         file_write,
 106         file_read,
 107         file_puts,
 108         file_gets,
 109         file_ctrl,
 110         file_new,
 111         file_free,
 112         NULL,
 113         };
 114
 115 BIO *BIO_new_file(const char *filename, const char *mode)
 116         {
 117         BIO *ret;
 118         FILE *file;
 119
 120         if ((file=fopen(filename,mode)) == NULL)
 121                 {
 122                 SYSerr(SYS_F_FOPEN,get_last_sys_error());
 123                 ERR_add_error_data(5,"fopen('",filename,"','",mode,"')");
 124                 if (errno == ENOENT)
 125                         BIOerr(BIO_F_BIO_NEW_FILE,BIO_R_NO_SUCH_FILE);
 126                 else
 127                         BIOerr(BIO_F_BIO_NEW_FILE,ERR_R_SYS_LIB);
 128                 return(NULL);
 129                 }
 130         if ((ret=BIO_new(BIO_s_file_internal())) == NULL)
 131                 return(NULL);
 132
 133         BIO_clear_flags(ret,BIO_FLAGS_UPLINK); /* we did fopen -> we disengage UPLINK */
 134         BIO_set_fp(ret,file,BIO_CLOSE);
 135         return(ret);
 136         }
 137
 138 BIO *BIO_new_fp(FILE *stream, int close_flag)
 139         {
 140         BIO *ret;
 141
 142         if ((ret=BIO_new(BIO_s_file())) == NULL)
 143                 return(NULL);
 144
 145         BIO_set_flags(ret,BIO_FLAGS_UPLINK); /* redundant, left for documentation puposes */
 146         BIO_set_fp(ret,stream,close_flag);
 147         return(ret);
 148         }
 149
 150 BIO_METHOD *BIO_s_file(void)
 151         {
 152         return(&methods_filep);
 153         }
 154
 155 static int MS_CALLBACK file_new(BIO *bi)
 156         {
 157         bi->init=0;
 158         bi->num=0;
 159         bi->ptr=NULL;
 160         bi->flags=BIO_FLAGS_UPLINK; /* default to UPLINK */
 161         return(1);
 162         }
 163
 164 static int MS_CALLBACK file_free(BIO *a)
 165         {
 166         if (a == NULL) return(0);
 167         if (a->shutdown)
 168                 {
 169                 if ((a->init) && (a->ptr != NULL))
 170                         {
 171                         if (a->flags&BIO_FLAGS_UPLINK)
 172                                 UP_fclose (a->ptr);
 173                         else
 174                                 fclose (a->ptr);
 175                         a->ptr=NULL;
 176                         a->flags=BIO_FLAGS_UPLINK;
 177                         }
 178                 a->init=0;
 179                 }
 180         return(1);
 181         }
 182
 183 static int MS_CALLBACK file_read(BIO *b, char *out, int outl)
 184         {
 185         int ret=0;
 186
 187         if (b->init && (out != NULL))
 188                 {
 189                 if (b->flags&BIO_FLAGS_UPLINK)
 190                         ret=UP_fread(out,1,(int)outl,b->ptr);
 191                 else
 192                         ret=fread(out,1,(int)outl,(FILE *)b->ptr);
 193                 if(ret == 0 && (b->flags&BIO_FLAGS_UPLINK)?UP_ferror((FILE *)b->ptr):ferror((FILE *)b->ptr))
 194                         {
 195                         SYSerr(SYS_F_FREAD,get_last_sys_error());
 196                         BIOerr(BIO_F_FILE_READ,ERR_R_SYS_LIB);
 197                         ret=-1;
 198                         }
 199                 }
 200         return(ret);
 201         }
 202
 203 static int MS_CALLBACK file_write(BIO *b, const char *in, int inl)
 204         {
 205         int ret=0;
 206
 207         if (b->init && (in != NULL))
 208                 {
 209                 if (b->flags&BIO_FLAGS_UPLINK)
 210                         ret=UP_fwrite(in,(int)inl,1,b->ptr);
 211                 else
 212                         ret=fwrite(in,(int)inl,1,(FILE *)b->ptr);
 213                 if (ret)
 214                         ret=inl;
 215                 /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
 216                 /* according to Tim Hudson <tjh@cryptsoft.com>, the commented
 217                  * out version above can cause 'inl' write calls under
 218                  * some stupid stdio implementations (VMS) */
 219                 }
 220         return(ret);
 221         }
 222
 223 static long MS_CALLBACK file_ctrl(BIO *b, int cmd, long num, void *ptr)
 224         {
 225         long ret=1;
 226         FILE *fp=(FILE *)b->ptr;
 227         FILE **fpp;
 228         char p[4];
 229
 230         switch (cmd)
 231                 {
 232         case BIO_C_FILE_SEEK:
 233         case BIO_CTRL_RESET:
 234                 if (b->flags&BIO_FLAGS_UPLINK)
 235                         ret=(long)UP_fseek(b->ptr,num,0);
 236                 else
 237                         ret=(long)fseek(fp,num,0);
 238                 break;
 239         case BIO_CTRL_EOF:
 240                 if (b->flags&BIO_FLAGS_UPLINK)
 241                         ret=(long)UP_feof(fp);
 242                 else
 243                         ret=(long)feof(fp);
 244                 break;
 245         case BIO_C_FILE_TELL:
 246         case BIO_CTRL_INFO:
 247                 if (b->flags&BIO_FLAGS_UPLINK)
 248                         ret=UP_ftell(b->ptr);
 249                 else
 250                         ret=ftell(fp);
 251                 break;
 252         case BIO_C_SET_FILE_PTR:
 253                 file_free(b);
 254                 b->shutdown=(int)num&BIO_CLOSE;
 255                 b->ptr=ptr;
 256                 b->init=1;
 257 #if BIO_FLAGS_UPLINK!=0
 258 #if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)
 259 #define _IOB_ENTRIES 20
 260 #endif
 261 #if defined(_IOB_ENTRIES)
 262                 /* Safety net to catch purely internal BIO_set_fp calls */
 263                 if ((size_t)ptr >= (size_t)stdin &&
 264                     (size_t)ptr <  (size_t)(stdin+_IOB_ENTRIES))
 265                         BIO_clear_flags(b,BIO_FLAGS_UPLINK);
 266 #endif
 267 #endif
 268 #ifdef UP_fsetmode
 269                 if (b->flags&BIO_FLAGS_UPLINK)
 270                         UP_fsetmode(b->ptr,num&BIO_FP_TEXT?'t':'b');
 271                 else
 272 #endif
 273                 {
 274 #if defined(OPENSSL_SYS_WINDOWS)
 275                 int fd = fileno((FILE*)ptr);
 276                 if (num & BIO_FP_TEXT)
 277                         _setmode(fd,_O_TEXT);
 278                 else
 279                         _setmode(fd,_O_BINARY);
 280 #elif defined(OPENSSL_SYS_NETWARE) && defined(NETWARE_CLIB)
 281                 int fd = fileno((FILE*)ptr);
 282          /* Under CLib there are differences in file modes
 283          */
 284                 if (num & BIO_FP_TEXT)
 285                         _setmode(fd,O_TEXT);
 286                 else
 287                         _setmode(fd,O_BINARY);
 288 #elif defined(OPENSSL_SYS_MSDOS)
 289                 int fd = fileno((FILE*)ptr);
 290                 /* Set correct text/binary mode */
 291                 if (num & BIO_FP_TEXT)
 292                         _setmode(fd,_O_TEXT);
 293                 /* Dangerous to set stdin/stdout to raw (unless redirected) */
 294                 else
 295                         {
 296                         if (fd == STDIN_FILENO || fd == STDOUT_FILENO)
 297                                 {
 298                                 if (isatty(fd) <= 0)
 299                                         _setmode(fd,_O_BINARY);
 300                                 }
 301                         else
 302                                 _setmode(fd,_O_BINARY);
 303                         }
 304 #elif defined(OPENSSL_SYS_OS2)
 305                 int fd = fileno((FILE*)ptr);
 306                 if (num & BIO_FP_TEXT)
 307                         setmode(fd, O_TEXT);
 308                 else
 309                         setmode(fd, O_BINARY);
 310 #endif
 311                 }
 312                 break;
 313         case BIO_C_SET_FILENAME:
 314                 file_free(b);
 315                 b->shutdown=(int)num&BIO_CLOSE;
 316                 if (num & BIO_FP_APPEND)
 317                         {
 318                         if (num & BIO_FP_READ)
 319                                 BUF_strlcpy(p,"a+",sizeof p);
 320                         else    BUF_strlcpy(p,"a",sizeof p);
 321                         }
 322                 else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
 323                         BUF_strlcpy(p,"r+",sizeof p);
 324                 else if (num & BIO_FP_WRITE)
 325                         BUF_strlcpy(p,"w",sizeof p);
 326                 else if (num & BIO_FP_READ)
 327                         BUF_strlcpy(p,"r",sizeof p);
 328                 else
 329                         {
 330                         BIOerr(BIO_F_FILE_CTRL,BIO_R_BAD_FOPEN_MODE);
 331                         ret=0;
 332                         break;
 333                         }
 334 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
 335                 if (!(num & BIO_FP_TEXT))
 336                         strcat(p,"b");
 337                 else
 338                         strcat(p,"t");
 339 #endif
 340 #if defined(OPENSSL_SYS_NETWARE)
 341                 if (!(num & BIO_FP_TEXT))
 342                         strcat(p,"b");
 343                 else
 344                         strcat(p,"t");
 345 #endif
 346                 fp=fopen(ptr,p);
 347                 if (fp == NULL)
 348                         {
 349                         SYSerr(SYS_F_FOPEN,get_last_sys_error());
 350                         ERR_add_error_data(5,"fopen('",ptr,"','",p,"')");
 351                         BIOerr(BIO_F_FILE_CTRL,ERR_R_SYS_LIB);
 352                         ret=0;
 353                         break;
 354                         }
 355                 b->ptr=fp;
 356                 b->init=1;
 357                 BIO_clear_flags(b,BIO_FLAGS_UPLINK); /* we did fopen -> we disengage UPLINK */
 358                 break;
 359         case BIO_C_GET_FILE_PTR:
 360                 /* the ptr parameter is actually a FILE ** in this case. */
 361                 if (ptr != NULL)
 362                         {
 363                         fpp=(FILE **)ptr;
 364                         *fpp=(FILE *)b->ptr;
 365                         }
 366                 break;
 367         case BIO_CTRL_GET_CLOSE:
 368                 ret=(long)b->shutdown;
 369                 break;
 370         case BIO_CTRL_SET_CLOSE:
 371                 b->shutdown=(int)num;
 372                 break;
 373         case BIO_CTRL_FLUSH:
 374                 if (b->flags&BIO_FLAGS_UPLINK)
 375                         UP_fflush(b->ptr);
 376                 else
 377                         fflush((FILE *)b->ptr);
 378                 break;
 379         case BIO_CTRL_DUP:
 380                 ret=1;
 381                 break;
 382
 383         case BIO_CTRL_WPENDING:
 384         case BIO_CTRL_PENDING:
 385         case BIO_CTRL_PUSH:
 386         case BIO_CTRL_POP:
 387         default:
 388                 ret=0;
 389                 break;
 390                 }
 391         return(ret);
 392         }
 393
 394 static int MS_CALLBACK file_gets(BIO *bp, char *buf, int size)
 395         {
 396         int ret=0;
 397
 398         buf[0]='\0';
 399         fgets(buf,size,(FILE *)bp->ptr);
 400         if (buf[0] != '\0')
 401                 ret=strlen(buf);
 402         return(ret);
 403         }
 404
 405 static int MS_CALLBACK file_puts(BIO *bp, const char *str)
 406         {
 407         int n,ret;
 408
 409         n=strlen(str);
 410         ret=file_write(bp,str,n);
 411         return(ret);
 412         }
 413
 414 #endif /* OPENSSL_NO_STDIO */
 415
 416 #endif /* HEADER_BSS_FILE_C */
 417
 418