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

randombit / botan / 22045109103

15 Feb 2026 11:27PM UTC coverage: 90.043% (-0.01%) from 90.054%
22045109103

push

github

web-flow
Merge pull request #5342 from randombit/jack/test-h-arb-eq

Rename test_is_eq to test_arb_eq and require the type be printable

102325 of 113640 relevant lines covered (90.04%)

11463137.71 hits per line

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

98.8
/src/tests/test_tls_session_manager.cpp
1
/*
2
* (C) 2022 Jack Lloyd
3
* (C) 2022 René Meusel - Rohde & Schwarz Cybersecurity
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include "tests.h"
9

10
#if defined(BOTAN_HAS_TLS)
11

12
   #include <botan/assert.h>
13
   #include <botan/credentials_manager.h>
14
   #include <botan/hex.h>
15
   #include <botan/rng.h>
16
   #include <botan/tls_callbacks.h>
17
   #include <botan/tls_policy.h>
18
   #include <botan/tls_session_manager_hybrid.h>
19
   #include <botan/tls_session_manager_memory.h>
20
   #include <botan/tls_session_manager_stateless.h>
21
   #include <botan/internal/fmt.h>
22
   #include <array>
23
   #include <chrono>
24

25
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
26
      #include <botan/tls_session_manager_sqlite.h>
27
   #endif
28

29
   #if defined(BOTAN_HAS_TLS_13)
30
      #include <botan/tls_psk_identity_13.h>
31
   #endif
32

33
   #if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
34
      #include <version>
35
      #if defined(__cpp_lib_filesystem)
36
         #include <filesystem>
37
      #endif
38
   #endif
39

40
// This file contains a number of `Botan::TLS::Version_Code::TLS_V**` protocol
41
// version specifications. This is to work around a compiler bug in GCC 11.3
42
// where `Botan::TLS::Protocol_Version::TLS_V12` would lead to an "Internal
43
// Compiler Error" when used in the affected context.
44
//
45
// TODO: remove the workaround once GCC 11 is not supported anymore.
46

47
namespace Botan_Tests {
48

49
class Test_Credentials_Manager : public Botan::Credentials_Manager {
7✔
50
   public:
51
      Botan::secure_vector<uint8_t> session_ticket_key() override {
55✔
52
         return Botan::hex_decode_locked("DEADFACECAFEBAAD");
55✔
53
      }
54
};
55

56
class Other_Test_Credentials_Manager : public Botan::Credentials_Manager {
1✔
57
   public:
58
      Botan::secure_vector<uint8_t> session_ticket_key() override {
1✔
59
         return Botan::hex_decode_locked("CAFEBAADFACEBABE");
1✔
60
      }
61
};
62

63
class Empty_Credentials_Manager : public Botan::Credentials_Manager {};
4✔
64

65
class Session_Manager_Callbacks : public Botan::TLS::Callbacks {
3✔
66
   public:
67
      void tls_emit_data(std::span<const uint8_t> /*data*/) override { BOTAN_ASSERT_NOMSG(false); }
×
68

69
      void tls_record_received(uint64_t /*record*/, std::span<const uint8_t> /*data*/) override {
×
70
         BOTAN_ASSERT_NOMSG(false);
×
71
      }
72

73
      void tls_alert(Botan::TLS::Alert /*alert*/) override { BOTAN_ASSERT_NOMSG(false); }
×
74

75
      void tls_session_established(const Botan::TLS::Session_Summary& /*summary*/) override {
×
76
         BOTAN_ASSERT_NOMSG(false);
×
77
      }
78

79
      std::chrono::system_clock::time_point tls_current_timestamp() override {
225✔
80
         return std::chrono::system_clock::now() + std::chrono::hours(m_ticks);
225✔
81
      }
82

83
      void tick() { ++m_ticks; }
13✔
84

85
   private:
86
      uint64_t m_ticks = 0;
87
};
88

89
class Session_Manager_Policy : public Botan::TLS::Policy {
6✔
90
   public:
91
      std::chrono::seconds session_ticket_lifetime() const override { return std::chrono::minutes(30); }
198✔
92

93
      bool reuse_session_tickets() const override { return m_allow_session_reuse; }
27✔
94

95
      size_t maximum_session_tickets_per_client_hello() const override { return m_session_limit; }
58✔
96

97
      void set_session_limit(size_t l) { m_session_limit = l; }
6✔
98

99
      void set_allow_session_reuse(bool b) { m_allow_session_reuse = b; }
4✔
100

101
   private:
102
      size_t m_session_limit = 1000;  // basically 'no limit'
103
      bool m_allow_session_reuse = true;
104
};
105

