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