crypto/openssl/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_SYS_NETWARE) && defined(NETWARE_CLIB)
  93 #include <nwfileio.h>
  94 #endif
  95
  96 #if !defined(OPENSSL_NO_STDIO)
  97
  98 static int MS_CALLBACK file_write(BIO *h, const char *buf, int num);
  99 static int MS_CALLBACK file_read(BIO *h, char *buf, int size);
 100 static int MS_CALLBACK file_puts(BIO *h, const char *str);
 101 static int MS_CALLBACK file_gets(BIO *h, char *str, int size);
 102 static long MS_CALLBACK file_ctrl(BIO *h, int cmd, long arg1, void *arg2);
 103 static int MS_CALLBACK file_new(BIO *h);
 104 static int MS_CALLBACK file_free(BIO *data);
 105 static BIO_METHOD methods_filep=
 106         {
 107         BIO_TYPE_FILE,
 108         "FILE pointer",
 109         file_write,
 110         file_read,
 111         file_puts,
 112         file_gets,
 113         file_ctrl,
 114         file_new,
 115         file_free,
 116         NULL,
 117         };
 118
 119 BIO *BIO_new_file(const char *filename, const char *mode)
 120         {
 121         BIO  *ret;
 122         FILE *file=NULL;
 123
 124 #if defined(_WIN32) && defined(CP_UTF8)
 125         int sz, len_0 = (int)strlen(filename)+1;
 126
 127         /*
 128          * Basically there are three cases to cover: a) filename is
 129          * pure ASCII string; b) actual UTF-8 encoded string and
 130          * c) locale-ized string, i.e. one containing 8-bit
 131          * characters that are meaningful in current system locale.
 132          * If filename is pure ASCII or real UTF-8 encoded string,
 133          * MultiByteToWideChar succeeds and _wfopen works. If
 134          * filename is locale-ized string, chances are that
 135          * MultiByteToWideChar fails reporting
 136          * ERROR_NO_UNICODE_TRANSLATION, in which case we fall
 137          * back to fopen...
 138          */
 139         if ((sz=MultiByteToWideChar(CP_UTF8,MB_ERR_INVALID_CHARS,
 140                                         filename,len_0,NULL,0))>0)
 141                 {
 142                 WCHAR  wmode[8];
 143                 WCHAR *wfilename = _alloca(sz*sizeof(WCHAR));
 144
 145                 if (MultiByteToWideChar(CP_UTF8,MB_ERR_INVALID_CHARS,
 146                                         filename,len_0,wfilename,sz) &&
 147                     MultiByteToWideChar(CP_UTF8,0,mode,strlen(mode)+1,
 148                                         wmode,sizeof(wmode)/sizeof(wmode[0])) &&
 149                     (file=_wfopen(wfilename,wmode))==NULL && errno==ENOENT
 150                    )    /* UTF-8 decode succeeded, but no file, filename
 151                          * could still have been locale-ized... */
 152                         file = fopen(filename,mode);
 153                 }
 154         else if (GetLastError()==ERROR_NO_UNICODE_TRANSLATION)
 155                 {
 156                 file = fopen(filename,mode);
 157                 }
 158 #else
 159         file=fopen(filename,mode);
 160 #endif
 161         if (file == NULL)
 162                 {
 163                 SYSerr(SYS_F_FOPEN,get_last_sys_error());
 164                 ERR_add_error_data(5,"fopen('",filename,"','",mode,"')");
 165                 if (errno == ENOENT)
 166                         BIOerr(BIO_F_BIO_NEW_FILE,BIO_R_NO_SUCH_FILE);
 167                 else
 168                         BIOerr(BIO_F_BIO_NEW_FILE,ERR_R_SYS_LIB);
 169                 return(NULL);
 170                 }
 171         if ((ret=BIO_new(BIO_s_file())) == NULL)
 172                 {
 173                 fclose(file);
 174                 return(NULL);
 175                 }
 176
 177         BIO_clear_flags(ret,BIO_FLAGS_UPLINK); /* we did fopen -> we disengage UPLINK */
 178         BIO_set_fp(ret,file,BIO_CLOSE);
 179         return(ret);
 180         }
 181
 182 BIO *BIO_new_fp(FILE *stream, int close_flag)
 183         {
 184         BIO *ret;
 185
 186         if ((ret=BIO_new(BIO_s_file())) == NULL)
 187                 return(NULL);
 188
 189         BIO_set_flags(ret,BIO_FLAGS_UPLINK); /* redundant, left for documentation puposes */
 190         BIO_set_fp(ret,stream,close_flag);
 191         return(ret);
 192         }
 193
 194 BIO_METHOD *BIO_s_file(void)
 195         {
 196         return(&methods_filep);
 197         }
 198
 199 static int MS_CALLBACK file_new(BIO *bi)
 200         {
 201         bi->init=0;
 202         bi->num=0;
 203         bi->ptr=NULL;
 204         bi->flags=BIO_FLAGS_UPLINK; /* default to UPLINK */
 205         return(1);
 206         }
 207
 208 static int MS_CALLBACK file_free(BIO *a)
 209         {
 210         if (a == NULL) return(0);
 211         if (a->shutdown)
 212                 {
 213                 if ((a->init) && (a->ptr != NULL))
 214                         {
 215                         if (a->flags&BIO_FLAGS_UPLINK)
 216                                 UP_fclose (a->ptr);
 217                         else
 218                                 fclose (a->ptr);
 219                         a->ptr=NULL;
 220                         a->flags=BIO_FLAGS_UPLINK;
 221                         }
 222                 a->init=0;
 223                 }
 224         return(1);
 225         }
 226
 227 static int MS_CALLBACK file_read(BIO *b, char *out, int outl)
 228         {
 229         int ret=0;
 230
 231         if (b->init && (out != NULL))
 232                 {
 233                 if (b->flags&BIO_FLAGS_UPLINK)
 234                         ret=UP_fread(out,1,(int)outl,b->ptr);
 235                 else
 236                         ret=fread(out,1,(int)outl,(FILE *)b->ptr);
 237                 if(ret == 0 && (b->flags&BIO_FLAGS_UPLINK)?UP_ferror((FILE *)b->ptr):ferror((FILE *)b->ptr))
 238                         {
 239                         SYSerr(SYS_F_FREAD,get_last_sys_error());
 240                         BIOerr(BIO_F_FILE_READ,ERR_R_SYS_LIB);
 241                         ret=-1;
 242                         }
 243                 }
 244         return(ret);
 245         }
 246
 247 static int MS_CALLBACK file_write(BIO *b, const char *in, int inl)
 248         {
 249         int ret=0;
 250
 251         if (b->init && (in != NULL))
 252                 {
 253                 if (b->flags&BIO_FLAGS_UPLINK)
 254                         ret=UP_fwrite(in,(int)inl,1,b->ptr);
 255                 else
 256                         ret=fwrite(in,(int)inl,1,(FILE *)b->ptr);
 257                 if (ret)
 258                         ret=inl;
 259                 /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
 260                 /* according to Tim Hudson <tjh@cryptsoft.com>, the commented
 261                  * out version above can cause 'inl' write calls under
 262                  * some stupid stdio implementations (VMS) */
 263                 }
 264         return(ret);
 265         }
 266
 267 static long MS_CALLBACK file_ctrl(BIO *b, int cmd, long num, void *ptr)
 268         {
 269         long ret=1;
 270         FILE *fp=(FILE *)b->ptr;
 271         FILE **fpp;
 272         char p[4];
 273
 274         switch (cmd)
 275                 {
 276         case BIO_C_FILE_SEEK:
 277         case BIO_CTRL_RESET:
 278                 if (b->flags&BIO_FLAGS_UPLINK)
 279                         ret=(long)UP_fseek(b->ptr,num,0);
 280                 else
 281                         ret=(long)fseek(fp,num,0);
 282                 break;
 283         case BIO_CTRL_EOF:
 284                 if (b->flags&BIO_FLAGS_UPLINK)
 285                         ret=(long)UP_feof(fp);
 286                 else
 287                         ret=(long)feof(fp);
 288                 break;
 289         case BIO_C_FILE_TELL:
 290         case BIO_CTRL_INFO:
 291                 if (b->flags&BIO_FLAGS_UPLINK)
 292                         ret=UP_ftell(b->ptr);
 293                 else
 294                         ret=ftell(fp);
 295                 break;
 296         case BIO_C_SET_FILE_PTR:
 297                 file_free(b);
 298                 b->shutdown=(int)num&BIO_CLOSE;
 299                 b->ptr=ptr;
 300                 b->init=1;
 301 #if BIO_FLAGS_UPLINK!=0
 302 #if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)
 303 #define _IOB_ENTRIES 20
 304 #endif
 305 #if defined(_IOB_ENTRIES)
 306                 /* Safety net to catch purely internal BIO_set_fp calls */
 307                 if ((size_t)ptr >= (size_t)stdin &&
 308                     (size_t)ptr <  (size_t)(stdin+_IOB_ENTRIES))
 309                         BIO_clear_flags(b,BIO_FLAGS_UPLINK);
 310 #endif
 311 #endif
 312 #ifdef UP_fsetmod
 313                 if (b->flags&BIO_FLAGS_UPLINK)
 314                         UP_fsetmod(b->ptr,(char)((num&BIO_FP_TEXT)?'t':'b'));
 315                 else
 316 #endif
 317                 {
 318 #if defined(OPENSSL_SYS_WINDOWS)
 319                 int fd = _fileno((FILE*)ptr);
 320                 if (num & BIO_FP_TEXT)
 321                         _setmode(fd,_O_TEXT);
 322                 else
 323                         _setmode(fd,_O_BINARY);
 324 #elif defined(OPENSSL_SYS_NETWARE) && defined(NETWARE_CLIB)
 325                 int fd = fileno((FILE*)ptr);
 326                 /* Under CLib there are differences in file modes */
 327                 if (num & BIO_FP_TEXT)
 328                         setmode(fd,O_TEXT);
 329                 else
 330                         setmode(fd,O_BINARY);
 331 #elif defined(OPENSSL_SYS_MSDOS)
 332                 int fd = fileno((FILE*)ptr);
 333                 /* Set correct text/binary mode */
 334                 if (num & BIO_FP_TEXT)
 335                         _setmode(fd,_O_TEXT);
 336                 /* Dangerous to set stdin/stdout to raw (unless redirected) */
 337                 else
 338                         {
 339                         if (fd == STDIN_FILENO || fd == STDOUT_FILENO)
 340                                 {
 341                                 if (isatty(fd) <= 0)
 342                                         _setmode(fd,_O_BINARY);
 343                                 }
 344                         else
 345                                 _setmode(fd,_O_BINARY);
 346                         }
 347 #elif defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
 348                 int fd = fileno((FILE*)ptr);
 349                 if (num & BIO_FP_TEXT)
 350                         setmode(fd, O_TEXT);
 351                 else
 352                         setmode(fd, O_BINARY);
 353 #endif
 354                 }
 355                 break;
 356         case BIO_C_SET_FILENAME:
 357                 file_free(b);
 358                 b->shutdown=(int)num&BIO_CLOSE;
 359                 if (num & BIO_FP_APPEND)
 360                         {
 361                         if (num & BIO_FP_READ)
 362                                 BUF_strlcpy(p,"a+",sizeof p);
 363                         else    BUF_strlcpy(p,"a",sizeof p);
 364                         }
 365                 else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
 366                         BUF_strlcpy(p,"r+",sizeof p);
 367                 else if (num & BIO_FP_WRITE)
 368                         BUF_strlcpy(p,"w",sizeof p);
 369                 else if (num & BIO_FP_READ)
 370                         BUF_strlcpy(p,"r",sizeof p);
 371                 else
 372                         {
 373                         BIOerr(BIO_F_FILE_CTRL,BIO_R_BAD_FOPEN_MODE);
 374                         ret=0;
 375                         break;
 376                         }
 377 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
 378                 if (!(num & BIO_FP_TEXT))
 379                         strcat(p,"b");
 380                 else
 381                         strcat(p,"t");
 382 #endif
 383 #if defined(OPENSSL_SYS_NETWARE)
 384                 if (!(num & BIO_FP_TEXT))
 385                         strcat(p,"b");
 386                 else
 387                         strcat(p,"t");
 388 #endif
 389                 fp=fopen(ptr,p);
 390                 if (fp == NULL)
 391                         {
 392                         SYSerr(SYS_F_FOPEN,get_last_sys_error());
 393                         ERR_add_error_data(5,"fopen('",ptr,"','",p,"')");
 394                         BIOerr(BIO_F_FILE_CTRL,ERR_R_SYS_LIB);
 395                         ret=0;
 396                         break;
 397                         }
 398                 b->ptr=fp;
 399                 b->init=1;
 400                 BIO_clear_flags(b,BIO_FLAGS_UPLINK); /* we did fopen -> we disengage UPLINK */
 401                 break;
 402         case BIO_C_GET_FILE_PTR:
 403                 /* the ptr parameter is actually a FILE ** in this case. */
 404                 if (ptr != NULL)
 405                         {
 406                         fpp=(FILE **)ptr;
 407                         *fpp=(FILE *)b->ptr;
 408                         }
 409                 break;
 410         case BIO_CTRL_GET_CLOSE:
 411                 ret=(long)b->shutdown;
 412                 break;
 413         case BIO_CTRL_SET_CLOSE:
 414                 b->shutdown=(int)num;
 415                 break;
 416         case BIO_CTRL_FLUSH:
 417                 if (b->flags&BIO_FLAGS_UPLINK)
 418                         UP_fflush(b->ptr);
 419                 else
 420                         fflush((FILE *)b->ptr);
 421                 break;
 422         case BIO_CTRL_DUP:
 423                 ret=1;
 424                 break;
 425
 426         case BIO_CTRL_WPENDING:
 427         case BIO_CTRL_PENDING:
 428         case BIO_CTRL_PUSH:
 429         case BIO_CTRL_POP:
 430         default:
 431                 ret=0;
 432                 break;
 433                 }
 434         return(ret);
 435         }
 436
 437 static int MS_CALLBACK file_gets(BIO *bp, char *buf, int size)
 438         {
 439         int ret=0;
 440
 441         buf[0]='\0';
 442         if (bp->flags&BIO_FLAGS_UPLINK)
 443                 {
 444                 if (!UP_fgets(buf,size,bp->ptr))
 445                         goto err;
 446                 }
 447         else
 448                 {
 449                 if (!fgets(buf,size,(FILE *)bp->ptr))
 450                         goto err;
 451                 }
 452         if (buf[0] != '\0')
 453                 ret=strlen(buf);
 454         err:
 455         return(ret);
 456         }
 457
 458 static int MS_CALLBACK file_puts(BIO *bp, const char *str)
 459         {
 460         int n,ret;
 461
 462         n=strlen(str);
 463         ret=file_write(bp,str,n);
 464         return(ret);
 465         }
 466
 467 #endif /* OPENSSL_NO_STDIO */
 468
 469 #endif /* HEADER_BSS_FILE_C */
 470
 471