106
namespace {
107

108
decltype(auto) random_id(Botan::RandomNumberGenerator& rng) {
60✔
109
   return rng.random_vec<Botan::TLS::Session_ID>(32);
58✔
110
}
111

112
decltype(auto) random_ticket(Botan::RandomNumberGenerator& rng) {
29✔
113
   return rng.random_vec<Botan::TLS::Session_Ticket>(32);
27✔
114
}
115

116
decltype(auto) random_opaque_handle(Botan::RandomNumberGenerator& rng) {
1✔
117
   return rng.random_vec<Botan::TLS::Opaque_Session_Handle>(32);
1✔
118
}
119

120
const Botan::TLS::Server_Information& server_info() {
151✔
121
   static const Botan::TLS::Server_Information si("botan.randombit.net");
151✔
122
   return si;
151✔
123
}
124

125
decltype(auto) default_session(Botan::TLS::Connection_Side side,
118✔
126
                               Botan::TLS::Callbacks& cbs,
127
                               Botan::TLS::Protocol_Version version = Botan::TLS::Protocol_Version::TLS_V12) {
128
   if(version.is_pre_tls_13()) {
118✔
129
      return Botan::TLS::Session(
108✔
130
         {}, version, 0x009C, side, true, true, {}, server_info(), 0, cbs.tls_current_timestamp());
216✔
131
   } else {
132
   #if defined(BOTAN_HAS_TLS_13)
133
      return Botan::TLS::Session({},
10✔
134
                                 std::nullopt,
135
                                 0,
136
                                 std::chrono::seconds(1024),
10✔
137
                                 Botan::TLS::Protocol_Version::TLS_V13,
138
                                 Botan::TLS::Ciphersuite::from_name("AES_128_GCM_SHA256")->ciphersuite_code(),
10✔
139
                                 side,
140
                                 {},
141
                                 nullptr,
142
                                 server_info(),
143
                                 cbs.tls_current_timestamp());
20✔
144
   #else
145
      throw Test_Error("TLS 1.3 is not available in this build");
146
   #endif
147
   }
148
}
149

150
using namespace std::literals;
151

152
std::vector<Test::Result> test_session_manager_in_memory() {
1✔
153
   auto rng = Test::new_shared_rng(__func__);
1✔
154

155
   const Botan::TLS::Session_ID default_id = random_id(*rng);
1✔
156

157
   std::optional<Botan::TLS::Session_Manager_In_Memory> mgr;
1✔
158

159
   Session_Manager_Callbacks cbs;
1✔
160
   Session_Manager_Policy plcy;
1✔
161

162
   return {
1✔
163
      CHECK("creation", [&](auto&) { mgr.emplace(rng, 5); }),
1✔
164

165
      CHECK("empty cache does not obtain anything",
166
            [&](auto& result) {
1✔
167
               result.test_is_true("no session found via server info", mgr->find(server_info(), cbs, plcy).empty());
1✔
168

169
               const Botan::TLS::Session_ID mock_id = random_id(*rng);
1✔
170
               auto mock_ticket = rng->random_vec<Botan::TLS::Session_Ticket>(128);
1✔
171

172
               result.test_is_true("no session found via ID", !mgr->retrieve(mock_id, cbs, plcy));
3✔
173
               result.test_is_true("no session found via ID", !mgr->retrieve(mock_ticket, cbs, plcy));
3✔
174
            }),
2✔
175

176
      CHECK("clearing empty cache",
177
            [&](auto& result) { result.test_sz_eq("does not delete anything", mgr->remove_all(), 0); }),
1✔
178

179
      CHECK("establish new session",
180
            [&](auto& result) {
1✔
181
               auto handle = mgr->establish(default_session(Botan::TLS::Connection_Side::Server, cbs), default_id);
1✔
182
               if(result.test_is_true("establishment was successful", handle.has_value())) {
1✔
183
                  result.require("session id was set", handle->id().has_value());
1✔
184
                  result.test_is_true("session ticket was empty", !handle->ticket().has_value());
1✔
185
                  result.test_bin_eq("session id is correct", handle->id().value(), default_id);
2✔
186
               }
187
            }),
1✔
188

189
      CHECK(
190
         "obtain session from server info",
191
         [&](auto& result) {
1✔
192
            auto sessions = mgr->find(server_info(), cbs, plcy);
1✔
193
            if(result.test_is_true("session was found successfully", sessions.size() == 1)) {
1✔
194
               result.test_u16_eq("protocol version was echoed", sessions[0].session.version().version_code(), 0x0303);
1✔
195
               result.test_u16_eq("ciphersuite was echoed", sessions[0].session.ciphersuite_code(), uint16_t(0x009C));
1✔
196
               result.test_bin_eq("ID was echoed", sessions[0].handle.id().value(), default_id);
2✔
197
               result.test_is_true("not a ticket", !sessions[0].handle.ticket().has_value());
1✔
198
            }
199
         }),
1✔
200

201
      CHECK("obtain session from ID",
202
            [&](auto& result) {
1✔
203
               auto session = mgr->retrieve(default_id, cbs, plcy);
2✔
204
               if(result.test_is_true("session was found successfully", session.has_value())) {
1✔
205
                  result.test_u16_eq("protocol version was echoed", session->version().version_code(), 0x0303);
1✔
206
                  result.test_u16_eq("ciphersuite was echoed", session->ciphersuite_code(), uint16_t(0x009C));
1✔
207
               }
208
            }),
1✔
209

210
      CHECK("obtain session from ID disguised as opaque handle",
211
            [&](auto& result) {
1✔
212
               auto session = mgr->retrieve(Botan::TLS::Opaque_Session_Handle(default_id), cbs, plcy);
2✔
213
               if(result.test_is_true("session was found successfully", session.has_value())) {
1✔
214
                  result.test_u16_eq("protocol version was echoed", session->version().version_code(), 0x0303);
1✔
215
                  result.test_u16_eq("ciphersuite was echoed", session->ciphersuite_code(), uint16_t(0x009C));
1✔
216
               }
217
            }),
1✔
218

219
      CHECK("obtain session from ticket == id does not work",
220
            [&](auto& result) {
1✔
221
               auto session = mgr->retrieve(Botan::TLS::Session_Ticket(default_id), cbs, plcy);
2✔
222
               result.test_is_true("session was not found", !session.has_value());
1✔
223
            }),
1✔
224

225
      CHECK("invalid ticket causes std::nullopt",
226
            [&](auto& result) {
1✔
227
               auto no_session = mgr->retrieve(random_ticket(*rng), cbs, plcy);
2✔
228
               result.test_is_true("std::nullopt on bogus ticket", !no_session.has_value());
1✔
229
            }),
1✔
230

231
      CHECK("invalid ID causes std::nullopt",
232
            [&](auto& result) {
1✔
233
               auto no_session = mgr->retrieve(random_id(*rng), cbs, plcy);
2✔
234
               result.test_is_true("std::nullopt on bogus ID", !no_session.has_value());
1✔
235
            }),
1✔
236

237
      CHECK("remove_all",
238
            [&](auto& result) {
1✔
239
               result.test_sz_eq("removed one element", mgr->remove_all(), 1);
1✔
240
               result.test_sz_eq("should be empty now", mgr->remove_all(), 0);
1✔
241
            }),
1✔
242

243
      CHECK(
244
         "add session with ID",
245
         [&](auto& result) {
1✔
246
            const Botan::TLS::Session_ID new_id = random_id(*rng);
1✔
247

248
            mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs), new_id);
3✔
249
            result.require("obtain via ID", mgr->retrieve(new_id, cbs, plcy).has_value());
4✔
250

251
            auto sessions = mgr->find(server_info(), cbs, plcy);
1✔
252
            if(result.test_is_true("found via server info", sessions.size() == 1)) {
1✔
253
               result.test_u16_eq("protocol version was echoed", sessions[0].session.version().version_code(), 0x0303);
1✔
254
               result.test_u16_eq("ciphersuite was echoed", sessions[0].session.ciphersuite_code(), uint16_t(0x009C));
1✔
255
               result.test_bin_eq("ID was echoed", sessions[0].handle.id().value(), new_id);
2✔
256
               result.test_is_true("ticket was not stored", !sessions[0].handle.ticket().has_value());
1✔
257
            }
258

259
            mgr->remove_all();
1✔
260
         }),
2✔
261

262
      CHECK(
263
         "add session with ticket",
264
         [&](auto& result) {
1✔
265
            const Botan::TLS::Session_Ticket new_ticket = random_ticket(*rng);
1✔
266

267
            mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs), new_ticket);
3✔
268
            // cannot be obtained by (non-existent) ID or randomly generated ticket
269

270
            auto sessions = mgr->find(server_info(), cbs, plcy);
1✔
271
            if(result.test_is_true("found via server info", sessions.size() == 1)) {
1✔
272
               result.test_u16_eq("protocol version was echoed", sessions[0].session.version().version_code(), 0x0303);
1✔
273
               result.test_u16_eq("ciphersuite was echoed", sessions[0].session.ciphersuite_code(), uint16_t(0x009C));
1✔
274
               result.test_is_true("ID was not stored", !sessions[0].handle.id().has_value());
1✔
275
               result.test_bin_eq("ticket was echoed", sessions[0].handle.ticket().value(), new_ticket);
2✔
276
            }
277

278
            mgr->remove_all();
1✔
279
         }),
2✔
280

281
      CHECK("removing by ID or opaque handle",
282
            [&](auto& result) {
1✔
283
               Botan::TLS::Session_Manager_In_Memory local_mgr(rng);
1✔
284

285
               const auto new_session1 =
1✔
286
                  local_mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), default_id);
287
               const auto new_session2 = local_mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
288
               result.require(
1✔
289
                  "saving worked",
290
                  new_session1.has_value() && new_session1->id().has_value() && !new_session1->ticket().has_value());
4✔
291
               result.require(
1✔
292
                  "saving worked",
293
                  new_session2.has_value() && new_session2->id().has_value() && !new_session2->ticket().has_value());
4✔
294

295
               result.test_sz_eq("can find via server info", local_mgr.find(server_info(), cbs, plcy).size(), 2);
1✔
296

297
               result.test_sz_eq("one was deleted", local_mgr.remove(default_id), 1);
3✔
298
               result.test_is_true("cannot obtain via default ID anymore",
1✔
299
                                   !local_mgr.retrieve(default_id, cbs, plcy).has_value());
4✔
300
               result.test_sz_eq("can find less via server info", local_mgr.find(server_info(), cbs, plcy).size(), 1);
1✔
301

302
               result.test_sz_eq("last one was deleted",
2✔
303
                                 local_mgr.remove(Botan::TLS::Opaque_Session_Handle(new_session2->id().value())),
3✔
304
                                 1);
305
               result.test_is_true("cannot obtain via ID anymore",
1✔
306
                                   !local_mgr.retrieve(new_session2->id().value(), cbs, plcy).has_value());
4✔
307
               result.test_is_true("cannot find via server info", local_mgr.find(server_info(), cbs, plcy).empty());
1✔
308
            }),
2✔
309

310
      CHECK("removing by ticket or opaque handle",
311
            [&](auto& result) {
1✔
312
               Botan::TLS::Session_Manager_In_Memory local_mgr(rng);
1✔
313

314
               const Botan::TLS::Session_Ticket ticket1 = random_ticket(*rng);
1✔
315
               const Botan::TLS::Session_Ticket ticket2 = random_ticket(*rng);
1✔
316
               Botan::TLS::Session_Ticket ticket3 = random_ticket(*rng);
1✔
317

318
               local_mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket1);
2✔
319
               local_mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket2);
