Remove NOPROTO definitions and error code comments.
[openssl.git] / 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 #include <stdio.h>
69 #include <errno.h>
70 #include "cryptlib.h"
71 #include <openssl/bio.h>
72 #include <openssl/err.h>
73
74 #if !defined(NO_STDIO)
75
76 static int MS_CALLBACK file_write(BIO *h,char *buf,int num);
77 static int MS_CALLBACK file_read(BIO *h,char *buf,int size);
78 static int MS_CALLBACK file_puts(BIO *h,char *str);
79 static int MS_CALLBACK file_gets(BIO *h,char *str,int size);
80 static long MS_CALLBACK file_ctrl(BIO *h,int cmd,long arg1,char *arg2);
81 static int MS_CALLBACK file_new(BIO *h);
82 static int MS_CALLBACK file_free(BIO *data);
83 static BIO_METHOD methods_filep=
84         {
85         BIO_TYPE_FILE,
86         "FILE pointer",
87         file_write,
88         file_read,
89         file_puts,
90         file_gets,
91         file_ctrl,
92         file_new,
93         file_free,
94         };
95
96 BIO *BIO_new_file(char *filename, char *mode)
97         {
98         BIO *ret;
99         FILE *file;
100
101         if ((file=fopen(filename,mode)) == NULL)
102                 {
103                 SYSerr(SYS_F_FOPEN,get_last_sys_error());
104                 ERR_add_error_data(5,"fopen('",filename,"','",mode,"')");
105                 BIOerr(BIO_F_BIO_NEW_FILE,ERR_R_SYS_LIB);
106                 return(NULL);
107                 }
108         if ((ret=BIO_new(BIO_s_file_internal())) == NULL)
109                 return(NULL);
110
111         BIO_set_fp(ret,file,BIO_CLOSE);
112         return(ret);
113         }
114
115 BIO *BIO_new_fp(FILE *stream, int close_flag)
116         {
117         BIO *ret;
118
119         if ((ret=BIO_new(BIO_s_file())) == NULL)
120                 return(NULL);
121
122         BIO_set_fp(ret,stream,close_flag);
123         return(ret);
124         }
125
126 BIO_METHOD *BIO_s_file(void)
127         {
128         return(&methods_filep);
129         }
130
131 static int MS_CALLBACK file_new(BIO *bi)
132         {
133         bi->init=0;
134         bi->num=0;
135         bi->ptr=NULL;
136         return(1);
137         }
138
139 static int MS_CALLBACK file_free(BIO *a)
140         {
141         if (a == NULL) return(0);
142         if (a->shutdown)
143                 {
144                 if ((a->init) && (a->ptr != NULL))
145                         {
146                         fclose((FILE *)a->ptr);
147                         a->ptr=NULL;
148                         }
149                 a->init=0;
150                 }
151         return(1);
152         }
153         
154 static int MS_CALLBACK file_read(BIO *b, char *out, int outl)
155         {
156         int ret=0;
157
158         if (b->init && (out != NULL))
159                 {
160                 ret=fread(out,1,(int)outl,(FILE *)b->ptr);
161                 }
162         return(ret);
163         }
164
165 static int MS_CALLBACK file_write(BIO *b, char *in, int inl)
166         {
167         int ret=0;
168
169         if (b->init && (in != NULL))
170                 {
171                 if (fwrite(in,(int)inl,1,(FILE *)b->ptr))
172                         ret=inl;
173                 /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
174                 /* acording to Tim Hudson <tjh@cryptsoft.com>, the commented
175                  * out version above can cause 'inl' write calls under
176                  * some stupid stdio implementations (VMS) */
177                 }
178         return(ret);
179         }
180
181 static long MS_CALLBACK file_ctrl(BIO *b, int cmd, long num, char *ptr)
182         {
183         long ret=1;
184         FILE *fp=(FILE *)b->ptr;
185         FILE **fpp;
186         char p[4];
187
188         switch (cmd)
189                 {
190         case BIO_C_FILE_SEEK:
191         case BIO_CTRL_RESET:
192                 ret=(long)fseek(fp,num,0);
193                 break;
194         case BIO_CTRL_EOF:
195                 ret=(long)feof(fp);
196                 break;
197         case BIO_C_FILE_TELL:
198         case BIO_CTRL_INFO:
199                 ret=ftell(fp);
200                 break;
201         case BIO_C_SET_FILE_PTR:
202                 file_free(b);
203                 b->shutdown=(int)num;
204                 b->ptr=(char *)ptr;
205                 b->init=1;
206 #if defined(MSDOS) || defined(WINDOWS)
207                 /* Set correct text/binary mode */
208                 if (num & BIO_FP_TEXT)
209                         _setmode(fileno((FILE *)ptr),_O_TEXT);
210                 else
211                         _setmode(fileno((FILE *)ptr),_O_BINARY);
212 #endif
213                 break;
214         case BIO_C_SET_FILENAME:
215                 file_free(b);
216                 b->shutdown=(int)num&BIO_CLOSE;
217                 if (num & BIO_FP_APPEND)
218                         {
219                         if (num & BIO_FP_READ)
220                                 strcpy(p,"a+");
221                         else    strcpy(p,"a");
222                         }
223                 else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
224                         strcpy(p,"r+");
225                 else if (num & BIO_FP_WRITE)
226                         strcpy(p,"w");
227                 else if (num & BIO_FP_READ)
228                         strcpy(p,"r");
229                 else
230                         {
231                         BIOerr(BIO_F_FILE_CTRL,BIO_R_BAD_FOPEN_MODE);
232                         ret=0;
233                         break;
234                         }
235 #if defined(MSDOS) || defined(WINDOWS)
236                 if (!(num & BIO_FP_TEXT))
237                         strcat(p,"b");
238                 else
239                         strcat(p,"t");
240 #endif
241                 fp=fopen(ptr,p);
242                 if (fp == NULL)
243                         {
244                         SYSerr(SYS_F_FOPEN,get_last_sys_error());
245                         ERR_add_error_data(5,"fopen('",ptr,"','",p,"')");
246                         BIOerr(BIO_F_FILE_CTRL,ERR_R_SYS_LIB);
247                         ret=0;
248                         break;
249                         }
250                 b->ptr=(char *)fp;
251                 b->init=1;
252                 break;
253         case BIO_C_GET_FILE_PTR:
254                 /* the ptr parameter is actually a FILE ** in this case. */
255                 if (ptr != NULL)
256                         {
257                         fpp=(FILE **)ptr;
258                         *fpp=(FILE *)b->ptr;
259                         }
260                 break;
261         case BIO_CTRL_GET_CLOSE:
262                 ret=(long)b->shutdown;
263                 break;
264         case BIO_CTRL_SET_CLOSE:
265                 b->shutdown=(int)num;
266                 break;
267         case BIO_CTRL_FLUSH:
268                 fflush((FILE *)b->ptr);
269                 break;
270         case BIO_CTRL_DUP:
271                 ret=1;
272                 break;
273
274         case BIO_CTRL_WPENDING:
275         case BIO_CTRL_PENDING:
276         case BIO_CTRL_PUSH:
277         case BIO_CTRL_POP:
278         default:
279                 ret=0;
280                 break;
281                 }
282         return(ret);
283         }
284
285 static int MS_CALLBACK file_gets(BIO *bp, char *buf, int size)
286         {
287         int ret=0;
288
289         buf[0]='\0';
290         fgets(buf,size,(FILE *)bp->ptr);
291         if (buf[0] != '\0')
292                 ret=strlen(buf);
293         return(ret);
294         }
295
296 static int MS_CALLBACK file_puts(BIO *bp, char *str)
297         {
298         int n,ret;
299
300         n=strlen(str);
301         ret=file_write(bp,str,n);
302         return(ret);
303         }
304
305 #endif /* NO_STDIO */
306
307 #endif /* HEADER_BSS_FILE_C */
308
309