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