• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

randombit / botan / 21031897445

15 Jan 2026 12:50PM UTC coverage: 90.037% (-0.4%) from 90.395%
21031897445

Pull #5240

github

web-flow
Merge 13ffffdd5 into 32478179d
Pull Request #5240: Some changes to reduce time taken by the coverage build

102027 of 113317 relevant lines covered (90.04%)

11676540.94 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

46.94
/src/lib/utils/socket/socket.cpp
1
/*
2
* (C) 2015,2016,2017 Jack Lloyd
3
* (C) 2016 Daniel Neus
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/internal/socket.h>
9

10
#include <botan/exceptn.h>
11
#include <botan/mem_ops.h>
12
#include <botan/internal/fmt.h>
13
#include <botan/internal/target_info.h>
14
#include <chrono>
15

16
#if defined(BOTAN_HAS_BOOST_ASIO)
17
   /*
18
  * We don't need serial port support anyway, and asking for it causes
19
  * macro conflicts with termios.h when this file is included in the
20
  * amalgamation.
21
  */
22
   #define BOOST_ASIO_DISABLE_SERIAL_PORT
23
   #include <boost/asio.hpp>
24
   #include <boost/asio/system_timer.hpp>
25

26
#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS)
27
   #include <errno.h>
28
   #include <fcntl.h>
29
   #include <netdb.h>
30
   #include <netinet/in.h>
31
   #include <string.h>
32
   #include <sys/socket.h>
33
   #include <sys/time.h>
34
   #include <unistd.h>
35

36
#elif defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
37
   #include <ws2tcpip.h>
38
#endif
39

