2 * Copyright 1995-2022 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"
14 #include "internal/bio_tfo.h"
15 #include "internal/ktls.h"
17 #ifndef OPENSSL_NO_SOCK
19 typedef struct bio_connect_st {
22 int connect_sock_type;
26 # ifndef OPENSSL_NO_KTLS
27 unsigned char record_type;
31 BIO_ADDRINFO *addr_first;
32 const BIO_ADDRINFO *addr_iter;
34 * int socket; this will be kept in bio->num so that it is compatible
35 * with the bss_sock bio
38 * called when the connection is initially made callback(BIO,state,ret);
39 * The callback should return 'ret'. state is for compatibility with the
42 BIO_info_cb *info_callback;
44 * Used when connect_sock_type is SOCK_DGRAM. Owned by us; we forward
45 * read/write(mmsg) calls to this if present.
50 static int conn_write(BIO *h, const char *buf, int num);
51 static int conn_read(BIO *h, char *buf, int size);
52 static int conn_puts(BIO *h, const char *str);
53 static int conn_gets(BIO *h, char *buf, int size);
54 static long conn_ctrl(BIO *h, int cmd, long arg1, void *arg2);
55 static int conn_new(BIO *h);
56 static int conn_free(BIO *data);
57 static long conn_callback_ctrl(BIO *h, int cmd, BIO_info_cb *);
58 static int conn_sendmmsg(BIO *h, BIO_MSG *m, size_t s, size_t n,
59 uint64_t f, size_t *mp);
60 static int conn_recvmmsg(BIO *h, BIO_MSG *m, size_t s, size_t n,
61 uint64_t f, size_t *mp);
63 static int conn_state(BIO *b, BIO_CONNECT *c);
64 static void conn_close_socket(BIO *data);
65 static BIO_CONNECT *BIO_CONNECT_new(void);
66 static void BIO_CONNECT_free(BIO_CONNECT *a);
68 #define BIO_CONN_S_BEFORE 1
69 #define BIO_CONN_S_GET_ADDR 2
70 #define BIO_CONN_S_CREATE_SOCKET 3
71 #define BIO_CONN_S_CONNECT 4
72 #define BIO_CONN_S_OK 5
73 #define BIO_CONN_S_BLOCKED_CONNECT 6
74 #define BIO_CONN_S_CONNECT_ERROR 7
76 static const BIO_METHOD methods_connectp = {
93 static int conn_create_dgram_bio(BIO *b, BIO_CONNECT *c)
95 if (c->connect_sock_type != SOCK_DGRAM)
98 #ifndef OPENSSL_NO_DGRAM
99 c->dgram_bio = BIO_new_dgram(b->num, 0);
100 if (c->dgram_bio == NULL)
107 c->state = BIO_CONN_S_CONNECT_ERROR;
111 static int conn_state(BIO *b, BIO_CONNECT *c)
114 BIO_info_cb *cb = NULL;
116 if (c->info_callback != NULL)
117 cb = c->info_callback;
121 case BIO_CONN_S_BEFORE:
122 if (c->param_hostname == NULL && c->param_service == NULL) {
123 ERR_raise_data(ERR_LIB_BIO,
124 BIO_R_NO_HOSTNAME_OR_SERVICE_SPECIFIED,
125 "hostname=%s service=%s",
126 c->param_hostname, c->param_service);
129 c->state = BIO_CONN_S_GET_ADDR;
132 case BIO_CONN_S_GET_ADDR:
134 int family = AF_UNSPEC;
135 switch (c->connect_family) {
136 case BIO_FAMILY_IPV6:
137 if (1) { /* This is a trick we use to avoid bit rot.
138 * at least the "else" part will always be
145 ERR_raise(ERR_LIB_BIO, BIO_R_UNAVAILABLE_IP_FAMILY);
149 case BIO_FAMILY_IPV4:
152 case BIO_FAMILY_IPANY:
156 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_IP_FAMILY);
159 if (BIO_lookup(c->param_hostname, c->param_service,
161 family, c->connect_sock_type,
162 &c->addr_first) == 0)
165 if (c->addr_first == NULL) {
166 ERR_raise(ERR_LIB_BIO, BIO_R_LOOKUP_RETURNED_NOTHING);
169 c->addr_iter = c->addr_first;
170 c->state = BIO_CONN_S_CREATE_SOCKET;
173 case BIO_CONN_S_CREATE_SOCKET:
174 ret = BIO_socket(BIO_ADDRINFO_family(c->addr_iter),
175 BIO_ADDRINFO_socktype(c->addr_iter),
176 BIO_ADDRINFO_protocol(c->addr_iter), 0);
177 if (ret == (int)INVALID_SOCKET) {
178 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
179 "calling socket(%s, %s)",
180 c->param_hostname, c->param_service);
181 ERR_raise(ERR_LIB_BIO, BIO_R_UNABLE_TO_CREATE_SOCKET);
185 c->state = BIO_CONN_S_CONNECT;
188 case BIO_CONN_S_CONNECT:
189 BIO_clear_retry_flags(b);
191 ret = BIO_connect(b->num, BIO_ADDRINFO_address(c->addr_iter),
192 BIO_SOCK_KEEPALIVE | c->connect_mode);
195 if (BIO_sock_should_retry(ret)) {
196 BIO_set_retry_special(b);
197 c->state = BIO_CONN_S_BLOCKED_CONNECT;
198 b->retry_reason = BIO_RR_CONNECT;
200 } else if ((c->addr_iter = BIO_ADDRINFO_next(c->addr_iter))
203 * if there are more addresses to try, do that first
205 BIO_closesocket(b->num);
206 c->state = BIO_CONN_S_CREATE_SOCKET;
210 ERR_clear_last_mark();
211 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
212 "calling connect(%s, %s)",
213 c->param_hostname, c->param_service);
214 c->state = BIO_CONN_S_CONNECT_ERROR;
219 ERR_clear_last_mark();
220 if (!conn_create_dgram_bio(b, c))
222 c->state = BIO_CONN_S_OK;
226 case BIO_CONN_S_BLOCKED_CONNECT:
227 /* wait for socket being writable, before querying BIO_sock_error */
228 if (BIO_socket_wait(b->num, 0, time(NULL)) == 0)
230 i = BIO_sock_error(b->num);
232 BIO_clear_retry_flags(b);
233 if ((c->addr_iter = BIO_ADDRINFO_next(c->addr_iter)) != NULL) {
235 * if there are more addresses to try, do that first
237 BIO_closesocket(b->num);
238 c->state = BIO_CONN_S_CREATE_SOCKET;
241 ERR_raise_data(ERR_LIB_SYS, i,
242 "calling connect(%s, %s)",
243 c->param_hostname, c->param_service);
244 ERR_raise(ERR_LIB_BIO, BIO_R_NBIO_CONNECT_ERROR);
248 if (!conn_create_dgram_bio(b, c))
250 c->state = BIO_CONN_S_OK;
251 # ifndef OPENSSL_NO_KTLS
253 * The new socket is created successfully regardless of ktls_enable.
254 * ktls_enable doesn't change any functionality of the socket, except
255 * changing the setsockopt to enable the processing of ktls_start.
256 * Thus, it is not a problem to call it for non-TLS sockets.
263 case BIO_CONN_S_CONNECT_ERROR:
264 ERR_raise(ERR_LIB_BIO, BIO_R_CONNECT_ERROR);
277 if ((ret = cb((BIO *)b, c->state, ret)) == 0)
282 /* Loop does not exit */
285 ret = cb((BIO *)b, c->state, ret);
290 static BIO_CONNECT *BIO_CONNECT_new(void)
294 if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL)
296 ret->state = BIO_CONN_S_BEFORE;
297 ret->connect_family = BIO_FAMILY_IPANY;
298 ret->connect_sock_type = SOCK_STREAM;
302 static void BIO_CONNECT_free(BIO_CONNECT *a)
306 OPENSSL_free(a->param_hostname);
307 OPENSSL_free(a->param_service);
308 BIO_ADDRINFO_free(a->addr_first);
312 const BIO_METHOD *BIO_s_connect(void)
314 return &methods_connectp;
317 static int conn_new(BIO *bi)
320 bi->num = (int)INVALID_SOCKET;
322 if ((bi->ptr = (char *)BIO_CONNECT_new()) == NULL)
328 static void conn_close_socket(BIO *bio)
332 c = (BIO_CONNECT *)bio->ptr;
333 if (bio->num != (int)INVALID_SOCKET) {
334 /* Only do a shutdown if things were established */
335 if (c->state == BIO_CONN_S_OK)
336 shutdown(bio->num, 2);
337 BIO_closesocket(bio->num);
338 bio->num = (int)INVALID_SOCKET;
342 static int conn_free(BIO *a)
348 data = (BIO_CONNECT *)a->ptr;
350 if (data->dgram_bio != NULL)
351 BIO_free(data->dgram_bio);
354 conn_close_socket(a);
355 BIO_CONNECT_free(data);
363 static int conn_read(BIO *b, char *out, int outl)
368 data = (BIO_CONNECT *)b->ptr;
369 if (data->state != BIO_CONN_S_OK) {
370 ret = conn_state(b, data);
375 if (data->dgram_bio != NULL)
376 return BIO_read(data->dgram_bio, out, outl);
379 clear_socket_error();
380 # ifndef OPENSSL_NO_KTLS
381 if (BIO_get_ktls_recv(b))
382 ret = ktls_read_record(b->num, out, outl);
385 ret = readsocket(b->num, out, outl);
386 BIO_clear_retry_flags(b);
388 if (BIO_sock_should_retry(ret))
389 BIO_set_retry_read(b);
391 b->flags |= BIO_FLAGS_IN_EOF;
397 static int conn_write(BIO *b, const char *in, int inl)
402 data = (BIO_CONNECT *)b->ptr;
403 if (data->state != BIO_CONN_S_OK) {
404 ret = conn_state(b, data);
409 if (data->dgram_bio != NULL)
410 return BIO_write(data->dgram_bio, in, inl);
412 clear_socket_error();
413 # ifndef OPENSSL_NO_KTLS
414 if (BIO_should_ktls_ctrl_msg_flag(b)) {
415 ret = ktls_send_ctrl_message(b->num, data->record_type, in, inl);
418 BIO_clear_ktls_ctrl_msg_flag(b);
422 # if defined(OSSL_TFO_SENDTO)
423 if (data->tfo_first) {
424 int peerlen = BIO_ADDRINFO_sockaddr_size(data->addr_iter);
426 ret = sendto(b->num, in, inl, OSSL_TFO_SENDTO,
427 BIO_ADDRINFO_sockaddr(data->addr_iter), peerlen);
431 ret = writesocket(b->num, in, inl);
432 BIO_clear_retry_flags(b);
434 if (BIO_sock_should_retry(ret))
435 BIO_set_retry_write(b);
440 static long conn_ctrl(BIO *b, int cmd, long num, void *ptr)
444 const char **pptr = NULL;
447 const BIO_ADDR *dg_addr;
448 # ifndef OPENSSL_NO_KTLS
449 ktls_crypto_info_t *crypto_info;
452 data = (BIO_CONNECT *)b->ptr;
457 data->state = BIO_CONN_S_BEFORE;
458 conn_close_socket(b);
459 BIO_ADDRINFO_free(data->addr_first);
460 data->addr_first = NULL;
463 case BIO_C_DO_STATE_MACHINE:
464 /* use this one to start the connection */
465 if (data->state != BIO_CONN_S_OK)
466 ret = (long)conn_state(b, data);
470 case BIO_C_GET_CONNECT:
472 pptr = (const char **)ptr;
474 *pptr = data->param_hostname;
475 } else if (num == 1) {
476 *pptr = data->param_service;
477 } else if (num == 2) {
478 *pptr = (const char *)BIO_ADDRINFO_address(data->addr_iter);
479 } else if (num == 3) {
480 switch (BIO_ADDRINFO_family(data->addr_iter)) {
481 # if OPENSSL_USE_IPV6
483 ret = BIO_FAMILY_IPV6;
487 ret = BIO_FAMILY_IPV4;
490 ret = data->connect_family;
496 } else if (num == 4) {
497 ret = data->connect_mode;
505 case BIO_C_SET_CONNECT:
508 if (num == 0) { /* BIO_set_conn_hostname */
509 char *hold_service = data->param_service;
510 /* We affect the hostname regardless. However, the input
511 * string might contain a host:service spec, so we must
512 * parse it, which might or might not affect the service
515 OPENSSL_free(data->param_hostname);
516 data->param_hostname = NULL;
517 ret = BIO_parse_hostserv(ptr,
518 &data->param_hostname,
519 &data->param_service,
520 BIO_PARSE_PRIO_HOST);
521 if (hold_service != data->param_service)
522 OPENSSL_free(hold_service);
523 } else if (num == 1) { /* BIO_set_conn_port */
524 OPENSSL_free(data->param_service);
525 if ((data->param_service = OPENSSL_strdup(ptr)) == NULL)
527 } else if (num == 2) { /* BIO_set_conn_address */
528 const BIO_ADDR *addr = (const BIO_ADDR *)ptr;
529 char *host = BIO_ADDR_hostname_string(addr, 1);
530 char *service = BIO_ADDR_service_string(addr, 1);
532 ret = host != NULL && service != NULL;
534 OPENSSL_free(data->param_hostname);
535 data->param_hostname = host;
536 OPENSSL_free(data->param_service);
537 data->param_service = service;
538 BIO_ADDRINFO_free(data->addr_first);
539 data->addr_first = NULL;
540 data->addr_iter = NULL;
543 OPENSSL_free(service);
545 } else if (num == 3) { /* BIO_set_conn_ip_family */
546 data->connect_family = *(int *)ptr;
552 case BIO_C_SET_SOCK_TYPE:
553 if ((num != SOCK_STREAM && num != SOCK_DGRAM)
554 || data->state >= BIO_CONN_S_GET_ADDR) {
559 data->connect_sock_type = (int)num;
562 case BIO_C_GET_SOCK_TYPE:
563 ret = data->connect_sock_type;
565 case BIO_C_GET_DGRAM_BIO:
566 if (data->dgram_bio != NULL) {
567 *(BIO **)ptr = data->dgram_bio;
573 case BIO_CTRL_DGRAM_GET_PEER:
574 case BIO_CTRL_DGRAM_DETECT_PEER_ADDR:
575 if (data->state != BIO_CONN_S_OK)
576 conn_state(b, data); /* best effort */
578 if (data->state >= BIO_CONN_S_CREATE_SOCKET
579 && data->addr_iter != NULL
580 && (dg_addr = BIO_ADDRINFO_address(data->addr_iter)) != NULL) {
582 ret = BIO_ADDR_sockaddr_size(dg_addr);
583 if (num == 0 || num > ret)
586 memcpy(ptr, dg_addr, num);
593 case BIO_CTRL_GET_RPOLL_DESCRIPTOR:
594 case BIO_CTRL_GET_WPOLL_DESCRIPTOR:
596 BIO_POLL_DESCRIPTOR *pd = ptr;
598 if (data->state != BIO_CONN_S_OK)
599 conn_state(b, data); /* best effort */
601 if (data->state >= BIO_CONN_S_CREATE_SOCKET) {
602 pd->type = BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD;
603 pd->value.fd = b->num;
611 data->connect_mode |= BIO_SOCK_NONBLOCK;
613 data->connect_mode &= ~BIO_SOCK_NONBLOCK;
615 if (data->dgram_bio != NULL)
616 ret = BIO_set_nbio(data->dgram_bio, num);
619 #if defined(TCP_FASTOPEN) && !defined(OPENSSL_NO_TFO)
622 data->connect_mode |= BIO_SOCK_TFO;
625 data->connect_mode &= ~BIO_SOCK_TFO;
630 case BIO_C_SET_CONNECT_MODE:
631 data->connect_mode = (int)num;
632 if (num & BIO_SOCK_TFO)
646 case BIO_CTRL_GET_CLOSE:
649 case BIO_CTRL_SET_CLOSE:
650 b->shutdown = (int)num;
652 case BIO_CTRL_PENDING:
653 case BIO_CTRL_WPENDING:
661 if (data->param_hostname)
662 BIO_set_conn_hostname(dbio, data->param_hostname);
663 if (data->param_service)
664 BIO_set_conn_port(dbio, data->param_service);
665 BIO_set_conn_ip_family(dbio, data->connect_family);
666 BIO_set_conn_mode(dbio, data->connect_mode);
668 * FIXME: the cast of the function seems unlikely to be a good
671 (void)BIO_set_info_callback(dbio, data->info_callback);
674 case BIO_CTRL_SET_CALLBACK:
675 ret = 0; /* use callback ctrl */
677 case BIO_CTRL_GET_CALLBACK:
681 fptr = (BIO_info_cb **)ptr;
682 *fptr = data->info_callback;
686 ret = (b->flags & BIO_FLAGS_IN_EOF) != 0;
688 # ifndef OPENSSL_NO_KTLS
689 case BIO_CTRL_SET_KTLS:
690 crypto_info = (ktls_crypto_info_t *)ptr;
691 ret = ktls_start(b->num, crypto_info, num);
693 BIO_set_ktls_flag(b, num);
695 case BIO_CTRL_GET_KTLS_SEND:
696 return BIO_should_ktls_flag(b, 1) != 0;
697 case BIO_CTRL_GET_KTLS_RECV:
698 return BIO_should_ktls_flag(b, 0) != 0;
699 case BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG:
700 BIO_set_ktls_ctrl_msg_flag(b);
701 data->record_type = num;
704 case BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG:
705 BIO_clear_ktls_ctrl_msg_flag(b);
708 case BIO_CTRL_SET_KTLS_TX_ZEROCOPY_SENDFILE:
709 ret = ktls_enable_tx_zerocopy_sendfile(b->num);
711 BIO_set_ktls_zerocopy_sendfile_flag(b);
721 static long conn_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
726 data = (BIO_CONNECT *)b->ptr;
729 case BIO_CTRL_SET_CALLBACK:
731 data->info_callback = fp;
741 static int conn_puts(BIO *bp, const char *str)
746 ret = conn_write(bp, str, n);
750 int conn_gets(BIO *bio, char *buf, int size)
757 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
761 ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT);
766 if (bio == NULL || bio->ptr == NULL) {
767 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
770 data = (BIO_CONNECT *)bio->ptr;
771 if (data->state != BIO_CONN_S_OK) {
772 ret = conn_state(bio, data);
777 if (data->dgram_bio != NULL) {
778 ERR_raise(ERR_LIB_BIO, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
782 clear_socket_error();
784 # ifndef OPENSSL_NO_KTLS
785 if (BIO_get_ktls_recv(bio))
786 ret = ktls_read_record(bio->num, ptr, 1);
789 ret = readsocket(bio->num, ptr, 1);
790 BIO_clear_retry_flags(bio);
792 if (BIO_sock_should_retry(ret))
793 BIO_set_retry_read(bio);
795 bio->flags |= BIO_FLAGS_IN_EOF;
802 return ret > 0 || (bio->flags & BIO_FLAGS_IN_EOF) != 0 ? ptr - buf : ret;
805 static int conn_sendmmsg(BIO *bio, BIO_MSG *msg, size_t stride, size_t num_msgs,
806 uint64_t flags, size_t *msgs_processed)
813 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
817 data = (BIO_CONNECT *)bio->ptr;
818 if (data->state != BIO_CONN_S_OK) {
819 ret = conn_state(bio, data);
826 if (data->dgram_bio == NULL) {
828 ERR_raise(ERR_LIB_BIO, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
832 return BIO_sendmmsg(data->dgram_bio, msg, stride, num_msgs,
833 flags, msgs_processed);
836 static int conn_recvmmsg(BIO *bio, BIO_MSG *msg, size_t stride, size_t num_msgs,
837 uint64_t flags, size_t *msgs_processed)
844 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
848 data = (BIO_CONNECT *)bio->ptr;
849 if (data->state != BIO_CONN_S_OK) {
850 ret = conn_state(bio, data);
857 if (data->dgram_bio == NULL) {
859 ERR_raise(ERR_LIB_BIO, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
863 return BIO_recvmmsg(data->dgram_bio, msg, stride, num_msgs,
864 flags, msgs_processed);
867 BIO *BIO_new_connect(const char *str)
871 ret = BIO_new(BIO_s_connect());
874 if (BIO_set_conn_hostname(ret, str))