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

randombit / botan / 20304984263

17 Dec 2025 01:46PM UTC coverage: 90.528% (+0.2%) from 90.358%
20304984263

Pull #5167

github

web-flow
Merge fc6e5fe09 into 3d96b675e
Pull Request #5167: Changes to reduce unnecessary inclusions

101179 of 111766 relevant lines covered (90.53%)

12666117.35 hits per line

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

83.49
/src/cli/tls_proxy.cpp
1
/*
2
* TLS Server Proxy
3
* (C) 2014,2015,2019 Jack Lloyd
4
* (C) 2016 Matthias Gierlings
5
* (C) 2023 René Meusel, Rohde & Schwarz Cybersecurity
6
*
7
* Botan is released under the Simplified BSD License (see license.txt)
8
*/
9

10
#include "cli.h"
11

12
#if defined(BOTAN_HAS_TLS) && defined(BOTAN_HAS_BOOST_ASIO) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
13

14
   #include <atomic>
15
   #include <iostream>
16
   #include <string>
17
   #include <thread>
18
   #include <utility>
19
   #include <vector>
20

21
   #include <boost/asio.hpp>
22
   #include <boost/bind.hpp>
23

24
   #include <botan/hex.h>
25
   #include <botan/pkcs8.h>
26
   #include <botan/rng.h>
27
   #include <botan/tls_callbacks.h>
28
   #include <botan/tls_server.h>
29
   #include <botan/tls_session_manager_memory.h>
30
   #include <botan/x509cert.h>
31

32
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
33
      #include <botan/tls_session_manager_sqlite.h>
34
   #endif
35

36
   #if defined(BOTAN_HAS_OS_UTILS)
37
      #include <botan/internal/os_utils.h>
38
   #endif
39

40
   #include "tls_helpers.h"
41