40
namespace Botan {
41

42
namespace {
43

44
#if defined(BOTAN_HAS_BOOST_ASIO)
45

46
class Asio_Socket final : public OS::Socket {
×
47
   public:
48
      Asio_Socket(std::string_view hostname, std::string_view service, std::chrono::milliseconds timeout) :
1✔
49
            m_timeout(timeout), m_timer(m_io), m_tcp(m_io) {
2✔
50
         m_timer.expires_after(m_timeout);
1✔
51
         check_timeout();
1✔
52

53
         boost::asio::ip::tcp::resolver resolver(m_io);
1✔
54
         const boost::asio::ip::tcp::resolver::results_type dns_iter =
1✔
55
            resolver.resolve(std::string{hostname}, std::string{service});
4✔
56

57
         boost::system::error_code ec = boost::asio::error::would_block;
1✔
58

59
         auto connect_cb = [&ec](const boost::system::error_code& e, const auto&) { ec = e; };
1✔
60

61
         boost::asio::async_connect(m_tcp, dns_iter.begin(), dns_iter.end(), connect_cb);
3✔
62

63
         while(ec == boost::asio::error::would_block) {
3✔
64
            m_io.run_one();
2✔
65
         }
66

67
         if(ec) {
1✔
68
            throw boost::system::system_error(ec);
1✔
69
         }
70
         if(!m_tcp.is_open()) {
×
71
            throw System_Error(fmt("Connection to host {} failed", hostname));
×
72
         }
73
      }
2✔
74

75
      void write(std::span<const uint8_t> buf) override {
×
76
         m_timer.expires_after(m_timeout);
×
77

78
         boost::system::error_code ec = boost::asio::error::would_block;
×
79

80
         // Some versions of asio don't know about span...
81
         m_tcp.async_send(boost::asio::buffer(buf.data(), buf.size()),
×
82
                          [&ec](boost::system::error_code e, size_t) { ec = e; });
×
83

84
         while(ec == boost::asio::error::would_block) {
×
85
            m_io.run_one();
×
86
         }
87

88
         if(ec) {
×
89
            throw boost::system::system_error(ec);
×
90
         }
91
      }
×
92

93
      size_t read(uint8_t buf[], size_t len) override {
×
94
         m_timer.expires_after(m_timeout);
×
95

96
         boost::system::error_code ec = boost::asio::error::would_block;
×
97
         size_t got = 0;
×
98

99
         m_tcp.async_read_some(boost::asio::buffer(buf, len), [&](boost::system::error_code cb_ec, size_t cb_got) {
×
100
            ec = cb_ec;
×
101
            got = cb_got;
×
102
         });
103

104
         while(ec == boost::asio::error::would_block) {
×
105
            m_io.run_one();
×
106
         }
107

108
         if(ec) {
×
109
            if(ec == boost::asio::error::eof) {
×
110
               return 0;
111
            }
112
            throw boost::system::system_error(ec);  // Some other error.
×
113
         }
114

115
         return got;
×
116
      }
117

118
   private:
119
      void check_timeout() {
2✔
120
         if(m_tcp.is_open() && m_timer.expiry() < std::chrono::system_clock::now()) {
2✔
121
            boost::system::error_code err;
1✔
122

123
            // NOLINTNEXTLINE(bugprone-unused-return-value,cert-err33-c)
124
            m_tcp.close(err);
1✔
125
         }
126

127
         // NOLINTNEXTLINE(*-avoid-bind) FIXME - unclear why we can't use a lambda here
128
         m_timer.async_wait(std::bind(&Asio_Socket::check_timeout, this));
2✔
129
      }
2✔
130

131
      const std::chrono::milliseconds m_timeout;
132
      boost::asio::io_context m_io;
133
      boost::asio::system_timer m_timer;
134
      boost::asio::ip::tcp::socket m_tcp;
135
};
136

137
#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
138

139
class BSD_Socket final : public OS::Socket {
140
   private:
141
   #if defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
142
      typedef SOCKET socket_type;
143
      typedef int socket_op_ret_type;
144
      typedef int socklen_type;
145
      typedef int sendrecv_len_type;
146

147
      static socket_type invalid_socket() { return INVALID_SOCKET; }
148

149
      static void close_socket(socket_type s) { ::closesocket(s); }
150

151
      static std::string get_last_socket_error() { return std::to_string(::WSAGetLastError()); }
152

153
      static bool nonblocking_connect_in_progress() { return (::WSAGetLastError() == WSAEWOULDBLOCK); }
154

155
      static void set_nonblocking(socket_type s) {
156
         u_long nonblocking = 1;
157
         ::ioctlsocket(s, FIONBIO, &nonblocking);
158
      }
159

160
      static void socket_init() {
161
         WSAData wsa_data;
162
         WORD wsa_version = MAKEWORD(2, 2);
163

164
         if(::WSAStartup(wsa_version, &wsa_data) != 0) {
165
            throw System_Error("WSAStartup() failed", WSAGetLastError());
166
         }
167

168
         if(LOBYTE(wsa_data.wVersion) != 2 || HIBYTE(wsa_data.wVersion) != 2) {
169
            ::WSACleanup();
170
            throw System_Error("Could not find a usable version of Winsock.dll");
171
         }
172
      }
173

174
      static void socket_fini() { ::WSACleanup(); }
175
   #else
176
      typedef int socket_type;
177
      typedef ssize_t socket_op_ret_type;
178
      typedef socklen_t socklen_type;
179
      typedef size_t sendrecv_len_type;
180

181
      static socket_type invalid_socket() { return -1; }
182

183
      static void close_socket(socket_type s) { ::close(s); }
184

185
      static std::string get_last_socket_error() { return ::strerror(errno); }
186

187
      static bool nonblocking_connect_in_progress() { return (errno == EINPROGRESS); }
188

189
      static void set_nonblocking(socket_type s) {
190
         // NOLINTNEXTLINE(*-vararg)
191
         if(::fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
192
            throw System_Error("Setting socket to non-blocking state failed", errno);
193
         }
194
      }
195

196
      static void socket_init() {}
197

198
      static void socket_fini() {}
199
   #endif
200

201
   public:
202
      BSD_Socket(std::string_view hostname, std::string_view service, std::chrono::microseconds timeout) :
203
            m_timeout(timeout), m_socket(invalid_socket()) {
204
         socket_init();
205

206
         addrinfo hints{};
207
         hints.ai_family = AF_UNSPEC;
208
         hints.ai_socktype = SOCK_STREAM;
209
         addrinfo* res = nullptr;
210

211
         const std::string hostname_str(hostname);
212
         const std::string service_str(service);
213

214
         const int rc = ::getaddrinfo(hostname_str.c_str(), service_str.c_str(), &hints, &res);
215

216
         if(rc != 0) {
217
            throw System_Error(fmt("Name resolution failed for {}", hostname), rc);
218
         }
219

220
         for(const addrinfo* rp = res; (m_socket == invalid_socket()) && (rp != nullptr); rp = rp->ai_next) {
221
            if(rp->ai_family != AF_INET && rp->ai_family != AF_INET6) {
222
               continue;
223
            }
224

225
            m_socket = ::socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
226

227
            if(m_socket == invalid_socket()) {
228
               // unsupported socket type?
229
               continue;
230
            }
231

232
            set_nonblocking(m_socket);
233

234
            const int err = ::connect(m_socket, rp->ai_addr, static_cast<socklen_type>(rp->ai_addrlen));
235

236
            if(err == -1) {
237
               int active = 0;
238
               if(nonblocking_connect_in_progress()) {
239
                  struct timeval timeout_tv = make_timeout_tv();
240
                  fd_set write_set;
241
                  FD_ZERO(&write_set);
242
                  FD_SET(m_socket, &write_set);
243

244
                  active = ::select(static_cast<int>(m_socket + 1), nullptr, &write_set, nullptr, &timeout_tv);
245

246
                  if(active > 0) {
247
                     int socket_error = 0;
248
                     socklen_t len = sizeof(socket_error);
249

250
                     if(::getsockopt(m_socket, SOL_SOCKET, SO_ERROR, reinterpret_cast<char*>(&socket_error), &len) <
251
                        0) {
252
                        throw System_Error("Error calling getsockopt", errno);
253
                     }
254

255
                     if(socket_error != 0) {
256
                        active = 0;
257
                     }
258
                  }
259
               }
260

261
               if(active == 0) {
262
                  close_socket(m_socket);
263
                  m_socket = invalid_socket();
264
                  continue;
265
               }
266
            }
267
         }
268

269
         ::freeaddrinfo(res);
270

271
         if(m_socket == invalid_socket()) {
272
            throw System_Error(fmt("Connecting to {} for service {} failed with errno {}", hostname, service, errno),
273
                               errno);
274
         }
275
      }
276

277
      ~BSD_Socket() override {
278
         close_socket(m_socket);
279
         m_socket = invalid_socket();
280
         socket_fini();
281
      }
282

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;
287

288
      void write(std::span<const uint8_t> buf) override {
289
         fd_set write_set;
290
         FD_ZERO(&write_set);
291
         FD_SET(m_socket, &write_set);
292

293
         const size_t len = buf.size();
294

295
         size_t sent_so_far = 0;
296
         while(sent_so_far != len) {
297
            struct timeval timeout = make_timeout_tv();
298
            const int active = ::select(static_cast<int>(m_socket + 1), nullptr, &write_set, nullptr, &timeout);
299

300
            if(active == 0) {
301
               throw System_Error("Timeout during socket write");
302
            }
303

304
            const size_t left = len - sent_so_far;
305
            const socket_op_ret_type sent =
306
               ::send(m_socket, cast_uint8_ptr_to_char(&buf[sent_so_far]), static_cast<sendrecv_len_type>(left), 0);
307
            if(sent < 0) {
308
               throw System_Error("Socket write failed", errno);
309
            } else {
310
               sent_so_far += static_cast<size_t>(sent);
311
            }
312
         }
313
      }
314

315
      size_t read(uint8_t buf[], size_t len) override {
316
         fd_set read_set;
317
         FD_ZERO(&read_set);
318
         FD_SET(m_socket, &read_set);
319

320
         struct timeval timeout = make_timeout_tv();
321
         const int active = ::select(static_cast<int>(m_socket + 1), &read_set, nullptr, nullptr, &timeout);
322

323
         if(active == 0) {
324
            throw System_Error("Timeout during socket read");
325
         }
326

327
         const socket_op_ret_type got =
328
            ::recv(m_socket, cast_uint8_ptr_to_char(buf), static_cast<sendrecv_len_type>(len), 0);
329

330
         if(got < 0) {
331
            throw System_Error("Socket read failed", errno);
332
         }
333

334
         return static_cast<size_t>(got);
335
      }
336

337
   private:
338
      struct timeval make_timeout_tv() const {
339
         struct timeval tv {};
340

341
         tv.tv_sec = static_cast<decltype(timeval::tv_sec)>(m_timeout.count() / 1000000);
342
         tv.tv_usec = static_cast<decltype(timeval::tv_usec)>(m_timeout.count() % 1000000);
343
         return tv;
344
      }
345

346
      const std::chrono::microseconds m_timeout;
347
      socket_type m_socket;
348
};
349

350
#endif
351

352
}  // namespace
353

354
std::unique_ptr<OS::Socket> OS::open_socket(std::string_view hostname,
1✔
355
                                            std::string_view service,
356
                                            std::chrono::milliseconds timeout) {
357
#if defined(BOTAN_HAS_BOOST_ASIO)
358
   return std::make_unique<Asio_Socket>(hostname, service, timeout);
1✔
359

360
#elif defined(BOTAN_TARGET_OS_HAS_SOCKETS) || defined(BOTAN_TARGET_OS_HAS_WINSOCK2)
361
   return std::make_unique<BSD_Socket>(hostname, service, timeout);
362

363
#else
364
   BOTAN_UNUSED(hostname, service, timeout);
365
   // No sockets for you
366
   return std::unique_ptr<Socket>();
367
#endif
368
}
369

370
}  // namespace Botan
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc