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

randombit / botan / 5079590438

25 May 2023 12:28PM UTC coverage: 92.228% (+0.5%) from 91.723%
5079590438

Pull #3502

github

Pull Request #3502: Apply clang-format to the codebase

75589 of 81959 relevant lines covered (92.23%)

12139530.51 hits per line

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

85.43
/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 <vector>
19

20
   #define _GLIBCXX_HAVE_GTHR_DEFAULT
21
   #include <botan/internal/os_utils.h>
22
   #include <boost/asio.hpp>
23
   #include <boost/bind.hpp>
24

25
   #include <botan/hex.h>
26
   #include <botan/pkcs8.h>
27
   #include <botan/rng.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
   #include "tls_helpers.h"
37

38
   #if BOOST_VERSION >= 107000
39
      #define GET_IO_SERVICE(s) (static_cast<boost::asio::io_context&>((s).get_executor().context()))
40
   #else
41
      #define GET_IO_SERVICE(s) ((s).get_io_service())
42
   #endif
43

44
namespace Botan_CLI {
45

46
namespace {
47

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

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

52
void log_error(const char* where, const boost::system::error_code& error) {
8✔
53
   std::cout << where << ' ' << error.message() << std::endl;
8✔
54
}
8✔
55

56
void log_error(const char* msg) { std::cout << msg << std::endl; }
×
57

58
void log_binary_message(const char* where, const uint8_t buf[], size_t buf_len) {
59
   BOTAN_UNUSED(where, buf, buf_len);
60
   //std::cout << where << ' ' << Botan::hex_encode(buf, buf_len) << std::endl;
61
}
62

63
void log_text_message(const char* where, const uint8_t buf[], size_t buf_len) {
64
   BOTAN_UNUSED(where, buf, buf_len);
65
   //const char* c = reinterpret_cast<const char*>(buf);
66
   //std::cout << where << ' ' << std::string(c, c + buf_len)  << std::endl;
67
}
68

69
class ServerStatus {
70
   public:
71
      ServerStatus(size_t max_clients) : m_max_clients(max_clients), m_clients_serviced(0) {}
1✔
72

73
      bool should_exit() const {
4✔
74
         if(m_max_clients == 0)
4✔
75
            return false;
76

77
         return clients_serviced() >= m_max_clients;
4✔
78
      }
79

80
      void client_serviced() { m_clients_serviced++; }
4✔
81

82
      size_t clients_serviced() const { return m_clients_serviced.load(); }
4✔
83

84
   private:
85
      size_t m_max_clients;
86
      std::atomic<size_t> m_clients_serviced;
87
};
88

89
class tls_proxy_session final : public std::enable_shared_from_this<tls_proxy_session>,
90
                                public Botan::TLS::Callbacks {
91
   public:
92
      enum { readbuf_size = 17 * 1024 };
93

94
      typedef std::shared_ptr<tls_proxy_session> pointer;
95

96
      static pointer create(boost::asio::io_service& io,
4✔
97
                            std::shared_ptr<Botan::TLS::Session_Manager> session_manager,
98
                            std::shared_ptr<Botan::Credentials_Manager> credentials,
99
                            std::shared_ptr<Botan::TLS::Policy> policy,
100
                            tcp::resolver::iterator endpoints) {
101
         auto session = std::make_shared<tls_proxy_session>(io, endpoints);
4✔
102

103
         // Defer the setup of the TLS server to make use of
104
         // shared_from_this() which wouldn't work in the c'tor.
105
         session->setup(session_manager, credentials, policy);
12✔
106

107
         return session;
4✔
108
      }
×
109

110
      tcp::socket& client_socket() { return m_client_socket; }
1✔
111

112
      void start() {
4✔
113
         m_c2p.resize(readbuf_size);
4✔
114
         client_read(boost::system::error_code(), 0);  // start read loop
4✔
115
      }
4✔
116

117
      void stop() {
8✔
118
         if(m_is_closed == false) {
8✔
119
            /*
120
            Don't need to talk to the server anymore
121
            Client socket is closed during write callback
122
            */
123
            m_server_socket.close();
4✔
124
            m_tls->close();
4✔
125

126
            // Need to explicitly destroy the TLS::Server object to break the
127
            // circular ownership of shared_from_this() and the shared_ptr of
128
            // this kept inside the TLS::Channel.
129
            m_tls.reset();
4✔
130
            m_is_closed = true;
4✔
131
         }
132
      }
8✔
133

134
      tls_proxy_session(boost::asio::io_service& io, tcp::resolver::iterator endpoints) :
4✔
135
            m_strand(io),
4✔
136
            m_server_endpoints(endpoints),
4✔
137
            m_client_socket(io),
4✔
138
            m_server_socket(io),
8✔
139
            m_rng(cli_make_rng()) {}
12✔
140

141
   private:
142
      void setup(std::shared_ptr<Botan::TLS::Session_Manager> session_manager,
4✔
143
                 std::shared_ptr<Botan::Credentials_Manager> credentials,
144
                 std::shared_ptr<Botan::TLS::Policy> policy) {
145
         m_tls = std::make_unique<Botan::TLS::Server>(shared_from_this(), session_manager, credentials, policy, m_rng);
4✔
146
      }
4✔
147

148
      void client_read(const boost::system::error_code& error, size_t bytes_transferred) {
20✔
149
         if(error) {
20✔
150
            log_error("Read failed", error);
4✔
151
            stop();
4✔
152
            return;
4✔
153
         }
154

155
         if(m_is_closed) {
16✔
156
            log_error("Received client data after close");
×
157
            return;
×
158
         }
159

160
         try {
16✔
161
            if(!m_tls->is_active()) {
16✔
162
               log_binary_message("From client", &m_c2p[0], bytes_transferred);
163
            }
164
            m_tls->received_data(&m_c2p[0], bytes_transferred);
16✔
165
         } catch(Botan::Exception& e) {
×
166
            log_exception("TLS connection failed", e);
×
167
            stop();
×
168
            return;
×
169
         }
×
170

171
         m_client_socket.async_read_some(boost::asio::buffer(&m_c2p[0], m_c2p.size()),
32✔
172
                                         m_strand.wrap(boost::bind(&tls_proxy_session::client_read,
32✔
173
                                                                   shared_from_this(),
32✔
174
                                                                   boost::asio::placeholders::error,
175
                                                                   boost::asio::placeholders::bytes_transferred)));
176
      }
177

178
      void handle_client_write_completion(const boost::system::error_code& error) {
25✔
179
         if(error) {
25✔
180
            log_error("Client write", error);
×
181
            stop();
×
182
            return;
×
183
         }
184

185
         m_p2c.clear();
25✔
186

187
         if(m_p2c_pending.empty() && (!m_tls || m_tls->is_closed())) {
25✔
188
            m_client_socket.close();
4✔
189
         }
190
         tls_emit_data({});  // initiate another write if needed
25✔
191
      }
192

193
      void handle_server_write_completion(const boost::system::error_code& error) {
4✔
194
         if(error) {
4✔
195
            log_error("Server write", error);
×
196
            stop();
×
197
            return;
×
198
         }
199

200
         m_p2s.clear();
4✔
201
         proxy_write_to_server({});  // initiate another write if needed
4✔
202
      }
203

204
      void tls_record_received(uint64_t /*rec_no*/, std::span<const uint8_t> buf) override {
4✔
205
         // Immediately bounce message to server
206
         proxy_write_to_server(buf);
4✔
207
      }
4✔
208

209
      void tls_emit_data(std::span<const uint8_t> buf) override {
55✔
210
         if(!buf.empty()) {
55✔
211
            m_p2c_pending.insert(m_p2c_pending.end(), buf.begin(), buf.end());
30✔
212
         }
213

214
         // no write now active and we still have output pending
215
         if(m_p2c.empty() && !m_p2c_pending.empty()) {
55✔
216
            std::swap(m_p2c_pending, m_p2c);
25✔
217

218
            log_binary_message("To Client", &m_p2c[0], m_p2c.size());
25✔
219

220
            boost::asio::async_write(m_client_socket,
25✔
221
                                     boost::asio::buffer(&m_p2c[0], m_p2c.size()),
25✔
222
                                     m_strand.wrap(boost::bind(&tls_proxy_session::handle_client_write_completion,
50✔
223
                                                               shared_from_this(),
50✔
224
                                                               boost::asio::placeholders::error)));
225
         }
226
      }
55✔
227

228
      void proxy_write_to_server(std::span<const uint8_t> buf) {
12✔
229
         if(!buf.empty()) {
12✔
230
            m_p2s_pending.insert(m_p2s_pending.end(), buf.begin(), buf.end());
4✔
231
         }
232

233
         // no write now active and we still have output pending
234
         if(m_p2s.empty() && !m_p2s_pending.empty()) {
12✔
235
            std::swap(m_p2s_pending, m_p2s);
4✔
236

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

239
            boost::asio::async_write(m_server_socket,
4✔
240
                                     boost::asio::buffer(&m_p2s[0], m_p2s.size()),
4✔
241
                                     m_strand.wrap(boost::bind(&tls_proxy_session::handle_server_write_completion,
8✔
242
                                                               shared_from_this(),
8✔
243
                                                               boost::asio::placeholders::error)));
244
         }
245
      }
12✔
246

247
      void server_read(const boost::system::error_code& error, size_t bytes_transferred) {
16✔
248
         if(error) {
16✔
249
            log_error("Server read failed", error);
4✔
250
            stop();
4✔
251
            return;
4✔
252
         }
253

254
         try {
12✔
255
            if(bytes_transferred) {
12✔
256
               log_text_message("Server to client", &m_s2p[0], m_s2p.size());
8✔
257
               log_binary_message("Server to client", &m_s2p[0], m_s2p.size());
8✔
258
               m_tls->send(&m_s2p[0], bytes_transferred);
8✔
259
            }
260
         } catch(Botan::Exception& e) {
×
261
            log_exception("TLS connection failed", e);
×
262
            stop();
×
263
            return;
×
264
         }
×
265

266
         m_s2p.resize(readbuf_size);
12✔
267

268
         m_server_socket.async_read_some(boost::asio::buffer(&m_s2p[0], m_s2p.size()),
24✔
269
                                         m_strand.wrap(boost::bind(&tls_proxy_session::server_read,
24✔
270
                                                                   shared_from_this(),
24✔
271
                                                                   boost::asio::placeholders::error,
272
                                                                   boost::asio::placeholders::bytes_transferred)));
273
      }
274

275
      void tls_session_activated() override {
4✔
276
         auto onConnect = [this](boost::system::error_code ec, tcp::resolver::iterator /*endpoint*/) {
16✔
277
            if(ec) {
4✔
278
               log_error("Server connection", ec);
×
279
               return;
×
280
            }
281
            server_read(boost::system::error_code(), 0);  // start read loop
4✔
282
            proxy_write_to_server({});
4✔
283
         };
4✔
284
         async_connect(m_server_socket, m_server_endpoints, onConnect);
4✔
285
      }
4✔
286

287
      void tls_session_established(const Botan::TLS::Session_Summary& session) override {
4✔
288
         m_hostname = session.server_info().hostname();
4✔
289
      }
4✔
290

291
      void tls_alert(Botan::TLS::Alert alert) override {
×
292
         if(alert.type() == Botan::TLS::Alert::CloseNotify) {
×
293
            m_tls->close();
×
294
            return;
×
295
         }
296
      }
297

298
      boost::asio::io_service::strand m_strand;
299

300
      tcp::resolver::iterator m_server_endpoints;
301

302
      tcp::socket m_client_socket;
303
      tcp::socket m_server_socket;
304

305
      std::shared_ptr<Botan::RandomNumberGenerator> m_rng;
306
      std::unique_ptr<Botan::TLS::Server> m_tls;
307
      std::string m_hostname;
308

309
      std::vector<uint8_t> m_c2p;
310
      std::vector<uint8_t> m_p2c;
311
      std::vector<uint8_t> m_p2c_pending;
312

313
      std::vector<uint8_t> m_s2p;
314
      std::vector<uint8_t> m_p2s;
315
      std::vector<uint8_t> m_p2s_pending;
316

317
      bool m_is_closed = false;
318
};
319

320
class tls_proxy_server final {
321
   public:
322
      typedef tls_proxy_session session;
323

324
      tls_proxy_server(boost::asio::io_service& io,
1✔
325
                       unsigned short port,
326
                       tcp::resolver::iterator endpoints,
327
                       std::shared_ptr<Botan::Credentials_Manager> creds,
328
                       std::shared_ptr<Botan::TLS::Policy> policy,
329
                       std::shared_ptr<Botan::TLS::Session_Manager> session_mgr,
330
                       size_t max_clients) :
1✔
331
            m_acceptor(io, tcp::endpoint(tcp::v4(), port)),
1✔
332
            m_server_endpoints(endpoints),
1✔
333
            m_creds(creds),
1✔
334
            m_policy(policy),
1✔
335
            m_session_manager(session_mgr),
1✔
336
            m_status(max_clients) {
1✔
337
         session::pointer new_session = make_session();
1✔
338

339
         m_acceptor.async_accept(
2✔
340
            new_session->client_socket(),
1✔
341
            boost::bind(&tls_proxy_server::handle_accept, this, new_session, boost::asio::placeholders::error));
3✔
342
      }
1✔
343

344
   private:
345
      session::pointer make_session() {
4✔
346
         return session::create(GET_IO_SERVICE(m_acceptor), m_session_manager, m_creds, m_policy, m_server_endpoints);
28✔
347
      }
348

349
      void serve_one_session() {
3✔
350
         session::pointer new_session = make_session();
3✔
351

352
         m_acceptor.async_accept(
6✔
353
            new_session->client_socket(),
3✔
354
            boost::bind(&tls_proxy_server::handle_accept, this, new_session, boost::asio::placeholders::error));
9✔
355
      }
3✔
356

357
      void handle_accept(session::pointer new_session, const boost::system::error_code& error) {
4✔
358
         if(!error) {
4✔
359
            new_session->start();
4✔
360
            m_status.client_serviced();
4✔
361

362
            if(!m_status.should_exit()) {
4✔
363
               serve_one_session();
3✔
364
            }
365
         }
366
      }
4✔
367

368
      tcp::acceptor m_acceptor;
369
      tcp::resolver::iterator m_server_endpoints;
370

371
      std::shared_ptr<Botan::Credentials_Manager> m_creds;
372
      std::shared_ptr<Botan::TLS::Policy> m_policy;
373
      std::shared_ptr<Botan::TLS::Session_Manager> m_session_manager;
374
      ServerStatus m_status;
375
};
376

377
}
378

379
class TLS_Proxy final : public Command {
380
   public:
381
      TLS_Proxy() :
2✔
382
            Command(
383
               "tls_proxy listen_port target_host target_port server_cert server_key "
384
               "--policy=default --threads=0 --max-clients=0 --session-db= --session-db-pass=") {}
4✔
385

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

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

390
      size_t thread_count() const {
1✔
391
         if(size_t t = get_arg_sz("threads"))
1✔
392
            return t;
393
         if(size_t t = Botan::OS::get_cpu_available())
1✔
394
            return t;
1✔
395
         return 2;
396
      }
397

398
      void go() override {
1✔
399
         const uint16_t listen_port = get_arg_u16("listen_port");
1✔
400
         const std::string target = get_arg("target_host");
1✔
401
         const std::string target_port = get_arg("target_port");
1✔
402

403
         const std::string server_crt = get_arg("server_cert");
1✔
404
         const std::string server_key = get_arg("server_key");
1✔
405

406
         const size_t num_threads = thread_count();
1✔
407
         const size_t max_clients = get_arg_sz("max-clients");
1✔
408

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

411
         auto policy = load_tls_policy(get_arg("policy"));
2✔
412

413
         boost::asio::io_service io;
1✔
414

415
         tcp::resolver resolver(io);
1✔
416
         auto server_endpoint_iterator = resolver.resolve({target, target_port});
1✔
417

418
         std::shared_ptr<Botan::TLS::Session_Manager> session_mgr;
1✔
419

420
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
421
         const std::string sessions_passphrase = get_passphrase_arg("Session DB passphrase", "session-db-pass");
2✔
422
         const std::string sessions_db = get_arg("session-db");
1✔
423

424
         if(!sessions_db.empty()) {
1✔
425
            session_mgr.reset(
×
426
               new Botan::TLS::Session_Manager_SQLite(sessions_passphrase, rng_as_shared(), sessions_db));
×
427
         }
428
   #endif
429
         if(!session_mgr) {
1✔
430
            session_mgr.reset(new Botan::TLS::Session_Manager_In_Memory(rng_as_shared()));
2✔
431
         }
432

433
         tls_proxy_server server(io, listen_port, server_endpoint_iterator, creds, policy, session_mgr, max_clients);
4✔
434

435
         std::vector<std::shared_ptr<std::thread>> threads;
1✔
436

437
         // run forever... first thread is main calling io.run below
438
         for(size_t i = 2; i <= num_threads; ++i) {
2✔
439
            threads.push_back(std::make_shared<std::thread>([&io]() { io.run(); }));
2✔
440
         }
441

442
         io.run();
1✔
443

444
         for(size_t i = 0; i < threads.size(); ++i) {
2✔
445
            threads[i]->join();
1✔
446
         }
447
      }
7✔
448
};
449

450
BOTAN_REGISTER_COMMAND("tls_proxy", TLS_Proxy);
2✔
451

452
}
453

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

© 2025 Coveralls, Inc