a72a476803c5ba594946e2a74d792e2394b913b4
[openssl.git] / crypto / bio / bss_sock.c
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include <errno.h>
12 #include "bio_local.h"
13 #include "internal/cryptlib.h"
14 #include "internal/ktls.h"
15
16 #ifndef OPENSSL_NO_SOCK
17
18 # include <openssl/bio.h>
19
20 # ifdef WATT32
21 /* Watt-32 uses same names */
22 #  undef sock_write
23 #  undef sock_read
24 #  undef sock_puts
25 #  define sock_write SockWrite
26 #  define sock_read  SockRead
27 #  define sock_puts  SockPuts
28 # endif
29
30 static int sock_write(BIO *h, const char *buf, int num);
31 static int sock_read(BIO *h, char *buf, int size);
32 static int sock_puts(BIO *h, const char *str);
33 static long sock_ctrl(BIO *h, int cmd, long arg1, void *arg2);
34 static int sock_new(BIO *h);
35 static int sock_free(BIO *data);
36 int BIO_sock_should_retry(int s);
37
38 static const BIO_METHOD methods_sockp = {
39     BIO_TYPE_SOCKET,
40     "socket",
41     /* TODO: Convert to new style write function */
42     bwrite_conv,
43     sock_write,
44     /* TODO: Convert to new style read function */
45     bread_conv,
46     sock_read,
47     sock_puts,
48     NULL,                       /* sock_gets,         */
49     sock_ctrl,
50     sock_new,
51     sock_free,
52     NULL,                       /* sock_callback_ctrl */
53 };
54
55 const BIO_METHOD *BIO_s_socket(void)
56 {
57     return &methods_sockp;
58 }
59
60 BIO *BIO_new_socket(int fd, int close_flag)
61 {
62     BIO *ret;
63
64     ret = BIO_new(BIO_s_socket());
65     if (ret == NULL)
66         return NULL;
67     BIO_set_fd(ret, fd, close_flag);
68 # ifndef OPENSSL_NO_KTLS
69     {
70         /*
71          * The new socket is created successfully regardless of ktls_enable.
72          * ktls_enable doesn't change any functionality of the socket, except
73          * changing the setsockopt to enable the processing of ktls_start.
74          * Thus, it is not a problem to call it for non-TLS sockets.
75          */
76         ktls_enable(fd);
77     }
78 # endif
79     return ret;
80 }
81
82 static int sock_new(BIO *bi)
83 {
84     bi->init = 0;
85     bi->num = 0;
86     bi->ptr = NULL;
87     bi->flags = 0;
88     return 1;
89 }
90
91 static int sock_free(BIO *a)
92 {
93     if (a == NULL)
94         return 0;
95     if (a->shutdown) {
96         if (a->init) {
97             BIO_closesocket(a->num);
98         }
99         a->init = 0;
100         a->flags = 0;
101     }
102     return 1;
103 }
104
105 static int sock_read(BIO *b, char *out, int outl)
106 {
107     int ret = 0;
108
109     if (out != NULL) {
110         clear_socket_error();
111 # ifndef OPENSSL_NO_KTLS
112         if (BIO_get_ktls_recv(b))
113             ret = ktls_read_record(b->num, out, outl);
114         else
115 # endif
116             ret = readsocket(b->num, out, outl);
117         BIO_clear_retry_flags(b);
118         if (ret <= 0) {
119             if (BIO_sock_should_retry(ret))
120                 BIO_set_retry_read(b);
121             else if (ret == 0)
122                 b->flags |= BIO_FLAGS_IN_EOF;
123         }
124     }
125     return ret;
126 }
127
128 static int sock_write(BIO *b, const char *in, int inl)
129 {
130     int ret = 0;
131
132     clear_socket_error();
133 # ifndef OPENSSL_NO_KTLS
134     if (BIO_should_ktls_ctrl_msg_flag(b)) {
135         unsigned char record_type = (intptr_t)b->ptr;
136         ret = ktls_send_ctrl_message(b->num, record_type, in, inl);
137         if (ret >= 0) {
138             ret = inl;
139             BIO_clear_ktls_ctrl_msg_flag(b);
140         }
141     } else
142 # endif
143         ret = writesocket(b->num, in, inl);
144     BIO_clear_retry_flags(b);
145     if (ret <= 0) {
146         if (BIO_sock_should_retry(ret))
147             BIO_set_retry_write(b);
148     }
149     return ret;
150 }
151
152 static long sock_ctrl(BIO *b, int cmd, long num, void *ptr)
153 {
154     long ret = 1;
155     int *ip;
156 # ifndef OPENSSL_NO_KTLS
157 #  ifdef __FreeBSD__
158     struct tls_enable *crypto_info;
159 #  else
160     struct tls12_crypto_info_aes_gcm_128 *crypto_info;
161 #  endif
162 # endif
163
164     switch (cmd) {
165     case BIO_C_SET_FD:
166         sock_free(b);
167         b->num = *((int *)ptr);
168         b->shutdown = (int)num;
169         b->init = 1;
170         break;
171     case BIO_C_GET_FD:
172         if (b->init) {
173             ip = (int *)ptr;
174             if (ip != NULL)
175                 *ip = b->num;
176             ret = b->num;
177         } else
178             ret = -1;
179         break;
180     case BIO_CTRL_GET_CLOSE:
181         ret = b->shutdown;
182         break;
183     case BIO_CTRL_SET_CLOSE:
184         b->shutdown = (int)num;
185         break;
186     case BIO_CTRL_DUP:
187     case BIO_CTRL_FLUSH:
188         ret = 1;
189         break;
190 # ifndef OPENSSL_NO_KTLS
191     case BIO_CTRL_SET_KTLS:
192 #  ifdef __FreeBSD__
193         crypto_info = (struct tls_enable *)ptr;
194 #  else
195         crypto_info = (struct tls12_crypto_info_aes_gcm_128 *)ptr;
196 #  endif
197         ret = ktls_start(b->num, crypto_info, sizeof(*crypto_info), num);
198         if (ret)
199             BIO_set_ktls_flag(b, num);
200         break;
201     case BIO_CTRL_GET_KTLS_SEND:
202         return BIO_should_ktls_flag(b, 1);
203     case BIO_CTRL_GET_KTLS_RECV:
204         return BIO_should_ktls_flag(b, 0);
205     case BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG:
206         BIO_set_ktls_ctrl_msg_flag(b);
207         b->ptr = (void *)num;
208         ret = 0;
209         break;
210     case BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG:
211         BIO_clear_ktls_ctrl_msg_flag(b);
212         ret = 0;
213         break;
214 # endif
215     case BIO_CTRL_EOF:
216         ret = (b->flags & BIO_FLAGS_IN_EOF) != 0 ? 1 : 0;
217         break;
218     default:
219         ret = 0;
220         break;
221     }
222     return ret;
223 }
224
225 static int sock_puts(BIO *bp, const char *str)
226 {
227     int n, ret;
228
229     n = strlen(str);
230     ret = sock_write(bp, str, n);
231     return ret;
232 }
233
234 int BIO_sock_should_retry(int i)
235 {
236     int err;
237
238     if ((i == 0) || (i == -1)) {
239         err = get_last_socket_error();
240
241         return BIO_sock_non_fatal_error(err);
242     }
243     return 0;
244 }
245
246 int BIO_sock_non_fatal_error(int err)
247 {
248     switch (err) {
249 # if defined(OPENSSL_SYS_WINDOWS)
250 #  if defined(WSAEWOULDBLOCK)
251     case WSAEWOULDBLOCK:
252 #  endif
253 # endif
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     default:
292         break;
293     }
294     return 0;
295 }
296
297 #endif                          /* #ifndef OPENSSL_NO_SOCK */