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

randombit / botan / 6421338519

05 Oct 2023 03:44PM UTC coverage: 91.703% (-0.08%) from 91.783%
6421338519

push

github

web-flow
Merge pull request #3609 from Rohde-Schwarz/tls13/kem_establishment

[TLS 1.3] Hybrid PQ/T key establishment

79958 of 87192 relevant lines covered (91.7%)

8521367.99 hits per line

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

94.71
/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*/,
222✔
83
                                                                             const std::string& /*context*/) override {
84
         std::vector<Botan::Certificate_Store*> v;
222✔
85
         v.reserve(m_stores.size());
222✔
86
         for(const auto& store : m_stores) {
444✔
87
            v.push_back(store.get());
222✔
88
         }
89
         return v;
222✔
90
      }
×
91

92
      std::vector<Botan::X509_Certificate> find_cert_chain(const std::vector<std::string>& cert_key_types,
434✔
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);
434✔
98
         std::vector<Botan::X509_Certificate> chain;
434✔
99

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

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

118
         return chain;
434✔
119
      }
×
120

121
      std::shared_ptr<Botan::Private_Key> private_key_for(const Botan::X509_Certificate& crt,
105✔
122
                                                          const std::string& /*type*/,
123
                                                          const std::string& /*context*/) override {
124
         if(crt == m_rsa_cert) {
105✔
125
            return m_rsa_key;
30✔
126
         }
127
         if(crt == m_ecdsa_cert) {
75✔
128
            return m_ecdsa_key;
75✔
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 {
124✔
138
         return Botan::hex_decode_locked("4AEA5EAD279CADEB537A594DA0E9DE3A");
124✔
139
      }
140

141
      std::vector<Botan::TLS::ExternalPSK> find_preshared_keys(
30✔
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()) {
30✔
147
            return find_preshared_keys(host, whoami, identities, prf);
×
148
         }
149

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

152
         if(host == "server.example.com") {
30✔
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) {
30✔
156
               psks.emplace_back(
15✔
157
                  std::string{}, "SHA-256", Botan::hex_decode_locked("20B602D1475F2DF888FCB60D2AE03AFD"));
30✔
158
            }
159

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

166
         return psks;
30✔
167
      }
30✔
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 Botan::EC_Group ecdsa_params("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
   // dsa support is optional
226
   std::unique_ptr<Botan::Private_Key> dsa_ca_key;
2✔
227
   std::unique_ptr<Botan::Private_Key> dsa_srv_key;
2✔
228
   std::unique_ptr<Botan::X509_CRL> dsa_crl;
2✔
229
   std::unique_ptr<Botan::X509_Certificate> dsa_srv_cert;
2✔
230
   std::unique_ptr<Botan::X509_Certificate> dsa_ca_cert;
2✔
231

232
   return std::make_shared<Credentials_Manager_Test>(with_client_certs,
2✔
233
                                                     rsa_srv_cert,
234
                                                     rsa_srv_key.release(),
4✔
235
                                                     rsa_ca_cert,
236
                                                     rsa_crl,
237
                                                     ecdsa_srv_cert,
238
                                                     ecdsa_srv_key.release(),
2✔
239
                                                     ecdsa_ca_cert,
240
                                                     ecdsa_crl);
4✔
241
}
4✔
242

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

264
         bool is_dtls = offer_version.is_datagram_protocol();
128✔
265

266
         m_server =
128✔
267
            std::make_unique<Botan::TLS::Server>(m_server_cb, server_sessions, m_creds, server_policy, m_rng, is_dtls);
128✔
268
      }
128✔
269

270
      void go();
271

272
      const Test::Result& results() const { return m_results; }
128✔
273

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

280
      void set_custom_server_tls_session_established_callback(
6✔
281
         std::function<void(const Botan::TLS::Session_Summary&)> clbk) {
282
         BOTAN_ASSERT_NONNULL(m_server_cb);
6✔
283
         m_server_cb->set_custom_tls_session_established_callback(std::move(clbk));
12✔
284
      }
6✔
285

286
      void set_client_expected_handshake_alert(Botan::TLS::Alert alert) {
6✔
287
         BOTAN_ASSERT_NONNULL(m_client_cb);
6✔
288
         m_client_cb->set_expected_handshake_alert(alert);
6✔
289
      }
6✔
290

291
      void set_server_expected_handshake_alert(Botan::TLS::Alert alert) {
6✔
292
         BOTAN_ASSERT_NONNULL(m_server_cb);
6✔
293
         m_server_cb->set_expected_handshake_alert(alert);
6✔
294
      }
6✔
295

296
   private:
