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