crypto/bio/bss_file.c

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