8#include <botan/internal/socket.h>
10#include <botan/exceptn.h>
11#include <botan/mem_ops.h>
12#include <botan/internal/fmt.h>
13#include <botan/internal/target_info.h>
16#if defined(BOTAN_HAS_BOOST_ASIO)
22 #define BOOST_ASIO_DISABLE_SERIAL_PORT
23 #include <boost/asio.hpp>
24 #include <boost/asio/system_timer.hpp>
26#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS)
30 #include <netinet/in.h>
32 #include <sys/socket.h>
36#elif defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
44#if defined(BOTAN_HAS_BOOST_ASIO)
46class Asio_Socket final :
public OS::Socket {
48 Asio_Socket(std::string_view hostname, std::string_view service, std::chrono::milliseconds timeout) :
49 m_timeout(timeout), m_timer(m_io), m_tcp(m_io) {
50 m_timer.expires_after(m_timeout);
53 boost::asio::ip::tcp::resolver resolver(m_io);
54 boost::asio::ip::tcp::resolver::results_type dns_iter =
55 resolver.resolve(std::string{hostname}, std::string{service});
57 boost::system::error_code ec = boost::asio::error::would_block;
59 auto connect_cb = [&ec](
const boost::system::error_code& e,
const auto&) { ec = e; };
61 boost::asio::async_connect(m_tcp, dns_iter.begin(), dns_iter.end(), connect_cb);
63 while(ec == boost::asio::error::would_block) {
68 throw boost::system::system_error(ec);
70 if(m_tcp.is_open() ==
false) {
71 throw System_Error(
fmt(
"Connection to host {} failed", hostname));
75 void write(
const uint8_t buf[],
size_t len)
override {
76 m_timer.expires_after(m_timeout);
78 boost::system::error_code ec = boost::asio::error::would_block;
80 m_tcp.async_send(boost::asio::buffer(buf, len), [&ec](boost::system::error_code e,
size_t) { ec = e; });
82 while(ec == boost::asio::error::would_block) {
87 throw boost::system::system_error(ec);
91 size_t read(uint8_t buf[],
size_t len)
override {
92 m_timer.expires_after(m_timeout);
94 boost::system::error_code ec = boost::asio::error::would_block;
97 m_tcp.async_read_some(boost::asio::buffer(buf, len), [&](boost::system::error_code cb_ec,
size_t cb_got) {
102 while(ec == boost::asio::error::would_block) {
107 if(ec == boost::asio::error::eof) {
110 throw boost::system::system_error(ec);
117 void check_timeout() {
118 if(m_tcp.is_open() && m_timer.expiry() < std::chrono::system_clock::now()) {
119 boost::system::error_code err;
125 m_timer.async_wait(std::bind(&Asio_Socket::check_timeout,
this));
128 const std::chrono::milliseconds m_timeout;
129 boost::asio::io_context m_io;
130 boost::asio::system_timer m_timer;
131 boost::asio::ip::tcp::socket m_tcp;
134#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
136class BSD_Socket final :
public OS::Socket {
138 #if defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
139 typedef SOCKET socket_type;
140 typedef int socket_op_ret_type;
141 typedef int socklen_type;
142 typedef int sendrecv_len_type;
144 static socket_type invalid_socket() {
return INVALID_SOCKET; }
146 static void close_socket(socket_type s) { ::closesocket(s); }
148 static std::string get_last_socket_error() {
return std::to_string(::WSAGetLastError()); }
150 static bool nonblocking_connect_in_progress() {
return (::WSAGetLastError() == WSAEWOULDBLOCK); }
152 static void set_nonblocking(socket_type s) {
153 u_long nonblocking = 1;
154 ::ioctlsocket(s, FIONBIO, &nonblocking);
157 static void socket_init() {
159 WORD wsa_version = MAKEWORD(2, 2);
161 if(::WSAStartup(wsa_version, &wsa_data) != 0) {
162 throw System_Error(
"WSAStartup() failed", WSAGetLastError());
165 if(LOBYTE(wsa_data.wVersion) != 2 || HIBYTE(wsa_data.wVersion) != 2) {
167 throw System_Error(
"Could not find a usable version of Winsock.dll");
171 static void socket_fini() { ::WSACleanup(); }
173 typedef int socket_type;
174 typedef ssize_t socket_op_ret_type;
175 typedef socklen_t socklen_type;
176 typedef size_t sendrecv_len_type;
178 static socket_type invalid_socket() {
return -1; }
180 static void close_socket(socket_type s) { ::close(s); }
182 static std::string get_last_socket_error() { return ::strerror(errno); }
184 static bool nonblocking_connect_in_progress() {
return (errno == EINPROGRESS); }
186 static void set_nonblocking(socket_type s) {
187 if(::fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
188 throw System_Error(
"Setting socket to non-blocking state failed", errno);
192 static void socket_init() {}
194 static void socket_fini() {}
198 BSD_Socket(std::string_view hostname, std::string_view service, std::chrono::microseconds timeout) :
202 m_socket = invalid_socket();
205 clear_mem(&hints, 1);
206 hints.ai_family = AF_UNSPEC;
207 hints.ai_socktype = SOCK_STREAM;
210 const std::string hostname_str(hostname);
211 const std::string service_str(service);
213 int rc = ::getaddrinfo(hostname_str.c_str(), service_str.c_str(), &hints, &res);
216 throw System_Error(fmt(
"Name resolution failed for {}", hostname), rc);
219 for(addrinfo* rp = res; (m_socket == invalid_socket()) && (rp !=
nullptr); rp = rp->ai_next) {
220 if(rp->ai_family != AF_INET && rp->ai_family != AF_INET6) {
224 m_socket = ::socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
226 if(m_socket == invalid_socket()) {
231 set_nonblocking(m_socket);
233 int err = ::connect(m_socket, rp->ai_addr,
static_cast<socklen_type
>(rp->ai_addrlen));
237 if(nonblocking_connect_in_progress()) {
238 struct timeval timeout_tv = make_timeout_tv();
242 FD_SET(
static_cast<int>(m_socket), &write_set);
244 active = ::select(
static_cast<int>(m_socket + 1),
nullptr, &write_set,
nullptr, &timeout_tv);
247 int socket_error = 0;
248 socklen_t len =
sizeof(socket_error);
250 if(::getsockopt(m_socket, SOL_SOCKET, SO_ERROR,
reinterpret_cast<char*
>(&socket_error), &len) <
252 throw System_Error(
"Error calling getsockopt", errno);
255 if(socket_error != 0) {
262 close_socket(m_socket);
263 m_socket = invalid_socket();
271 if(m_socket == invalid_socket()) {
272 throw System_Error(fmt(
"Connecting to {} for service {} failed with errno {}", hostname, service, errno),
277 ~BSD_Socket()
override {
278 close_socket(m_socket);
279 m_socket = invalid_socket();
283 BSD_Socket(
const BSD_Socket& other) =
delete;
284 BSD_Socket(BSD_Socket&& other) =
delete;
285 BSD_Socket& operator=(
const BSD_Socket& other) =
delete;
286 BSD_Socket& operator=(BSD_Socket&& other) =
delete;
288 void write(
const uint8_t buf[],
size_t len)
override {
291 FD_SET(m_socket, &write_set);
293 size_t sent_so_far = 0;
294 while(sent_so_far != len) {
295 struct timeval timeout = make_timeout_tv();
296 int active = ::select(
static_cast<int>(m_socket + 1),
nullptr, &write_set,
nullptr, &timeout);
299 throw System_Error(
"Timeout during socket write");
302 const size_t left = len - sent_so_far;
303 socket_op_ret_type sent =
304 ::send(m_socket, cast_uint8_ptr_to_char(&buf[sent_so_far]),
static_cast<sendrecv_len_type
>(left), 0);
306 throw System_Error(
"Socket write failed", errno);
308 sent_so_far +=
static_cast<size_t>(sent);
313 size_t read(uint8_t buf[],
size_t len)
override {
316 FD_SET(m_socket, &read_set);
318 struct timeval timeout = make_timeout_tv();
319 int active = ::select(
static_cast<int>(m_socket + 1), &read_set,
nullptr,
nullptr, &timeout);
322 throw System_Error(
"Timeout during socket read");
325 socket_op_ret_type got = ::recv(m_socket, cast_uint8_ptr_to_char(buf),
static_cast<sendrecv_len_type
>(len), 0);
328 throw System_Error(
"Socket read failed", errno);
331 return static_cast<size_t>(got);
335 struct timeval make_timeout_tv() const {
337 tv.tv_sec =
static_cast<decltype(timeval::tv_sec)
>(m_timeout.count() / 1000000);
338 tv.tv_usec =
static_cast<decltype(timeval::tv_usec)
>(m_timeout.count() % 1000000);
342 const std::chrono::microseconds m_timeout;
343 socket_type m_socket;
351 std::string_view service,
352 std::chrono::milliseconds timeout) {
353#if defined(BOTAN_HAS_BOOST_ASIO)
354 return std::make_unique<Asio_Socket>(hostname, service, timeout);
356#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
357 return std::make_unique<BSD_Socket>(hostname, service, timeout);
362 return std::unique_ptr<Socket>();
std::unique_ptr< Socket > BOTAN_TEST_API open_socket(std::string_view hostname, std::string_view service, std::chrono::milliseconds timeout)
std::string fmt(std::string_view format, const T &... args)