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