c274877c13086226b8114e0cde5b88d048217db9
[oweals/openssl.git] / crypto / bio / bss_fd.c
1 /* crypto/bio/bss_fd.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 #include <stdio.h>
60 #include <errno.h>
61 #define USE_SOCKETS
62 #include "cryptlib.h"
63
64 #if defined(OPENSSL_NO_POSIX_IO)
65 /*
66  * Dummy placeholder for BIO_s_fd...
67  */
68 BIO *BIO_new_fd(int fd,int close_flag)
69         {
70         return NULL;
71         }
72 int BIO_fd_non_fatal_error(int err)
73         {
74         return 0;
75         }
76 int BIO_fd_should_retry(int i)
77         {
78         return 0;
79         }
80
81 BIO_METHOD *BIO_s_fd(void)
82         {
83         return NULL;
84         }
85 #else
86 /*
87  * As for unconditional usage of "UPLINK" interface in this module.
88  * Trouble is that unlike Unix file descriptors [which are indexes
89  * in kernel-side per-process table], corresponding descriptors on
90  * platforms which require "UPLINK" interface seem to be indexes
91  * in a user-land, non-global table. Well, in fact they are indexes
92  * in stdio _iob[], and recall that _iob[] was the very reason why
93  * "UPLINK" interface was introduced in first place. But one way on
94  * another. Neither libcrypto or libssl use this BIO meaning that
95  * file descriptors can only be provided by application. Therefore
96  * "UPLINK" calls are due...
97  */
98 #include "bio_lcl.h"
99
100 static int fd_write(BIO *h, const char *buf, int num);
101 static int fd_read(BIO *h, char *buf, int size);
102 static int fd_puts(BIO *h, const char *str);
103 static int fd_gets(BIO *h, char *buf, int size);
104 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
105 static int fd_new(BIO *h);
106 static int fd_free(BIO *data);
107 int BIO_fd_should_retry(int s);
108
109 static BIO_METHOD methods_fdp=
110         {
111         BIO_TYPE_FD,"file descriptor",
112         fd_write,
113         fd_read,
114         fd_puts,
115         fd_gets,
116         fd_ctrl,
117         fd_new,
118         fd_free,
119         NULL,
120         };
121
122 BIO_METHOD *BIO_s_fd(void)
123         {
124         return(&methods_fdp);
125         }
126
127 BIO *BIO_new_fd(int fd,int close_flag)
128         {
129         BIO *ret;
130         ret=BIO_new(BIO_s_fd());
131         if (ret == NULL) return(NULL);
132         BIO_set_fd(ret,fd,close_flag);
133         return(ret);
134         }
135
136 static int fd_new(BIO *bi)
137         {
138         bi->init=0;
139         bi->num=-1;
140         bi->ptr=NULL;
141         bi->flags=BIO_FLAGS_UPLINK; /* essentially redundant */
142         return(1);
143         }
144
145 static int fd_free(BIO *a)
146         {
147         if (a == NULL) return(0);
148         if (a->shutdown)
149                 {
150                 if (a->init)
151                         {
152                         UP_close(a->num);
153                         }
154                 a->init=0;
155                 a->flags=BIO_FLAGS_UPLINK;
156                 }
157         return(1);
158         }
159         
160 static int fd_read(BIO *b, char *out,int outl)
161         {
162         int ret=0;
163
164         if (out != NULL)
165                 {
166                 clear_sys_error();
167                 ret=UP_read(b->num,out,outl);
168                 BIO_clear_retry_flags(b);
169                 if (ret <= 0)
170                         {
171                         if (BIO_fd_should_retry(ret))
172                                 BIO_set_retry_read(b);
173                         }
174                 }
175         return(ret);
176         }
177
178 static int fd_write(BIO *b, const char *in, int inl)
179         {
180         int ret;
181         clear_sys_error();
182         ret=UP_write(b->num,in,inl);
183         BIO_clear_retry_flags(b);
184         if (ret <= 0)
185                 {
186                 if (BIO_fd_should_retry(ret))
187                         BIO_set_retry_write(b);
188                 }
189         return(ret);
190         }
191
192 static long fd_ctrl(BIO *b, int cmd, long num, void *ptr)
193         {
194         long ret=1;
195         int *ip;
196
197         switch (cmd)
198                 {
199         case BIO_CTRL_RESET:
200                 num=0;
201         case BIO_C_FILE_SEEK:
202                 ret=(long)UP_lseek(b->num,num,0);
203                 break;
204         case BIO_C_FILE_TELL:
205         case BIO_CTRL_INFO:
206                 ret=(long)UP_lseek(b->num,0,1);
207                 break;
208         case BIO_C_SET_FD:
209                 fd_free(b);
210                 b->num= *((int *)ptr);
211                 b->shutdown=(int)num;
212                 b->init=1;
213                 break;
214         case BIO_C_GET_FD:
215                 if (b->init)
216                         {
217                         ip=(int *)ptr;
218                         if (ip != NULL) *ip=b->num;
219                         ret=b->num;
220                         }
221                 else
222                         ret= -1;
223                 break;
224         case BIO_CTRL_GET_CLOSE:
225                 ret=b->shutdown;
226                 break;
227         case BIO_CTRL_SET_CLOSE:
228                 b->shutdown=(int)num;
229                 break;
230         case BIO_CTRL_PENDING:
231         case BIO_CTRL_WPENDING:
232                 ret=0;
233                 break;
234         case BIO_CTRL_DUP:
235         case BIO_CTRL_FLUSH:
236                 ret=1;
237                 break;
238         default:
239                 ret=0;
240                 break;
241                 }
242         return(ret);
243         }
244
245 static int fd_puts(BIO *bp, const char *str)
246         {
247         int n,ret;
248
249         n=strlen(str);
250         ret=fd_write(bp,str,n);
251         return(ret);
252         }
253
254 static int fd_gets(BIO *bp, char *buf, int size)
255         {
256         int ret=0;
257         char *ptr=buf;
258         char *end=buf+size-1;
259
260         while ( (ptr < end) && (fd_read(bp, ptr, 1) > 0) && (ptr[0] != '\n') )
261                 ptr++;
262
263         ptr[0]='\0';
264
265         if (buf[0] != '\0')
266                 ret=strlen(buf);
267         return(ret);
268         }
269
270 int BIO_fd_should_retry(int i)
271         {
272         int err;
273
274         if ((i == 0) || (i == -1))
275                 {
276                 err=get_last_sys_error();
277
278 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
279                 if ((i == -1) && (err == 0))
280                         return(1);
281 #endif
282
283                 return(BIO_fd_non_fatal_error(err));
284                 }
285         return(0);
286         }
287
288 int BIO_fd_non_fatal_error(int err)
289         {
290         switch (err)
291                 {
292
293 #ifdef EWOULDBLOCK
294 # ifdef WSAEWOULDBLOCK
295 #  if WSAEWOULDBLOCK != EWOULDBLOCK
296         case EWOULDBLOCK:
297 #  endif
298 # else
299         case EWOULDBLOCK:
300 # endif
301 #endif
302
303 #if defined(ENOTCONN)
304         case ENOTCONN:
305 #endif
306
307 #ifdef EINTR
308         case EINTR:
309 #endif
310
311 #ifdef EAGAIN
312 #if EWOULDBLOCK != EAGAIN
313         case EAGAIN:
314 # endif
315 #endif
316
317 #ifdef EPROTO
318         case EPROTO:
319 #endif
320
321 #ifdef EINPROGRESS
322         case EINPROGRESS:
323 #endif
324
325 #ifdef EALREADY
326         case EALREADY:
327 #endif
328                 return(1);
329                 /* break; */
330         default:
331                 break;
332                 }
333         return(0);
334         }
335 #endif