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