297
      class Test_Extension : public Botan::TLS::Extension {
298
         public:
299
            static Botan::TLS::Extension_Code static_type() { return static_cast<Botan::TLS::Extension_Code>(666); }
300

301
            Botan::TLS::Extension_Code type() const override { return static_type(); }
1,830✔
302

303
            std::vector<uint8_t> serialize(Botan::TLS::Connection_Side /*whoami*/) const override { return m_buf; }
318✔
304

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

307
            bool empty() const override { return false; }
318✔
308

309
            explicit Test_Extension(Botan::TLS::Connection_Side side) {
256✔
310
               const uint8_t client_extn[6] = {'c', 'l', 'i', 'e', 'n', 't'};
256✔
311
               const uint8_t server_extn[6] = {'s', 'e', 'r', 'v', 'e', 'r'};
256✔
312

313
               Botan::TLS::append_tls_length_value(
384✔
314
                  m_buf, (side == Botan::TLS::Connection_Side::Client) ? client_extn : server_extn, 6, 1);
315
            }
256✔
316

317
         private:
318
            std::vector<uint8_t> m_buf;
319
      };
320

321
      class Test_Callbacks final : public Botan::TLS::Callbacks {
322
         public:
323
            Test_Callbacks(Test::Result& results,
256✔
324
                           Botan::TLS::Protocol_Version expected_version,
325
                           std::vector<uint8_t>& outbound,
326
                           std::vector<uint8_t>& recv_buf) :
256✔
327
                  m_results(results), m_expected_version(expected_version), m_outbound(outbound), m_recv(recv_buf) {}
256✔
328

329
            Test_Callbacks(Test_Callbacks&&) = delete;
330
            Test_Callbacks(const Test_Callbacks&) = delete;
331
            Test_Callbacks& operator=(const Test_Callbacks&) = delete;
332
            Test_Callbacks& operator=(Test_Callbacks&&) = delete;
333

334
            ~Test_Callbacks() override {
256✔
335
               if(m_expected_handshake_alert.has_value()) {
256✔
336
                  m_results.test_failure("Expected: " + m_expected_handshake_alert->type_string() +
×
337
                                         " during handshake");
338
               }
339
            }
256✔
340

341
            void tls_emit_data(std::span<const uint8_t> bits) override {
2,333✔
342
               m_outbound.insert(m_outbound.end(), bits.begin(), bits.end());
2,333✔
343
            }
2,333✔
344

345
            void tls_record_received(uint64_t /*seq*/, std::span<const uint8_t> bits) override {
388✔
346
               m_recv.insert(m_recv.end(), bits.begin(), bits.end());
388✔
347
            }
388✔
348

349
            void tls_alert(Botan::TLS::Alert alert) override {
464✔
350
               // TODO test that it is a no_renegotiation alert
351

352
               if(m_expected_handshake_alert.has_value()) {
464✔
353
                  if(m_expected_handshake_alert->type() != alert.type()) {
12✔
354
                     m_results.test_failure("Got unexpected alert: " + alert.type_string() +
×
355
                                            " expected: " + m_expected_handshake_alert->type_string());
×
356
                  } else {
357
                     // acknowledge that the expected Alert was detected
358
                     m_results.test_note("saw expected alert: " + m_expected_handshake_alert->type_string());
24✔
359
                     m_expected_handshake_alert.reset();
12✔
360
                  }
361
               }
362
            }
464✔
363

364
            void tls_modify_extensions(Botan::TLS::Extensions& extn,
256✔
365
                                       Botan::TLS::Connection_Side which_side,
366
                                       Botan::TLS::Handshake_Type /* unused */) override {
367
               extn.add(new Test_Extension(which_side));
256✔
368

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

379
            void tls_examine_extensions(const Botan::TLS::Extensions& extn,
256✔
380
                                        Botan::TLS::Connection_Side which_side,
381
                                        Botan::TLS::Handshake_Type /*unused*/) override {
382
               Botan::TLS::Extension* test_extn = extn.get(static_cast<Botan::TLS::Extension_Code>(666));
256✔
383

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

389
                  if(unknown_ext) {
256✔
390
                     const std::vector<uint8_t> val = unknown_ext->value();
256✔
391

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

405
            void tls_session_established(const Botan::TLS::Session_Summary& session) override {
242✔
406
               const std::string session_report = "Session established " + session.version().to_string() + " " +
484✔
407
                                                  session.ciphersuite().to_string() + " " +
968✔
408
                                                  Botan::hex_encode(session.session_id().get());
484✔
409

410
               m_results.test_note(session_report);
242✔
411

412
               if(m_session_established_callback) {
242✔
413
                  m_session_established_callback(session);
12✔
414
               }
415

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

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

429
            std::unique_ptr<Botan::PK_Key_Agreement_Key> tls_generate_ephemeral_key(
170✔
430
               const std::variant<Botan::TLS::Group_Params, Botan::DL_Group>& group,
431
               Botan::RandomNumberGenerator& rng) override {
432
               if(std::holds_alternative<Botan::TLS::Group_Params>(group) &&
170✔
433
                  static_cast<uint16_t>(std::get<Botan::TLS::Group_Params>(group)) == 0xFEE1) {
166✔
434
                  const Botan::EC_Group ec_group("secp112r1");
4✔
435
                  return std::make_unique<Botan::ECDH_PrivateKey>(rng, ec_group);
8✔
436
               }
4✔
437

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

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

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

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

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

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

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

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

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

483
      std::shared_ptr<Test_Callbacks> m_client_cb;
484

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

488
      const bool m_client_auth;
489

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

493
void TLS_Handshake_Test::go() {
128✔
494
   m_results.start_timer();
128✔
495

496
   Botan::RandomNumberGenerator& rng = Test::rng();
128✔
497

498
   const std::vector<std::string> protocols_offered = {"test/1", "test/2"};
384✔
499

500
   // Choose random application data to send
501
   const size_t c_len = 1 + ((static_cast<size_t>(rng.next_byte()) << 4) ^ rng.next_byte());
128✔
502
   std::vector<uint8_t> client_msg(c_len);
128✔
503
   Test::rng().randomize(client_msg.data(), client_msg.size());
128✔
504
   bool client_has_written = false;
128✔
505

506
   const size_t s_len = 1 + ((static_cast<size_t>(rng.next_byte()) << 4) ^ rng.next_byte());
128✔
507
   std::vector<uint8_t> server_msg(s_len);
128✔
508
   Test::rng().randomize(server_msg.data(), server_msg.size());
128✔
509
   bool server_has_written = false;
128✔
510

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

521
   size_t rounds = 0;
128✔
522

523
   bool client_handshake_completed = false;
128✔
524
   bool server_handshake_completed = false;
128✔
525

526
   while(true) {
1,203✔
527
      ++rounds;
1,203✔
528

529
      if(rounds > 25) {
1,203✔
530
         m_results.test_failure("Still here after many rounds, deadlock?");
×
531
         break;
×
532
      }
533

534
      if(client_handshake_completed == false && client->is_active()) {
1,203✔
535
         client_handshake_completed = true;
536
      }
537

538
      if(server_handshake_completed == false && m_server->is_active()) {
1,203✔
539
         server_handshake_completed = true;
540
      }
541

542
      if(client->is_active() && client_has_written == false) {
1,203✔
543
         m_results.test_eq("client ALPN protocol", client->application_protocol(), "test/3");
224✔
544

545
         size_t sent_so_far = 0;
112✔
546
         while(sent_so_far != client_msg.size()) {
308✔
547
            const size_t left = client_msg.size() - sent_so_far;
196✔
548
            const size_t rnd12 = (rng.next_byte() << 4) ^ rng.next_byte();
196✔
549
            const size_t sending = std::min(left, rnd12);
196✔
550

551
            client->send(&client_msg[sent_so_far], sending);
196✔
552
            sent_so_far += sending;
196✔
553
         }
554
         client->send_warning_alert(Botan::TLS::Alert::NoRenegotiation);
112✔
555
         client_has_written = true;
556
      }
557

558
      if(m_server->is_active() && server_has_written == false) {
1,203✔
559
         m_results.test_eq("server ALPN protocol", m_server->application_protocol(), "test/3");
236✔
560

561
         size_t sent_so_far = 0;
118✔
562
         while(sent_so_far != server_msg.size()) {
322✔
563
            const size_t left = server_msg.size() - sent_so_far;
204✔
564
            const size_t rnd12 = (rng.next_byte() << 4) ^ rng.next_byte();
204✔
565
            const size_t sending = std::min(left, rnd12);
204✔
566

567
            m_server->send(&server_msg[sent_so_far], sending);
204✔
568
            sent_so_far += sending;
204✔
569
         }
570

571
         m_server->send_warning_alert(Botan::TLS::Alert::NoRenegotiation);
118✔
572
         server_has_written = true;
573
      }
574

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

584
         try {
537✔
585
            size_t needed = m_server->received_data(input.data(), input.size());
537✔
586
            m_results.test_eq("full packet received", needed, 0);
1,062✔
587
         } catch(...) { /* ignore exceptions */
6✔
588
         }
6✔
589

590
         continue;
537✔
591
      }
537✔
592

593
      if(!m_s2c.empty()) {
666✔
594
         std::vector<uint8_t> input;
426✔
595
         std::swap(m_s2c, input);
426✔
596

597
         try {
426✔
598
            size_t needed = client->received_data(input.data(), input.size());
426✔
599
            m_results.test_eq("full packet received", needed, 0);
832✔
600
         } catch(...) { /* ignore exceptions */
10✔
601
         }
10✔
602

603
         continue;
426✔
604
      }
426✔
605

606
      if(!m_client_recv.empty()) {
240✔
607
         m_results.test_eq("client recv", m_client_recv, server_msg);
448✔
608
      }
609

610
      if(!m_server_recv.empty()) {
240✔
611
         m_results.test_eq("server recv", m_server_recv, client_msg);
448✔
612
      }
613

614
      if(client->is_closed() && m_server->is_closed()) {
240✔
615
         break;
616
      }
617

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

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

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

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

635
      if(!m_server_recv.empty() && !m_client_recv.empty()) {
112✔
636
         Botan::SymmetricKey client_key = client->key_material_export("label", "context", 32);
112✔
637
         Botan::SymmetricKey server_key = m_server->key_material_export("label", "context", 32);
112✔
638

639
         m_results.test_eq("TLS key material export", client_key.bits_of(), server_key.bits_of());
336✔
640

641
         m_results.confirm("Client is active", client->is_active());
224✔
642
         m_results.confirm("Client is not closed", !client->is_closed());
224✔
643
         client->close();
112✔
644
         m_results.confirm("Client is no longer active", !client->is_active());
224✔
645
         m_results.confirm("Client is closed", client->is_closed());
336✔
646
      }
224✔
647
   }
648

649
   m_results.end_timer();
128✔
650
}
384✔
651

652
class Test_Policy final : public Botan::TLS::Text_Policy {
29✔
653
   public:
654
      Test_Policy() : Text_Policy("") {}
29✔
655

656
      bool acceptable_protocol_version(Botan::TLS::Protocol_Version version) const override {
600✔
657
         // TODO: handle TLS 1.3 server once the time is ripe.
658
         return version.is_pre_tls_13();
600✔
659
      }
660

661
      size_t dtls_initial_timeout() const override { return 1; }
124✔
662

663
      size_t dtls_maximum_timeout() const override { return 8; }
124✔
664

665
      size_t minimum_rsa_bits() const override { return 1024; }
11✔
666

667
      size_t minimum_signature_strength() const override { return 80; }
101✔
668
};
669

670
class TLS_Unit_Tests final : public Test {
×
671
   private:
672
      static void test_with_policy(const std::string& test_descr,
30✔
673
                                   std::vector<Test::Result>& results,
674
                                   const std::shared_ptr<Botan::TLS::Session_Manager>& client_ses,
675
                                   const std::shared_ptr<Botan::TLS::Session_Manager>& server_ses,
676
                                   const std::shared_ptr<Credentials_Manager_Test>& creds,
677
                                   const std::vector<Botan::TLS::Protocol_Version>& versions,
678
                                   const std::shared_ptr<const Botan::TLS::Policy>& policy,
679
                                   bool client_auth = false) {
680
         auto rng = Test::rng_as_shared();
30✔
681

682
         try {
30✔
683
            for(const auto& version : versions) {
88✔
684
               TLS_Handshake_Test test(version.to_string() + " " + test_descr,
116✔
685
                                       version,
686
                                       creds,
687
                                       policy,
688
                                       policy,
689
                                       rng,
690
                                       client_ses,
691
                                       server_ses,
692
                                       client_auth);
116✔
693
               test.go();
58✔
694
               results.push_back(test.results());
58✔
695

696
               TLS_Handshake_Test test_resumption(version.to_string() + " " + test_descr,
116✔
697
                                                  version,
698
                                                  creds,
699
                                                  policy,
700
                                                  policy,
701
                                                  rng,
702
                                                  client_ses,
703
                                                  server_ses,
704
                                                  client_auth);
58✔
705
               test_resumption.go();
58✔
706
               results.push_back(test_resumption.results());
58✔
707
            }
58✔
708
         } catch(std::exception& e) {
×
709
            results.push_back(Test::Result::Failure(test_descr, e.what()));
×
710
         }
×
711
      }
30✔
712

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

729
         policy->set("allow_tls12", "true");
16✔
730
         policy->set("allow_dtls12", "true");
16✔
731

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

736
         std::vector<Botan::TLS::Protocol_Version> versions = {Botan::TLS::Protocol_Version::TLS_V12,
8✔
737
                                                               Botan::TLS::Protocol_Version::DTLS_V12};
8✔
738

739
         return test_with_policy(test_descr, results, client_ses, server_ses, creds, versions, policy, client_auth);
16✔
740
      }
16✔
741

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

764
      static void test_modern_versions(const std::string& test_descr,
20✔
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
                                       const std::string& kex_policy,
770
                                       const std::string& cipher_policy,
771
                                       const std::string& mac_policy,
772
                                       const std::map<std::string, std::string>& extra_policies,
773
                                       bool client_auth = false) {
774
         auto policy = std::make_shared<Test_Policy>();
20✔
775
         policy->set("ciphers", cipher_policy);
20✔
776
         policy->set("macs", mac_policy);
20✔
777
         policy->set("key_exchange_methods", kex_policy);
20✔
778
         policy->set("allow_tls12", "true");
40✔
779
         policy->set("allow_dtls12", "true");
40✔
780

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

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

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

792
         return test_with_policy(test_descr, results, client_ses, server_ses, creds, versions, policy, client_auth);
40✔
793
      }
40✔
794

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

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

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

820
               test.go();
6✔
821
               results.push_back(test.results());
6✔
822
            }
6✔
823
         };
3✔
824

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

841
               test.go();
6✔
842
               results.push_back(test.results());
6✔
843
            }
6✔
844
         };
3✔
845

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

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

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

868
         auto rng = Test::rng_as_shared();
1✔
869

870
         std::shared_ptr<Botan::TLS::Session_Manager> client_ses;
1✔
871
         std::shared_ptr<Botan::TLS::Session_Manager> server_ses;
1✔
872

873
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
874
         client_ses.reset(new Botan::TLS::Session_Manager_SQLite("client pass", rng, ":memory:", 5));
1✔
875
         server_ses.reset(new Botan::TLS::Session_Manager_SQLite("server pass", rng, ":memory:", 10));
1✔
876

877
   #else
878
         client_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
879
         server_ses = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng);