2✔
320
               local_mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket3);
2✔
321
               result.test_sz_eq("can find them via server info ", local_mgr.find(server_info(), cbs, plcy).size(), 3);
1✔
322

323
               result.test_sz_eq("remove one session by ticket", local_mgr.remove(ticket2), 1);
2✔
324
               result.test_sz_eq("can find two via server info", local_mgr.find(server_info(), cbs, plcy).size(), 2);
1✔
325

326
               result.test_sz_eq("remove one session by opaque handle",
2✔
327
                                 local_mgr.remove(Botan::TLS::Opaque_Session_Handle(ticket3.get())),
2✔
328
                                 1);
329
               result.test_sz_eq(
1✔
330
                  "can find only one via server info", local_mgr.find(server_info(), cbs, plcy).size(), 1);
331
            }),
3✔
332

333
      CHECK(
334
         "session purging",
335
         [&](auto& result) {
1✔
336
            result.require("max sessions is 5", mgr->capacity() == 5);
1✔
337

338
            // fill the Session_Manager up fully
339
            std::vector<Botan::TLS::Session_Handle> handles;
1✔
340
            handles.reserve(mgr->capacity());
1✔
341
            for(size_t i = 0; i < mgr->capacity(); ++i) {
6✔
342
               handles.push_back(
5✔
343
                  mgr->establish(default_session(Botan::TLS::Connection_Side::Server, cbs), random_id(*rng)).value());
15✔
344
            }
345

346
            for(const auto& handle : handles) {
6✔
347
               result.test_is_true("session still there", mgr->retrieve(handle, cbs, plcy).has_value());
10✔
348
            }
349

350
            // add one more session (causing a first purge to happen)
351
            handles.push_back(
1✔
352
               mgr->establish(default_session(Botan::TLS::Connection_Side::Server, cbs), random_id(*rng)).value());
3✔
353

354
            result.test_is_true("oldest session gone", !mgr->retrieve(handles[0], cbs, plcy).has_value());
1✔
355
            for(size_t i = 1; i < handles.size(); ++i) {
6✔
356
               result.test_is_true("session still there", mgr->retrieve(handles[i], cbs, plcy).has_value());
10✔
357
            }
358

359
            // remove a session to cause a 'gap' in the FIFO
360
            mgr->remove(handles[4]);
1✔
361
            result.test_is_true("oldest session gone", !mgr->retrieve(handles[0], cbs, plcy).has_value());
1✔
362
            result.test_is_true("deleted session gone", !mgr->retrieve(handles[4], cbs, plcy).has_value());
1✔
363
            for(size_t i = 1; i < handles.size(); ++i) {
6✔
364
               result.test_is_true("session still there", i == 4 || mgr->retrieve(handles[i], cbs, plcy).has_value());
9✔
365
            }
366

367
            // insert enough new sessions to fully purge the ones currently held
368
            for(size_t i = 0; i < mgr->capacity(); ++i) {
6✔
369
               handles.push_back(
5✔
370
                  mgr->establish(default_session(Botan::TLS::Connection_Side::Server, cbs), random_id(*rng)).value());
15✔
371
            }
372

373
            for(size_t i = 0; i < handles.size() - mgr->capacity(); ++i) {
7✔
374
               result.test_is_true("session gone", !mgr->retrieve(handles[i], cbs, plcy).has_value());
6✔
375
            }
376

377
            for(size_t i = handles.size() - mgr->capacity(); i < handles.size(); ++i) {
6✔
378
               result.test_is_true("session still there", mgr->retrieve(handles[i], cbs, plcy).has_value());
10✔
379
            }
380

381
            // clear it all out
382
            result.test_sz_eq("rest of the sessions removed", mgr->remove_all(), size_t(5));
1✔
383
         }),
1✔
384
   };
17✔
385
}
5✔
386

