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

randombit / botan / 13429216726

20 Feb 2025 06:22AM UTC coverage: 91.647% (+0.003%) from 91.644%
13429216726

Pull #4660

github

web-flow
Merge b720e7b81 into a2981b3c6
Pull Request #4660: Consolidation and Enhancement of BSD Socket Layer

95032 of 103694 relevant lines covered (91.65%)

11432150.21 hits per line

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

70.24
/src/cli/tls_server.cpp
1
/*
2
* TLS echo server using BSD sockets
3
* (C) 2014 Jack Lloyd
4
*     2017 René Korthaus, Rohde & Schwarz Cybersecurity
5
*     2023 René Meusel, Rohde & Schwarz Cybersecurity
6
      2025 Kagan Can Sit
7
*
8
* Botan is released under the Simplified BSD License (see license.txt)
9
*/
10

11
#include "cli.h"
12
#include "sandbox.h"
13

14
#include <botan/internal/target_info.h>
15

16
#if defined(BOTAN_TARGET_OS_HAS_SOCKETS)
17
   #include <sys/socket.h>
18
#endif
19

20
#if defined(BOTAN_HAS_TLS) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM) && defined(BOTAN_TARGET_OS_HAS_SOCKETS)
21

22
   #if defined(SO_MARK) || defined(SO_USER_COOKIE) || defined(SO_RTABLE)
23
      #if defined(SO_MARK)
24
         #define BOTAN_SO_SOCKETID SO_MARK
25
      #elif defined(SO_USER_COOKIE)
26
         #define BOTAN_SO_SOCKETID SO_USER_COOKIE
27
      #else
28
         #define BOTAN_SO_SOCKETID SO_RTABLE
29
      #endif
30
   #endif
31

32
   #include <botan/hex.h>
33
   #include <botan/mem_ops.h>
34
   #include <botan/tls_callbacks.h>
35
   #include <botan/tls_policy.h>
36
   #include <botan/tls_server.h>
37
   #include <botan/tls_session_manager_memory.h>
38

39
   #include <chrono>
40
   #include <fstream>
41
   #include <list>
42
   #include <memory>
43

44
   #include "socket_utils.h"
45
   #include "tls_helpers.h"
46

