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