387
std::vector<Test::Result> test_session_manager_choose_ticket() {
1✔
388
   #if defined(BOTAN_HAS_TLS_13)
389
   Session_Manager_Callbacks cbs;
1✔
390
   Session_Manager_Policy plcy;
1✔
391

392
   auto rng = Test::new_shared_rng(__func__);
1✔
393

394
   auto default_session = [&](const std::string& suite,
9✔
395
                              Botan::TLS::Callbacks& mycbs,
396
                              Botan::TLS::Protocol_Version version = Botan::TLS::Protocol_Version::TLS_V13) {
397
      return (version.is_pre_tls_13())
8✔
398
                ? Botan::TLS::Session({},
8✔
399
                                      version,
400
                                      Botan::TLS::Ciphersuite::from_name(suite)->ciphersuite_code(),
1✔
401
                                      Botan::TLS::Connection_Side::Server,
402
                                      true,
403
                                      true,
404
                                      {},
405
                                      server_info(),
406
                                      0,
407
                                      mycbs.tls_current_timestamp())
1✔
408
                : Botan::TLS::Session({},
409
                                      std::nullopt,
410
                                      0,
411
                                      std::chrono::seconds(1024),
7✔
412
                                      version,
413
                                      Botan::TLS::Ciphersuite::from_name(suite)->ciphersuite_code(),
7✔
414
                                      Botan::TLS::Connection_Side::Server,
415
                                      {},
416
                                      nullptr,
417
                                      server_info(),
418
                                      mycbs.tls_current_timestamp());
23✔
419
   };
420

421
   auto ticket = [&](std::span<const uint8_t> identity) {
16✔
422
      return Botan::TLS::PskIdentity(std::vector(identity.begin(), identity.end()), 0);
15✔
423
   };
424

425
   return {
1✔
426
      CHECK("empty manager has nothing to choose from",
427
            [&](auto& result) {
1✔
428
               Botan::TLS::Session_Manager_In_Memory mgr(rng);
1✔
429

430
               Botan::TLS::Session_Ticket random_session_ticket = random_ticket(*rng);
1✔
431

432
               result.test_is_true("empty ticket list, no session",
1✔
433
                                   !mgr.choose_from_offered_tickets({}, "SHA-256", cbs, plcy).has_value());
2✔
434
               result.test_is_true(
1✔
435
                  "empty session manager, no session",
436
                  !mgr.choose_from_offered_tickets(std::vector{ticket(random_session_ticket)}, "SHA-256", cbs, plcy)
3✔
437
                      .has_value());
3✔
438
            }),
3✔
439

440
      CHECK("choose ticket by ID",
441
            [&](auto& result) {
1✔
442
               Botan::TLS::Session_Manager_In_Memory mgr(rng);
1✔
443
               std::vector<Botan::TLS::Session_Handle> handles;
1✔
444

445
               handles.push_back(mgr.establish(default_session("AES_128_GCM_SHA256", cbs)).value());
3✔
446
               handles.push_back(mgr.establish(default_session("AES_128_GCM_SHA256", cbs)).value());
3✔
447

448
               // choose from a list of tickets that contains only handles[0]
449
               auto session1 =
2✔
450
                  mgr.choose_from_offered_tickets(std::vector{ticket(handles[0].id().value())}, "SHA-256", cbs, plcy);
3✔
451
               result.require("ticket was chosen and produced a session (1)", session1.has_value());
1✔
452
               result.test_u16_eq("chosen offset", session1->second, uint16_t(0));
1✔
453

454
               // choose from a list of tickets that contains only handles[1]
455
               auto session2 =
2✔
456
                  mgr.choose_from_offered_tickets(std::vector{ticket(handles[1].id().value())}, "SHA-256", cbs, plcy);
3✔
457
               result.require("ticket was chosen and produced a session (2)", session2.has_value());
1✔
458
               result.test_u16_eq("chosen offset", session2->second, uint16_t(0));
1✔
459

460
               // choose from a list of tickets that contains a random ticket and handles[1]
461
               auto session3 = mgr.choose_from_offered_tickets(
2✔
462
                  std::vector{ticket(random_ticket(*rng)), ticket(handles[1].id().value())}, "SHA-256", cbs, plcy);
5✔
463
               result.require("ticket was chosen and produced a session (3)", session3.has_value());
1✔
464
               result.test_u16_eq("chosen second offset", session3->second, uint16_t(1));
1✔
465
            }),
13✔
466

467
      CHECK("choose ticket by ticket",
468
            [&](auto& result) {
1✔
469
               auto creds = std::make_shared<Test_Credentials_Manager>();
470
               Botan::TLS::Session_Manager_Stateless mgr(creds, rng);
1✔
471
               std::vector<Botan::TLS::Session_Handle> handles;
1✔
472

473
               handles.push_back(mgr.establish(default_session("AES_128_GCM_SHA256", cbs)).value());
3✔
474
               handles.push_back(mgr.establish(default_session("AES_128_GCM_SHA256", cbs)).value());
3✔
475

476
               // choose from a list of tickets that contains only handles[0]
477
               auto session1 = mgr.choose_from_offered_tickets(
2✔
478
                  std::vector{ticket(handles[0].ticket().value())}, "SHA-256", cbs, plcy);
4✔
479
               result.require("ticket was chosen and produced a session (1)", session1.has_value());
1✔
480
               result.test_u16_eq("chosen offset", session1->second, uint16_t(0));
1✔
481

482
               // choose from a list of tickets that contains only handles[1]
483
               auto session2 = mgr.choose_from_offered_tickets(
2✔
484
                  std::vector{ticket(handles[1].ticket().value())}, "SHA-256", cbs, plcy);
4✔
485
               result.require("ticket was chosen and produced a session (2)", session2.has_value());
1✔
486
               result.test_u16_eq("chosen offset", session2->second, uint16_t(0));
1✔
487

488
               // choose from a list of tickets that contains a random ticket and handles[1]
489
               auto session3 = mgr.choose_from_offered_tickets(
2✔
490
                  std::vector{ticket(random_ticket(*rng)), ticket(handles[1].ticket().value())}, "SHA-256", cbs, plcy);
5✔
491
               result.require("ticket was chosen and produced a session (3)", session3.has_value());
1✔
492
               result.test_u16_eq("chosen second offset", session3->second, uint16_t(1));
1✔
493
            }),
14✔
494

495
      CHECK("choose ticket based on requested hash function",
496
            [&](auto& result) {
1✔
497
               auto creds = std::make_shared<Test_Credentials_Manager>();
498
               Botan::TLS::Session_Manager_Stateless mgr(creds, rng);
1✔
499
               std::vector<Botan::TLS::Session_Handle> handles;
1✔
500

501
               handles.push_back(mgr.establish(default_session("AES_128_GCM_SHA256", cbs)).value());
3✔
502
               handles.push_back(mgr.establish(default_session("AES_256_GCM_SHA384", cbs)).value());
3✔
503

504
               auto session = mgr.choose_from_offered_tickets(std::vector{ticket(random_ticket(*rng)),
5✔
505
                                                                          ticket(handles[0].ticket().value()),
1✔
506
                                                                          ticket(handles[1].ticket().value())},
1✔
507
                                                              "SHA-384",
508
                                                              cbs,
509
                                                              plcy);
510
               result.require("ticket was chosen and produced a session", session.has_value());
1✔
511
               result.test_u16_eq("chosen second offset", session->second, uint16_t(2));
1✔
512
            }),
7✔
513

514
      CHECK("choose ticket based on protocol version",
515
            [&](auto& result) {
1✔
516
               auto creds = std::make_shared<Test_Credentials_Manager>();
517
               Botan::TLS::Session_Manager_Stateless mgr(creds, rng);
1✔
518
               std::vector<Botan::TLS::Session_Handle> handles;
1✔
519

520
               handles.push_back(
1✔
521
                  mgr.establish(default_session("AES_128_GCM_SHA256", cbs, Botan::TLS::Version_Code::TLS_V12)).value());
3✔
522
               handles.push_back(
1✔
523
                  mgr.establish(default_session("AES_128_GCM_SHA256", cbs, Botan::TLS::Version_Code::TLS_V13)).value());
3✔
524

525
               auto session = mgr.choose_from_offered_tickets(std::vector{ticket(random_ticket(*rng)),
5✔
526
                                                                          ticket(handles[0].ticket().value()),
1✔
527
                                                                          ticket(handles[1].ticket().value())},
1✔
528
                                                              "SHA-256",
529
                                                              cbs,
530
                                                              plcy);
531
               result.require("ticket was chosen and produced a session", session.has_value());
1✔
532
               result.test_u16_eq("chosen second offset (TLS 1.3 ticket)", session->second, uint16_t(2));
1✔
533
            }),
7✔
534
   };
7✔
535
   #else
536
   return {};
537
   #endif
538
}
2✔
539

540
std::vector<Test::Result> test_session_manager_stateless() {
1✔
541
   auto creds = std::make_shared<Test_Credentials_Manager>();
1✔
542

543
   auto rng = Test::new_shared_rng(__func__);
1✔
544

545
   Botan::TLS::Session_Manager_Stateless mgr(creds, rng);
1✔
546

547
   Session_Manager_Callbacks cbs;
1✔
548
   Session_Manager_Policy plcy;
1✔
549

550
   return {
1✔
551
      CHECK("establish with default parameters",
552
            [&](auto& result) {
1✔
553
               result.test_is_true("will emit tickets", mgr.emits_session_tickets());
1✔
554
               auto ticket = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
555
               result.test_is_true("returned ticket", ticket.has_value() && ticket->is_ticket());
1✔
556
            }),
1✔
557

558
      CHECK("establish with disabled tickets",
559
            [&](auto& result) {
1✔
560
               result.test_is_true("will emit tickets", mgr.emits_session_tickets());
1✔
561
               auto ticket =
1✔
562
                  mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), std::nullopt, true);
1✔
563
               result.test_is_true("returned std::nullopt", !ticket.has_value());
1✔
564
            }),
1✔
565

566
      CHECK("establish without ticket key in credentials manager",
567
            [&](auto& result) {
1✔
568
               Botan::TLS::Session_Manager_Stateless local_mgr(std::make_shared<Empty_Credentials_Manager>(), rng);
2✔
569

570
               result.test_is_true("won't emit tickets", !local_mgr.emits_session_tickets());
1✔
571
               auto ticket = local_mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
572
               result.test_is_true("returned std::nullopt", !ticket.has_value());
1✔
573
            }),
1✔
574

575
      CHECK("retrieve via ticket",
576
            [&](auto& result) {
1✔
577
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
578
               auto ticket2 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
579
               result.require("tickets created successfully", ticket1.has_value() && ticket2.has_value());
1✔
580

581
               Botan::TLS::Session_Manager_Stateless local_mgr(creds, rng);
1✔
582
               result.test_is_true("can retrieve ticket 1", mgr.retrieve(ticket1.value(), cbs, plcy).has_value());
1✔
583
               result.test_is_true("can retrieve ticket 2 from different manager but sam credentials",
1✔
584
                                   local_mgr.retrieve(ticket2.value(), cbs, plcy).has_value());
1✔
585
            }),
3✔
586

587
      CHECK("retrieve via ID does not work",
588
            [&](auto& result) {
1✔
589
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
590
               result.require("tickets created successfully", ticket1.has_value() && ticket1.has_value());
1✔
591

592
               result.test_is_true("retrieval by ID does not work",
1✔
593
                                   !mgr.retrieve(random_id(*rng), cbs, plcy).has_value());
3✔
594
            }),
1✔
595

596
      CHECK("retrieve via opaque handle does work",
597
            [&](auto& result) {
1✔
598
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
599
               result.require("tickets created successfully", ticket1.has_value() && ticket1.has_value());
1✔
600

601
               result.test_is_true("retrieval by opaque handle",
1✔
602
                                   mgr.retrieve(ticket1->opaque_handle(), cbs, plcy).has_value());
3✔
603
            }),
1✔
604

