2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
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
13 #include "bio_local.h"
15 #ifndef OPENSSL_NO_SOCK
17 typedef struct bio_connect_st {
24 BIO_ADDRINFO *addr_first;
25 const BIO_ADDRINFO *addr_iter;
27 * int socket; this will be kept in bio->num so that it is compatible
28 * with the bss_sock bio
31 * called when the connection is initially made callback(BIO,state,ret);
32 * The callback should return 'ret'. state is for compatibility with the
35 BIO_info_cb *info_callback;
38 static int conn_write(BIO *h, const char *buf, int num);
39 static int conn_read(BIO *h, char *buf, int size);
40 static int conn_puts(BIO *h, const char *str);
41 static long conn_ctrl(BIO *h, int cmd, long arg1, void *arg2);
42 static int conn_new(BIO *h);
43 static int conn_free(BIO *data);
44 static long conn_callback_ctrl(BIO *h, int cmd, BIO_info_cb *);
46 static int conn_state(BIO *b, BIO_CONNECT *c);
47 static void conn_close_socket(BIO *data);
48 BIO_CONNECT *BIO_CONNECT_new(void);
49 void BIO_CONNECT_free(BIO_CONNECT *a);
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
59 static const BIO_METHOD methods_connectp = {
62 /* TODO: Convert to new style write function */
65 /* TODO: Convert to new style read function */
69 NULL, /* conn_gets, */
76 static int conn_state(BIO *b, BIO_CONNECT *c)
79 BIO_info_cb *cb = NULL;
81 if (c->info_callback != NULL)
82 cb = c->info_callback;
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);
90 "hostname=", c->param_hostname,
91 " service=", c->param_service);
94 c->state = BIO_CONN_S_GET_ADDR;
97 case BIO_CONN_S_GET_ADDR:
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
110 BIOerr(BIO_F_CONN_STATE, BIO_R_UNAVAILABLE_IP_FAMILY);
114 case BIO_FAMILY_IPV4:
117 case BIO_FAMILY_IPANY:
121 BIOerr(BIO_F_CONN_STATE, BIO_R_UNSUPPORTED_IP_FAMILY);
124 if (BIO_lookup(c->param_hostname, c->param_service,
126 family, SOCK_STREAM, &c->addr_first) == 0)
129 if (c->addr_first == NULL) {
130 BIOerr(BIO_F_CONN_STATE, BIO_R_LOOKUP_RETURNED_NOTHING);
133 c->addr_iter = c->addr_first;
134 c->state = BIO_CONN_S_CREATE_SOCKET;
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);
149 c->state = BIO_CONN_S_CONNECT;
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);
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;
163 } else if ((c->addr_iter = BIO_ADDRINFO_next(c->addr_iter))
166 * if there are more addresses to try, do that first
168 BIO_closesocket(b->num);
169 c->state = BIO_CONN_S_CREATE_SOCKET;
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;
181 c->state = BIO_CONN_S_OK;
185 case BIO_CONN_S_BLOCKED_CONNECT:
186 i = BIO_sock_error(b->num);
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);
196 c->state = BIO_CONN_S_OK;
199 case BIO_CONN_S_CONNECT_ERROR:
200 BIOerr(BIO_F_CONN_STATE, BIO_R_CONNECT_ERROR);
213 if ((ret = cb((BIO *)b, c->state, ret)) == 0)
218 /* Loop does not exit */
221 ret = cb((BIO *)b, c->state, ret);
226 BIO_CONNECT *BIO_CONNECT_new(void)
230 if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
231 BIOerr(BIO_F_BIO_CONNECT_NEW, ERR_R_MALLOC_FAILURE);
234 ret->state = BIO_CONN_S_BEFORE;
235 ret->connect_family = BIO_FAMILY_IPANY;
239 void BIO_CONNECT_free(BIO_CONNECT *a)
243 OPENSSL_free(a->param_hostname);
244 OPENSSL_free(a->param_service);
245 BIO_ADDRINFO_free(a->addr_first);
249 const BIO_METHOD *BIO_s_connect(void)
251 return &methods_connectp;
254 static int conn_new(BIO *bi)
257 bi->num = (int)INVALID_SOCKET;
259 if ((bi->ptr = (char *)BIO_CONNECT_new()) == NULL)
265 static void conn_close_socket(BIO *bio)
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;
279 static int conn_free(BIO *a)
285 data = (BIO_CONNECT *)a->ptr;
288 conn_close_socket(a);
289 BIO_CONNECT_free(data);
297 static int conn_read(BIO *b, char *out, int outl)
302 data = (BIO_CONNECT *)b->ptr;
303 if (data->state != BIO_CONN_S_OK) {
304 ret = conn_state(b, data);
310 clear_socket_error();
311 ret = readsocket(b->num, out, outl);
312 BIO_clear_retry_flags(b);
314 if (BIO_sock_should_retry(ret))
315 BIO_set_retry_read(b);
317 b->flags |= BIO_FLAGS_IN_EOF;
323 static int conn_write(BIO *b, const char *in, int inl)
328 data = (BIO_CONNECT *)b->ptr;
329 if (data->state != BIO_CONN_S_OK) {
330 ret = conn_state(b, data);
335 clear_socket_error();
336 ret = writesocket(b->num, in, inl);
337 BIO_clear_retry_flags(b);
339 if (BIO_sock_should_retry(ret))
340 BIO_set_retry_write(b);
345 static long conn_ctrl(BIO *b, int cmd, long num, void *ptr)
349 const char **pptr = NULL;
353 data = (BIO_CONNECT *)b->ptr;
358 data->state = BIO_CONN_S_BEFORE;
359 conn_close_socket(b);
360 BIO_ADDRINFO_free(data->addr_first);
361 data->addr_first = NULL;
364 case BIO_C_DO_STATE_MACHINE:
365 /* use this one to start the connection */
366 if (data->state != BIO_CONN_S_OK)
367 ret = (long)conn_state(b, data);
371 case BIO_C_GET_CONNECT:
373 pptr = (const char **)ptr;
375 *pptr = data->param_hostname;
376 } else if (num == 1) {
377 *pptr = data->param_service;
378 } else if (num == 2) {
379 *pptr = (const char *)BIO_ADDRINFO_address(data->addr_iter);
380 } else if (num == 3) {
381 switch (BIO_ADDRINFO_family(data->addr_iter)) {
384 ret = BIO_FAMILY_IPV6;
388 ret = BIO_FAMILY_IPV4;
391 ret = data->connect_family;
404 case BIO_C_SET_CONNECT:
408 char *hold_service = data->param_service;
409 /* We affect the hostname regardless. However, the input
410 * string might contain a host:service spec, so we must
411 * parse it, which might or might not affect the service
413 OPENSSL_free(data->param_hostname);
414 data->param_hostname = NULL;
415 ret = BIO_parse_hostserv(ptr,
416 &data->param_hostname,
417 &data->param_service,
418 BIO_PARSE_PRIO_HOST);
419 if (hold_service != data->param_service)
420 OPENSSL_free(hold_service);
421 } else if (num == 1) {
422 OPENSSL_free(data->param_service);
423 data->param_service = OPENSSL_strdup(ptr);
424 } else if (num == 2) {
425 const BIO_ADDR *addr = (const BIO_ADDR *)ptr;
427 data->param_hostname = BIO_ADDR_hostname_string(addr, 1);
428 data->param_service = BIO_ADDR_service_string(addr, 1);
429 BIO_ADDRINFO_free(data->addr_first);
430 data->addr_first = NULL;
431 data->addr_iter = NULL;
433 } else if (num == 3) {
434 data->connect_family = *(int *)ptr;
442 data->connect_mode |= BIO_SOCK_NONBLOCK;
444 data->connect_mode &= ~BIO_SOCK_NONBLOCK;
446 case BIO_C_SET_CONNECT_MODE:
447 data->connect_mode = (int)num;
458 case BIO_CTRL_GET_CLOSE:
461 case BIO_CTRL_SET_CLOSE:
462 b->shutdown = (int)num;
464 case BIO_CTRL_PENDING:
465 case BIO_CTRL_WPENDING:
473 if (data->param_hostname)
474 BIO_set_conn_hostname(dbio, data->param_hostname);
475 if (data->param_service)
476 BIO_set_conn_port(dbio, data->param_service);
477 BIO_set_conn_ip_family(dbio, data->connect_family);
478 BIO_set_conn_mode(dbio, data->connect_mode);
480 * FIXME: the cast of the function seems unlikely to be a good
483 (void)BIO_set_info_callback(dbio, data->info_callback);
486 case BIO_CTRL_SET_CALLBACK:
487 ret = 0; /* use callback ctrl */
489 case BIO_CTRL_GET_CALLBACK:
493 fptr = (BIO_info_cb **)ptr;
494 *fptr = data->info_callback;
498 ret = (b->flags & BIO_FLAGS_IN_EOF) != 0 ? 1 : 0;
507 static long conn_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
512 data = (BIO_CONNECT *)b->ptr;
515 case BIO_CTRL_SET_CALLBACK:
517 data->info_callback = fp;
527 static int conn_puts(BIO *bp, const char *str)
532 ret = conn_write(bp, str, n);
536 BIO *BIO_new_connect(const char *str)
540 ret = BIO_new(BIO_s_connect());
543 if (BIO_set_conn_hostname(ret, str))