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

randombit / botan / 14732017105

29 Apr 2025 01:07PM UTC coverage: 90.895% (-0.01%) from 90.907%
14732017105

Pull #4776

github

web-flow
Merge f137f1d27 into dbe524bf5
Pull Request #4776: Add support for null ciphers

95954 of 105566 relevant lines covered (90.89%)

12971514.27 hits per line

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

93.68
/src/tests/unit_tls.cpp
1
/*
2
* (C) 2014,2015,2018 Jack Lloyd
3
*     2016 Matthias Gierlings
4
*     2017 René Korthaus, Rohde & Schwarz Cybersecurity
5
*     2017 Harry Reimann, Rohde & Schwarz Cybersecurity
6
*     2023 René Meusel, Rohde & Schwarz Cybersecurity
7
*
8
* Botan is released under the Simplified BSD License (see license.txt)
9
*/
10

11
#include "tests.h"
12
#include <memory>
13
#include <vector>
14

15
#if defined(BOTAN_HAS_TLS)
16

17
   #include <botan/tls_client.h>
18
   #include <botan/tls_exceptn.h>
19
   #include <botan/tls_extensions.h>
20
   #include <botan/tls_policy.h>
21
   #include <botan/tls_server.h>
22
   #include <botan/tls_session_manager_memory.h>
23
   #include <botan/tls_session_manager_noop.h>
24
   #include <botan/internal/tls_reader.h>
25

26
   #include <botan/ec_group.h>
27
   #include <botan/ecdh.h>
28
   #include <botan/ecdsa.h>
29
   #include <botan/hex.h>
30
   #include <botan/pkcs10.h>
31
   #include <botan/rsa.h>
32
   #include <botan/x509_ca.h>
33
   #include <botan/x509self.h>
34

35
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
36
      #include <botan/tls_session_manager_sqlite.h>
37
   #endif
38

39
namespace Botan::TLS {
40

41
// TODO: remove this, once TLS 1.3 is fully implemented
42
class Strict_Policy_Without_TLS13 : public Strict_Policy {
1✔
43
      bool allow_tls13() const override { return false; }
4✔
44
};
45

46
}  // namespace Botan::TLS
47

48
#endif
49

