ISSUE 43: Add BIO_sock_shutdown
[openssl.git] / crypto / bio / bss_sock.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 #define USE_SOCKETS
61 #include "internal/cryptlib.h"
62
63 #ifndef OPENSSL_NO_SOCK
64
65 # include <openssl/bio.h>
66
67 # ifdef WATT32
68 #  define sock_write SockWrite  /* Watt-32 uses same names */
69 #  define sock_read  SockRead
70 #  define sock_puts  SockPuts
71 # endif
72
73 static int sock_write(BIO *h, const char *buf, int num);
74 static int sock_read(BIO *h, char *buf, int size);
75 static int sock_puts(BIO *h, const char *str);
76 static long sock_ctrl(BIO *h, int cmd, long arg1, void *arg2);
77 static int sock_new(BIO *h);
78 static int sock_free(BIO *data);
79 int BIO_sock_should_retry(int s);
80
81 static BIO_METHOD methods_sockp = {
82     BIO_TYPE_SOCKET,
83     "socket",
84     sock_write,
85     sock_read,
86     sock_puts,
87     NULL,                       /* sock_gets, */
88     sock_ctrl,
89     sock_new,
90     sock_free,
91     NULL,
92 };
93
94 BIO_METHOD *BIO_s_socket(void)
95 {
96     return (&methods_sockp);
97 }
98
99 BIO *BIO_new_socket(int fd, int close_flag)
100 {
101     BIO *ret;
102
103     ret = BIO_new(BIO_s_socket());
104     if (ret == NULL)
105         return (NULL);
106     BIO_set_fd(ret, fd, close_flag);
107     return (ret);
108 }
109
110 static int sock_new(BIO *bi)
111 {
112     bi->init = 0;
113     bi->num = 0;
114     bi->ptr = NULL;
115     bi->flags = 0;
116     return (1);
117 }
118
119 static int sock_free(BIO *a)
120 {
121     if (a == NULL)
122         return (0);
123     if (a->shutdown) {
124         if (a->init) {
125             BIO_closesocket(a->num);
126         }
127         a->init = 0;
128         a->flags = 0;
129     }
130     return (1);
131 }
132
133 static int sock_read(BIO *b, char *out, int outl)
134 {
135     int ret = 0;
136
137     if (out != NULL) {
138         clear_socket_error();
139         ret = readsocket(b->num, out, outl);
140         BIO_clear_retry_flags(b);
141         if (ret <= 0) {
142             if (BIO_sock_should_retry(ret))
143                 BIO_set_retry_read(b);
144         }
145     }
146     return (ret);
147 }
148
149 static int sock_write(BIO *b, const char *in, int inl)
150 {
151     int ret;
152
153     clear_socket_error();
154     ret = writesocket(b->num, in, inl);
155     BIO_clear_retry_flags(b);
156     if (ret <= 0) {
157         if (BIO_sock_should_retry(ret))
158             BIO_set_retry_write(b);
159     }
160     return (ret);
161 }
162
163 static long sock_ctrl(BIO *b, int cmd, long num, void *ptr)
164 {
165     long ret = 1;
166     int *ip;
167
168     switch (cmd) {
169     case BIO_C_SET_FD:
170         sock_free(b);
171         b->num = *((int *)ptr);
172         b->shutdown = (int)num;
173         b->init = 1;
174         break;
175     case BIO_C_GET_FD:
176         if (b->init) {
177             ip = (int *)ptr;
178             if (ip != NULL)
179                 *ip = b->num;
180             ret = b->num;
181         } else
182             ret = -1;
183         break;
184     case BIO_CTRL_GET_CLOSE:
185         ret = b->shutdown;
186         break;
187     case BIO_CTRL_SET_CLOSE:
188         b->shutdown = (int)num;
189         break;
190     case BIO_CTRL_DUP:
191     case BIO_CTRL_FLUSH:
192         ret = 1;
193         break;
194     default:
195         ret = 0;
196         break;
197     }
198     return (ret);
199 }
200
201 static int sock_puts(BIO *bp, const char *str)
202 {
203     int n, ret;
204
205     n = strlen(str);
206     ret = sock_write(bp, str, n);
207     return (ret);
208 }
209
210 int BIO_sock_should_retry(int i)
211 {
212     int err;
213
214     if ((i == 0) || (i == -1)) {
215         err = get_last_socket_error();
216
217 # if defined(OPENSSL_SYS_WINDOWS) && 0/* more microsoft stupidity? perhaps
218                                        * not? Ben 4/1/99 */
219         if ((i == -1) && (err == 0))
220             return (1);
221 # endif
222
223         return (BIO_sock_non_fatal_error(err));
224     }
225     return (0);
226 }
227
228 int BIO_sock_non_fatal_error(int err)
229 {
230     switch (err) {
231 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_NETWARE)
232 #  if defined(WSAEWOULDBLOCK)
233     case WSAEWOULDBLOCK:
234 #  endif
235 # endif
236
237 # ifdef EWOULDBLOCK
238 #  ifdef WSAEWOULDBLOCK
239 #   if WSAEWOULDBLOCK != EWOULDBLOCK
240     case EWOULDBLOCK:
241 #   endif
242 #  else
243     case EWOULDBLOCK:
244 #  endif
245 # endif
246
247 # if defined(ENOTCONN)
248     case ENOTCONN:
249 # endif
250
251 # ifdef EINTR
252     case EINTR:
253 # endif
254
255 # ifdef EAGAIN
256 #  if EWOULDBLOCK != EAGAIN
257     case EAGAIN:
258 #  endif
259 # endif
260
261 # ifdef EPROTO
262     case EPROTO:
263 # endif
264
265 # ifdef EINPROGRESS
266     case EINPROGRESS:
267 # endif
268
269 # ifdef EALREADY
270     case EALREADY:
271 # endif
272         return (1);
273         /* break; */
274     default:
275         break;
276     }
277     return (0);
278 }
279
280 #endif                          /* #ifndef OPENSSL_NO_SOCK */