880
   #endif
881

882
         auto creds = create_creds(*rng);
1✔
883

884
   #if defined(BOTAN_HAS_TLS_CBC)
885
         for(std::string etm_setting : {"false", "true"}) {
3✔
886
            test_all_versions(
4✔
887
               "AES-128 RSA", results, client_ses, server_ses, creds, "RSA", "AES-128", "SHA-256 SHA-1", etm_setting);
888
            test_all_versions(
4✔
889
               "AES-128 ECDH", results, client_ses, server_ses, creds, "ECDH", "AES-128", "SHA-256 SHA-1", etm_setting);
890

891
      #if defined(BOTAN_HAS_DES)
892
            test_all_versions("3DES RSA", results, client_ses, server_ses, creds, "RSA", "3DES", "SHA-1", etm_setting);
4✔
893
            test_all_versions(
4✔
894
               "3DES ECDH", results, client_ses, server_ses, creds, "ECDH", "3DES", "SHA-1", etm_setting);
895
      #endif
896

897
            server_ses->remove_all();
2✔
898
         }
2✔
899
         client_ses->remove_all();
1✔
900

901
         test_modern_versions("AES-128 DH", results, client_ses, server_ses, creds, "DH", "AES-128", "SHA-256");
2✔
902

903
   #endif
904

