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 /*
  70  * Following definition aliases fopen to fopen64 on above mentioned
  71  * platforms. This makes it possible to open and sequentially access files
  72  * larger than 2GB from 32-bit application. It does not allow to traverse
  73  * them beyond 2GB with fseek/ftell, but on the other hand *no* 32-bit
  74  * platform permits that, not with fseek/ftell. Not to mention that breaking
  75  * 2GB limit for seeking would require surgery to *our* API. But sequential
  76  * access suffices for practical cases when you can run into large files,
  77  * such as fingerprinting, so we can let API alone. For reference, the list
  78  * of 32-bit platforms which allow for sequential access of large files
  79  * without extra "magic" comprise *BSD, 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     BIO_TYPE_FILE,
 107     "FILE pointer",
 108     file_write,
 109     file_read,
 110     file_puts,
 111     file_gets,
 112     file_ctrl,
 113     file_new,
 114     file_free,
 115     NULL,
 116 };
 117
 118 BIO *BIO_new_file(const char *filename, const char *mode)
 119 {
 120     BIO *ret;
 121     FILE *file;
 122
 123     if ((file = fopen(filename, mode)) == NULL) {
 124         SYSerr(SYS_F_FOPEN, get_last_sys_error());
 125         ERR_add_error_data(5, "fopen('", filename, "','", mode, "')");
 126         if (errno == ENOENT)
 127             BIOerr(BIO_F_BIO_NEW_FILE, BIO_R_NO_SUCH_FILE);
 128         else
 129             BIOerr(BIO_F_BIO_NEW_FILE, ERR_R_SYS_LIB);
 130         return (NULL);
 131     }
 132     if ((ret = BIO_new(BIO_s_file_internal())) == NULL) {
 133         fclose(file);
 134         return (NULL);
 135     }
 136
 137     BIO_clear_flags(ret, BIO_FLAGS_UPLINK); /* we did fopen -> we disengage
 138                                              * UPLINK */
 139     BIO_set_fp(ret, file, BIO_CLOSE);
 140     return (ret);
 141 }
 142
 143 BIO *BIO_new_fp(FILE *stream, int close_flag)
 144 {
 145     BIO *ret;
 146
 147     if ((ret = BIO_new(BIO_s_file())) == NULL)
 148         return (NULL);
 149
 150     BIO_set_flags(ret, BIO_FLAGS_UPLINK); /* redundant, left for
 151                                            * documentation puposes */
 152     BIO_set_fp(ret, stream, close_flag);
 153     return (ret);
 154 }
 155
 156 BIO_METHOD *BIO_s_file(void)
 157 {
 158     return (&methods_filep);
 159 }
 160
 161 static int MS_CALLBACK file_new(BIO *bi)
 162 {
 163     bi->init = 0;
 164     bi->num = 0;
 165     bi->ptr = NULL;
 166     bi->flags = BIO_FLAGS_UPLINK; /* default to UPLINK */
 167     return (1);
 168 }
 169
 170 static int MS_CALLBACK file_free(BIO *a)
 171 {
 172     if (a == NULL)
 173         return (0);
 174     if (a->shutdown) {
 175         if ((a->init) && (a->ptr != NULL)) {
 176             if (a->flags & BIO_FLAGS_UPLINK)
 177                 UP_fclose(a->ptr);
 178             else
 179                 fclose(a->ptr);
 180             a->ptr = NULL;
 181             a->flags = BIO_FLAGS_UPLINK;
 182         }
 183         a->init = 0;
 184     }
 185     return (1);
 186 }
 187
 188 static int MS_CALLBACK file_read(BIO *b, char *out, int outl)
 189 {
 190     int ret = 0;
 191
 192     if (b->init && (out != NULL)) {
 193         if (b->flags & BIO_FLAGS_UPLINK)
 194             ret = UP_fread(out, 1, (int)outl, b->ptr);
 195         else
 196             ret = fread(out, 1, (int)outl, (FILE *)b->ptr);
 197         if (ret == 0
 198             && (b->flags & BIO_FLAGS_UPLINK) ? UP_ferror((FILE *)b->ptr) :
 199             ferror((FILE *)b->ptr)) {
 200             SYSerr(SYS_F_FREAD, get_last_sys_error());
 201             BIOerr(BIO_F_FILE_READ, ERR_R_SYS_LIB);
 202             ret = -1;
 203         }
 204     }
 205     return (ret);
 206 }
 207
 208 static int MS_CALLBACK file_write(BIO *b, const char *in, int inl)
 209 {
 210     int ret = 0;
 211
 212     if (b->init && (in != NULL)) {
 213         if (b->flags & BIO_FLAGS_UPLINK)
 214             ret = UP_fwrite(in, (int)inl, 1, b->ptr);
 215         else
 216             ret = fwrite(in, (int)inl, 1, (FILE *)b->ptr);
 217         if (ret)
 218             ret = inl;
 219         /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
 220         /*
 221          * according to Tim Hudson <tjh@cryptsoft.com>, the commented out
 222          * version above can cause 'inl' write calls under some stupid stdio
 223          * implementations (VMS)
 224          */
 225     }
 226     return (ret);
 227 }
 228
 229 static long MS_CALLBACK file_ctrl(BIO *b, int cmd, long num, void *ptr)
 230 {
 231     long ret = 1;
 232     FILE *fp = (FILE *)b->ptr;
 233     FILE **fpp;
 234     char p[4];
 235
 236     switch (cmd) {
 237     case BIO_C_FILE_SEEK:
 238     case BIO_CTRL_RESET:
 239         if (b->flags & BIO_FLAGS_UPLINK)
 240             ret = (long)UP_fseek(b->ptr, num, 0);
 241         else
 242             ret = (long)fseek(fp, num, 0);
 243         break;
 244     case BIO_CTRL_EOF:
 245         if (b->flags & BIO_FLAGS_UPLINK)
 246             ret = (long)UP_feof(fp);
 247         else
 248             ret = (long)feof(fp);
 249         break;
 250     case BIO_C_FILE_TELL:
 251     case BIO_CTRL_INFO:
 252         if (b->flags & BIO_FLAGS_UPLINK)
 253             ret = UP_ftell(b->ptr);
 254         else
 255             ret = ftell(fp);
 256         break;
 257     case BIO_C_SET_FILE_PTR:
 258         file_free(b);
 259         b->shutdown = (int)num & BIO_CLOSE;
 260         b->ptr = ptr;
 261         b->init = 1;
 262 #  if BIO_FLAGS_UPLINK!=0
 263 #   if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)
 264 #    define _IOB_ENTRIES 20
 265 #   endif
 266 #   if defined(_IOB_ENTRIES)
 267         /* Safety net to catch purely internal BIO_set_fp calls */
 268         if ((size_t)ptr >= (size_t)stdin &&
 269             (size_t)ptr < (size_t)(stdin + _IOB_ENTRIES))
 270             BIO_clear_flags(b, BIO_FLAGS_UPLINK);
 271 #   endif
 272 #  endif
 273 #  ifdef UP_fsetmod
 274         if (b->flags & BIO_FLAGS_UPLINK)
 275             UP_fsetmod(b->ptr, (char)((num & BIO_FP_TEXT) ? 't' : 'b'));
 276         else
 277 #  endif
 278         {
 279 #  if defined(OPENSSL_SYS_WINDOWS)
 280             int fd = _fileno((FILE *)ptr);
 281             if (num & BIO_FP_TEXT)
 282                 _setmode(fd, _O_TEXT);
 283             else
 284                 _setmode(fd, _O_BINARY);
 285 #  elif defined(OPENSSL_SYS_NETWARE) && defined(NETWARE_CLIB)
 286             int fd = fileno((FILE *)ptr);
 287             /*
 288              * Under CLib there are differences in file modes
 289              */
 290             if (num & BIO_FP_TEXT)
 291                 setmode(fd, O_TEXT);
 292             else
 293                 setmode(fd, O_BINARY);
 294 #  elif defined(OPENSSL_SYS_MSDOS)
 295             int fd = fileno((FILE *)ptr);
 296             /* Set correct text/binary mode */
 297             if (num & BIO_FP_TEXT)
 298                 _setmode(fd, _O_TEXT);
 299             /* Dangerous to set stdin/stdout to raw (unless redirected) */
 300             else {
 301                 if (fd == STDIN_FILENO || fd == STDOUT_FILENO) {
 302                     if (isatty(fd) <= 0)
 303                         _setmode(fd, _O_BINARY);
 304                 } else
 305                     _setmode(fd, _O_BINARY);
 306             }
 307 #  elif defined(OPENSSL_SYS_OS2)
 308             int fd = fileno((FILE *)ptr);
 309             if (num & BIO_FP_TEXT)
 310                 setmode(fd, O_TEXT);
 311             else
 312                 setmode(fd, O_BINARY);
 313 #  endif
 314         }
 315         break;
 316     case BIO_C_SET_FILENAME:
 317         file_free(b);
 318         b->shutdown = (int)num & BIO_CLOSE;
 319         if (num & BIO_FP_APPEND) {
 320             if (num & BIO_FP_READ)
 321                 BUF_strlcpy(p, "a+", sizeof p);
 322             else
 323                 BUF_strlcpy(p, "a", sizeof p);
 324         } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
 325             BUF_strlcpy(p, "r+", sizeof p);
 326         else if (num & BIO_FP_WRITE)
 327             BUF_strlcpy(p, "w", sizeof p);
 328         else if (num & BIO_FP_READ)
 329             BUF_strlcpy(p, "r", sizeof p);
 330         else {
 331             BIOerr(BIO_F_FILE_CTRL, BIO_R_BAD_FOPEN_MODE);
 332             ret = 0;
 333             break;
 334         }
 335 #  if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
 336         if (!(num & BIO_FP_TEXT))
 337             strcat(p, "b");
 338         else
 339             strcat(p, "t");
 340 #  endif
 341 #  if defined(OPENSSL_SYS_NETWARE)
 342         if (!(num & BIO_FP_TEXT))
 343             strcat(p, "b");
 344         else
 345             strcat(p, "t");
 346 #  endif
 347         fp = fopen(ptr, p);
 348         if (fp == NULL) {
 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
 358                                                * UPLINK */
 359         break;
 360     case BIO_C_GET_FILE_PTR:
 361         /* the ptr parameter is actually a FILE ** in this case. */
 362         if (ptr != NULL) {
 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     if (bp->flags & BIO_FLAGS_UPLINK) {
 400         if (!UP_fgets(buf, size, bp->ptr))
 401             goto err;
 402     } else {
 403         if (!fgets(buf, size, (FILE *)bp->ptr))
 404             goto err;
 405     }
 406     if (buf[0] != '\0')
 407         ret = strlen(buf);
 408  err:
 409     return (ret);
 410 }
 411
 412 static int MS_CALLBACK file_puts(BIO *bp, const char *str)
 413 {
 414     int n, ret;
 415
 416     n = strlen(str);
 417     ret = file_write(bp, str, n);
 418     return (ret);
 419 }
 420
 421 # endif                         /* OPENSSL_NO_STDIO */
 422
 423 #endif                          /* HEADER_BSS_FILE_C */