605
      CHECK("no retrieve without or with wrong ticket key",
606
            [&](auto& result) {
1✔
607
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
608
               result.require("tickets created successfully", ticket1.has_value() && ticket1.has_value());
1✔
609

610
               Botan::TLS::Session_Manager_Stateless local_mgr1(std::make_shared<Empty_Credentials_Manager>(), rng);
2✔
611

612
               Botan::TLS::Session_Manager_Stateless local_mgr2(std::make_shared<Other_Test_Credentials_Manager>(),
2✔
613
                                                                rng);
614

615
               result.test_is_true("no successful retrieval (without key)",
1✔
616
                                   !local_mgr1.retrieve(ticket1.value(), cbs, plcy).has_value());
1✔
617
               result.test_is_true("no successful retrieval (with wrong key)",
1✔
618
                                   !local_mgr2.retrieve(ticket1.value(), cbs, plcy).has_value());
1✔
619
               result.test_is_true("successful retrieval", mgr.retrieve(ticket1.value(), cbs, plcy).has_value());
1✔
620
            }),
2✔
621

622
      CHECK("Clients cannot be stateless",
623
            [&](auto& result) {
1✔
624
               result.test_throws("::store() does not work with ID", [&] {
1✔
625
                  mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), random_id(*rng));
3✔
626
               });
627
               result.test_throws("::store() does not work with ticket", [&] {
1✔
628
                  mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), random_ticket(*rng));
3✔
629
               });
630
               result.test_throws("::store() does not work with opaque handle", [&] {
1✔
631
                  mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), random_opaque_handle(*rng));
3✔
632
               });
633

634
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
635
               result.require("tickets created successfully", ticket1.has_value() && ticket1.has_value());
1✔
636
               result.test_is_true("finding tickets does not work", mgr.find(server_info(), cbs, plcy).empty());
1✔
637
            }),
1✔
638

639
      CHECK("remove is a NOOP",
640
            [&](auto& result) {
1✔
641
               auto ticket1 = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
642
               result.require("tickets created successfully", ticket1.has_value() && ticket1.has_value());
1✔
643

644
               result.test_sz_eq("remove the ticket", mgr.remove(ticket1.value()), 0);
1✔
645
               result.test_is_true("successful retrieval 1", mgr.retrieve(ticket1.value(), cbs, plcy).has_value());
1✔
646

647
               result.test_sz_eq("remove the ticket", mgr.remove_all(), 0);
1✔
648
               result.test_is_true("successful retrieval 1", mgr.retrieve(ticket1.value(), cbs, plcy).has_value());
2✔
649
            }),
1✔
650

651
      CHECK(
652
         "retrieval via ticket reconstructs the start_time stamp",
653
         [&](auto& result) {
1✔
654
            auto session_before = default_session(Botan::TLS::Connection_Side::Server, cbs);
1✔
655
            auto ticket = mgr.establish(session_before);
2✔
656
            result.require("got a ticket", ticket.has_value() && ticket->is_ticket());
1✔
657
            auto session_after = mgr.retrieve(ticket.value(), cbs, plcy);
1✔
658
            result.require("got the session back", session_after.has_value());
1✔
659

660
            result.test_u64_eq(
×
661
               "timestamps match",
662
               std::chrono::duration_cast<std::chrono::seconds>(session_before.start_time().time_since_epoch()).count(),
1✔
663
               std::chrono::duration_cast<std::chrono::seconds>(session_after->start_time().time_since_epoch())
1✔
664
                  .count());
1✔
665
         }),
2✔
666
   };
11✔
667
}
4✔
668

669
std::vector<Test::Result> test_session_manager_hybrid() {
1✔
670
   auto rng = Test::new_shared_rng(__func__);
1✔
671

672
   auto creds = std::make_shared<Test_Credentials_Manager>();
1✔
673
   Session_Manager_Callbacks cbs;
1✔
674
   Session_Manager_Policy plcy;
1✔
675

676
   // Runs the passed-in hybrid manager test lambdas for all available stateful
677
   // managers. The `make_manager()` helper is passed into the test code and
678
   // transparently constructs a hybrid manager with the respective internal
679
   // stateful manager.
680
   auto CHECK_all = [&](const std::string& name, auto lambda) -> std::vector<Test::Result> {
4✔
681
      const std::vector<std::pair<std::string, std::function<std::unique_ptr<Botan::TLS::Session_Manager>()>>>
682
         stateful_manager_factories = {
9✔
683
            {"In Memory",
684
             [&rng]() -> std::unique_ptr<Botan::TLS::Session_Manager> {
9✔
685
                return std::make_unique<Botan::TLS::Session_Manager_In_Memory>(rng, 10);
6✔
686
             }},
687
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
688
            {"SQLite",
689
             [&rng]() -> std::unique_ptr<Botan::TLS::Session_Manager> {
9✔
690
                return std::make_unique<Botan::TLS::Session_Manager_SQLite>(
691
                   "secure_pw", rng, Test::temp_file_name("tls_session_manager_sqlite"), 10);
6✔
692
             }},
693
   #endif
694
         };
695

696
      std::vector<Test::Result> results;
3✔
697
      using namespace std::placeholders;
698
      for(const auto& factory_and_name : stateful_manager_factories) {
15✔
699
         const auto& stateful_manager_name = factory_and_name.first;
6✔
700
         const auto& stateful_manager_factory = factory_and_name.second;
6✔
701
         auto make_manager = [stateful_manager_factory, &creds, &rng](bool prefer_tickets) {
42✔
702
            return Botan::TLS::Session_Manager_Hybrid(stateful_manager_factory(), creds, rng, prefer_tickets);
48✔
703
         };
704

705
         auto nm = Botan::fmt("{} ({})", name, stateful_manager_name);
6✔
706
         auto fn = std::bind(lambda, make_manager, _1);  // NOLINT(*-avoid-bind)
6✔
707
         results.push_back(CHECK(nm.c_str(), fn));
18✔
708
      }
709
      return results;
3✔
710
   };
7✔
711

712
   return Test::flatten_result_lists({
3✔
713
      CHECK_all("ticket vs ID preference in establishment",
1✔
714
                [&](const auto& make_manager, auto& result) {
2✔
715
                   auto mgr_prefers_tickets = make_manager(true);
2✔
716
                   auto ticket1 =
2✔
717
                      mgr_prefers_tickets.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
2✔
718
                   result.test_is_true("emits a ticket", ticket1.has_value() && ticket1->is_ticket());
2✔
719

720
                   auto mgr_prefers_ids = make_manager(false);
2✔
721
                   auto ticket2 = mgr_prefers_ids.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
2✔
722
                   result.test_is_true("emits an ID", ticket2.has_value() && ticket2->is_id());
2✔
723

724
                   auto ticket3 = mgr_prefers_ids.establish(default_session(Botan::TLS::Connection_Side::Server, cbs),
2✔
725
                                                            std::nullopt,
726
                                                            true /* TLS 1.2 no ticket support */);
727
                   result.test_is_true("emits an ID", ticket3.has_value() && ticket3->is_id());
2✔
728

729
                   auto ticket4 = mgr_prefers_ids.establish(default_session(Botan::TLS::Connection_Side::Server, cbs),
2✔
730
                                                            std::nullopt,
731
                                                            true /* TLS 1.2 no ticket support */);
732
                   result.test_is_true("emits an ID", ticket4.has_value() && ticket4->is_id());
2✔
733
                }),
8✔
734

735
      CHECK_all(
1✔
736
         "ticket vs ID preference in retrieval",
737
         [&](const auto& make_manager, auto& result) {
2✔
738
            auto mgr_prefers_tickets = make_manager(true);
2✔
739
            auto mgr_prefers_ids = make_manager(false);
2✔
740

741
            auto id1 = mgr_prefers_tickets.underlying_stateful_manager()->establish(
2✔
742
               default_session(Botan::TLS::Connection_Side::Server, cbs));
743
            auto id2 = mgr_prefers_ids.underlying_stateful_manager()->establish(
2✔
744
               default_session(Botan::TLS::Connection_Side::Server, cbs));
745
            auto ticket = mgr_prefers_tickets.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
2✔
746

747
            result.require("establishments worked", id1.has_value() && id2.has_value() && ticket.has_value());
2✔
748

749
            result.test_is_true("mgr1 + ID1", mgr_prefers_tickets.retrieve(id1.value(), cbs, plcy).has_value());
2✔
750
            result.test_is_true("mgr1 + ID2", !mgr_prefers_tickets.retrieve(id2.value(), cbs, plcy).has_value());
2✔
751
            result.test_is_true("mgr2 + ID1", !mgr_prefers_ids.retrieve(id1.value(), cbs, plcy).has_value());
2✔
752
            result.test_is_true("mgr2 + ID2", mgr_prefers_ids.retrieve(id2.value(), cbs, plcy).has_value());
2✔
753
            result.test_is_true("mgr1 + ticket", mgr_prefers_tickets.retrieve(ticket.value(), cbs, plcy).has_value());
2✔
754
            result.test_is_true("mgr2 + ticket", mgr_prefers_ids.retrieve(ticket.value(), cbs, plcy).has_value());
4✔
755
         }),
6✔
756

757
      CHECK_all("no session tickets if hybrid manager cannot create them",
1✔
758
                [&](const auto& make_manager, auto& result) {
2✔
759
                   Botan::TLS::Session_Manager_Hybrid empty_mgr(
8✔
760
                      std::make_unique<Botan::TLS::Session_Manager_In_Memory>(rng, 10),
4✔
761
                      std::make_shared<Empty_Credentials_Manager>(),
762
                      rng);
763
                   auto mgr_prefers_tickets = make_manager(true);
2✔
764
                   auto mgr_prefers_ids = make_manager(false);
2✔
765

766
                   result.test_is_true("does not emit tickets", !empty_mgr.emits_session_tickets());
2✔
767
                   result.test_is_true("does emit tickets 1", mgr_prefers_tickets.emits_session_tickets());
2✔
768
                   result.test_is_true("does emit tickets 2", mgr_prefers_ids.emits_session_tickets());
2✔
769
                }),
2✔
770
   });
4✔
771
}
4✔
772