905
         auto strict_policy = std::make_shared<Botan::TLS::Strict_Policy_Without_TLS13>();
1✔
906
         test_with_policy("Strict policy",
3✔
907
                          results,
908
                          client_ses,
909
                          server_ses,
910
                          creds,
911
                          {Botan::TLS::Protocol_Version::TLS_V12},
912
                          strict_policy);
913

914
         auto suiteb_128 = std::make_shared<Botan::TLS::NSA_Suite_B_128>();
1✔
915
         test_with_policy(
3✔
916
            "Suite B", results, client_ses, server_ses, creds, {Botan::TLS::Protocol_Version::TLS_V12}, suiteb_128);
917

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

921
         test_modern_versions("AES-128/GCM RSA", results, client_ses, server_ses, creds, "RSA", "AES-128/GCM");
2✔
922
         test_modern_versions("AES-128/GCM ECDH", results, client_ses, server_ses, creds, "ECDH", "AES-128/GCM");
2✔
923

924
         test_modern_versions("AES-128/GCM ECDH RSA",
3✔
925
                              results,
926
                              client_ses,
927
                              server_ses,
928
                              creds,
929
                              "ECDH",
930
                              "AES-128/GCM",
931
                              "AEAD",
932
                              {{"signature_methods", "RSA"}});
