8#ifndef BOTAN_TLS_SEQ_NUMBERS_H_
9#define BOTAN_TLS_SEQ_NUMBERS_H_
11#include <botan/assert.h>
12#include <botan/exceptn.h>
49 m_read_epoch = next_epoch(m_read_epoch);
54 m_write_epoch = next_epoch(m_write_epoch);
63 if(m_write_seq_no == std::numeric_limits<uint64_t>::max()) {
64 throw Invalid_State(
"TLS 1.2 write sequence number overflow");
66 return m_write_seq_no++;
74 if(m_read_seq_no == std::numeric_limits<uint64_t>::max()) {
82 static uint16_t next_epoch(uint16_t epoch) {
83 if(epoch == std::numeric_limits<uint16_t>::max()) {
86 return static_cast<uint16_t
>(epoch + 1);
89 uint64_t m_write_seq_no;
90 uint64_t m_read_seq_no;
91 uint16_t m_read_epoch;
92 uint16_t m_write_epoch;
98 uint64_t initial_write_sequence_number = 0) {
101 const auto is_epoch0 = ((initial_read_sequence_number >> 48) + (initial_write_sequence_number >> 48)) == 0;
102 BOTAN_ARG_CHECK(is_epoch0,
"Initial sequence numbers must be in epoch 0");
104 m_write_seqs[0] = initial_write_sequence_number;
108 m_write_seqs.clear();
112 m_read_windows.clear();
113 m_read_windows[0] = Replay_Window{};
117 m_read_epoch = next_epoch(m_read_epoch);
118 m_read_windows.try_emplace(m_read_epoch);
119 prune_epochs(m_read_windows, m_read_epoch);
123 m_write_epoch = next_epoch(m_write_epoch);
124 m_write_seqs[m_write_epoch] = 0;
125 prune_epochs(m_write_seqs, m_write_epoch);
133 const auto i = m_write_seqs.find(epoch);
134 if(i == m_write_seqs.end()) {
137 if(i->second > 0x0000FFFFFFFFFFFF) {
140 return (
static_cast<uint64_t
>(epoch) << 48) | i->second++;
146 const uint16_t epoch =
static_cast<uint16_t
>(sequence >> 48);
147 const uint64_t record_sequence = sequence & 0x0000FFFFFFFFFFFF;
148 const auto window = m_read_windows.find(epoch);
150 if(window == m_read_windows.end()) {
154 const size_t window_size =
sizeof(window->second.bits) * 8;
156 if(record_sequence > window->second.highest) {
160 const uint64_t offset = window->second.highest - record_sequence;
162 if(offset >= window_size) {
166 return (((window->second.bits >> offset) & 1) == 1);
170 const uint16_t epoch =
static_cast<uint16_t
>(sequence >> 48);
171 const uint64_t record_sequence = sequence & 0x0000FFFFFFFFFFFF;
172 auto& window = m_read_windows[epoch];
173 const size_t window_size =
sizeof(window.bits) * 8;
175 if(record_sequence > window.highest) {
177 const uint64_t offset = record_sequence - window.highest;
178 window.highest += offset;
180 if(offset >= window_size) {
183 window.bits <<= offset;
188 const uint64_t offset = window.highest - record_sequence;
190 if(offset < window_size) {
192 window.bits |= (
static_cast<uint64_t
>(1) << offset);
197 window.highest = record_sequence;
204 struct Replay_Window final {
205 uint64_t highest = 0;
217 static uint16_t next_epoch(uint16_t epoch) {
218 if(epoch == std::numeric_limits<uint16_t>::max()) {
221 return static_cast<uint16_t
>(epoch + 1);
233 template <
typename T>
234 static void prune_epochs(std::map<uint16_t, T>& epochs, uint16_t current) {
235 for(
auto i = epochs.begin(); i != epochs.end();) {
236 if(i->first == 0 || i->first + 1 >= current) {
244 std::map<uint16_t, uint64_t> m_write_seqs;
245 std::map<uint16_t, Replay_Window> m_read_windows;
246 uint16_t m_write_epoch = 0;
247 uint16_t m_read_epoch = 0;
#define BOTAN_ARG_CHECK(expr, msg)
virtual uint16_t current_read_epoch() const =0
virtual uint64_t next_read_sequence()=0
virtual ~Connection_Sequence_Numbers()=default
virtual void read_accept(uint64_t seq)=0
virtual uint16_t current_write_epoch() const =0
virtual void new_read_cipher_state()=0
virtual bool already_seen(uint64_t seq) const =0
virtual void new_write_cipher_state()=0
virtual uint64_t next_write_sequence(uint16_t)=0
Datagram_Sequence_Numbers(uint64_t initial_read_sequence_number=0, uint64_t initial_write_sequence_number=0)
uint64_t next_read_sequence() override
void read_accept(uint64_t sequence) override
uint16_t current_read_epoch() const override
void new_read_cipher_state() override
uint16_t current_write_epoch() const override
uint64_t next_write_sequence(uint16_t epoch) override
bool already_seen(uint64_t sequence) const override
void new_write_cipher_state() override
uint64_t next_write_sequence(uint16_t) override
uint64_t next_read_sequence() override
void read_accept(uint64_t) override
Stream_Sequence_Numbers()
void new_read_cipher_state() override
void new_write_cipher_state() override
uint16_t current_read_epoch() const override
bool already_seen(uint64_t) const override
uint16_t current_write_epoch() const override