773
namespace {
774

775
class Temporary_Database_File {
776
   private:
777
      std::string m_temp_file;
778

779
   public:
780
      explicit Temporary_Database_File(const std::string& db_file) :
1✔
781
            m_temp_file(Test::data_file_as_temporary_copy(db_file)) {
1✔
782
         if(m_temp_file.empty()) {
1✔
783
            throw Test_Error("Failed to create temporary database file");
×
784
         }
785
      }
1✔
786

787
      ~Temporary_Database_File() {
1✔
788
   #if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM) && defined(__cpp_lib_filesystem)
789
         if(!m_temp_file.empty()) {
1✔
790
            std::filesystem::remove(m_temp_file);
1✔
791
         }
792
   #endif
793
      }
1✔
794

795
      const std::string& get() const { return m_temp_file; }
796

797
      Temporary_Database_File(const Temporary_Database_File&) = delete;
798
      Temporary_Database_File& operator=(const Temporary_Database_File&) = delete;
799
      Temporary_Database_File(Temporary_Database_File&&) = delete;
800
      Temporary_Database_File& operator=(Temporary_Database_File&&) = delete;
801
};
802

803
}  // namespace
804

805
std::vector<Test::Result> test_session_manager_sqlite() {
1✔
806
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
807
   auto rng = Test::new_shared_rng(__func__);
1✔
808
   Session_Manager_Callbacks cbs;
1✔
809
   Session_Manager_Policy plcy;
1✔
810

811
   return {
1✔
812
      CHECK(
813
         "migrate session database scheme (purges database)",
814
         [&](auto& result) {
1✔
815
            const Temporary_Database_File dbfile("tls-sessions/botan-2.19.3.sqlite");
1✔
816

817
            // legacy database (encrypted with 'thetruthisoutthere') containing:
818
            //    $ sqlite3 src/tests/data/tls-sessions/botan-2.19.3.sqlite  'SELECT * FROM tls_sessions;'
819
            //    63C136FAD49F05A184F910FD6568A3884164216C11E41CEBFDCD149AF66C1714|1673606906|cloudflare.com|443|...
820
            //    63C137030387E4A6CDAD303CCB1F53884944FDE5B4EDD91E6FCF74DCB033DCEB|1673606915|randombit.net|443|...
821
            Botan::TLS::Session_Manager_SQLite legacy_db("thetruthisoutthere", rng, dbfile.get());
1✔
822

823
            result.test_is_true("Session_ID for randombit.net is gone",
1✔
824
                                !legacy_db
825
                                    .retrieve(Botan::TLS::Session_ID(Botan::hex_decode(
2✔
826
                                                 "63C137030387E4A6CDAD303CCB1F53884944FDE5B4EDD91E6FCF74DCB033DCEB")),
827
                                              cbs,
828
                                              plcy)
829
                                    .has_value());
3✔
830
            result.test_is_true("Session_ID for cloudflare.com is gone",
1✔
831
                                !legacy_db
832
                                    .retrieve(Botan::TLS::Session_ID(Botan::hex_decode(
2✔
833
                                                 "63C136FAD49F05A184F910FD6568A3884164216C11E41CEBFDCD149AF66C1714")),
834
                                              cbs,
835
                                              plcy)
836
                                    .has_value());
3✔
837
            result.test_is_true(
2✔
838
               "no more session for randombit.net",
839
               legacy_db.find(Botan::TLS::Server_Information("randombit.net", 443), cbs, plcy).empty());
1✔
840
            result.test_is_true(
2✔
841
               "no more session for cloudflare.com",
842
               legacy_db.find(Botan::TLS::Server_Information("cloudflare.com", 443), cbs, plcy).empty());
1✔
843

844
            result.test_sz_eq("empty database won't get more empty", legacy_db.remove_all(), 0);
1✔
845
         }),
1✔
846

847
      CHECK("clearing empty database",
848
            [&](auto& result) {
1✔
849
               Botan::TLS::Session_Manager_SQLite mgr("thetruthisoutthere", rng, Test::temp_file_name("empty.sqlite"));
1✔
850
               result.test_sz_eq("does not delete anything", mgr.remove_all(), 0);
1✔
851
            }),
1✔
852

853
      CHECK("establish new session",
854
            [&](auto& result) {
1✔
855
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
856
                  "thetruthisoutthere", rng, Test::temp_file_name("new_session.sqlite"));
1✔
857
               auto some_random_id = random_id(*rng);
1✔
858
               auto some_random_handle =
1✔
859
                  mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), some_random_id);
860
               result.require("establishment was successful", some_random_handle.has_value());
1✔
861
               result.require("session id was set", some_random_handle->id().has_value());
1✔
862
               result.test_bin_eq("session id is correct", some_random_handle->id().value(), some_random_id);
2✔
863

864
               auto some_virtual_handle = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
865
               result.require("establishment was successful", some_virtual_handle.has_value());
1✔
866
               result.require("session id was set", some_virtual_handle->id().has_value());
1✔
867
            }),
3✔
868

869
      CHECK("retrieve session by ID",
870
            [&](auto& result) {
1✔
871
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
872
                  "thetruthisoutthere", rng, Test::temp_file_name("retrieve_by_id.sqlite"));
1✔
873
               auto some_random_id = random_id(*rng);
1✔
874
               auto some_random_handle =
1✔
875
                  mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), some_random_id);
876
               auto some_virtual_handle = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
877

878
               result.require("establishment was successful",
1✔
879
                              some_random_handle->is_id() && some_virtual_handle->is_id());
1✔
880

881
               auto session1 = mgr.retrieve(some_random_handle.value(), cbs, plcy);
1✔
882
               if(result.test_is_true("found session by user-provided ID", session1.has_value())) {
1✔
883
                  result.test_u16_eq("protocol version was echoed", session1->version().version_code(), 0x0303);
1✔
884
                  result.test_u16_eq("ciphersuite was echoed", session1->ciphersuite_code(), uint16_t(0x009C));
1✔
885
               }
886

887
               auto session2 = mgr.retrieve(some_virtual_handle.value(), cbs, plcy);
1✔
888
               if(result.test_is_true("found session by manager-generated ID", session2.has_value())) {
1✔
889
                  result.test_u16_eq("protocol version was echoed", session2->version().version_code(), 0x0303);
1✔
890
                  result.test_u16_eq("ciphersuite was echoed", session2->ciphersuite_code(), uint16_t(0x009C));
1✔
891
               }
