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