47
namespace Botan_CLI {
48

49
class TLS_Server;
50

51
namespace {
52

53
class Callbacks : public Botan::TLS::Callbacks {
1✔
54
   public:
55
      Callbacks(TLS_Server& server_command) : m_server_command(server_command) {}
1✔
56

57
      std::ostream& output();
58
      void send(std::span<const uint8_t> buffer);
59
      void push_pending_output(std::string line);
60

61
      void tls_session_established(const Botan::TLS::Session_Summary& session) override {
9✔
62
         output() << "Handshake complete, " << session.version().to_string() << " using "
9✔
63
                  << session.ciphersuite().to_string();
27✔
64

65
         if(const auto& psk = session.external_psk_identity()) {
9✔
66
            output() << " (utilized PSK identity: " << maybe_hex_encode(psk.value()) << ")";
6✔
67
         }
68

69
         output() << std::endl;
9✔
70

71
         if(const auto& session_id = session.session_id(); !session_id.empty()) {
9✔
72
            output() << "Session ID " << Botan::hex_encode(session_id.get()) << std::endl;
9✔
73
         }
74

75
         if(const auto& session_ticket = session.session_ticket()) {
9✔
76
            output() << "Session ticket " << Botan::hex_encode(session_ticket->get()) << std::endl;
×
77
         }
78
      }
9✔
79

80
      void tls_record_received(uint64_t /*seq_no*/, std::span<const uint8_t> input) override {
9✔
81
         for(size_t i = 0; i != input.size(); ++i) {
2,052✔
82
            const char c = static_cast<char>(input[i]);
2,043✔
83
            m_line_buf += c;
2,043✔
84
            if(c == '\n') {
2,043✔
85
               push_pending_output(std::exchange(m_line_buf, {}));
27✔
86
            }
87
         }
88
      }
9✔
89

90
      void tls_emit_data(std::span<const uint8_t> buf) override { send(buf); }
132✔
91

92
      void tls_alert(Botan::TLS::Alert alert) override { output() << "Alert: " << alert.type_string() << std::endl; }
18✔
93

94
      std::string tls_server_choose_app_protocol(const std::vector<std::string>& /*client_protos*/) override {
×
95
         // we ignore whatever the client sends here
96
         return "echo/0.1";
×
97
      }
98

99
      void tls_verify_raw_public_key(const Botan::Public_Key& raw_public_key,
×
100
                                     Botan::Usage_Type /* usage */,
101
                                     std::string_view /* hostname */,
102
                                     const Botan::TLS::Policy& /* policy */) override {
103
         const auto fingerprint = raw_public_key.fingerprint_public("SHA-256");
×
104
         output() << "received Raw Public Key (" << fingerprint << ")\n";
×
105
      }
×
106

107
   private:
108
      TLS_Server& m_server_command;
109
      std::string m_line_buf;
110
};
111

112
}  // namespace
113

114
class TLS_Server final : public Command {
115
   public:
116
   #if defined(BOTAN_SO_SOCKETID)
117
      TLS_Server() :
2✔
118
            Command(
119
               "tls_server cert-or-pubkey key --port=443 --psk= --psk-identity= --psk-prf=SHA-256 --type=tcp --policy=default --dump-traces= --max-clients=0 --socket-id=0")
4✔
120
   #else
121
      TLS_Server() :
122
            Command(
123
               "tls_server cert-or-pubkey key --port=443 --psk= --psk-identity= --psk-prf=SHA-256 --type=tcp --policy=default --dump-traces= --max-clients=0")
124
   #endif
125
      {
126
         Socket_Utils::init();
2✔
127
      }
2✔
128

129
      ~TLS_Server() override { Socket_Utils::cleanup(); }
4✔
130

131
      TLS_Server(const TLS_Server& other) = delete;
132
      TLS_Server(TLS_Server&& other) = delete;
133
      TLS_Server& operator=(const TLS_Server& other) = delete;
134
      TLS_Server& operator=(TLS_Server&& other) = delete;
135

136
      std::string group() const override { return "tls"; }
1✔
137

138
      std::string description() const override { return "Accept TLS/DTLS connections from TLS/DTLS clients"; }
1✔
139

140
      void go() override {
1✔
141
         const std::string server_cred = get_arg("cert-or-pubkey");
1✔
142
         const std::string server_key = get_arg("key");
1✔
143
         const uint16_t port = get_arg_u16("port");
1✔
144
         const size_t max_clients = get_arg_sz("max-clients");
1✔
145
         const std::string transport = get_arg("type");
1✔
146
         const std::string dump_traces_to = get_arg("dump-traces");
1✔
147
         auto psk = [this]() -> std::optional<Botan::secure_vector<uint8_t>> {
×
148
            auto psk_hex = get_arg_maybe("psk");
1✔
149
            if(psk_hex) {
1✔
150
               return Botan::hex_decode_locked(psk_hex.value());
1✔
151
            } else {
152
               return {};
×
153
            }
154
         }();
2✔
155
         const std::optional<std::string> psk_identity = get_arg_maybe("psk-identity");
1✔
156
         const std::optional<std::string> psk_prf = get_arg_maybe("psk-prf");
1✔
157

158
   #if defined(BOTAN_SO_SOCKETID)
159
         m_socket_id = static_cast<uint32_t>(get_arg_sz("socket-id"));
1✔
160
   #endif
161

162
         if(transport != "tcp" && transport != "udp") {
1✔
163
            throw CLI_Usage_Error("Invalid transport type '" + transport + "' for TLS");
×
164
         }
165

166
         m_is_tcp = (transport == "tcp");
1✔
167

168
         auto policy = load_tls_policy(get_arg("policy"));
2✔
169
         auto session_manager =
1✔
170
            std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng_as_shared());  // TODO sqlite3
2✔
171
         auto creds =
1✔
172
            std::make_shared<Basic_Credentials_Manager>(server_cred, server_key, std::move(psk), psk_identity, psk_prf);
1✔
173
         auto callbacks = std::make_shared<Callbacks>(*this);
1✔
174

175
         if(!m_sandbox.init()) {
1✔
176
            error_output() << "Failed sandboxing\n";
×
177
            return;
×
178
         }
179

180
         socket_type server_fd = make_server_socket(port);
1✔
181
         size_t clients_served = 0;
1✔
182

183
         output() << "Listening for new connections on " << transport << " port " << port << std::endl;
1✔
184

185
         while(true) {
21✔
186
            if(max_clients > 0 && clients_served >= max_clients) {
11✔
187
               break;
188
            }
189

190
            if(m_is_tcp) {
10✔
191
               m_socket = ::accept(server_fd, nullptr, nullptr);
10✔
192
            } else {
193
               struct sockaddr_in from;
×
194
               socklen_t from_len = sizeof(sockaddr_in);
×
195

196
               void* peek_buf = nullptr;
×
197
               size_t peek_len = 0;
×
198

199
   #if defined(BOTAN_TARGET_OS_IS_MACOS)
200
               // macOS handles zero size buffers differently - it will return 0 even if there's no incoming data,
201
               // and after that connect() will fail as sockaddr_in from is not initialized
202
               int dummy;
203
               peek_buf = &dummy;
204
               peek_len = sizeof(dummy);
205
   #endif
206

207
               if(::recvfrom(server_fd,
×
208
                             static_cast<char*>(peek_buf),
209
                             static_cast<sendrecv_len_type>(peek_len),
210
                             MSG_PEEK,
211
                             reinterpret_cast<struct sockaddr*>(&from),
212
                             &from_len) != 0) {
213
                  throw CLI_Error("Could not peek next packet");
×
214
               }
215

216
               if(::connect(server_fd, reinterpret_cast<struct sockaddr*>(&from), from_len) != 0) {
×
217
                  throw CLI_Error("Could not connect UDP socket");
×
218
               }
219
               m_socket = server_fd;
×
220
            }
221

222
            clients_served++;
10✔
223

224
            Botan::TLS::Server server(callbacks, session_manager, creds, policy, rng_as_shared(), m_is_tcp == false);
60✔
225

226
            std::unique_ptr<std::ostream> dump_stream;
10✔
227

228
            if(!dump_traces_to.empty()) {
10✔
229
               auto now = std::chrono::system_clock::now().time_since_epoch();
×
230
               uint64_t timestamp = std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
×
231
               const std::string dump_file = dump_traces_to + "/tls_" + std::to_string(timestamp) + ".bin";
×
232
               dump_stream = std::make_unique<std::ofstream>(dump_file.c_str());
×
233
            }
×
234

235
            try {
236
               while(!server.is_closed()) {
54✔
237
                  try {
44✔
238
                     uint8_t buf[4 * 1024] = {0};
44✔
239
                     ssize_t got = ::recv(m_socket, Botan::cast_uint8_ptr_to_char(buf), sizeof(buf), 0);
44✔
240

241
                     if(got == -1) {
44✔
242
                        error_output() << "Error in socket read - " << Socket_Utils::get_last_error() << std::endl;
×
243
                        break;
×
244
                     }
245

246
                     if(got == 0) {
44✔
247
                        error_output() << "EOF on socket" << std::endl;
×
248
                        break;
249
                     }
250

251
                     if(dump_stream) {
44✔
252
                        dump_stream->write(reinterpret_cast<const char*>(buf), got);
×
253
                     }
254

255
                     server.received_data(buf, got);
44✔
256

257
                     while(server.is_active() && !m_pending_output.empty()) {
52✔
258
                        std::string output = m_pending_output.front();
9✔
259
                        m_pending_output.pop_front();
9✔
260
                        server.send(output);
9✔
261

262
                        if(output == "quit\n") {
9✔
263
                           server.close();
×
264
                        }
265
                     }
9✔
266
                  } catch(std::exception& e) {
1✔
267
                     error_output() << "Connection problem: " << e.what() << std::endl;
1✔
268
                     if(m_is_tcp) {
1✔
269
                        Socket_Utils::close_socket(m_socket);
1✔
270
                        m_socket = Socket_Utils::invalid_socket();
1✔
271
                     }
272
                  }
1✔
273
               }
274
            } catch(Botan::Exception& e) {
×
275
               error_output() << "Connection failed: " << e.what() << "\n";
×
276
            }
×
277

278
            if(m_is_tcp) {
10✔
279
               Socket_Utils::close_socket(m_socket);
10✔
280
               m_socket = Socket_Utils::invalid_socket();
10✔
281
            }
282
         }
10✔
283

284
         Socket_Utils::close_socket(server_fd);
2✔
285
      }
6✔
286

287
   public:
288
      using Command::flag_set;
289
      using Command::output;
290

291
      void send(std::span<const uint8_t> buf) {
66✔
292
         if(m_is_tcp) {
66✔
293
            ssize_t sent = ::send(m_socket, buf.data(), static_cast<sendrecv_len_type>(buf.size()), MSG_NOSIGNAL);
66✔
294

295
            if(sent == -1) {
66✔
296
               error_output() << "Error writing to socket - " << Socket_Utils::get_last_error() << std::endl;
×
297
            } else if(sent != static_cast<ssize_t>(buf.size())) {
66✔
298
               error_output() << "Packet of length " << buf.size() << " truncated to " << sent << std::endl;
×
299
            }
300
         } else {
301
            while(!buf.empty()) {
×
302
               ssize_t sent = ::send(m_socket, buf.data(), static_cast<sendrecv_len_type>(buf.size()), MSG_NOSIGNAL);
×
303

304
               if(sent == -1) {
×
305
                  if(errno == EINTR) {
×
306
                     sent = 0;
307
                  } else {
308
                     throw CLI_Error("Socket write failed");
×
309
                  }
310
               }
311

312
               buf = buf.subspan(sent);
×
313
            }
314
         }
315
      }
66✔
316

317
      void push_pending_output(std::string line) { m_pending_output.emplace_back(std::move(line)); }
9✔
318

319
   private:
320
      // Import socket operation types from Socket_Platform namespace
321
      using socket_type = Socket_Utils::socket_type;
322
      using socket_op_ret_type = Socket_Utils::socket_op_ret_type;
323
      using socklen_type = Socket_Utils::socklen_type;
324
      using sendrecv_len_type = Socket_Utils::sendrecv_len_type;
325

326
      socket_type make_server_socket(uint16_t port) {
1✔
327
         const int type = m_is_tcp ? SOCK_STREAM : SOCK_DGRAM;
1✔
328

329
         socket_type fd = ::socket(PF_INET, type, 0);
1✔
330
         if(fd == Socket_Utils::invalid_socket()) {
1✔
331
            throw CLI_Error("Unable to acquire socket");
×
332
         }
333

334
         sockaddr_in socket_info;
1✔
335
         Botan::clear_mem(&socket_info, 1);
1✔
336
         socket_info.sin_family = AF_INET;
1✔
337
         socket_info.sin_port = htons(port);
1✔
338

339
         // FIXME: support limiting listeners
340
         socket_info.sin_addr.s_addr = INADDR_ANY;
1✔
341

342
         if(::bind(fd, reinterpret_cast<struct sockaddr*>(&socket_info), sizeof(struct sockaddr)) != 0) {
1✔
343
            Socket_Utils::close_socket(fd);
×
344
            throw CLI_Error("server bind failed");
×
345
         }
346

347
         if(m_is_tcp) {
1✔
348
            constexpr int backlog = std::min(100, SOMAXCONN);
1✔
349
            if(::listen(fd, backlog) != 0) {
1✔
350
               Socket_Utils::close_socket(fd);
×
351
               throw CLI_Error("listen failed");
×
352
            }
353
         }
354
         if(m_socket_id > 0) {
1✔
355
   #if defined(BOTAN_SO_SOCKETID)
356
            if(::setsockopt(fd,
×
357
                            SOL_SOCKET,
358
                            BOTAN_SO_SOCKETID,
359
                            reinterpret_cast<const void*>(&m_socket_id),
×
360
                            sizeof(m_socket_id)) != 0) {
361
               // Failed but not world-ending issue
362
               output() << "set socket identifier setting failed" << std::endl;
×
363
            }
364
   #endif
365
         }
366
         return fd;
1✔
367
      }
368

369
      socket_type m_socket = Socket_Utils::invalid_socket();
370
      bool m_is_tcp = false;
371
      uint32_t m_socket_id = 0;
372
      std::list<std::string> m_pending_output;
373
      Sandbox m_sandbox;
374
};
375

376
namespace {
377

378
std::ostream& Callbacks::output() {
38✔
379
   return m_server_command.output();
38✔
380
}
381

382
void Callbacks::send(std::span<const uint8_t> buffer) {
66✔
383
   m_server_command.send(buffer);
66✔
384
}
385

386
void Callbacks::push_pending_output(std::string line) {
9✔
387
   m_server_command.push_pending_output(std::move(line));
18✔
388
}
9✔
389

390
}  // namespace
391

392
BOTAN_REGISTER_COMMAND("tls_server", TLS_Server);
2✔
393

394
}  // namespace Botan_CLI
395

396
#endif
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