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