933

934
         test_modern_versions("AES-128/GCM ECDH no OCSP",
3✔
935
                              results,
936
                              client_ses,
937
                              server_ses,
938
                              creds,
939
                              "ECDH",
940
                              "AES-128/GCM",
941
                              "AEAD",
942
                              {{"support_cert_status_message", "false"}});
943

944
         client_ses->remove_all();
1✔
945

946
   #if defined(BOTAN_HAS_CAMELLIA) && defined(BOTAN_HAS_AEAD_GCM)
947
         test_modern_versions(
3✔
948
            "Camellia-128/GCM ECDH", results, client_ses, server_ses, creds, "ECDH", "Camellia-128/GCM", "AEAD");
949
   #endif
950

951
   #if defined(BOTAN_HAS_ARIA)
952
         test_modern_versions("ARIA/GCM ECDH", results, client_ses, server_ses, creds, "ECDH", "ARIA-128/GCM", "AEAD");
2✔
953
   #endif
954

955
         test_modern_versions("AES-128/GCM point compression",
3✔
956
                              results,
957
                              client_ses,
958
                              server_ses,
959
                              creds,
960
                              "ECDH",
961
                              "AES-128/GCM",
962
                              "AEAD",
963
                              {{"use_ecc_point_compression", "true"}});
964
         test_modern_versions("AES-256/GCM p521",
3✔
965
                              results,
966
                              client_ses,
967
                              server_ses,
968
                              creds,
969
                              "ECDH",
970
                              "AES-256/GCM",
971
                              "AEAD",
972
                              {{"groups", "secp521r1"}});
