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

randombit / botan / 16055899095

03 Jul 2025 04:34PM UTC coverage: 90.571% (-0.003%) from 90.574%
16055899095

push

github

web-flow
Merge pull request #4931 from randombit/jack/moar-tidy

Address various warnings from clang-tidy

99050 of 109362 relevant lines covered (90.57%)

12478386.65 hits per line

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

83.41
/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_server.h>
28
   #include <botan/tls_session_manager_memory.h>
29
   #include <botan/x509cert.h>
30

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

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

39
   #include "tls_helpers.h"
40

41
namespace Botan_CLI {
42

43
namespace {
44

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

125
         return session;
4✔
126
      }
×
127

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

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

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

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

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

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

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

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

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

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

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

203
         m_p2c.clear();
22✔
204

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

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

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

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

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

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

236
            log_binary_message("To Client", &m_p2c[0], m_p2c.size());
22✔
237

238
            boost::asio::async_write(m_client_socket,
22✔
239
                                     boost::asio::buffer(&m_p2c[0], m_p2c.size()),
22✔
240
                                     m_strand.wrap(boost::bind(&tls_proxy_session::handle_client_write_completion,
44✔
241
                                                               shared_from_this(),
44✔
242
                                                               boost::asio::placeholders::error)));
243
         }
244
      }
49✔
245

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

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

255
            log_text_message("To Server", &m_p2s[0], m_p2s.size());
4✔
256

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

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

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

284
         m_s2p.resize(readbuf_size);
9✔
285

286
         m_server_socket.async_read_some(boost::asio::buffer(&m_s2p[0], m_s2p.size()),
18✔
287
                                         m_strand.wrap(boost::bind(&tls_proxy_session::server_read,
18✔
288
                                                                   shared_from_this(),
18✔
289
                                                                   boost::asio::placeholders::error,
290
                                                                   boost::asio::placeholders::bytes_transferred)));
291
      }
292

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

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

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

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

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

325
      tcp::resolver::results_type m_server_endpoints;
326

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

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

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

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

342
      bool m_is_closed = false;
343
};
344

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

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

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

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

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

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

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

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

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

399
}  // namespace
400

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

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

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

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

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

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

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

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

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

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

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

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

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

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

459
         tls_proxy_server server(io, listen_port, server_endpoint_iterator, creds, policy, session_mgr, max_clients);
2✔
460

461
         std::vector<std::shared_ptr<std::thread>> threads;
1✔
462

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

468
         io.run();
1✔
469

470
         for(size_t i = 0; i < threads.size(); ++i) {
4✔
471
            threads[i]->join();
3✔
472
         }
473
      }
5✔
474
};
475

476
// NOLINTEND(*-avoid-endl,*-avoid-bind)
477

478
BOTAN_REGISTER_COMMAND("tls_proxy", TLS_Proxy);
2✔
479

480
}  // namespace Botan_CLI
481

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