50
namespace Botan_Tests {
51

52
namespace {
53

54
#if defined(BOTAN_HAS_TLS)
55
class Credentials_Manager_Test final : public Botan::Credentials_Manager {
56
   public:
57
      Credentials_Manager_Test(bool with_client_certs,
2✔
58
                               const Botan::X509_Certificate& rsa_cert,
59
                               Botan::Private_Key* rsa_key,
60
                               const Botan::X509_Certificate& rsa_ca,
61
                               const Botan::X509_CRL& rsa_crl,
62
                               const Botan::X509_Certificate& ecdsa_cert,
63
                               Botan::Private_Key* ecdsa_key,
64
                               const Botan::X509_Certificate& ecdsa_ca,
65
                               const Botan::X509_CRL& ecdsa_crl) :
2✔
66
            m_rsa_cert(rsa_cert),
2✔
67
            m_rsa_ca(rsa_ca),
2✔
68
            m_rsa_key(rsa_key),
2✔
69
            m_ecdsa_cert(ecdsa_cert),
2✔
70
            m_ecdsa_ca(ecdsa_ca),
2✔
71
            m_ecdsa_key(ecdsa_key) {
6✔
72
         auto store = std::make_unique<Botan::Certificate_Store_In_Memory>();
2✔
73
         store->add_certificate(m_rsa_ca);
2✔
74
         store->add_certificate(m_ecdsa_ca);
2✔
75
         store->add_crl(rsa_crl);
2✔
76
         store->add_crl(ecdsa_crl);
2✔
77

78
         m_stores.push_back(std::move(store));
2✔
79
         m_provides_client_certs = with_client_certs;
2✔
80
      }
2✔
81

82
      std::vector<Botan::Certificate_Store*> trusted_certificate_authorities(const std::string& /*type*/,
218✔
83
                                                                             const std::string& /*context*/) override {
84
         std::vector<Botan::Certificate_Store*> v;
218✔
85
         v.reserve(m_stores.size());
218✔
86
         for(const auto& store : m_stores) {
436✔
87
            v.push_back(store.get());
218✔
88
         }
89
         return v;
218✔
90
      }
×
91

92
      std::vector<Botan::X509_Certificate> find_cert_chain(const std::vector<std::string>& cert_key_types,
442✔
93
                                                           const std::vector<Botan::AlgorithmIdentifier>& /*unused*/,
94
                                                           const std::vector<Botan::X509_DN>& acceptable_CAs,
95
                                                           const std::string& type,
96
                                                           const std::string& context) override {
97
         BOTAN_UNUSED(context);
442✔
98
         std::vector<Botan::X509_Certificate> chain;
442✔
99

100
         if(m_acceptable_cas.empty()) {
442✔
101
            m_acceptable_cas = acceptable_CAs;
17✔
102
         }
103

104
         if(type == "tls-server" || (type == "tls-client" && m_provides_client_certs)) {
442✔
105
            for(const auto& key_type : cert_key_types) {
487✔
106
               if(key_type == "RSA") {
366✔
107
                  chain.push_back(m_rsa_cert);
124✔
108
                  chain.push_back(m_rsa_ca);
124✔
109
                  break;
110
               } else if(key_type == "ECDSA") {
242✔
111
                  chain.push_back(m_ecdsa_cert);
121✔
112
                  chain.push_back(m_ecdsa_ca);
121✔
113
                  break;
114
               }
115
            }
116
         }
117

118
         return chain;
442✔
119
      }
×
120

121
      std::shared_ptr<Botan::Private_Key> private_key_for(const Botan::X509_Certificate& crt,
101✔
122
                                                          const std::string& /*type*/,
123
                                                          const std::string& /*context*/) override {
124
         if(crt == m_rsa_cert) {
101✔
125
            return m_rsa_key;
30✔
126
         }
127
         if(crt == m_ecdsa_cert) {
71✔
128
            return m_ecdsa_key;
71✔
129
         }
130
         return nullptr;
×
131
      }
132

133
      Botan::secure_vector<uint8_t> session_ticket_key() override {
×
134
         return Botan::hex_decode_locked("AABBCCDDEEFF012345678012345678");
×
135
      }
136

137
      Botan::secure_vector<uint8_t> dtls_cookie_secret() override {
128✔
138
         return Botan::hex_decode_locked("4AEA5EAD279CADEB537A594DA0E9DE3A");
128✔
139
      }
140

141
      std::vector<Botan::TLS::ExternalPSK> find_preshared_keys(
38✔
142
         std::string_view host,
143
         Botan::TLS::Connection_Side whoami,
144
         const std::vector<std::string>& identities = {},
145
         const std::optional<std::string>& prf = std::nullopt) override {
146
         if(identities.empty()) {
38✔
147
            return find_preshared_keys(host, whoami, identities, prf);
×
148
         }
149

150
         std::vector<Botan::TLS::ExternalPSK> psks;
38✔
151

152
         if(host == "server.example.com") {
38✔
153
            // PSKs for server and client are equal. For the sake of clarity,
154
            // we're not simplifying this code further
155
            if(whoami == Botan::TLS::Connection_Side::Client) {
38✔
156
               psks.emplace_back(
19✔
157
                  std::string{}, "SHA-256", Botan::hex_decode_locked("20B602D1475F2DF888FCB60D2AE03AFD"));
38✔
158
            }
159

160
            if(whoami == Botan::TLS::Connection_Side::Server) {
38✔
161
               psks.emplace_back(
19✔
162
                  std::string{}, "SHA-256", Botan::hex_decode_locked("20B602D1475F2DF888FCB60D2AE03AFD"));
38✔
163
            }
164
         }
165

166
         return psks;
38✔
167
      }
38✔
168

169
      const std::vector<Botan::X509_DN>& get_acceptable_cas() const { return m_acceptable_cas; }
4✔
170

171
   private:
172
      Botan::X509_Certificate m_rsa_cert, m_rsa_ca;
173
      std::shared_ptr<Botan::Private_Key> m_rsa_key;
174

175
      Botan::X509_Certificate m_ecdsa_cert, m_ecdsa_ca;
176
      std::shared_ptr<Botan::Private_Key> m_ecdsa_key;
177

178
      std::vector<std::unique_ptr<Botan::Certificate_Store>> m_stores;
179
      bool m_provides_client_certs;
180
      std::vector<Botan::X509_DN> m_acceptable_cas;
181
};
182

183
std::shared_ptr<Credentials_Manager_Test> create_creds(Botan::RandomNumberGenerator& rng,
2✔
184
                                                       bool with_client_certs = false) {
185
   // rsa and ecdsa are required for the tls module
186
   const auto ecdsa_params = Botan::EC_Group::from_name("secp256r1");
2✔
187
   const size_t rsa_params = 1024;
2✔
188

189
   auto rsa_ca_key = std::make_unique<Botan::RSA_PrivateKey>(rng, rsa_params);
2✔
190
   auto rsa_srv_key = std::make_unique<Botan::RSA_PrivateKey>(rng, rsa_params);
2✔
191

192
   auto ecdsa_ca_key = std::make_unique<Botan::ECDSA_PrivateKey>(rng, ecdsa_params);
2✔
193
   auto ecdsa_srv_key = std::make_unique<Botan::ECDSA_PrivateKey>(rng, ecdsa_params);
2✔
194

195
   Botan::X509_Cert_Options rsa_ca_opts("RSA Test CA/VT");
2✔
196
   Botan::X509_Cert_Options ecdsa_ca_opts("ECDSA Test CA/VT");
2✔
197
   rsa_ca_opts.CA_key(1);
2✔
198
   ecdsa_ca_opts.CA_key(1);
2✔
199

200
   const Botan::X509_Certificate rsa_ca_cert =
2✔
201
      Botan::X509::create_self_signed_cert(rsa_ca_opts, *rsa_ca_key, "SHA-256", rng);
2✔
202
   const Botan::X509_Certificate ecdsa_ca_cert =
2✔
203
      Botan::X509::create_self_signed_cert(ecdsa_ca_opts, *ecdsa_ca_key, "SHA-256", rng);
2✔
204

205
   const Botan::X509_Cert_Options server_opts("server.example.com");
2✔
206

207
   const Botan::PKCS10_Request rsa_req = Botan::X509::create_cert_req(server_opts, *rsa_srv_key, "SHA-256", rng);
2✔
208
   const Botan::PKCS10_Request ecdsa_req = Botan::X509::create_cert_req(server_opts, *ecdsa_srv_key, "SHA-256", rng);
2✔
209

210
   Botan::X509_CA rsa_ca(rsa_ca_cert, *rsa_ca_key, "SHA-256", rng);
2✔
211
   Botan::X509_CA ecdsa_ca(ecdsa_ca_cert, *ecdsa_ca_key, "SHA-256", rng);
2✔
212

213
   typedef std::chrono::duration<int, std::ratio<31556926>> years;
2✔
214
   auto now = std::chrono::system_clock::now();
2✔
215

216
   const Botan::X509_Time start_time(now);
2✔
217
   const Botan::X509_Time end_time(now + years(1));
2✔
218

219
   const Botan::X509_Certificate rsa_srv_cert = rsa_ca.sign_request(rsa_req, rng, start_time, end_time);
2✔
220
   const Botan::X509_Certificate ecdsa_srv_cert = ecdsa_ca.sign_request(ecdsa_req, rng, start_time, end_time);
2✔
221

222
   Botan::X509_CRL rsa_crl = rsa_ca.new_crl(rng);
2✔
223
   Botan::X509_CRL ecdsa_crl = ecdsa_ca.new_crl(rng);
2✔
224

225
   return std::make_shared<Credentials_Manager_Test>(with_client_certs,
2✔
226
                                                     rsa_srv_cert,
227
                                                     rsa_srv_key.release(),
4✔
228
                                                     rsa_ca_cert,
229
                                                     rsa_crl,
230
                                                     ecdsa_srv_cert,
231
                                                     ecdsa_srv_key.release(),
2✔
232
                                                     ecdsa_ca_cert,
233
                                                     ecdsa_crl);
2✔
234
}
4✔
235

236
class TLS_Handshake_Test final {
237
   public:
238
      TLS_Handshake_Test(const std::string& test_descr,
132✔
239
                         Botan::TLS::Protocol_Version offer_version,
240
                         const std::shared_ptr<Credentials_Manager_Test>& creds,
241
                         const std::shared_ptr<const Botan::TLS::Policy>& client_policy,
242
                         const std::shared_ptr<const Botan::TLS::Policy>& server_policy,
243
                         const std::shared_ptr<Botan::RandomNumberGenerator>& rng,
244
                         const std::shared_ptr<Botan::TLS::Session_Manager>& client_sessions,
245
                         const std::shared_ptr<Botan::TLS::Session_Manager>& server_sessions,
246
                         bool expect_client_auth) :
132✔
247
            m_offer_version(offer_version),
132✔
248
            m_results(test_descr),
132✔
249
            m_creds(creds),
132✔
250
            m_client_policy(client_policy),
132✔
251
            m_client_sessions(client_sessions),
132✔
252
            m_rng(rng),
132✔
253
            m_client_auth(expect_client_auth) {
132✔
254
         m_server_cb = std::make_shared<Test_Callbacks>(m_results, offer_version, m_s2c, m_server_recv);
132✔
255
         m_client_cb = std::make_shared<Test_Callbacks>(m_results, offer_version, m_c2s, m_client_recv);
132✔
256

257
         bool is_dtls = offer_version.is_datagram_protocol();
132✔
258

259
         m_server =
132✔
260
            std::make_unique<Botan::TLS::Server>(m_server_cb, server_sessions, m_creds, server_policy, m_rng, is_dtls);
132✔
261
      }
132✔
262

263
      void go();
264

265
      const Test::Result& results() const { return m_results; }
132✔
266

267
      void set_custom_client_tls_session_established_callback(
6✔
268
         std::function<void(const Botan::TLS::Session_Summary&)> clbk) {
269
         BOTAN_ASSERT_NONNULL(m_client_cb);
6✔
270
         m_client_cb->set_custom_tls_session_established_callback(std::move(clbk));
12✔
271
      }
6✔
272

273
      void set_custom_server_tls_session_established_callback(
6✔
274
         std::function<void(const Botan::TLS::Session_Summary&)> clbk) {
275
         BOTAN_ASSERT_NONNULL(m_server_cb);
6✔
276
         m_server_cb->set_custom_tls_session_established_callback(std::move(clbk));
12✔
277
      }
6✔
278

279
      void set_client_expected_handshake_alert(Botan::TLS::Alert alert) {
6✔
280
         BOTAN_ASSERT_NONNULL(m_client_cb);
6✔
281
         m_client_cb->set_expected_handshake_alert(alert);
6✔
282
      }
6✔
283

284
      void set_server_expected_handshake_alert(Botan::TLS::Alert alert) {
6✔
285
         BOTAN_ASSERT_NONNULL(m_server_cb);
6✔
286
         m_server_cb->set_expected_handshake_alert(alert);
6✔
287
      }
6✔
288

289
   private:
290
      class Test_Extension : public Botan::TLS::Extension {
291
         public:
292
            static Botan::TLS::Extension_Code static_type() {
293
               // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
294
               return static_cast<Botan::TLS::Extension_Code>(666);
295
            }
296

297
            Botan::TLS::Extension_Code type() const override { return static_type(); }
1,860✔
298

299
            std::vector<uint8_t> serialize(Botan::TLS::Connection_Side /*whoami*/) const override { return m_buf; }
324✔
300

301
            const std::vector<uint8_t>& value() const { return m_buf; }
302

303
            bool empty() const override { return false; }
324✔
304

305
            explicit Test_Extension(Botan::TLS::Connection_Side side) {
260✔
306
               const uint8_t client_extn[6] = {'c', 'l', 'i', 'e', 'n', 't'};
260✔
307
               const uint8_t server_extn[6] = {'s', 'e', 'r', 'v', 'e', 'r'};
260✔
308

309
               Botan::TLS::append_tls_length_value(
260✔
310
                  m_buf, (side == Botan::TLS::Connection_Side::Client) ? client_extn : server_extn, 6, 1);
260✔
311
            }
260✔
312

313
         private:
314
            std::vector<uint8_t> m_buf;
315
      };
316

317
      class Test_Callbacks final : public Botan::TLS::Callbacks {
318
         public:
319
            Test_Callbacks(Test::Result& results,
264✔
320
                           Botan::TLS::Protocol_Version expected_version,
321
                           std::vector<uint8_t>& outbound,
322
                           std::vector<uint8_t>& recv_buf) :
264✔
323
                  m_results(results), m_expected_version(expected_version), m_outbound(outbound), m_recv(recv_buf) {}
264✔
324

325
            Test_Callbacks(Test_Callbacks&&) = delete;
326
            Test_Callbacks(const Test_Callbacks&) = delete;
327
            Test_Callbacks& operator=(const Test_Callbacks&) = delete;
328
            Test_Callbacks& operator=(Test_Callbacks&&) = delete;
329

330
            ~Test_Callbacks() override {
264✔
331
               if(m_expected_handshake_alert.has_value()) {
264✔
332
                  m_results.test_failure("Expected: " + m_expected_handshake_alert->type_string() +
×
333
                                         " during handshake");
334
               }
335
            }
264✔
336

337
            void tls_emit_data(std::span<const uint8_t> bits) override {
2,397✔
338
               m_outbound.insert(m_outbound.end(), bits.begin(), bits.end());
2,397✔
339
            }
2,397✔
340

341
            void tls_record_received(uint64_t /*seq*/, std::span<const uint8_t> bits) override {
418✔
342
               m_recv.insert(m_recv.end(), bits.begin(), bits.end());
418✔
343
            }
418✔
344

345
            void tls_alert(Botan::TLS::Alert alert) override {
480✔
346
               // TODO test that it is a no_renegotiation alert
347

348
               if(m_expected_handshake_alert.has_value()) {
480✔
349
                  if(m_expected_handshake_alert->type() != alert.type()) {
12✔
350
                     m_results.test_failure("Got unexpected alert: " + alert.type_string() +
×
351
                                            " expected: " + m_expected_handshake_alert->type_string());
×
352
                  } else {
353
                     // acknowledge that the expected Alert was detected
354
                     m_results.test_note("saw expected alert: " + m_expected_handshake_alert->type_string());
36✔
355
                     m_expected_handshake_alert.reset();
12✔
356
                  }
357
               }
358
            }
480✔
359

360
            void tls_modify_extensions(Botan::TLS::Extensions& extn,
260✔
361
                                       Botan::TLS::Connection_Side which_side,
362
                                       Botan::TLS::Handshake_Type /* unused */) override {
363
               extn.add(new Test_Extension(which_side));
260✔
364

365
               // Insert an unsupported signature scheme as highest prio, to ensure we are tolerant of this
366
               if(auto sig_algs = extn.take<Botan::TLS::Signature_Algorithms>()) {
260✔
367
                  std::vector<Botan::TLS::Signature_Scheme> schemes = sig_algs->supported_schemes();
132✔
368
                  // 0x0301 is RSA PKCS1/SHA-224, which is not supported anymore
369
                  schemes.insert(schemes.begin(), 0x0301);
132✔
370
                  // This replaces the previous extension value
371
                  extn.add(new Botan::TLS::Signature_Algorithms(schemes));
132✔
372
               }
132✔
373
            }
260✔
374

375
            void tls_examine_extensions(const Botan::TLS::Extensions& extn,
260✔
376
                                        Botan::TLS::Connection_Side which_side,
377
                                        Botan::TLS::Handshake_Type /*unused*/) override {
378
               // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
379
               const auto extn_id = static_cast<Botan::TLS::Extension_Code>(666);
260✔
380
               Botan::TLS::Extension* test_extn = extn.get(extn_id);
260✔
381

382
               if(test_extn == nullptr) {
260✔
383
                  m_results.test_failure("Did not receive test extension from peer");
×
384
               } else {
385
                  Botan::TLS::Unknown_Extension* unknown_ext = dynamic_cast<Botan::TLS::Unknown_Extension*>(test_extn);
260✔
386

387
                  if(unknown_ext) {
260✔
388
                     const std::vector<uint8_t> val = unknown_ext->value();
260✔
389

390
                     if(m_results.test_eq("Expected size for test extn", val.size(), 7)) {
260✔
391
                        if(which_side == Botan::TLS::Connection_Side::Client) {
260✔
392
                           m_results.test_eq("Expected extension value", val, "06636C69656E74");
264✔
393
                        } else {
394
                           m_results.test_eq("Expected extension value", val, "06736572766572");
256✔
395
                        }
396
                     }
397
                  } else {
260✔
398
                     m_results.test_failure("Unknown extension type had unexpected type at runtime");
×
399
                  }
400
               }
401
            }
260✔
402

403
            void tls_session_established(const Botan::TLS::Session_Summary& session) override {
250✔
404
               const std::string session_report = "Session established " + session.version().to_string() + " " +
750✔
405
                                                  session.ciphersuite().to_string() + " " +
750✔
406
                                                  Botan::hex_encode(session.session_id().get());
500✔
407

408
               m_results.test_note(session_report);
250✔
409

410
               if(m_session_established_callback) {
250✔
411
                  m_session_established_callback(session);
12✔
412
               }
413

414
               if(session.version() != m_expected_version) {
238✔
415
                  m_results.test_failure("Expected " + m_expected_version.to_string() + " negotiated " +
×
416
                                         session.version().to_string());
12✔
417
               }
418
            }
238✔
419

420
            std::string tls_server_choose_app_protocol(const std::vector<std::string>& protos) override {
132✔
421
               m_results.test_eq("ALPN protocol count", protos.size(), 2);
132✔
422
               m_results.test_eq("ALPN protocol 1", protos[0], "test/1");
264✔
423
               m_results.test_eq("ALPN protocol 2", protos[1], "test/2");
264✔
424
               return "test/3";
132✔
425
            }
426

427
            std::unique_ptr<Botan::PK_Key_Agreement_Key> tls_generate_ephemeral_key(
166✔
428
               const std::variant<Botan::TLS::Group_Params, Botan::DL_Group>& group,
429
               Botan::RandomNumberGenerator& rng) override {
430
               if(std::holds_alternative<Botan::TLS::Group_Params>(group) &&
166✔
431
                  std::get<Botan::TLS::Group_Params>(group).wire_code() == 0xFEE1) {
162✔
432
                  const auto ec_group = Botan::EC_Group::from_name("numsp256d1");
×
433
                  return std::make_unique<Botan::ECDH_PrivateKey>(rng, ec_group);
×
434
               }
×
435

436
               return Botan::TLS::Callbacks::tls_generate_ephemeral_key(group, rng);
166✔
437
            }
438

439
            Botan::secure_vector<uint8_t> tls_ephemeral_key_agreement(
166✔
440
               const std::variant<Botan::TLS::Group_Params, Botan::DL_Group>& group,
441
               const Botan::PK_Key_Agreement_Key& private_key,
442
               const std::vector<uint8_t>& public_value,
443
               Botan::RandomNumberGenerator& rng,
444
               const Botan::TLS::Policy& policy) override {
445
               if(std::holds_alternative<Botan::TLS::Group_Params>(group) &&
166✔
446
                  std::get<Botan::TLS::Group_Params>(group).wire_code() == 0xFEE1) {
162✔
447
                  const auto ec_group = Botan::EC_Group::from_name("numsp256d1");
×
448
                  const auto ec_point = Botan::EC_AffinePoint(ec_group, public_value);
×
449
                  Botan::ECDH_PublicKey peer_key(ec_group, ec_point);
×
450
                  Botan::PK_Key_Agreement ka(private_key, rng, "Raw");
×
451
                  return ka.derive_key(0, peer_key.public_value()).bits_of();
×
452
               }
×
453

454
               return Botan::TLS::Callbacks::tls_ephemeral_key_agreement(group, private_key, public_value, rng, policy);
166✔
455
            }
456

457
            void set_custom_tls_session_established_callback(
12✔
458
               std::function<void(const Botan::TLS::Session_Summary&)> clbk) {
459
               m_session_established_callback = std::move(clbk);
12✔
460
            }
461

462
            void set_expected_handshake_alert(Botan::TLS::Alert alert) { m_expected_handshake_alert = alert; }
12✔
463

464
         private:
465
            Test::Result& m_results;
466
            const Botan::TLS::Protocol_Version m_expected_version;
467
            std::vector<uint8_t>& m_outbound;
468
            std::vector<uint8_t>& m_recv;
469

470
            std::function<void(const Botan::TLS::Session_Summary&)> m_session_established_callback;
471
            std::optional<Botan::TLS::Alert> m_expected_handshake_alert;
472
      };
473

474
      const Botan::TLS::Protocol_Version m_offer_version;
475
      Test::Result m_results;
476

477
      std::shared_ptr<Credentials_Manager_Test> m_creds;
478
      std::shared_ptr<const Botan::TLS::Policy> m_client_policy;
479
      std::shared_ptr<Botan::TLS::Session_Manager> m_client_sessions;
480
      std::shared_ptr<Botan::RandomNumberGenerator> m_rng;
481

482
      std::shared_ptr<Test_Callbacks> m_client_cb;
483

484
      std::shared_ptr<Test_Callbacks> m_server_cb;
485
      std::unique_ptr<Botan::TLS::Server> m_server;
486

487
      const bool m_client_auth;
488

489
      std::vector<uint8_t> m_c2s, m_s2c, m_client_recv, m_server_recv;
490
};
491

492
void TLS_Handshake_Test::go() {
132✔
493
   m_results.start_timer();
132✔
494

495
   const std::vector<std::string> protocols_offered = {"test/1", "test/2"};
132✔
496

497
   // Choose random application data to send
498
   const size_t c_len = 1 + ((static_cast<size_t>(m_rng->next_byte()) << 4) ^ m_rng->next_byte());
132✔
499
   std::vector<uint8_t> client_msg(c_len);
132✔
500
   m_rng->randomize(client_msg.data(), client_msg.size());
132✔
501
   bool client_has_written = false;
132✔
502

503
   const size_t s_len = 1 + ((static_cast<size_t>(m_rng->next_byte()) << 4) ^ m_rng->next_byte());
132✔
504
   std::vector<uint8_t> server_msg(s_len);
132✔
505
   m_rng->randomize(server_msg.data(), server_msg.size());
132✔
506
   bool server_has_written = false;
132✔
507

508
   std::unique_ptr<Botan::TLS::Client> client;
132✔
509
   client = std::make_unique<Botan::TLS::Client>(m_client_cb,
132✔
510
                                                 m_client_sessions,
132✔
511
                                                 m_creds,
132✔
512
                                                 m_client_policy,
132✔
513
                                                 m_rng,
132✔
514
                                                 Botan::TLS::Server_Information("server.example.com"),
132✔
515
                                                 m_offer_version,
132✔
516
                                                 protocols_offered);
132✔
517

518
   size_t rounds = 0;
132✔
519

520
   bool client_handshake_completed = false;
132✔
521
   bool server_handshake_completed = false;
132✔
522

523
   while(true) {
1,239✔
524
      ++rounds;
1,239✔
525

526
      if(rounds > 25) {
1,239✔
527
         m_results.test_failure("Still here after many rounds, deadlock?");
×
528
         break;
×
529
      }
530

531
      if(client_handshake_completed == false && client->is_active()) {
1,239✔
532
         client_handshake_completed = true;
533
      }
534

535
      if(server_handshake_completed == false && m_server->is_active()) {
1,239✔
536
         server_handshake_completed = true;
537
      }
538

539
      if(client->is_active() && client_has_written == false) {
1,239✔
540
         m_results.test_eq("client ALPN protocol", client->application_protocol(), "test/3");
232✔
541

542
         size_t sent_so_far = 0;
116✔
543
         while(sent_so_far != client_msg.size()) {
327✔
544
            const size_t left = client_msg.size() - sent_so_far;
211✔
545
            const size_t rnd12 = (m_rng->next_byte() << 4) ^ m_rng->next_byte();
211✔
546
            const size_t sending = std::min(left, rnd12);
211✔
547

548
            client->send(&client_msg[sent_so_far], sending);
211✔
549
            sent_so_far += sending;
211✔
550
         }
551
         client->send_warning_alert(Botan::TLS::Alert::NoRenegotiation);
116✔
552
         client_has_written = true;
553
      }
554

555
      if(m_server->is_active() && server_has_written == false) {
1,239✔
556
         m_results.test_eq("server ALPN protocol", m_server->application_protocol(), "test/3");
244✔
557

558
         size_t sent_so_far = 0;
122✔
559
         while(sent_so_far != server_msg.size()) {
343✔
560
            const size_t left = server_msg.size() - sent_so_far;
221✔
561
            const size_t rnd12 = (m_rng->next_byte() << 4) ^ m_rng->next_byte();
221✔
562
            const size_t sending = std::min(left, rnd12);
221✔
563

564
            m_server->send(&server_msg[sent_so_far], sending);
221✔
565
            sent_so_far += sending;
221✔
566
         }
567

568
         m_server->send_warning_alert(Botan::TLS::Alert::NoRenegotiation);
122✔
569
         server_has_written = true;
570
      }
571

572
      if(!m_c2s.empty()) {
1,239✔
573
         /*
574
         * Use this as a temp value to hold the queues as otherwise they
575
         * might end up appending more in response to messages during the
576
         * handshake.
577
         */
578
         std::vector<uint8_t> input;
551✔
579
         std::swap(m_c2s, input);
551✔
580

581
         try {
551✔
582
            size_t needed = m_server->received_data(input.data(), input.size());
551✔
583
            m_results.test_eq("full packet received", needed, 0);
1,082✔
584
         } catch(...) { /* ignore exceptions */
10✔
585
         }
10✔
586

587
         continue;
551✔
588
      }
551✔
589

590
      if(!m_s2c.empty()) {
688✔
591
         std::vector<uint8_t> input;
440✔
592
         std::swap(m_s2c, input);
440✔
593

594
         try {
440✔
595
            size_t needed = client->received_data(input.data(), input.size());
440✔
596
            m_results.test_eq("full packet received", needed, 0);
868✔
597
         } catch(...) { /* ignore exceptions */
6✔
598
         }
6✔
599

600
         continue;
440✔
601
      }
440✔
602

603
      if(!m_client_recv.empty()) {
248✔
604
         m_results.test_eq("client recv", m_client_recv, server_msg);
464✔
605
      }
606

607
      if(!m_server_recv.empty()) {
248✔
608
         m_results.test_eq("server recv", m_server_recv, client_msg);
464✔
609
      }
610

611
      if(client->is_closed() && m_server->is_closed()) {
248✔
612
         break;
613
      }
614

615
      if(m_server->is_active()) {
116✔
616
         std::vector<Botan::X509_Certificate> certs = m_server->peer_cert_chain();
116✔
617
         if(m_client_auth) {
116✔
618
            m_results.test_eq("got client certs", certs.size(), 2);
4✔
619

620
            std::vector<Botan::X509_DN> acceptable_CAs = m_creds->get_acceptable_cas();
4✔
621

622
            m_results.test_eq("client got CA list", acceptable_CAs.size(), 2);  // RSA + ECDSA
4✔
623

624
            for(const Botan::X509_DN& dn : acceptable_CAs) {
12✔
625
               m_results.test_eq("Expected CA country field", dn.get_first_attribute("C"), "VT");
16✔
626
            }
627
         } else {
4✔
628
            m_results.test_eq("no client certs", certs.size(), 0);
224✔
629
         }
630
      }
116✔
631

632
      if(!m_server_recv.empty() && !m_client_recv.empty()) {
116✔
633
         Botan::SymmetricKey client_key = client->key_material_export("label", "context", 32);
116✔
634
         Botan::SymmetricKey server_key = m_server->key_material_export("label", "context", 32);
116✔
635

636
         m_results.test_eq("TLS key material export", client_key.bits_of(), server_key.bits_of());
348✔
637

638
         m_results.confirm("Client is active", client->is_active());
232✔
639
         m_results.confirm("Client is not closed", !client->is_closed());
232✔
640
         client->close();
116✔
641
         m_results.confirm("Client is no longer active", !client->is_active());
232✔
642
         m_results.confirm("Client is closed", client->is_closed());
232✔
643
      }
232✔
644
   }
645

646
   m_results.end_timer();
132✔
647
}
396✔
648

649
class Test_Policy final : public Botan::TLS::Text_Policy {
30✔
650
   public:
651
      Test_Policy() : Text_Policy("") {}
30✔
652

653
      bool acceptable_protocol_version(Botan::TLS::Protocol_Version version) const override {
616✔
654
         // TODO: handle TLS 1.3 server once the time is ripe.
655
         return version.is_pre_tls_13();
616✔
656
      }
657

658
      size_t dtls_initial_timeout() const override { return 1; }
128✔
659

660
      size_t dtls_maximum_timeout() const override { return 8; }
128✔
661

662
      size_t minimum_rsa_bits() const override { return 1024; }
11✔
663

664
      size_t minimum_signature_strength() const override { return 80; }
97✔
665
};
666

667
class TLS_Unit_Tests final : public Test {
×
668
   private:
669
      static void test_with_policy(const std::string& test_descr,
31✔
670
                                   std::vector<Test::Result>& results,
671
                                   const std::shared_ptr<Botan::TLS::Session_Manager>& client_ses,
672
                                   const std::shared_ptr<Botan::TLS::Session_Manager>& server_ses,
673
                                   const std::shared_ptr<Credentials_Manager_Test>& creds,
674
                                   const std::vector<Botan::TLS::Protocol_Version>& versions,
675
                                   const std::shared_ptr<const Botan::TLS::Policy>& policy,
676
                                   std::shared_ptr<Botan::RandomNumberGenerator>& rng,
677
                                   bool client_auth = false) {
678
         try {
31✔
679
            for(const auto& version : versions) {
91✔
680
               TLS_Handshake_Test test(version.to_string() + " " + test_descr,
120✔
681
                                       version,
682
                                       creds,
683
                                       policy,
684
                                       policy,
685
                                       rng,
686
                                       client_ses,
687
                                       server_ses,
688
                                       client_auth);
120✔
689
               test.go();
60✔
690
               results.push_back(test.results());
60✔
691

692
               TLS_Handshake_Test test_resumption(version.to_string() + " " + test_descr,
180✔
693
                                                  version,
694
                                                  creds,
695
                                                  policy,
696
                                                  policy,
697
                                                  rng,
698
                                                  client_ses,
699
                                                  server_ses,
700
                                                  client_auth);
60✔
701
               test_resumption.go();
60✔
702
               results.push_back(test_resumption.results());
60✔
703
            }
60✔
704
         } catch(std::exception& e) {
×
705
            results.push_back(Test::Result::Failure(test_descr, e.what()));
×
706
         }
×
707
      }
31✔
708

709
      static void test_all_versions(const std::string& test_descr,
8✔
710
                                    std::vector<Test::Result>& results,
711
                                    const std::shared_ptr<Botan::TLS::Session_Manager>& client_ses,
712
                                    const std::shared_ptr<Botan::TLS::Session_Manager>& server_ses,
713
                                    const std::shared_ptr<Credentials_Manager_Test>& creds,
714
                                    std::shared_ptr<Botan::RandomNumberGenerator>& rng,
715
                                    const std::string& kex_policy,
716
                                    const std::string& cipher_policy,
717
                                    const std::string& mac_policy,
718
                                    const std::string& etm_policy,
719
                                    bool client_auth = false) {
720
         auto policy = std::make_shared<Test_Policy>();
8✔
721
         policy->set("ciphers", cipher_policy);
8✔
722
         policy->set("macs", mac_policy);
8✔
723
         policy->set("key_exchange_methods", kex_policy);
8✔
724
         policy->set("negotiate_encrypt_then_mac", etm_policy);
8✔
725

726
         policy->set("allow_tls12", "true");
16✔
727
         policy->set("allow_dtls12", "true");
16✔
728

729
         if(kex_policy.find("RSA") != std::string::npos) {
8✔
730
            policy->set("signature_methods", "IMPLICIT");
8✔
731
         }
732

733
         std::vector<Botan::TLS::Protocol_Version> versions = {Botan::TLS::Protocol_Version::TLS_V12,
8✔
734
                                                               Botan::TLS::Protocol_Version::DTLS_V12};
8✔
735

736
         return test_with_policy(
8✔
737
            test_descr, results, client_ses, server_ses, creds, versions, policy, rng, client_auth);
8✔
738
      }
16✔
739

740
      static void test_modern_versions(const std::string& test_descr,
13✔
741
                                       std::vector<Test::Result>& results,
742
                                       const std::shared_ptr<Botan::TLS::Session_Manager>& client_ses,
743
                                       const std::shared_ptr<Botan::TLS::Session_Manager>& server_ses,
744
                                       const std::shared_ptr<Credentials_Manager_Test>& creds,
745
                                       std::shared_ptr<Botan::RandomNumberGenerator>& rng,
746
                                       const std::string& kex_policy,
747
                                       const std::string& cipher_policy,
748
                                       const std::string& mac_policy = "AEAD",
749
                                       bool client_auth = false) {
750
         std::map<std::string, std::string> no_extra_policies;
13✔
751
         return test_modern_versions(test_descr,
13✔
752
                                     results,
753
                                     client_ses,
754
                                     server_ses,
755
                                     creds,
756
                                     rng,
757
                                     kex_policy,
758
                                     cipher_policy,
759
                                     mac_policy,
760
                                     no_extra_policies,
761
                                     client_auth);
13✔
762
      }
13✔
763

764
      static void test_modern_versions(const std::string& test_descr,
21✔
765
                                       std::vector<Test::Result>& results,
766
                                       const std::shared_ptr<Botan::TLS::Session_Manager>& client_ses,
767
                                       const std::shared_ptr<Botan::TLS::Session_Manager>& server_ses,
768
                                       const std::shared_ptr<Credentials_Manager_Test>& creds,
769
                                       std::shared_ptr<Botan::RandomNumberGenerator>& rng,
770
                                       const std::string& kex_policy,
771
                                       const std::string& cipher_policy,
772
                                       const std::string& mac_policy,
773
                                       const std::map<std::string, std::string>& extra_policies,
774
                                       bool client_auth = false) {
775
         auto policy = std::make_shared<Test_Policy>();
21✔
776
         policy->set("ciphers", cipher_policy);
21✔
777
         policy->set("macs", mac_policy);
21✔
778
         policy->set("key_exchange_methods", kex_policy);
21✔
779
         policy->set("allow_tls12", "true");
42✔
780
         policy->set("allow_dtls12", "true");
42✔
781

782
         if(kex_policy.find("RSA") != std::string::npos) {
21✔
783
            policy->set("signature_methods", "IMPLICIT");
2✔
784
         }
785

786
         for(const auto& kv : extra_policies) {
30✔
787
            policy->set(kv.first, kv.second);
9✔
788
         }
789

790
         std::vector<Botan::TLS::Protocol_Version> versions = {Botan::TLS::Protocol_Version::TLS_V12,
21✔
791
                                                               Botan::TLS::Protocol_Version::DTLS_V12};
21✔
792

793
         return test_with_policy(
21✔
794
            test_descr, results, client_ses, server_ses, creds, versions, policy, rng, client_auth);
21✔
795
      }
42✔
796

797
      void test_session_established_abort(std::vector<Test::Result>& results,
1✔
798
                                          std::shared_ptr<Credentials_Manager_Test> creds,
799
                                          std::shared_ptr<Botan::RandomNumberGenerator> rng) {
800
         std::vector<Botan::TLS::Protocol_Version> versions = {Botan::TLS::Protocol_Version::TLS_V12,
1✔
801
                                                               Botan::TLS::Protocol_Version::DTLS_V12};
1✔
802

803
         auto policy = std::make_shared<Test_Policy>();
1✔
804
         auto noop_session_manager = std::make_shared<Botan::TLS::Session_Manager_Noop>();
1✔
805

806
         auto client_aborts = [&](const std::exception_ptr& ex, Botan::TLS::Alert expected_server_alert) {
4✔
807
            for(const auto version : versions) {
9✔
808
               TLS_Handshake_Test test("Client aborts in tls_session_established with " +
12✔
809
                                          expected_server_alert.type_string() + ": " + version.to_string(),
24✔
810
                                       version,
811
                                       creds,
812
                                       policy,
813
                                       policy,
814
                                       rng,
815
                                       noop_session_manager,
816
                                       noop_session_manager,
817
                                       false);
30✔
818
               test.set_custom_client_tls_session_established_callback(
12✔
819
                  [=](const auto&) { std::rethrow_exception(ex); });
42✔
820
               test.set_server_expected_handshake_alert(expected_server_alert);
6✔
821

822
               test.go();
6✔
823
               results.push_back(test.results());
6✔
824
            }
6✔
825
         };
3✔
826

827
         auto server_aborts = [&](const std::exception_ptr& ex, Botan::TLS::Alert expected_server_alert) {
4✔
828
            for(const auto version : versions) {
9✔
829
               TLS_Handshake_Test test("Server aborts in tls_session_established with " +
12✔
830
                                          expected_server_alert.type_string() + ": " + version.to_string(),
24✔
831
                                       version,
832
                                       creds,
833
                                       policy,
834
                                       policy,
835
                                       rng,
836
                                       noop_session_manager,
837
                                       noop_session_manager,
838
                                       false);
30✔
839
               test.set_custom_server_tls_session_established_callback(
12✔
840
                  [=](const auto&) { std::rethrow_exception(ex); });
42✔
841
               test.set_client_expected_handshake_alert(expected_server_alert);
6✔
842

843
               test.go();
6✔
844
               results.push_back(test.results());
6✔
845
            }
6✔
846
         };
3✔
847

848
         client_aborts(std::make_exception_ptr(
3✔
849
                          Botan::TLS::TLS_Exception(Botan::TLS::Alert::AccessDenied, "some test TLS exception")),
1✔
850
                       Botan::TLS::Alert::AccessDenied);
851
         client_aborts(std::make_exception_ptr(Botan::Invalid_Authentication_Tag("some symmetric crypto failed :o)")),
2✔
852
                       Botan::TLS::Alert::BadRecordMac);
853
         client_aborts(std::make_exception_ptr(std::runtime_error("something strange happened")),
2✔
854
                       Botan::TLS::Alert::InternalError);
855

856
         server_aborts(std::make_exception_ptr(
3✔
857
                          Botan::TLS::TLS_Exception(Botan::TLS::Alert::AccessDenied, "some server test TLS exception")),
1✔
858
                       Botan::TLS::Alert::AccessDenied);
859
         server_aborts(std::make_exception_ptr(
2✔
860
                          Botan::Invalid_Authentication_Tag("some symmetric crypto failed in the server :o)")),
1✔
861
                       Botan::TLS::Alert::BadRecordMac);
862
         server_aborts(std::make_exception_ptr(std::runtime_error("something strange happened in the server")),
2✔
863
                       Botan::TLS::Alert::InternalError);
864
      }
2✔
865

866
   public:
867
      std::vector<Test::Result> run() override {
1✔
868
         std::vector<Test::Result> results;
1✔
869

870
         auto rng = Test::new_shared_rng(this->test_name());
1✔
871

872
         std::shared_ptr<Botan::TLS::Session_Manager> client_ses;
1✔
873
         std::shared_ptr<Botan::TLS::Session_Manager> server_ses;
1✔
874

875
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
876
         client_ses = std::make_shared<Botan::TLS::Session_Manager_SQLite>("client pass", rng, ":memory:", 5);
1✔
877
         server_ses = std::make_shared<Botan::TLS::Session_Manager_SQLite>("server pass", rng, ":memory:", 5);
1✔
878
   #endif
879

880
         if(!client_ses) {
1✔
881
            client_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
×
882
         }
883

884
         if(!server_ses) {
1✔
885
            server_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
×
886
         }
887

888
         auto creds = create_creds(*rng);
1✔
889

890
   #if defined(BOTAN_HAS_TLS_CBC)
891
         for(std::string etm_setting : {"false", "true"}) {
3✔
892
            test_all_versions("AES-128 RSA",
4✔
893
                              results,
894
                              client_ses,
895
                              server_ses,
896
                              creds,
897
                              rng,
898
                              "RSA",
899
                              "AES-128",
900
                              "SHA-256 SHA-1",
901
                              etm_setting);
902
            test_all_versions("AES-128 ECDH",
4✔
903
                              results,
904
                              client_ses,
905
                              server_ses,
906
                              creds,
907
                              rng,
908
                              "ECDH",
909
                              "AES-128",
910
                              "SHA-256 SHA-1",
911
                              etm_setting);
912

913
      #if defined(BOTAN_HAS_DES)
914
            test_all_versions(
4✔
915
               "3DES RSA", results, client_ses, server_ses, creds, rng, "RSA", "3DES", "SHA-1", etm_setting);
916
            test_all_versions(
4✔
917
               "3DES ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "3DES", "SHA-1", etm_setting);
918
      #endif
919

920
            server_ses->remove_all();
2✔
921
         }
2✔
922
         client_ses->remove_all();
1✔
923

924
         test_modern_versions("AES-128 DH", results, client_ses, server_ses, creds, rng, "DH", "AES-128", "SHA-256");
2✔
925

926
   #endif
927

928
   #if defined(BOTAN_HAS_TLS_NULL)
929
         test_modern_versions("NULL PSK", results, client_ses, server_ses, creds, rng, "PSK", "NullCipher", "SHA-256");
2✔
930
   #endif
931

932
         auto strict_policy = std::make_shared<Botan::TLS::Strict_Policy_Without_TLS13>();
1✔
933
         test_with_policy("Strict policy",
2✔
934
                          results,
935
                          client_ses,
936
                          server_ses,
937
                          creds,
938
                          {Botan::TLS::Protocol_Version::TLS_V12},
939
                          strict_policy,
940
                          rng);
941

942
         auto suiteb_128 = std::make_shared<Botan::TLS::NSA_Suite_B_128>();
1✔
943
         test_with_policy("Suite B",
2✔
944
                          results,
945
                          client_ses,
946
                          server_ses,
947
                          creds,
948
                          {Botan::TLS::Protocol_Version::TLS_V12},
949
                          suiteb_128,
950
                          rng);
951

952
         // Remove server sessions before client, so clients retry with session server doesn't know
953
         server_ses->remove_all();
1✔
954

955
         test_modern_versions("AES-128/GCM RSA", results, client_ses, server_ses, creds, rng, "RSA", "AES-128/GCM");
2✔
956
         test_modern_versions("AES-128/GCM ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "AES-128/GCM");
2✔
957

958
         test_modern_versions("AES-128/GCM ECDH RSA",
3✔
959
                              results,
960
                              client_ses,
961
                              server_ses,
962
                              creds,
963
                              rng,
964
                              "ECDH",
965
                              "AES-128/GCM",
966
                              "AEAD",
967
                              {{"signature_methods", "RSA"}});
968

969
         test_modern_versions("AES-128/GCM ECDH no OCSP",
3✔
970
                              results,
971
                              client_ses,
972
                              server_ses,
973
                              creds,
974
                              rng,
975
                              "ECDH",
976
                              "AES-128/GCM",
977
                              "AEAD",
978
                              {{"support_cert_status_message", "false"}});
979

980
         client_ses->remove_all();
1✔
981

982
   #if defined(BOTAN_HAS_CAMELLIA) && defined(BOTAN_HAS_AEAD_GCM)
983
         test_modern_versions(
2✔
984
            "Camellia-128/GCM ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "Camellia-128/GCM", "AEAD");
985
   #endif
986

987
   #if defined(BOTAN_HAS_ARIA)
988
         test_modern_versions(
2✔
989
            "ARIA/GCM ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "ARIA-128/GCM", "AEAD");
990
   #endif
991

992
         test_modern_versions("AES-128/GCM point compression",
3✔
993
                              results,
994
                              client_ses,
995
                              server_ses,
996
                              creds,
997
                              rng,
998
                              "ECDH",
999
                              "AES-128/GCM",
1000
                              "AEAD",
1001
                              {{"use_ecc_point_compression", "true"}});
1002
         test_modern_versions("AES-256/GCM p521",
3✔
1003
                              results,
1004
                              client_ses,
1005
                              server_ses,
1006
                              creds,
1007
                              rng,
1008
                              "ECDH",
1009
                              "AES-256/GCM",
1010
                              "AEAD",
1011
                              {{"groups", "secp521r1"}});
1012
         test_modern_versions("AES-128/GCM bp256r1",
3✔
1013
                              results,
1014
                              client_ses,
1015
                              server_ses,
1016
                              creds,
1017
                              rng,
1018
                              "ECDH",
1019
                              "AES-128/GCM",
1020
                              "AEAD",
1021
                              {{"groups", "brainpool256r1"}});
1022

1023
   #if defined(BOTAN_HAS_X25519)
1024
         test_modern_versions("AES-128/GCM x25519",
3✔
1025
                              results,
1026
                              client_ses,
1027
                              server_ses,
1028
                              creds,
1029
                              rng,
1030
                              "ECDH",
1031
                              "AES-128/GCM",
1032
                              "AEAD",
1033
                              {{"groups", "x25519"}});
1034
   #endif
1035

1036
         test_modern_versions("AES-128/GCM FFDHE-2048",
3✔
1037
                              results,
1038
                              client_ses,
1039
                              server_ses,
1040
                              creds,
1041
                              rng,
1042
                              "DH",
1043
                              "AES-128/GCM",
1044
                              "AEAD",
1045
                              {{"groups", "ffdhe/ietf/2048"}});
1046

1047
         auto creds_with_client_cert = create_creds(*rng, true);
1✔
1048

1049
         client_ses->remove_all();
1✔
1050
         test_modern_versions("AES-256/GCM client certs",
2✔
1051
                              results,
1052
                              client_ses,
1053
                              server_ses,
1054
                              creds_with_client_cert,
1055
                              rng,
1056
                              "ECDH",
1057
                              "AES-256/GCM",
1058
                              "AEAD",
1059
                              true);
1060

1061
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
1062
         client_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
2✔
1063
         server_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
2✔
1064
   #endif
1065

1066
   #if defined(BOTAN_HAS_AEAD_OCB)
1067
         test_modern_versions(
2✔
1068
            "AES-256/OCB ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "AES-256/OCB(12)");
1069
   #endif
1070

1071
         server_ses->remove_all();
1✔
1072

1073
   #if defined(BOTAN_HAS_AEAD_CHACHA20_POLY1305)
1074
         test_modern_versions(
2✔
1075
            "ChaCha20Poly1305 ECDH", results, client_ses, server_ses, creds, rng, "ECDH", "ChaCha20Poly1305");
1076
   #endif
1077

1078
         test_modern_versions("AES-128/GCM PSK", results, client_ses, server_ses, creds, rng, "PSK", "AES-128/GCM");
2✔
1079

1080
   #if defined(BOTAN_HAS_AEAD_CCM)
1081
         test_modern_versions("AES-128/CCM PSK", results, client_ses, server_ses, creds, rng, "PSK", "AES-128/CCM");
2✔
1082
         test_modern_versions(
2✔
1083
            "AES-128/CCM-8 PSK", results, client_ses, server_ses, creds, rng, "PSK", "AES-128/CCM(8)");
1084
   #endif
1085

1086
         test_modern_versions(
2✔
1087
            "AES-128/GCM ECDHE_PSK", results, client_ses, server_ses, creds, rng, "ECDHE_PSK", "AES-128/GCM");
1088

1089
         // Test with a custom curve
1090

1091
         if(Botan::EC_Group::supports_application_specific_group()) {
1✔
1092
            /*
1093
            * First register a curve, in this case numsp256d1
1094
            */
1095
            const Botan::BigInt p("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF43");
1✔
1096
            const Botan::BigInt a("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF40");
1✔
1097
            const Botan::BigInt b("0x25581");
1✔
1098
            const Botan::BigInt order("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE43C8275EA265C6020AB20294751A825");
1✔
1099

1100
            const Botan::BigInt g_x("0x01");
1✔
1101
            const Botan::BigInt g_y("0x696F1853C1E466D7FC82C96CCEEEDD6BD02C2F9375894EC10BF46306C2B56C77");
1✔
1102

1103
            const Botan::OID oid("1.3.6.1.4.1.25258.4.1");
1✔
1104

1105
            Botan::OID::register_oid(oid, "numsp256d1");
1✔
1106

1107
            // Creating this object implicitly registers the curve for future use ...
1108
            Botan::EC_Group reg_numsp256d1(oid, p, a, b, g_x, g_y, order);
1✔
1109

1110
            test_modern_versions("AES-256/GCM numsp256d1",
4✔
1111
                                 results,
1112
                                 client_ses,
1113
                                 server_ses,
1114
                                 creds,
1115
                                 rng,
1116
                                 "ECDH",
1117
                                 "AES-256/GCM",
1118
                                 "AEAD",
1119
                                 {{"groups", "0xFEE1"}, {"minimum_ecdh_group_size", "112"}});
1120
         }
1✔
1121

1122
         // Test connection abort by the application
1123
         // by throwing in Callbacks::tls_session_established()
1124

1125
         test_session_established_abort(results, creds, rng);
2✔
1126

1127
         return results;
1✔
1128
      }
15✔
1129
};
1130

1131
BOTAN_REGISTER_TEST("tls", "unit_tls", TLS_Unit_Tests);
1132

1133
class DTLS_Reconnection_Test : public Test {
×
1134
   public:
1135
      std::vector<Test::Result> run() override {
1✔
1136
         class Test_Callbacks : public Botan::TLS::Callbacks {
4✔
1137
            public:
1138
               Test_Callbacks(Test::Result& results, std::vector<uint8_t>& outbound, std::vector<uint8_t>& recv_buf) :
3✔
1139
                     m_results(results), m_outbound(outbound), m_recv(recv_buf) {}
3✔
1140

1141
               void tls_emit_data(std::span<const uint8_t> bits) override {
28✔
1142
                  m_outbound.insert(m_outbound.end(), bits.begin(), bits.end());
28✔
1143
               }
28✔
1144

1145
               void tls_record_received(uint64_t /*seq*/, std::span<const uint8_t> bits) override {
4✔
1146
                  m_recv.insert(m_recv.end(), bits.begin(), bits.end());
4✔
1147
               }
4✔
1148

1149
               void tls_alert(Botan::TLS::Alert /*alert*/) override {
×
1150
                  // ignore
1151
               }
×
1152

1153
               void tls_session_established(const Botan::TLS::Session_Summary& /*session*/) override {
4✔
1154
                  m_results.test_success("Established a session");
4✔
1155
               }
4✔
1156

1157
            private:
1158
               Test::Result& m_results;
1159
               std::vector<uint8_t>& m_outbound;
1160
               std::vector<uint8_t>& m_recv;
1161
         };
1162

1163
         class Credentials_PSK : public Botan::Credentials_Manager {
3✔
1164
            public:
1165
               Botan::SymmetricKey psk(const std::string& type,
8✔
1166
                                       const std::string& context,
1167
                                       const std::string& /*identity*/) override {
1168
                  if(type == "tls-server" && context == "session-ticket") {
8✔
1169
                     return Botan::SymmetricKey("AABBCCDDEEFF012345678012345678");
×
1170
                  }
1171

1172
                  if(type == "tls-server" && context == "dtls-cookie-secret") {
8✔
1173
                     return Botan::SymmetricKey("4AEA5EAD279CADEB537A594DA0E9DE3A");
4✔
1174
                  }
1175

1176
                  if(context == "localhost" && type == "tls-client") {
4✔
1177
                     return Botan::SymmetricKey("20B602D1475F2DF888FCB60D2AE03AFD");
2✔
1178
                  }
1179

1180
                  if(context == "localhost" && type == "tls-server") {
2✔
1181
                     return Botan::SymmetricKey("20B602D1475F2DF888FCB60D2AE03AFD");
2✔
1182
                  }
1183

1184
                  throw Test_Error("No PSK set for " + type + "/" + context);
×
1185
               }
1186
         };
1187

1188
         class Datagram_PSK_Policy : public Botan::TLS::Policy {
5✔
1189
            public:
1190
               std::vector<std::string> allowed_macs() const override { return std::vector<std::string>({"AEAD"}); }
216✔
1191

1192
               std::vector<std::string> allowed_key_exchange_methods() const override { return {"PSK"}; }
4✔
1193

1194
               bool allow_tls12() const override { return false; }
6✔
1195

1196
               bool allow_dtls12() const override { return true; }
19✔
1197

1198
               bool allow_dtls_epoch0_restart() const override { return true; }
8✔
1199
         };
1200

1201
         Test::Result result("DTLS reconnection");
1✔
1202

1203
         auto rng = Test::new_shared_rng(this->test_name());
1✔
1204

1205
         auto server_policy = std::make_shared<Datagram_PSK_Policy>();
1✔
1206
         auto client_policy = std::make_shared<Datagram_PSK_Policy>();
1✔
1207
         auto creds = std::make_shared<Credentials_PSK>();
1✔
1208
         auto server_sessions = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
1✔
1209
         auto client_sessions = std::make_shared<Botan::TLS::Session_Manager_Noop>();
1✔
1210

1211
         std::vector<uint8_t> s2c, server_recv;
1✔
1212
         auto server_callbacks = std::make_shared<Test_Callbacks>(result, s2c, server_recv);
1✔
1213
         Botan::TLS::Server server(server_callbacks, server_sessions, creds, server_policy, rng, true);
4✔
1214

1215
         std::vector<uint8_t> c1_c2s, client1_recv;
1✔
1216
         auto client1_callbacks = std::make_shared<Test_Callbacks>(result, c1_c2s, client1_recv);
1✔
1217
         Botan::TLS::Client client1(client1_callbacks,
1✔
1218
                                    client_sessions,
1219
                                    creds,
1220
                                    client_policy,
1221
                                    rng,
1222
                                    Botan::TLS::Server_Information("localhost"),
1✔
1223
                                    Botan::TLS::Protocol_Version::latest_dtls_version());
7✔
1224

1225
         bool c1_to_server_sent = false;
1✔
1226
         bool server_to_c1_sent = false;
1✔
1227

1228
         const std::vector<uint8_t> c1_to_server_magic(16, 0xC1);
1✔
1229
         const std::vector<uint8_t> server_to_c1_magic(16, 0x42);
1✔
1230

1231
         size_t c1_rounds = 0;
1✔
1232
         for(;;) {
10✔
1233
            c1_rounds++;
10✔
1234

1235
            if(c1_rounds > 64) {
10✔
1236
               result.test_failure("Still spinning in client1 loop after 64 rounds");
×
1237
               return {result};
×
1238
            }
1239

1240
            if(!c1_c2s.empty()) {
10✔
1241
               std::vector<uint8_t> input;
4✔
1242
               std::swap(c1_c2s, input);
4✔
1243
               server.received_data(input.data(), input.size());
4✔
1244
               continue;
4✔
1245
            }
4✔
1246

1247
            if(!s2c.empty()) {
6✔
1248
               std::vector<uint8_t> input;
4✔
1249
               std::swap(s2c, input);
4✔
1250
               client1.received_data(input.data(), input.size());
4✔
1251
               continue;
4✔
1252
            }
4✔
1253

1254
            if(!c1_to_server_sent && client1.is_active()) {
2✔
1255
               client1.send(c1_to_server_magic);
1✔
1256
               c1_to_server_sent = true;
1✔
1257
            }
1258

1259
            if(!server_to_c1_sent && server.is_active()) {
2✔
1260
               server.send(server_to_c1_magic);
2✔
1261
            }
1262

1263
            if(!server_recv.empty() && !client1_recv.empty()) {
2✔
1264
               result.test_eq("Expected message from client1", server_recv, c1_to_server_magic);
2✔
1265
               result.test_eq("Expected message to client1", client1_recv, server_to_c1_magic);
2✔
1266
               break;
1✔
1267
            }
1268
         }
1269

1270
         // Now client1 "goes away" (goes silent) and new client
1271
         // connects to same server context (ie due to reuse of client source port)
1272
         // See RFC 6347 section 4.2.8
1273

1274
         server_recv.clear();
1✔
1275
         s2c.clear();
1✔
1276

1277
         std::vector<uint8_t> c2_c2s, client2_recv;
1✔
1278
         auto client2_callbacks = std::make_shared<Test_Callbacks>(result, c2_c2s, client2_recv);
1✔
1279
         Botan::TLS::Client client2(client2_callbacks,
1✔
1280
                                    client_sessions,
1281
                                    creds,
1282
                                    client_policy,
1283
                                    rng,
1284
                                    Botan::TLS::Server_Information("localhost"),
1✔
1285
                                    Botan::TLS::Protocol_Version::latest_dtls_version());
7✔
1286

1287
         bool c2_to_server_sent = false;
1✔
1288
         bool server_to_c2_sent = false;
1✔
1289

1290
         const std::vector<uint8_t> c2_to_server_magic(16, 0xC2);
1✔
1291
         const std::vector<uint8_t> server_to_c2_magic(16, 0x66);
1✔
1292

1293
         size_t c2_rounds = 0;
1✔
1294

1295
         for(;;) {
10✔
1296
            c2_rounds++;
10✔
1297

1298
            if(c2_rounds > 64) {
10✔
1299
               result.test_failure("Still spinning in client2 loop after 64 rounds");
×
1300
               return {result};
×
1301
            }
1302

1303
            if(!c2_c2s.empty()) {
10✔
1304
               std::vector<uint8_t> input;
4✔
1305
               std::swap(c2_c2s, input);
4✔
1306
               server.received_data(input.data(), input.size());
4✔
1307
               continue;
4✔
1308
            }
4✔
1309

1310
            if(!s2c.empty()) {
6✔
1311
               std::vector<uint8_t> input;
4✔
1312
               std::swap(s2c, input);
4✔
1313
               client2.received_data(input.data(), input.size());
4✔
1314
               continue;
4✔
1315
            }
4✔
1316

1317
            if(!c2_to_server_sent && client2.is_active()) {
2✔
1318
               client2.send(c2_to_server_magic);
1✔
1319
               c2_to_server_sent = true;
1✔
1320
            }
1321

1322
            if(!server_to_c2_sent && server.is_active()) {
2✔
1323
               server.send(server_to_c2_magic);
2✔
1324
            }
1325

1326
            if(!server_recv.empty() && !client2_recv.empty()) {
2✔
1327
               result.test_eq("Expected message from client2", server_recv, c2_to_server_magic);
2✔
1328
               result.test_eq("Expected message to client2", client2_recv, server_to_c2_magic);
2✔
1329
               break;
1✔
1330
            }
1331
         }
1332

1333
         return {result};
2✔
1334
      }
18✔
1335
};
1336

1337
BOTAN_REGISTER_TEST("tls", "tls_dtls_reconnect", DTLS_Reconnection_Test);
1338

1339
#endif
1340

1341
}  // namespace
1342

1343
}  // namespace Botan_Tests
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