973
         test_modern_versions("AES-128/GCM bp256r1",
3✔
974
                              results,
975
                              client_ses,
976
                              server_ses,
977
                              creds,
978
                              "ECDH",
979
                              "AES-128/GCM",
980
                              "AEAD",
981
                              {{"groups", "brainpool256r1"}});
982

983
   #if defined(BOTAN_HAS_CURVE_25519)
984
         test_modern_versions(
3✔
985
            "AES-128/GCM x25519", results, client_ses, server_ses, creds, "ECDH", "AES-128/GCM", "AEAD", {{
986
               "groups",
987
               "x25519"
988
            }});
989
   #endif
990

991
         test_modern_versions("AES-128/GCM FFDHE-2048",
3✔
992
                              results,
993
                              client_ses,
994
                              server_ses,
995
                              creds,
996
                              "DH",
997
                              "AES-128/GCM",
998
                              "AEAD",
999
                              {{"groups", "ffdhe/ietf/2048"}});
1000

1001
         auto creds_with_client_cert = create_creds(*rng, true);
1✔
1002

1003
         client_ses->remove_all();
1✔
1004
         test_modern_versions("AES-256/GCM client certs",
2✔
1005
                              results,
1006
                              client_ses,
1007
                              server_ses,
1008
                              creds_with_client_cert,
1009
                              "ECDH",
1010
                              "AES-256/GCM",
1011
                              "AEAD",
1012
                              true);
1013

1014
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
1015
         client_ses.reset(new Botan::TLS::Session_Manager_In_Memory(rng));
1✔
1016
         server_ses.reset(new Botan::TLS::Session_Manager_In_Memory(rng));
1✔
1017
   #endif
1018

1019
   #if defined(BOTAN_HAS_AEAD_OCB)
1020
         test_modern_versions("AES-256/OCB ECDH", results, client_ses, server_ses, creds, "ECDH", "AES-256/OCB(12)");
2✔
1021
   #endif
1022

1023
         server_ses->remove_all();
1✔
1024

1025
   #if defined(BOTAN_HAS_AEAD_CHACHA20_POLY1305)
1026
         test_modern_versions(
3✔
1027
            "ChaCha20Poly1305 ECDH", results, client_ses, server_ses, creds, "ECDH", "ChaCha20Poly1305");
1028
   #endif
1029

1030
         test_modern_versions("AES-128/GCM PSK", results, client_ses, server_ses, creds, "PSK", "AES-128/GCM");
2✔
1031

1032
   #if defined(BOTAN_HAS_AEAD_CCM)
1033
         test_modern_versions("AES-128/CCM PSK", results, client_ses, server_ses, creds, "PSK", "AES-128/CCM");
2✔
1034
         test_modern_versions("AES-128/CCM-8 PSK", results, client_ses, server_ses, creds, "PSK", "AES-128/CCM(8)");
2✔
1035
   #endif
1036

1037
         test_modern_versions(
2✔
1038
            "AES-128/GCM ECDHE_PSK", results, client_ses, server_ses, creds, "ECDHE_PSK", "AES-128/GCM");
1039

1040
         // Test with a custom curve
1041

1042
         /*
1043
         * First register a curve, in this case secp112r1
1044
         */
1045
         const Botan::BigInt p("0xDB7C2ABF62E35E668076BEAD208B");
1✔
1046
         const Botan::BigInt a("0xDB7C2ABF62E35E668076BEAD2088");
1✔
1047
         const Botan::BigInt b("0x659EF8BA043916EEDE8911702B22");
1✔
1048

1049
         const Botan::BigInt g_x("0x09487239995A5EE76B55F9C2F098");
1✔
1050
         const Botan::BigInt g_y("0xA89CE5AF8724C0A23E0E0FF77500");
1✔
1051
         const Botan::BigInt order("0xDB7C2ABF62E35E7628DFAC6561C5");
1✔
1052

1053
         const Botan::OID oid("1.3.132.0.6");
1✔
1054
         Botan::OID::register_oid(oid, "secp112r1");
1✔
1055

1056
         // Creating this object implicitly registers the curve for future use ...
1057
         Botan::EC_Group reg_secp112r1(p, a, b, g_x, g_y, order, 1, oid);
1✔
1058

1059
         test_modern_versions("AES-256/GCM secp112r1",
4✔
1060
                              results,
1061
                              client_ses,
1062
                              server_ses,
1063
                              creds,
1064
                              "ECDH",
1065
                              "AES-256/GCM",
1066
                              "AEAD",
1067
                              {{"groups", "0xFEE1"}, {"minimum_ecdh_group_size", "112"}});
1068

1069
         // Test connection abort by the application
1070
         // by throwing in Callbacks::tls_session_established()
1071

1072
         test_session_established_abort(results, creds, rng);
2✔
1073

1074
         return results;
2✔
1075
      }
14✔
1076
};
1077

1078
BOTAN_REGISTER_TEST("tls", "unit_tls", TLS_Unit_Tests);
1079

1080
class DTLS_Reconnection_Test : public Test {
×
1081
   public:
1082
      std::vector<Test::Result> run() override {
1✔
1083
         class Test_Callbacks : public Botan::TLS::Callbacks {
4✔
1084
            public:
1085
               Test_Callbacks(Test::Result& results, std::vector<uint8_t>& outbound, std::vector<uint8_t>& recv_buf) :
3✔
1086
                     m_results(results), m_outbound(outbound), m_recv(recv_buf) {}
3✔
1087

1088
               void tls_emit_data(std::span<const uint8_t> bits) override {
28✔
1089
                  m_outbound.insert(m_outbound.end(), bits.begin(), bits.end());
28✔
1090
               }
28✔
1091

1092
               void tls_record_received(uint64_t /*seq*/, std::span<const uint8_t> bits) override {
4✔
1093
                  m_recv.insert(m_recv.end(), bits.begin(), bits.end());
4✔
1094
               }
4✔
1095

1096
               void tls_alert(Botan::TLS::Alert /*alert*/) override {
×
1097
                  // ignore
1098
               }
×
1099

1100
               void tls_session_established(const Botan::TLS::Session_Summary& /*session*/) override {
4✔
1101
                  m_results.test_success("Established a session");
4✔
1102
               }
4✔
1103

1104
            private:
1105
               Test::Result& m_results;
1106
               std::vector<uint8_t>& m_outbound;
1107
               std::vector<uint8_t>& m_recv;
1108
         };
1109

1110
         class Credentials_PSK : public Botan::Credentials_Manager {
3✔
1111
            public:
1112
               Botan::SymmetricKey psk(const std::string& type,
8✔
1113
                                       const std::string& context,
1114
                                       const std::string& /*identity*/) override {
1115
                  if(type == "tls-server" && context == "session-ticket") {
8✔
1116
                     return Botan::SymmetricKey("AABBCCDDEEFF012345678012345678");
×
1117
                  }
1118

1119
                  if(type == "tls-server" && context == "dtls-cookie-secret") {
8✔
1120
                     return Botan::SymmetricKey("4AEA5EAD279CADEB537A594DA0E9DE3A");
4✔
1121
                  }
1122

1123
                  if(context == "localhost" && type == "tls-client") {
4✔
1124
                     return Botan::SymmetricKey("20B602D1475F2DF888FCB60D2AE03AFD");
2✔
1125
                  }
1126

1127
                  if(context == "localhost" && type == "tls-server") {
2✔
1128
                     return Botan::SymmetricKey("20B602D1475F2DF888FCB60D2AE03AFD");
2✔
1129
                  }
1130

1131
                  throw Test_Error("No PSK set for " + type + "/" + context);
×
1132
               }
1133
         };
1134

1135
         class Datagram_PSK_Policy : public Botan::TLS::Policy {
5✔
1136
            public:
1137
               std::vector<std::string> allowed_macs() const override { return std::vector<std::string>({"AEAD"}); }
216✔
1138

1139
               std::vector<std::string> allowed_key_exchange_methods() const override { return {"PSK"}; }
8✔
1140

1141
               bool allow_tls12() const override { return false; }
6✔
1142

1143
               bool allow_dtls12() const override { return true; }
19✔
1144

1145
               bool allow_dtls_epoch0_restart() const override { return true; }
8✔
1146
         };
1147

1148
         Test::Result result("DTLS reconnection");
1✔
1149

1150
         auto server_policy = std::make_shared<Datagram_PSK_Policy>();
1✔
1151
         auto client_policy = std::make_shared<Datagram_PSK_Policy>();
1✔
1152
         auto creds = std::make_shared<Credentials_PSK>();
1✔
1153
         auto server_sessions = std::make_shared<Botan::TLS::Session_Manager_In_Memory>(rng_as_shared());
2✔
1154
         auto client_sessions = std::make_shared<Botan::TLS::Session_Manager_Noop>();
1✔
1155

1156
         std::vector<uint8_t> s2c, server_recv;
1✔
1157
         auto server_callbacks = std::make_shared<Test_Callbacks>(result, s2c, server_recv);
1✔
1158
         Botan::TLS::Server server(server_callbacks, server_sessions, creds, server_policy, rng_as_shared(), true);
6✔
1159

1160
         std::vector<uint8_t> c1_c2s, client1_recv;
1✔
1161
         auto client1_callbacks = std::make_shared<Test_Callbacks>(result, c1_c2s, client1_recv);
1✔
1162
         Botan::TLS::Client client1(client1_callbacks,
1✔
1163
                                    client_sessions,
1164
                                    creds,
1165
                                    client_policy,
1166
                                    rng_as_shared(),
1✔
1167
                                    Botan::TLS::Server_Information("localhost"),
2✔
1168
                                    Botan::TLS::Protocol_Version::latest_dtls_version());
6✔
1169

1170
         bool c1_to_server_sent = false;
1✔
1171
         bool server_to_c1_sent = false;
1✔
1172

1173
         const std::vector<uint8_t> c1_to_server_magic(16, 0xC1);
1✔
1174
         const std::vector<uint8_t> server_to_c1_magic(16, 0x42);
1✔
1175

1176
         size_t c1_rounds = 0;
1✔
1177
         for(;;) {
10✔
1178
            c1_rounds++;
10✔
1179

1180
            if(c1_rounds > 64) {
10✔
1181
               result.test_failure("Still spinning in client1 loop after 64 rounds");
×
1182
               return {result};
×
1183
            }
1184

1185
            if(!c1_c2s.empty()) {
10✔
1186
               std::vector<uint8_t> input;
4✔
1187
               std::swap(c1_c2s, input);
4✔
1188
               server.received_data(input.data(), input.size());
4✔
1189
               continue;
4✔
1190
            }
4✔
1191

1192
            if(!s2c.empty()) {
6✔
1193
               std::vector<uint8_t> input;
4✔
1194
               std::swap(s2c, input);
4✔
1195
               client1.received_data(input.data(), input.size());
4✔
1196
               continue;
4✔
1197
            }
4✔
1198

1199
            if(!c1_to_server_sent && client1.is_active()) {
2✔
1200
               client1.send(c1_to_server_magic);
1✔
1201
               c1_to_server_sent = true;
1✔
1202
            }
1203

1204
            if(!server_to_c1_sent && server.is_active()) {
2✔
1205
               server.send(server_to_c1_magic);
2✔
1206
            }
1207

1208
            if(!server_recv.empty() && !client1_recv.empty()) {
2✔
1209
               result.test_eq("Expected message from client1", server_recv, c1_to_server_magic);
1✔
1210
               result.test_eq("Expected message to client1", client1_recv, server_to_c1_magic);
1✔
1211
               break;
1✔
1212
            }
1213
         }
1214

1215
         // Now client1 "goes away" (goes silent) and new client
1216
         // connects to same server context (ie due to reuse of client source port)
1217
         // See RFC 6347 section 4.2.8
1218

1219
         server_recv.clear();
1✔
1220
         s2c.clear();
1✔
1221

1222
         std::vector<uint8_t> c2_c2s, client2_recv;
1✔
1223
         auto client2_callbacks = std::make_shared<Test_Callbacks>(result, c2_c2s, client2_recv);
1✔
1224
         Botan::TLS::Client client2(client2_callbacks,
1✔
1225
                                    client_sessions,
1226
                                    creds,
1227
                                    client_policy,
1228
                                    rng_as_shared(),
1✔
1229
                                    Botan::TLS::Server_Information("localhost"),
2✔
1230
                                    Botan::TLS::Protocol_Version::latest_dtls_version());
6✔
1231

1232
         bool c2_to_server_sent = false;
1✔
1233
         bool server_to_c2_sent = false;
1✔
1234

1235
         const std::vector<uint8_t> c2_to_server_magic(16, 0xC2);
1✔
1236
         const std::vector<uint8_t> server_to_c2_magic(16, 0x66);
1✔
1237

1238
         size_t c2_rounds = 0;
1✔
1239

1240
         for(;;) {
10✔
1241
            c2_rounds++;
10✔
1242

1243
            if(c2_rounds > 64) {
10✔
1244
               result.test_failure("Still spinning in client2 loop after 64 rounds");
×
1245
               return {result};
×
1246
            }
1247

1248
            if(!c2_c2s.empty()) {
10✔
1249
               std::vector<uint8_t> input;
4✔
1250
               std::swap(c2_c2s, input);
4✔
1251
               server.received_data(input.data(), input.size());
4✔
1252
               continue;
4✔
1253
            }
4✔
1254

1255
            if(!s2c.empty()) {
6✔
1256
               std::vector<uint8_t> input;
4✔
1257
               std::swap(s2c, input);
4✔
1258
               client2.received_data(input.data(), input.size());
4✔
1259
               continue;
4✔
1260
            }
4✔
1261

1262
            if(!c2_to_server_sent && client2.is_active()) {
2✔
1263
               client2.send(c2_to_server_magic);
1✔
1264
               c2_to_server_sent = true;
1✔
1265
            }
1266

1267
            if(!server_to_c2_sent && server.is_active()) {
2✔
1268
               server.send(server_to_c2_magic);
2✔
1269
            }
1270

1271
            if(!server_recv.empty() && !client2_recv.empty()) {
2✔
1272
               result.test_eq("Expected message from client2", server_recv, c2_to_server_magic);
1✔
1273
               result.test_eq("Expected message to client2", client2_recv, server_to_c2_magic);
1✔
1274
               break;
1✔
1275
            }
1276
         }
1277

1278
         return {result};
2✔
1279
      }
17✔
1280
};
1281

1282
BOTAN_REGISTER_TEST("tls", "tls_dtls_reconnect", DTLS_Reconnection_Test);
1283

1284
#endif
1285

1286
}  // namespace
1287

1288
}  // 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