8#include <botan/internal/socket.h>
10#include <botan/exceptn.h>
11#include <botan/mem_ops.h>
12#include <botan/internal/fmt.h>
15#if defined(BOTAN_HAS_BOOST_ASIO)
21 #define BOOST_ASIO_DISABLE_SERIAL_PORT
22 #include <boost/asio.hpp>
23 #include <boost/asio/system_timer.hpp>
25#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS)
29 #include <netinet/in.h>
31 #include <sys/socket.h>
35#elif defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
43#if defined(BOTAN_HAS_BOOST_ASIO)
45class Asio_Socket
final :
public OS::Socket {
47 Asio_Socket(std::string_view hostname, std::string_view service, std::chrono::milliseconds timeout) :
48 m_timeout(timeout), m_timer(m_io), m_tcp(m_io) {
49 m_timer.expires_after(m_timeout);
52 boost::asio::ip::tcp::resolver resolver(m_io);
53 boost::asio::ip::tcp::resolver::results_type dns_iter =
54 resolver.resolve(std::string{hostname}, std::string{service});
56 boost::system::error_code ec = boost::asio::error::would_block;
58 auto connect_cb = [&ec](
const boost::system::error_code& e,
const auto&) { ec = e; };
60 boost::asio::async_connect(m_tcp, dns_iter.begin(), dns_iter.end(), connect_cb);
62 while(ec == boost::asio::error::would_block) {
67 throw boost::system::system_error(ec);
69 if(m_tcp.is_open() ==
false) {
70 throw System_Error(
fmt(
"Connection to host {} failed", hostname));
74 void write(
const uint8_t buf[],
size_t len)
override {
75 m_timer.expires_after(m_timeout);
77 boost::system::error_code ec = boost::asio::error::would_block;
79 m_tcp.async_send(boost::asio::buffer(buf, len), [&ec](boost::system::error_code e,
size_t) { ec = e; });
81 while(ec == boost::asio::error::would_block) {
86 throw boost::system::system_error(ec);
90 size_t read(uint8_t buf[],
size_t len)
override {
91 m_timer.expires_after(m_timeout);
93 boost::system::error_code ec = boost::asio::error::would_block;
96 m_tcp.async_read_some(boost::asio::buffer(buf, len), [&](boost::system::error_code cb_ec,
size_t cb_got) {
101 while(ec == boost::asio::error::would_block) {
106 if(ec == boost::asio::error::eof) {
109 throw boost::system::system_error(ec);
116 void check_timeout() {
117 if(m_tcp.is_open() && m_timer.expiry() < std::chrono::system_clock::now()) {
118 boost::system::error_code err;
124 m_timer.async_wait(std::bind(&Asio_Socket::check_timeout,
this));
127 const std::chrono::milliseconds m_timeout;
128 boost::asio::io_context m_io;
129 boost::asio::system_timer m_timer;
130 boost::asio::ip::tcp::socket m_tcp;
133#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
135class BSD_Socket
final :
public OS::Socket {
137 #if defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
138 typedef SOCKET socket_type;
139 typedef int socket_op_ret_type;
140 typedef int socklen_type;
141 typedef int sendrecv_len_type;
143 static socket_type invalid_socket() {
return INVALID_SOCKET; }
145 static void close_socket(socket_type s) { ::closesocket(s); }
147 static std::string get_last_socket_error() {
return std::to_string(::WSAGetLastError()); }
149 static bool nonblocking_connect_in_progress() {
return (::WSAGetLastError() == WSAEWOULDBLOCK); }
151 static void set_nonblocking(socket_type s) {
152 u_long nonblocking = 1;
153 ::ioctlsocket(s, FIONBIO, &nonblocking);
156 static void socket_init() {
158 WORD wsa_version = MAKEWORD(2, 2);
160 if(::WSAStartup(wsa_version, &wsa_data) != 0) {
161 throw System_Error(
"WSAStartup() failed", WSAGetLastError());
164 if(LOBYTE(wsa_data.wVersion) != 2 || HIBYTE(wsa_data.wVersion) != 2) {
166 throw System_Error(
"Could not find a usable version of Winsock.dll");
170 static void socket_fini() { ::WSACleanup(); }
172 typedef int socket_type;
173 typedef ssize_t socket_op_ret_type;
174 typedef socklen_t socklen_type;
175 typedef size_t sendrecv_len_type;
177 static socket_type invalid_socket() {
return -1; }
179 static void close_socket(socket_type s) { ::close(s); }
181 static std::string get_last_socket_error() { return ::strerror(errno); }
183 static bool nonblocking_connect_in_progress() {
return (errno == EINPROGRESS); }
185 static void set_nonblocking(socket_type s) {
186 if(::fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
187 throw System_Error(
"Setting socket to non-blocking state failed", errno);
191 static void socket_init() {}
193 static void socket_fini() {}
197 BSD_Socket(std::string_view hostname, std::string_view service, std::chrono::microseconds timeout) :
201 m_socket = invalid_socket();
204 clear_mem(&hints, 1);
205 hints.ai_family = AF_UNSPEC;
206 hints.ai_socktype = SOCK_STREAM;
209 const std::string hostname_str(hostname);
210 const std::string service_str(service);
212 int rc = ::getaddrinfo(hostname_str.c_str(), service_str.c_str(), &hints, &res);
215 throw System_Error(fmt(
"Name resolution failed for {}", hostname), rc);
218 for(addrinfo* rp = res; (m_socket == invalid_socket()) && (rp !=
nullptr); rp = rp->ai_next) {
219 if(rp->ai_family != AF_INET && rp->ai_family != AF_INET6) {
223 m_socket = ::socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
225 if(m_socket == invalid_socket()) {
230 set_nonblocking(m_socket);
232 int err = ::connect(m_socket, rp->ai_addr,
static_cast<socklen_type
>(rp->ai_addrlen));
236 if(nonblocking_connect_in_progress()) {
237 struct timeval timeout_tv = make_timeout_tv();
241 FD_SET(
static_cast<int>(m_socket), &write_set);
243 active = ::select(
static_cast<int>(m_socket + 1),
nullptr, &write_set,
nullptr, &timeout_tv);
246 int socket_error = 0;
247 socklen_t len =
sizeof(socket_error);
249 if(::getsockopt(m_socket, SOL_SOCKET, SO_ERROR,
reinterpret_cast<char*
>(&socket_error), &len) <
251 throw System_Error(
"Error calling getsockopt", errno);
254 if(socket_error != 0) {
261 close_socket(m_socket);
262 m_socket = invalid_socket();
270 if(m_socket == invalid_socket()) {
271 throw System_Error(fmt(
"Connecting to {} for service {} failed with errno {}", hostname, service, errno),
276 ~BSD_Socket()
override {
277 close_socket(m_socket);
278 m_socket = invalid_socket();
282 BSD_Socket(
const BSD_Socket& other) =
delete;
283 BSD_Socket(BSD_Socket&& other) =
delete;
284 BSD_Socket& operator=(
const BSD_Socket& other) =
delete;
285 BSD_Socket& operator=(BSD_Socket&& other) =
delete;
287 void write(
const uint8_t buf[],
size_t len)
override {
290 FD_SET(m_socket, &write_set);
292 size_t sent_so_far = 0;
293 while(sent_so_far != len) {
294 struct timeval timeout = make_timeout_tv();
295 int active = ::select(
static_cast<int>(m_socket + 1),
nullptr, &write_set,
nullptr, &timeout);
298 throw System_Error(
"Timeout during socket write");
301 const size_t left = len - sent_so_far;
302 socket_op_ret_type sent =
303 ::send(m_socket, cast_uint8_ptr_to_char(&buf[sent_so_far]),
static_cast<sendrecv_len_type
>(left), 0);
305 throw System_Error(
"Socket write failed", errno);
307 sent_so_far +=
static_cast<size_t>(sent);
312 size_t read(uint8_t buf[],
size_t len)
override {
315 FD_SET(m_socket, &read_set);
317 struct timeval timeout = make_timeout_tv();
318 int active = ::select(
static_cast<int>(m_socket + 1), &read_set,
nullptr,
nullptr, &timeout);
321 throw System_Error(
"Timeout during socket read");
324 socket_op_ret_type got = ::recv(m_socket, cast_uint8_ptr_to_char(buf),
static_cast<sendrecv_len_type
>(len), 0);
327 throw System_Error(
"Socket read failed", errno);
330 return static_cast<size_t>(got);
334 struct timeval make_timeout_tv() const {
336 tv.tv_sec =
static_cast<decltype(timeval::tv_sec)
>(m_timeout.count() / 1000000);
337 tv.tv_usec =
static_cast<decltype(timeval::tv_usec)
>(m_timeout.count() % 1000000);
341 const std::chrono::microseconds m_timeout;
342 socket_type m_socket;
350 std::string_view service,
351 std::chrono::milliseconds timeout) {
352#if defined(BOTAN_HAS_BOOST_ASIO)
353 return std::make_unique<Asio_Socket>(hostname, service, timeout);
355#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
356 return std::make_unique<BSD_Socket>(hostname, service, timeout);
361 return std::unique_ptr<Socket>();
int(* final)(unsigned char *, CTX *)
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)