Refactoring BIO: Small adjustments
[openssl.git] / crypto / bio / bss_fd.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include <errno.h>
60
61 #include "bio_lcl.h"
62
63 #if defined(OPENSSL_NO_POSIX_IO)
64 /*
65  * Dummy placeholder for BIO_s_fd...
66  */
67 BIO *BIO_new_fd(int fd, int close_flag)
68 {
69     return NULL;
70 }
71
72 int BIO_fd_non_fatal_error(int err)
73 {
74     return 0;
75 }
76
77 int BIO_fd_should_retry(int i)
78 {
79     return 0;
80 }
81
82 BIO_METHOD *BIO_s_fd(void)
83 {
84     return NULL;
85 }
86 #else
87 /*
88  * As for unconditional usage of "UPLINK" interface in this module.
89  * Trouble is that unlike Unix file descriptors [which are indexes
90  * in kernel-side per-process table], corresponding descriptors on
91  * platforms which require "UPLINK" interface seem to be indexes
92  * in a user-land, non-global table. Well, in fact they are indexes
93  * in stdio _iob[], and recall that _iob[] was the very reason why
94  * "UPLINK" interface was introduced in first place. But one way on
95  * another. Neither libcrypto or libssl use this BIO meaning that
96  * file descriptors can only be provided by application. Therefore
97  * "UPLINK" calls are due...
98  */
99 static int fd_write(BIO *h, const char *buf, int num);
100 static int fd_read(BIO *h, char *buf, int size);
101 static int fd_puts(BIO *h, const char *str);
102 static int fd_gets(BIO *h, char *buf, int size);
103 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
104 static int fd_new(BIO *h);
105 static int fd_free(BIO *data);
106 int BIO_fd_should_retry(int s);
107
108 static BIO_METHOD methods_fdp = {
109     BIO_TYPE_FD, "file descriptor",
110     fd_write,
111     fd_read,
112     fd_puts,
113     fd_gets,
114     fd_ctrl,
115     fd_new,
116     fd_free,
117     NULL,
118 };
119
120 BIO_METHOD *BIO_s_fd(void)
121 {
122     return (&methods_fdp);
123 }
124
125 BIO *BIO_new_fd(int fd, int close_flag)
126 {
127     BIO *ret;
128     ret = BIO_new(BIO_s_fd());
129     if (ret == NULL)
130         return (NULL);
131     BIO_set_fd(ret, fd, close_flag);
132     return (ret);
133 }
134
135 static int fd_new(BIO *bi)
136 {
137     bi->init = 0;
138     bi->num = -1;
139     bi->ptr = NULL;
140     bi->flags = BIO_FLAGS_UPLINK; /* essentially redundant */
141     return (1);
142 }
143
144 static int fd_free(BIO *a)
145 {
146     if (a == NULL)
147         return (0);
148     if (a->shutdown) {
149         if (a->init) {
150             UP_close(a->num);
151         }
152         a->init = 0;
153         a->flags = BIO_FLAGS_UPLINK;
154     }
155     return (1);
156 }
157
158 static int fd_read(BIO *b, char *out, int outl)
159 {
160     int ret = 0;
161
162     if (out != NULL) {
163         clear_sys_error();
164         ret = UP_read(b->num, out, outl);
165         BIO_clear_retry_flags(b);
166         if (ret <= 0) {
167             if (BIO_fd_should_retry(ret))
168                 BIO_set_retry_read(b);
169         }
170     }
171     return (ret);
172 }
173
174 static int fd_write(BIO *b, const char *in, int inl)
175 {
176     int ret;
177     clear_sys_error();
178     ret = UP_write(b->num, in, inl);
179     BIO_clear_retry_flags(b);
180     if (ret <= 0) {
181         if (BIO_fd_should_retry(ret))
182             BIO_set_retry_write(b);
183     }
184     return (ret);
185 }
186
187 static long fd_ctrl(BIO *b, int cmd, long num, void *ptr)
188 {
189     long ret = 1;
190     int *ip;
191
192     switch (cmd) {
193     case BIO_CTRL_RESET:
194         num = 0;
195     case BIO_C_FILE_SEEK:
196         ret = (long)UP_lseek(b->num, num, 0);
197         break;
198     case BIO_C_FILE_TELL:
199     case BIO_CTRL_INFO:
200         ret = (long)UP_lseek(b->num, 0, 1);
201         break;
202     case BIO_C_SET_FD:
203         fd_free(b);
204         b->num = *((int *)ptr);
205         b->shutdown = (int)num;
206         b->init = 1;
207         break;
208     case BIO_C_GET_FD:
209         if (b->init) {
210             ip = (int *)ptr;
211             if (ip != NULL)
212                 *ip = b->num;
213             ret = b->num;
214         } else
215             ret = -1;
216         break;
217     case BIO_CTRL_GET_CLOSE:
218         ret = b->shutdown;
219         break;
220     case BIO_CTRL_SET_CLOSE:
221         b->shutdown = (int)num;
222         break;
223     case BIO_CTRL_PENDING:
224     case BIO_CTRL_WPENDING:
225         ret = 0;
226         break;
227     case BIO_CTRL_DUP:
228     case BIO_CTRL_FLUSH:
229         ret = 1;
230         break;
231     default:
232         ret = 0;
233         break;
234     }
235     return (ret);
236 }
237
238 static int fd_puts(BIO *bp, const char *str)
239 {
240     int n, ret;
241
242     n = strlen(str);
243     ret = fd_write(bp, str, n);
244     return (ret);
245 }
246
247 static int fd_gets(BIO *bp, char *buf, int size)
248 {
249     int ret = 0;
250     char *ptr = buf;
251     char *end = buf + size - 1;
252
253     while ((ptr < end) && (fd_read(bp, ptr, 1) > 0) && (ptr[0] != '\n'))
254         ptr++;
255
256     ptr[0] = '\0';
257
258     if (buf[0] != '\0')
259         ret = strlen(buf);
260     return (ret);
261 }
262
263 int BIO_fd_should_retry(int i)
264 {
265     int err;
266
267     if ((i == 0) || (i == -1)) {
268         err = get_last_sys_error();
269
270 # if defined(OPENSSL_SYS_WINDOWS) && 0/* more microsoft stupidity? perhaps
271                                        * not? Ben 4/1/99 */
272         if ((i == -1) && (err == 0))
273             return (1);
274 # endif
275
276         return (BIO_fd_non_fatal_error(err));
277     }
278     return (0);
279 }
280
281 int BIO_fd_non_fatal_error(int err)
282 {
283     switch (err) {
284
285 # ifdef EWOULDBLOCK
286 #  ifdef WSAEWOULDBLOCK
287 #   if WSAEWOULDBLOCK != EWOULDBLOCK
288     case EWOULDBLOCK:
289 #   endif
290 #  else
291     case EWOULDBLOCK:
292 #  endif
293 # endif
294
295 # if defined(ENOTCONN)
296     case ENOTCONN:
297 # endif
298
299 # ifdef EINTR
300     case EINTR:
301 # endif
302
303 # ifdef EAGAIN
304 #  if EWOULDBLOCK != EAGAIN
305     case EAGAIN:
306 #  endif
307 # endif
308
309 # ifdef EPROTO
310     case EPROTO:
311 # endif
312
313 # ifdef EINPROGRESS
314     case EINPROGRESS:
315 # endif
316
317 # ifdef EALREADY
318     case EALREADY:
319 # endif
320         return (1);
321         /* break; */
322     default:
323         break;
324     }
325     return (0);
326 }
327 #endif