892

893
               auto session3 = mgr.retrieve(random_id(*rng), cbs, plcy);
2✔
894
               result.test_is_true("random ID creates empty result", !session3.has_value());
1✔
895
            }),
6✔
896

897
      CHECK("retrieval via ticket creates empty result",
898
            [&](auto& result) {
1✔
899
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
900
                  "thetruthisoutthere", rng, Test::temp_file_name("retrieve_by_ticket.sqlite"));
1✔
901
               auto some_random_handle =
1✔
902
                  mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), random_id(*rng));
1✔
903
               auto some_virtual_handle = mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
1✔
904

905
               result.test_is_true("std::nullopt on random ticket",
1✔
906
                                   !mgr.retrieve(random_ticket(*rng), cbs, plcy).has_value());
3✔
907
            }),
2✔
908

909
      CHECK("storing sessions and finding them by server info",
910
            [&](auto& result) {
1✔
911
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
912
                  "thetruthisoutthere", rng, Test::temp_file_name("store_and_find.sqlite"));
1✔
913
               auto id = random_id(*rng);
1✔
914
               auto ticket = random_ticket(*rng);
1✔
915
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), id);
2✔
916
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket);
2✔
917

918
               auto found_sessions = mgr.find(server_info(), cbs, plcy);
1✔
919
               if(result.test_sz_eq("found both sessions", found_sessions.size(), 2)) {
1✔
920
                  for(const auto& [session, handle] : found_sessions) {
3✔
921
                     result.test_is_true("ID matches", !handle.is_id() || handle.id().value() == id);
3✔
922
                     result.test_is_true("ticket matches", !handle.is_ticket() || handle.ticket().value() == ticket);
3✔
923
                  }
924
               }
925
            }),
3✔
926

927
      CHECK("removing sessions",
928
            [&](auto& result) {
1✔
929
               Botan::TLS::Session_Manager_SQLite mgr("thetruthisoutthere", rng, Test::temp_file_name("remove.sqlite"));
1✔
930
               auto id = random_id(*rng);
1✔
931
               auto ticket = random_ticket(*rng);
1✔
932
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), id);
2✔
933
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket);
2✔
934
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), random_id(*rng));
2✔
935
               mgr.store(default_session(Botan::TLS::Connection_Side::Client, cbs), random_ticket(*rng));
2✔
936

937
               result.test_sz_eq("deletes one session by ID", mgr.remove(id), 1);
2✔
938
               result.test_sz_eq("deletes one session by ticket", mgr.remove(ticket), 1);
2✔
939

940
               auto found_sessions = mgr.find(server_info(), cbs, plcy);
1✔
941
               if(result.test_sz_eq("found some other sessions", found_sessions.size(), 2)) {
1✔
942
                  for(const auto& [session, handle] : found_sessions) {
3✔
943
                     result.test_is_true("ID does not match", !handle.is_id() || handle.id().value() != id);
4✔
944
                     result.test_is_true("ticket does not match",
2✔
945
                                         !handle.is_ticket() || handle.ticket().value() != ticket);
5✔
946
                  }
947
               }
948

949
               result.test_sz_eq("removing the rest of the sessions", mgr.remove_all(), 2);
1✔
950
            }),
3✔
951

952
      CHECK("old sessions are purged when needed",
953
            [&](auto& result) {
1✔
954
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
955
                  "thetruthisoutthere", rng, Test::temp_file_name("purging.sqlite"), 1);
1✔
956

957
               std::vector<Botan::TLS::Session_ID> ids = {random_id(*rng), random_id(*rng), random_id(*rng)};
5✔
958
               mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), ids[0]);
2✔
959
               result.require("new ID exists", mgr.retrieve(ids[0], cbs, plcy).has_value());
4✔
960

961
               // Session timestamps are saved with second-resolution. If more than
962
               // one session has the same (coarse) timestamp it is undefined which
963
               // will be purged first. The clock tick ensures that session's
964
               // timestamps are unique.
965
               cbs.tick();
1✔
966
               mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), ids[1]);
2✔
967
               result.require("first ID is gone", !mgr.retrieve(ids[0], cbs, plcy).has_value());
3✔
968
               result.require("new ID exists", mgr.retrieve(ids[1], cbs, plcy).has_value());
4✔
969

970
               cbs.tick();
1✔
971
               mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), ids[2]);
2✔
972
               result.require("second ID is gone", !mgr.retrieve(ids[1], cbs, plcy).has_value());
3✔
973
               result.require("new ID exists", mgr.retrieve(ids[2], cbs, plcy).has_value());
4✔
974

975
               result.test_sz_eq("only one entry exists", mgr.remove_all(), 1);
1✔
976
            }),
2✔
977

978
      CHECK("session purging can be disabled",
979
            [&](auto& result) {
1✔
980
               Botan::TLS::Session_Manager_SQLite mgr(
1✔
981
                  "thetruthisoutthere", rng, Test::temp_file_name("purging.sqlite"), 0 /* no pruning! */);
1✔
982

983
               for(size_t i = 0; i < 25; ++i) {
26✔
984
                  mgr.establish(default_session(Botan::TLS::Connection_Side::Server, cbs), random_id(*rng));
50✔
985
               }
986

987
               result.test_sz_eq("no entries were purged along the way", mgr.remove_all(), 25);
1✔
988
            }),
1✔
989
   };
10✔
990
   #else
991
   return {};
992
   #endif
993
}
3✔
994

995
std::vector<Test::Result> tls_session_manager_expiry() {
1✔
996
   auto rng = Test::new_shared_rng(__func__);
1✔
997
   Session_Manager_Callbacks cbs;
1✔
998
   Session_Manager_Policy plcy;
1✔
999

1000
   auto CHECK_all = [&](const std::string& name, auto lambda) -> std::vector<Test::Result> {
6✔
1001
      const std::vector<std::pair<std::string, std::function<std::unique_ptr<Botan::TLS::Session_Manager>()>>>
1002
         stateful_manager_factories = {
20✔
1003
            {"In Memory",
1004
             [&rng]() -> std::unique_ptr<Botan::TLS::Session_Manager> {
10✔
1005
                return std::make_unique<Botan::TLS::Session_Manager_In_Memory>(rng, 10);
5✔
1006
             }},
1007
            {"Stateless",
1008
             [&]() -> std::unique_ptr<Botan::TLS::Session_Manager> {
7✔
1009
                return std::make_unique<Botan::TLS::Session_Manager_Stateless>(
1010
                   std::make_shared<Test_Credentials_Manager>(), rng);
4✔
1011
             }},
1012
   #if defined(BOTAN_HAS_TLS_SQLITE3_SESSION_MANAGER)
1013
            {"SQLite",
1014
             [&rng]() -> std::unique_ptr<Botan::TLS::Session_Manager> {
10✔
1015
                return std::make_unique<Botan::TLS::Session_Manager_SQLite>(
1016
                   "secure_pw", rng, Test::temp_file_name("tls_session_manager_sqlite"), 10);
5✔
1017
             }},
1018
   #endif
1019
         };
1020

1021
      std::vector<Test::Result> results;
5✔
1022
      results.reserve(stateful_manager_factories.size());
5✔
1023
      using namespace std::placeholders;
1024
      for(const auto& [sub_name, factory] : stateful_manager_factories) {
20✔
1025
         auto nm = Botan::fmt("{} ({})", name, sub_name);
15✔
1026
         auto fn = std::bind(lambda, sub_name, factory, _1);  // NOLINT(*-avoid-bind)
15✔
1027
         results.push_back(CHECK(nm.c_str(), fn));
30✔
1028
      }
1029
      return results;
5✔
1030
   };
11✔
1031

1032
   return Test::flatten_result_lists({
5✔
1033
      CHECK_all("sessions expire",
1✔
1034
                [&](const auto&, const auto& factory, auto& result) {
3✔
1035
                   auto mgr = factory();
3✔
1036

1037
                   auto handle = mgr->establish(default_session(Botan::TLS::Connection_Side::Server, cbs));
3✔
1038
                   result.require("saved successfully", handle.has_value());
3✔
1039
                   result.require("session was found", mgr->retrieve(handle.value(), cbs, plcy).has_value());
3✔
1040
                   cbs.tick();
3✔
1041
                   result.test_is_true("session has expired", !mgr->retrieve(handle.value(), cbs, plcy).has_value());
3✔
1042
                   result.test_sz_eq("session was deleted when it expired", mgr->remove_all(), 0);
3✔
1043
                }),
6✔
1044

1045
         CHECK_all("expired sessions are not found",
1✔
1046
                   [&](const std::string& type, const auto& factory, auto& result) {
3✔
1047
                      if(type == "Stateless") {
3✔
1048
                         return;  // this manager can neither store nor find anything
1✔
1049
                      }
1050

1051
                      auto mgr = factory();
2✔
1052

1053
                      auto handle_old = random_id(*rng);
2✔
1054
                      mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs), handle_old);
6✔
1055
                      result.require("session was found", mgr->retrieve(handle_old, cbs, plcy).has_value());
8✔
1056

1057
                      cbs.tick();
2✔
1058
                      auto handle_new = random_id(*rng);
2✔
1059
                      mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs), handle_new);
6✔
1060
                      result.require("session was found", mgr->retrieve(handle_new, cbs, plcy).has_value());
8✔
1061

1062
                      auto sessions_and_handles = mgr->find(server_info(), cbs, plcy);
2✔
1063
                      result.require("sessions are found", !sessions_and_handles.empty());
2✔
1064
                      result.test_sz_eq("exactly one session is found", sessions_and_handles.size(), 1);
2✔
1065
                      result.test_bin_eq(
4✔
1066
                         "the new session is found", sessions_and_handles.front().handle.id().value(), handle_new);
2✔
1067

1068
                      result.test_sz_eq("old session was deleted when it expired", mgr->remove_all(), 1);
2✔
1069
                   }),