42
namespace Botan_CLI {
43

44
namespace {
45

46
// NOLINTBEGIN(*-avoid-endl,*-avoid-bind)
47

48
using boost::asio::ip::tcp;
49

50
template <typename T>
51
boost::asio::io_context& get_io_service(T& s) {
4✔
52
   #if BOOST_VERSION >= 107000
53
   //NOLINTNEXTLINE(*-type-static-cast-downcast)
54
   return static_cast<boost::asio::io_context&>((s).get_executor().context());
4✔
55
   #else
56
   return s.get_io_service();
57
   #endif
58
}
59

60
void log_info(const std::string& msg) {
1✔
61
   std::cout << msg << std::endl;
1✔
62
}
1✔
63

64
void log_exception(const char* where, const std::exception& e) {
×
65
   std::cout << where << ' ' << e.what() << std::endl;
×
66
}
×
67

68
void log_error(const char* where, const boost::system::error_code& error) {
8✔
69
   std::cout << where << ' ' << error.message() << std::endl;
16✔
70
}
8✔
71

72
void log_error(const char* msg) {
×
73
   std::cout << msg << std::endl;
×
74
}
×
75

76
void log_binary_message(const char* where, const uint8_t buf[], size_t buf_len) {
77
   BOTAN_UNUSED(where, buf, buf_len);
25✔
78
   //std::cout << where << ' ' << Botan::hex_encode(buf, buf_len) << std::endl;
79
}
80

81
void log_text_message(const char* where, const uint8_t buf[], size_t buf_len) {
82
   BOTAN_UNUSED(where, buf, buf_len);
8✔
83
   //const char* c = reinterpret_cast<const char*>(buf);
84
   //std::cout << where << ' ' << std::string(c, c + buf_len)  << std::endl;
85
}
86

87
class ServerStatus {
88
   public:
89
      explicit ServerStatus(size_t max_clients) : m_max_clients(max_clients), m_clients_serviced(0) {}
1✔
90

91
      bool should_exit() const {
4✔
92
         if(m_max_clients == 0) {
4✔
93
            return false;
94
         }
95

96
         return clients_serviced() >= m_max_clients;
4✔
97
      }
98

99
      void client_serviced() { m_clients_serviced++; }
4✔
100

101
      size_t clients_serviced() const { return m_clients_serviced.load(); }
4✔
102

103
   private:
104
      size_t m_max_clients;
105
      std::atomic<size_t> m_clients_serviced;
106
};
107

108
class tls_proxy_session final : public std::enable_shared_from_this<tls_proxy_session>,
109
                                public Botan::TLS::Callbacks {
110
   public:
111
      static constexpr size_t readbuf_size = 17 * 1024;
112

113
      typedef std::shared_ptr<tls_proxy_session> pointer;
114

115
      static pointer create(boost::asio::io_context& io,
4✔
116
                            const std::shared_ptr<Botan::TLS::Session_Manager>& session_manager,
117
                            const std::shared_ptr<Botan::Credentials_Manager>& credentials,
118
                            const std::shared_ptr<Botan::TLS::Policy>& policy,
119
                            const tcp::resolver::results_type& endpoints) {
120
         auto session = std::make_shared<tls_proxy_session>(io, endpoints);
4✔
121

122
         // Defer the setup of the TLS server to make use of
123
         // shared_from_this() which wouldn't work in the c'tor.
124
         session->setup(session_manager, credentials, policy);
4✔
125

126
         return session;
4✔
127
      }
×
128

129
      tcp::socket& client_socket() { return m_client_socket; }
130

131
      void start() {
4✔
132
         m_c2p.resize(readbuf_size);
4✔
133
         client_read(boost::system::error_code(), 0);  // start read loop
4✔
134
      }
4✔
135

136
      void stop() {
8✔
137
         if(!m_is_closed) {
8✔
138
            /*
139
            Don't need to talk to the server anymore
140
            Client socket is closed during write callback
141
            */
142
            m_server_socket.close();
4✔
143
            m_tls->close();
4✔
144

145
            // Need to explicitly destroy the TLS::Server object to break the
146
            // circular ownership of shared_from_this() and the shared_ptr of
147
            // this kept inside the TLS::Channel.
148
            m_tls.reset();
4✔
149
            m_is_closed = true;
4✔
150
         }
151
      }
8✔
152

153
      tls_proxy_session(boost::asio::io_context& io, tcp::resolver::results_type endpoints) :
4✔
154
            m_strand(io),
4✔
155
            m_server_endpoints(std::move(endpoints)),
4✔
156
            m_client_socket(io),
4✔
157
            m_server_socket(io),
8✔
158
            m_rng(cli_make_rng()) {}
12✔
159

160
   private:
161
      void setup(const std::shared_ptr<Botan::TLS::Session_Manager>& session_manager,
4✔
162
                 const std::shared_ptr<Botan::Credentials_Manager>& credentials,
163
                 const std::shared_ptr<Botan::TLS::Policy>& policy) {
164
         m_tls = std::make_unique<Botan::TLS::Server>(shared_from_this(), session_manager, credentials, policy, m_rng);
4✔
165
      }
4✔
166

167
      void client_read(const boost::system::error_code& error, size_t bytes_transferred) {
19✔
168
         if(error) {
19✔
169
            log_error("Read failed", error);
4✔
170
            stop();
4✔
171
            return;
4✔
172
         }
173

174
         if(m_is_closed) {
15✔
175
            log_error("Received client data after close");
×
176
            return;
×
177
         }
178

179
         try {
15✔
180
            if(!m_tls->is_active()) {
15✔
181
               log_binary_message("From client", m_c2p.data(), bytes_transferred);
182
            }
183
            m_tls->received_data(m_c2p.data(), bytes_transferred);
15✔
184
         } catch(Botan::Exception& e) {
×
185
            log_exception("TLS connection failed", e);
×
186
            stop();
×
187
            return;
×
188
         }
×
189

190
         m_client_socket.async_read_some(boost::asio::buffer(m_c2p.data(), m_c2p.size()),
30✔
191
                                         m_strand.wrap(boost::bind(&tls_proxy_session::client_read,
30✔
192
                                                                   shared_from_this(),
30✔
193
                                                                   boost::asio::placeholders::error,
194
                                                                   boost::asio::placeholders::bytes_transferred)));
195
      }
196

197
      void handle_client_write_completion(const boost::system::error_code& error) {
21✔
198
         if(error) {
21✔
199
            log_error("Client write", error);
×
200
            stop();
×
201
            return;
×
202
         }
203

204
         m_p2c.clear();
21✔
205

206
         if(m_p2c_pending.empty() && (!m_tls || m_tls->is_closed())) {
21✔
207
            m_client_socket.close();
4✔
208
         }
209
         tls_emit_data({});  // initiate another write if needed
21✔
210
      }
211

212
      void handle_server_write_completion(const boost::system::error_code& error) {
4✔
213
         if(error) {
4✔
214
            log_error("Server write", error);
×
215
            stop();
×
216
            return;
×
217
         }
218

219
         m_p2s.clear();
4✔
220
         proxy_write_to_server({});  // initiate another write if needed
4✔
221
      }
222

223
      void tls_record_received(uint64_t /*rec_no*/, std::span<const uint8_t> buf) override {
4✔
224
         // Immediately bounce message to server
225
         proxy_write_to_server(buf);
4✔
226
      }
4✔
227

228
      void tls_emit_data(std::span<const uint8_t> buf) override {
47✔
229
         if(!buf.empty()) {
47✔
230
            m_p2c_pending.insert(m_p2c_pending.end(), buf.begin(), buf.end());
26✔
231
         }
232

233
         // no write now active and we still have output pending
234
         if(m_p2c.empty() && !m_p2c_pending.empty()) {
47✔
235
            std::swap(m_p2c_pending, m_p2c);
21✔
236

237
            log_binary_message("To Client", m_p2c.data(), m_p2c.size());
21✔
238

239
            boost::asio::async_write(m_client_socket,
21✔
240
                                     boost::asio::buffer(m_p2c.data(), m_p2c.size()),
21✔
241
                                     m_strand.wrap(boost::bind(&tls_proxy_session::handle_client_write_completion,
42✔
242
                                                               shared_from_this(),
42✔
243
                                                               boost::asio::placeholders::error)));
244
         }
245
      }
47✔
246

247
      void proxy_write_to_server(std::span<const uint8_t> buf) {
12✔
248
         if(!buf.empty()) {
12✔
249
            m_p2s_pending.insert(m_p2s_pending.end(), buf.begin(), buf.end());
4✔
250
         }
251

252
         // no write now active and we still have output pending
253
         if(m_p2s.empty() && !m_p2s_pending.empty()) {
12✔
254
            std::swap(m_p2s_pending, m_p2s);
4✔
255

256
            log_text_message("To Server", m_p2s.data(), m_p2s.size());
4✔
257

258
            boost::asio::async_write(m_server_socket,
4✔
259
                                     boost::asio::buffer(m_p2s.data(), m_p2s.size()),
4✔
260
                                     m_strand.wrap(boost::bind(&tls_proxy_session::handle_server_write_completion,
8✔
261
                                                               shared_from_this(),
8✔
262
                                                               boost::asio::placeholders::error)));
263
         }
264
      }
12✔
265

266
      void server_read(const boost::system::error_code& error, size_t bytes_transferred) {
12✔
267
         if(error) {
12✔
268
            log_error("Server read failed", error);
4✔
269
            stop();
4✔
270
            return;
4✔
271
         }
272

273
         try {
8✔
274
            if(bytes_transferred > 0) {
8✔
275
               log_text_message("Server to client", m_s2p.data(), m_s2p.size());
4✔
276
               log_binary_message("Server to client", m_s2p.data(), m_s2p.size());
4✔
277
               m_tls->send(m_s2p.data(), bytes_transferred);
4✔
278
            }
279
         } catch(Botan::Exception& e) {
×
280
            log_exception("TLS connection failed", e);
×
281
            stop();
×
282
            return;
×
283
         }
×
284

285
         m_s2p.resize(readbuf_size);
8✔
286

287
         m_server_socket.async_read_some(boost::asio::buffer(m_s2p.data(), m_s2p.size()),
16✔
288
                                         m_strand.wrap(boost::bind(&tls_proxy_session::server_read,
16✔
289
                                                                   shared_from_this(),
16✔
290
                                                                   boost::asio::placeholders::error,
291
                                                                   boost::asio::placeholders::bytes_transferred)));
292
      }
293

294
      void tls_session_activated() override {
4✔
295
         auto onConnect = [self = weak_from_this()](boost::system::error_code ec,
12✔
296
                                                    const tcp::resolver::results_type::iterator& /*endpoint*/) {
297
            if(ec) {
4✔
298
               log_error("Server connection", ec);
×
299
               return;
×
300
            }
301

302
            if(auto ptr = self.lock()) {
4✔
303
               ptr->server_read(boost::system::error_code(), 0);  // start read loop
4✔
304
               ptr->proxy_write_to_server({});
4✔
305
            } else {
306
               log_error("Server connection established, but client session already closed");
×
307
               return;
×
308
            }
4✔
309
         };
4✔
310
         async_connect(m_server_socket, m_server_endpoints.begin(), m_server_endpoints.end(), onConnect);
8✔
311
      }
4✔
312

313
      void tls_session_established(const Botan::TLS::Session_Summary& session) override {
4✔
314
         m_hostname = session.server_info().hostname();
4✔
315
      }
4✔
316

317
      void tls_alert(Botan::TLS::Alert alert) override {
×
318
         if(alert.type() == Botan::TLS::Alert::CloseNotify) {
×
319
            m_tls->close();
×
320
            return;
×
321
         }
322
      }
323

324
      boost::asio::io_context::strand m_strand;
325

326
      tcp::resolver::results_type m_server_endpoints;
327

328
      tcp::socket m_client_socket;
329
      tcp::socket m_server_socket;
330

331
      std::shared_ptr<Botan::RandomNumberGenerator> m_rng;
332
      std::unique_ptr<Botan::TLS::Server> m_tls;
333
      std::string m_hostname;
334

335
      std::vector<uint8_t> m_c2p;
336
      std::vector<uint8_t> m_p2c;
337
      std::vector<uint8_t> m_p2c_pending;
338

339
      std::vector<uint8_t> m_s2p;
340
      std::vector<uint8_t> m_p2s;
341
      std::vector<uint8_t> m_p2s_pending;
342

343
      bool m_is_closed = false;
344
};
345

346
class tls_proxy_server final {
347
   public:
348
      typedef tls_proxy_session session;
349

350
      tls_proxy_server(boost::asio::io_context& io,
1✔
351
                       unsigned short port,
352
                       tcp::resolver::results_type endpoints,
353
                       std::shared_ptr<Botan::Credentials_Manager> creds,
354
                       std::shared_ptr<Botan::TLS::Policy> policy,
355
                       std::shared_ptr<Botan::TLS::Session_Manager> session_mgr,
356
                       size_t max_clients) :
1✔
357
            m_acceptor(io, tcp::endpoint(tcp::v4(), port)),
1✔
358
            m_server_endpoints(std::move(endpoints)),
1✔
359
            m_creds(std::move(creds)),
1✔
360
            m_policy(std::move(policy)),
1✔
361
            m_session_manager(std::move(session_mgr)),
1✔
362
            m_status(max_clients) {
1✔
363
         log_info("Listening for new connections on port " + std::to_string(port));
3✔
364
         serve_one_session();
1✔
365
      }
1✔
366

367
   private:
368
      session::pointer make_session() {
4✔
369
         return session::create(get_io_service(m_acceptor), m_session_manager, m_creds, m_policy, m_server_endpoints);
4✔
370
      }
371

372
      void serve_one_session() {
4✔
373
         const session::pointer new_session = make_session();
4✔
374

375
         m_acceptor.async_accept(
8✔
376
            new_session->client_socket(),
4✔
377
            boost::bind(&tls_proxy_server::handle_accept, this, new_session, boost::asio::placeholders::error));
12✔
378
      }
4✔
379

380
      void handle_accept(const session::pointer& new_session, const boost::system::error_code& error) {
4✔
381
         if(!error) {
4✔
382
            new_session->start();
4✔
383
            m_status.client_serviced();
4✔
384

385
            if(!m_status.should_exit()) {
4✔
386
               serve_one_session();
3✔
387
            }
388
         }
389
      }
4✔
390

391
      tcp::acceptor m_acceptor;
392
      tcp::resolver::results_type m_server_endpoints;
393

394
      std::shared_ptr<Botan::Credentials_Manager> m_creds;
395
      std::shared_ptr<Botan::TLS::Policy> m_policy;
396
      std::shared_ptr<Botan::TLS::Session_Manager> m_session_manager;
397
      ServerStatus m_status;
398
};
399

400
}  // namespace
401

402
class TLS_Proxy final : public Command {
403
   public:
404
      TLS_Proxy() :
2✔
405
            Command(
406
               "tls_proxy listen_port target_host target_port server_cert server_key "
407
               "--policy=default --threads=0 --max-clients=0 --session-db= --session-db-pass=") {}
4✔
408

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

411
      std::string description() const override { return "Proxies requests between a TLS client and a TLS server"; }
1✔
412

413
      size_t thread_count() const {
1✔
414
         if(const size_t t = get_arg_sz("threads")) {
1✔
415
            return t;
416
         }
417
   #if defined(BOTAN_HAS_OS_UTILS)
418
         if(const size_t t = Botan::OS::get_cpu_available()) {
1✔
419
            return t;
1✔
420
         }
421
   #endif
422
         return 2;
423
      }
424

425
      void go() override {
1✔
426
         const uint16_t listen_port = get_arg_u16("listen_port");
1✔
427
         const std::string target = get_arg("target_host");
1✔
428
         const std::string target_port = get_arg("target_port");
1✔
429

430
         const std::string server_crt = get_arg("server_cert");
1✔
431
         const std::string server_key = get_arg("server_key");
1✔
432

433
         const size_t num_threads = thread_count();
1✔
434
         const size_t max_clients = get_arg_sz("max-clients");
1✔
435

436
         auto creds = std::make_shared<Basic_Credentials_Manager>(server_crt, server_key);
1✔
437

438
         auto policy = load_tls_policy(get_arg("policy"));
2✔
439

440
         boost::asio::io_context io;
1✔
441

442
         tcp::resolver resolver(io);
1✔
443
         auto server_endpoint_iterator = resolver.resolve(target, target_port);
1✔
444

445
         std::shared_ptr<Botan::TLS::Session_Manager> session_mgr;
1✔
446

447
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
448
         const std::string sessions_passphrase = get_passphrase_arg("Session DB passphrase", "session-db-pass");
2✔
449
         const std::string sessions_db = get_arg("session-db");
1✔
450

451
         if(!sessions_db.empty()) {
1✔
452
            session_mgr =
×
453
               std::make_shared<Botan::TLS::Session_Manager_SQLite>(sessions_passphrase, rng_as_shared(), sessions_db);
×
454
         }
455
   #endif
456
         if(!session_mgr) {
1✔
457
            session_mgr = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng_as_shared());
3✔
458
         }
459

460
         const tls_proxy_server server(
1✔
461
            io, listen_port, server_endpoint_iterator, creds, policy, session_mgr, max_clients);
2✔
462

463
         std::vector<std::shared_ptr<std::thread>> threads;
1✔
464

465
         // run forever... first thread is main calling io.run below
466
         for(size_t i = 2; i <= num_threads; ++i) {
4✔
467
            threads.push_back(std::make_shared<std::thread>([&io]() { io.run(); }));
6✔
468
         }
469

470
         io.run();
1✔
471

472
         for(auto& thread : threads) {
4✔
473
            thread->join();
3✔
474
         }
475
      }
5✔
476
};
477

478
// NOLINTEND(*-avoid-endl,*-avoid-bind)
479

480
BOTAN_REGISTER_COMMAND("tls_proxy", TLS_Proxy);
2✔
481

482
}  // namespace Botan_CLI
483

484
#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