1/*
2 * Copyright 1995-2018 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
13#include "bio_local.h"
14
15#ifndef OPENSSL_NO_SOCK
16
17typedef struct bio_connect_st {
18 int state;
19 int connect_family;
20 char *param_hostname;
21 char *param_service;
22 int connect_mode;
23
24 BIO_ADDRINFO *addr_first;
25 const BIO_ADDRINFO *addr_iter;
26 /*
27 * int socket; this will be kept in bio->num so that it is compatible
28 * with the bss_sock bio
29 */
30 /*
31 * called when the connection is initially made callback(BIO,state,ret);
32 * The callback should return 'ret'. state is for compatibility with the
33 * ssl info_callback
34 */
35 BIO_info_cb *info_callback;
36} BIO_CONNECT;
37
38static int conn_write(BIO *h, const char *buf, int num);
39static int conn_read(BIO *h, char *buf, int size);
40static int conn_puts(BIO *h, const char *str);
41static long conn_ctrl(BIO *h, int cmd, long arg1, void *arg2);
42static int conn_new(BIO *h);
43static int conn_free(BIO *data);
44static long conn_callback_ctrl(BIO *h, int cmd, BIO_info_cb *);
45
46static int conn_state(BIO *b, BIO_CONNECT *c);
47static void conn_close_socket(BIO *data);
48BIO_CONNECT *BIO_CONNECT_new(void);
49void BIO_CONNECT_free(BIO_CONNECT *a);
50
51#define BIO_CONN_S_BEFORE 1
52#define BIO_CONN_S_GET_ADDR 2
53#define BIO_CONN_S_CREATE_SOCKET 3
54#define BIO_CONN_S_CONNECT 4
55#define BIO_CONN_S_OK 5
56#define BIO_CONN_S_BLOCKED_CONNECT 6
57#define BIO_CONN_S_CONNECT_ERROR 7
58
59static const BIO_METHOD methods_connectp = {
60 BIO_TYPE_CONNECT,
61 "socket connect",
62 /* TODO: Convert to new style write function */
63 bwrite_conv,
64 conn_write,
65 /* TODO: Convert to new style read function */
66 bread_conv,
67 conn_read,
68 conn_puts,
69 NULL, /* conn_gets, */
70 conn_ctrl,
71 conn_new,
72 conn_free,
73 conn_callback_ctrl,
74};
75
76static int conn_state(BIO *b, BIO_CONNECT *c)
77{
78 int ret = -1, i;
79 BIO_info_cb *cb = NULL;
80
81 if (c->info_callback != NULL)
82 cb = c->info_callback;
83
84 for (;;) {
85 switch (c->state) {
86 case BIO_CONN_S_BEFORE:
87 if (c->param_hostname == NULL && c->param_service == NULL) {
88 BIOerr(BIO_F_CONN_STATE, BIO_R_NO_HOSTNAME_OR_SERVICE_SPECIFIED);
89 ERR_add_error_data(4,
90 "hostname=", c->param_hostname,
91 " service=", c->param_service);
92 goto exit_loop;
93 }
94 c->state = BIO_CONN_S_GET_ADDR;
95 break;
96
97 case BIO_CONN_S_GET_ADDR:
98 {
99 int family = AF_UNSPEC;
100 switch (c->connect_family) {
101 case BIO_FAMILY_IPV6:
102 if (1) { /* This is a trick we use to avoid bit rot.
103 * at least the "else" part will always be
104 * compiled.
105 */
106#ifdef AF_INET6
107 family = AF_INET6;
108 } else {
109#endif
110 BIOerr(BIO_F_CONN_STATE, BIO_R_UNAVAILABLE_IP_FAMILY);
111 goto exit_loop;
112 }
113 break;
114 case BIO_FAMILY_IPV4:
115 family = AF_INET;
116 break;
117 case BIO_FAMILY_IPANY:
118 family = AF_UNSPEC;
119 break;
120 default:
121 BIOerr(BIO_F_CONN_STATE, BIO_R_UNSUPPORTED_IP_FAMILY);
122 goto exit_loop;
123 }
124 if (BIO_lookup(c->param_hostname, c->param_service,
125 BIO_LOOKUP_CLIENT,
126 family, SOCK_STREAM, &c->addr_first) == 0)
127 goto exit_loop;
128 }
129 if (c->addr_first == NULL) {
130 BIOerr(BIO_F_CONN_STATE, BIO_R_LOOKUP_RETURNED_NOTHING);
131 goto exit_loop;
132 }
133 c->addr_iter = c->addr_first;
134 c->state = BIO_CONN_S_CREATE_SOCKET;
135 break;
136
137 case BIO_CONN_S_CREATE_SOCKET:
138 ret = BIO_socket(BIO_ADDRINFO_family(c->addr_iter),
139 BIO_ADDRINFO_socktype(c->addr_iter),
140 BIO_ADDRINFO_protocol(c->addr_iter), 0);
141 if (ret == (int)INVALID_SOCKET) {
142 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
143 "calling socket(%s, %s)",
144 c->param_hostname, c->param_service);
145 BIOerr(BIO_F_CONN_STATE, BIO_R_UNABLE_TO_CREATE_SOCKET);
146 goto exit_loop;
147 }
148 b->num = ret;
149 c->state = BIO_CONN_S_CONNECT;
150 break;
151
152 case BIO_CONN_S_CONNECT:
153 BIO_clear_retry_flags(b);
154 ret = BIO_connect(b->num, BIO_ADDRINFO_address(c->addr_iter),
155 BIO_SOCK_KEEPALIVE | c->connect_mode);
156 b->retry_reason = 0;
157 if (ret == 0) {
158 if (BIO_sock_should_retry(ret)) {
159 BIO_set_retry_special(b);
160 c->state = BIO_CONN_S_BLOCKED_CONNECT;
161 b->retry_reason = BIO_RR_CONNECT;
162 ERR_clear_error();
163 } else if ((c->addr_iter = BIO_ADDRINFO_next(c->addr_iter))
164 != NULL) {
165 /*
166 * if there are more addresses to try, do that first
167 */
168 BIO_closesocket(b->num);
169 c->state = BIO_CONN_S_CREATE_SOCKET;
170 ERR_clear_error();
171 break;
172 } else {
173 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
174 "calling connect(%s, %s)",
175 c->param_hostname, c->param_service);
176 c->state = BIO_CONN_S_CONNECT_ERROR;
177 break;
178 }
179 goto exit_loop;
180 } else {
181 c->state = BIO_CONN_S_OK;
182 }
183 break;
184
185 case BIO_CONN_S_BLOCKED_CONNECT:
186 i = BIO_sock_error(b->num);
187 if (i) {
188 BIO_clear_retry_flags(b);
189 ERR_raise_data(ERR_LIB_SYS, i,
190 "calling connect(%s, %s)",
191 c->param_hostname, c->param_service);
192 BIOerr(BIO_F_CONN_STATE, BIO_R_NBIO_CONNECT_ERROR);
193 ret = 0;
194 goto exit_loop;
195 } else
196 c->state = BIO_CONN_S_OK;
197 break;
198
199 case BIO_CONN_S_CONNECT_ERROR:
200 BIOerr(BIO_F_CONN_STATE, BIO_R_CONNECT_ERROR);
201 ret = 0;
202 goto exit_loop;
203
204 case BIO_CONN_S_OK:
205 ret = 1;
206 goto exit_loop;
207 default:
208 /* abort(); */
209 goto exit_loop;
210 }
211
212 if (cb != NULL) {
213 if ((ret = cb((BIO *)b, c->state, ret)) == 0)
214 goto end;
215 }
216 }
217
218 /* Loop does not exit */
219 exit_loop:
220 if (cb != NULL)
221 ret = cb((BIO *)b, c->state, ret);
222 end:
223 return ret;
224}
225
226BIO_CONNECT *BIO_CONNECT_new(void)
227{
228 BIO_CONNECT *ret;
229
230 if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
231 BIOerr(BIO_F_BIO_CONNECT_NEW, ERR_R_MALLOC_FAILURE);
232 return NULL;
233 }
234 ret->state = BIO_CONN_S_BEFORE;
235 ret->connect_family = BIO_FAMILY_IPANY;
236 return ret;
237}
238
239void BIO_CONNECT_free(BIO_CONNECT *a)
240{
241 if (a == NULL)
242 return;
243 OPENSSL_free(a->param_hostname);
244 OPENSSL_free(a->param_service);
245 BIO_ADDRINFO_free(a->addr_first);
246 OPENSSL_free(a);
247}
248
249const BIO_METHOD *BIO_s_connect(void)
250{
251 return &methods_connectp;
252}
253
254static int conn_new(BIO *bi)
255{
256 bi->init = 0;
257 bi->num = (int)INVALID_SOCKET;
258 bi->flags = 0;
259 if ((bi->ptr = (char *)BIO_CONNECT_new()) == NULL)
260 return 0;
261 else
262 return 1;
263}
264
265static void conn_close_socket(BIO *bio)
266{
267 BIO_CONNECT *c;
268
269 c = (BIO_CONNECT *)bio->ptr;
270 if (bio->num != (int)INVALID_SOCKET) {
271 /* Only do a shutdown if things were established */
272 if (c->state == BIO_CONN_S_OK)
273 shutdown(bio->num, 2);
274 BIO_closesocket(bio->num);
275 bio->num = (int)INVALID_SOCKET;
276 }
277}
278
279static int conn_free(BIO *a)
280{
281 BIO_CONNECT *data;
282
283 if (a == NULL)
284 return 0;
285 data = (BIO_CONNECT *)a->ptr;
286
287 if (a->shutdown) {
288 conn_close_socket(a);
289 BIO_CONNECT_free(data);
290 a->ptr = NULL;
291 a->flags = 0;
292 a->init = 0;
293 }
294 return 1;
295}
296
297static int conn_read(BIO *b, char *out, int outl)
298{
299 int ret = 0;
300 BIO_CONNECT *data;
301
302 data = (BIO_CONNECT *)b->ptr;
303 if (data->state != BIO_CONN_S_OK) {
304 ret = conn_state(b, data);
305 if (ret <= 0)
306 return ret;
307 }
308
309 if (out != NULL) {
310 clear_socket_error();
311 ret = readsocket(b->num, out, outl);
312 BIO_clear_retry_flags(b);
313 if (ret <= 0) {
314 if (BIO_sock_should_retry(ret))
315 BIO_set_retry_read(b);
316 }
317 }
318 return ret;
319}
320
321static int conn_write(BIO *b, const char *in, int inl)
322{
323 int ret;
324 BIO_CONNECT *data;
325
326 data = (BIO_CONNECT *)b->ptr;
327 if (data->state != BIO_CONN_S_OK) {
328 ret = conn_state(b, data);
329 if (ret <= 0)
330 return ret;
331 }
332
333 clear_socket_error();
334 ret = writesocket(b->num, in, inl);
335 BIO_clear_retry_flags(b);
336 if (ret <= 0) {
337 if (BIO_sock_should_retry(ret))
338 BIO_set_retry_write(b);
339 }
340 return ret;
341}
342
343static long conn_ctrl(BIO *b, int cmd, long num, void *ptr)
344{
345 BIO *dbio;
346 int *ip;
347 const char **pptr = NULL;
348 long ret = 1;
349 BIO_CONNECT *data;
350
351 data = (BIO_CONNECT *)b->ptr;
352
353 switch (cmd) {
354 case BIO_CTRL_RESET:
355 ret = 0;
356 data->state = BIO_CONN_S_BEFORE;
357 conn_close_socket(b);
358 BIO_ADDRINFO_free(data->addr_first);
359 data->addr_first = NULL;
360 b->flags = 0;
361 break;
362 case BIO_C_DO_STATE_MACHINE:
363 /* use this one to start the connection */
364 if (data->state != BIO_CONN_S_OK)
365 ret = (long)conn_state(b, data);
366 else
367 ret = 1;
368 break;
369 case BIO_C_GET_CONNECT:
370 if (ptr != NULL) {
371 pptr = (const char **)ptr;
372 if (num == 0) {
373 *pptr = data->param_hostname;
374 } else if (num == 1) {
375 *pptr = data->param_service;
376 } else if (num == 2) {
377 *pptr = (const char *)BIO_ADDRINFO_address(data->addr_iter);
378 } else if (num == 3) {
379 switch (BIO_ADDRINFO_family(data->addr_iter)) {
380# ifdef AF_INET6
381 case AF_INET6:
382 ret = BIO_FAMILY_IPV6;
383 break;
384# endif
385 case AF_INET:
386 ret = BIO_FAMILY_IPV4;
387 break;
388 case 0:
389 ret = data->connect_family;
390 break;
391 default:
392 ret = -1;
393 break;
394 }
395 } else {
396 ret = 0;
397 }
398 } else {
399 ret = 0;
400 }
401 break;
402 case BIO_C_SET_CONNECT:
403 if (ptr != NULL) {
404 b->init = 1;
405 if (num == 0) {
406 char *hold_service = data->param_service;
407 /* We affect the hostname regardless. However, the input
408 * string might contain a host:service spec, so we must
409 * parse it, which might or might not affect the service
410 */
411 OPENSSL_free(data->param_hostname);
412 data->param_hostname = NULL;
413 ret = BIO_parse_hostserv(ptr,
414 &data->param_hostname,
415 &data->param_service,
416 BIO_PARSE_PRIO_HOST);
417 if (hold_service != data->param_service)
418 OPENSSL_free(hold_service);
419 } else if (num == 1) {
420 OPENSSL_free(data->param_service);
421 data->param_service = OPENSSL_strdup(ptr);
422 } else if (num == 2) {
423 const BIO_ADDR *addr = (const BIO_ADDR *)ptr;
424 if (ret) {
425 data->param_hostname = BIO_ADDR_hostname_string(addr, 1);
426 data->param_service = BIO_ADDR_service_string(addr, 1);
427 BIO_ADDRINFO_free(data->addr_first);
428 data->addr_first = NULL;
429 data->addr_iter = NULL;
430 }
431 } else if (num == 3) {
432 data->connect_family = *(int *)ptr;
433 } else {
434 ret = 0;
435 }
436 }
437 break;
438 case BIO_C_SET_NBIO:
439 if (num != 0)
440 data->connect_mode |= BIO_SOCK_NONBLOCK;
441 else
442 data->connect_mode &= ~BIO_SOCK_NONBLOCK;
443 break;
444 case BIO_C_SET_CONNECT_MODE:
445 data->connect_mode = (int)num;
446 break;
447 case BIO_C_GET_FD:
448 if (b->init) {
449 ip = (int *)ptr;
450 if (ip != NULL)
451 *ip = b->num;
452 ret = b->num;
453 } else
454 ret = -1;
455 break;
456 case BIO_CTRL_GET_CLOSE:
457 ret = b->shutdown;
458 break;
459 case BIO_CTRL_SET_CLOSE:
460 b->shutdown = (int)num;
461 break;
462 case BIO_CTRL_PENDING:
463 case BIO_CTRL_WPENDING:
464 ret = 0;
465 break;
466 case BIO_CTRL_FLUSH:
467 break;
468 case BIO_CTRL_DUP:
469 {
470 dbio = (BIO *)ptr;
471 if (data->param_hostname)
472 BIO_set_conn_hostname(dbio, data->param_hostname);
473 if (data->param_service)
474 BIO_set_conn_port(dbio, data->param_service);
475 BIO_set_conn_ip_family(dbio, data->connect_family);
476 BIO_set_conn_mode(dbio, data->connect_mode);
477 /*
478 * FIXME: the cast of the function seems unlikely to be a good
479 * idea
480 */
481 (void)BIO_set_info_callback(dbio, data->info_callback);
482 }
483 break;
484 case BIO_CTRL_SET_CALLBACK:
485 ret = 0; /* use callback ctrl */
486 break;
487 case BIO_CTRL_GET_CALLBACK:
488 {
489 BIO_info_cb **fptr;
490
491 fptr = (BIO_info_cb **)ptr;
492 *fptr = data->info_callback;
493 }
494 break;
495 default:
496 ret = 0;
497 break;
498 }
499 return ret;
500}
501
502static long conn_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
503{
504 long ret = 1;
505 BIO_CONNECT *data;
506
507 data = (BIO_CONNECT *)b->ptr;
508
509 switch (cmd) {
510 case BIO_CTRL_SET_CALLBACK:
511 {
512 data->info_callback = fp;
513 }
514 break;
515 default:
516 ret = 0;
517 break;
518 }
519 return ret;
520}
521
522static int conn_puts(BIO *bp, const char *str)
523{
524 int n, ret;
525
526 n = strlen(str);
527 ret = conn_write(bp, str, n);
528 return ret;
529}
530
531BIO *BIO_new_connect(const char *str)
532{
533 BIO *ret;
534
535 ret = BIO_new(BIO_s_connect());
536 if (ret == NULL)
537 return NULL;
538 if (BIO_set_conn_hostname(ret, str))
539 return ret;
540 BIO_free(ret);
541 return NULL;
542}
543
544#endif
545