8✔
1070

1071
         CHECK_all(
1✔
1072
            "session tickets are not reused",
1073
            [&](const std::string& type, const auto& factory, auto& result) {
3✔
1074
               if(type == "Stateless") {
3✔
1075
                  return;  // this manager can neither store nor find anything
1✔
1076
               }
1077

1078
               auto mgr = factory();
2✔
1079

1080
               auto handle_1 = random_id(*rng);
2✔
1081
               mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs, Botan::TLS::Version_Code::TLS_V12),
6✔
1082
                          handle_1);
1083
               auto handle_2 = random_ticket(*rng);
2✔
1084
               mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs, Botan::TLS::Version_Code::TLS_V12),
6✔
1085
                          handle_2);
1086

1087
   #if defined(BOTAN_HAS_TLS_13)
1088
               auto handle_3 = random_id(*rng);
2✔
1089
               mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs, Botan::TLS::Version_Code::TLS_V13),
6✔
1090
                          handle_3);
1091
               auto handle_4 = random_ticket(*rng);
2✔
1092
               mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs, Botan::TLS::Version_Code::TLS_V13),
6✔
1093
                          handle_4);
1094
   #endif
1095

1096
               plcy.set_allow_session_reuse(false);
2✔
1097

1098
               auto sessions_and_handles1 = mgr->find(server_info(), cbs, plcy);
2✔
1099
               result.require("all sessions are found", sessions_and_handles1.size() > 1);
2✔
1100

1101
               auto sessions_and_handles2 = mgr->find(server_info(), cbs, plcy);
2✔
1102
               result.test_sz_eq("only one session is found", sessions_and_handles2.size(), 1);
2✔
1103
               result.test_is_true("found session is the Session_ID", sessions_and_handles2.front().handle.is_id());
2✔
1104
               result.test_bin_eq(
4✔
1105
                  "found session is the Session_ID", sessions_and_handles2.front().handle.id().value(), handle_1);
2✔
1106
               result.test_is_true("found session is TLS 1.2",
2✔
1107
                                   sessions_and_handles2.front().session.version().is_pre_tls_13());
2✔
1108
            }),
12✔
1109

1110
         CHECK_all("number of found tickets is capped",
1✔
1111
                   [&](const std::string& type, const auto& factory, auto& result) {
3✔
1112
                      if(type == "Stateless") {
3✔
1113
                         return;  // this manager can neither store nor find anything
1✔
1114
                      }
1115

1116
                      auto mgr = factory();
2✔
1117

1118
                      std::array<Botan::TLS::Session_Ticket, 5> tickets;
2✔
1119
                      for(auto& ticket : tickets) {
12✔
1120
                         ticket = random_ticket(*rng);
10✔
1121
                         mgr->store(default_session(Botan::TLS::Connection_Side::Client, cbs), ticket);
30✔
1122
                      }
1123

1124
                      plcy.set_allow_session_reuse(true);
2✔
1125

1126
                      plcy.set_session_limit(1);
2✔
1127
                      result.test_sz_eq("find one",
2✔
1128
                                        mgr->find(server_info(), cbs, plcy).size(),
2✔
1129
                                        plcy.maximum_session_tickets_per_client_hello());
2✔
1130

1131
                      plcy.set_session_limit(3);
2✔
1132
                      result.test_sz_eq("find three",
2✔
1133
                                        mgr->find(server_info(), cbs, plcy).size(),
2✔
1134
                                        plcy.maximum_session_tickets_per_client_hello());
2✔
1135

1136
                      plcy.set_session_limit(10);
2✔
1137
                      result.test_sz_eq("find all five", mgr->find(server_info(), cbs, plcy).size(), 5);
2✔
1138
                   }),
4✔
1139

1140
   #if defined(BOTAN_HAS_TLS_13)
1141
         CHECK_all("expired tickets are not selected for PSK resumption",
1✔
1142
                   [&](const auto&, const auto& factory, auto& result) {
3✔
1143
                      auto ticket = [&](const Botan::TLS::Session_Handle& handle) {
12✔
1144
                         return Botan::TLS::PskIdentity(handle.opaque_handle().get(), 0);
12✔
1145
                      };
1146

1147
                      auto mgr = factory();
3✔
1148

1149
                      auto old_handle = mgr->establish(
3✔
1150
                         default_session(Botan::TLS::Connection_Side::Server, cbs, Botan::TLS::Version_Code::TLS_V13));
1151
                      cbs.tick();
3✔
1152
                      auto new_handle = mgr->establish(
3✔
1153
                         default_session(Botan::TLS::Connection_Side::Server, cbs, Botan::TLS::Version_Code::TLS_V13));
1154
                      result.require("both sessions are stored", old_handle.has_value() && new_handle.has_value());
3✔
1155

1156
                      auto session_and_index = mgr->choose_from_offered_tickets(
12✔
1157
                         std::vector{ticket(old_handle.value()), ticket(new_handle.value())}, "SHA-256", cbs, plcy);
6✔
1158
                      result.require("a ticket was chosen", session_and_index.has_value());
3✔
1159
                      result.test_u16_eq("the new ticket was chosen", session_and_index->second, uint16_t(1));
3✔
1160

1161
                      cbs.tick();
3✔
1162

1163
                      auto nothing = mgr->choose_from_offered_tickets(
12✔
1164
                         std::vector{ticket(new_handle.value()), ticket(old_handle.value())}, "SHA-256", cbs, plcy);
6✔
1165
                      result.require("all tickets are expired", !nothing.has_value());
3✔
1166
                   }),
33✔
1167
   #endif
1168
   });
6✔
1169
}
3✔
1170

1171
}  // namespace
1172

1173
BOTAN_REGISTER_TEST_FN("tls",
1174
                       "tls_session_manager",
1175
                       test_session_manager_in_memory,
1176
                       test_session_manager_choose_ticket,
1177
                       test_session_manager_stateless,
1178
                       test_session_manager_hybrid,
1179
                       test_session_manager_sqlite,
1180
                       tls_session_manager_expiry);
1181

1182
}  // namespace Botan_Tests
1183

1184
#endif  // BOTAN_HAS_TLS
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc