Botan 3.14.1
Crypto and TLS for C&
Botan::TLS::Datagram_Sequence_Numbers Class Referencefinal

#include <tls_seq_numbers.h>

Inheritance diagram for Botan::TLS::Datagram_Sequence_Numbers:
Botan::TLS::Connection_Sequence_Numbers

Public Member Functions

bool already_seen (uint64_t sequence) const override
uint16_t current_read_epoch () const override
uint16_t current_write_epoch () const override
 Datagram_Sequence_Numbers (uint64_t initial_read_sequence_number=0, uint64_t initial_write_sequence_number=0)
void new_read_cipher_state () override
void new_write_cipher_state () override
uint64_t next_read_sequence () override
uint64_t next_write_sequence (uint16_t epoch) override
void read_accept (uint64_t sequence) override
void reset () override

Detailed Description

Definition at line 95 of file tls_seq_numbers.h.

Constructor & Destructor Documentation

◆ Datagram_Sequence_Numbers()

Botan::TLS::Datagram_Sequence_Numbers::Datagram_Sequence_Numbers ( uint64_t initial_read_sequence_number = 0,
uint64_t initial_write_sequence_number = 0 )
inlineexplicit

Definition at line 97 of file tls_seq_numbers.h.

98 {
100
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");
103
104 m_write_seqs[0] = initial_write_sequence_number;
105 }
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33

References BOTAN_ARG_CHECK, and reset().

Member Function Documentation

◆ already_seen()

bool Botan::TLS::Datagram_Sequence_Numbers::already_seen ( uint64_t sequence) const
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 145 of file tls_seq_numbers.h.

145 {
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);
149
150 if(window == m_read_windows.end()) {
151 return false;
152 }
153
154 const size_t window_size = sizeof(window->second.bits) * 8;
155
156 if(record_sequence > window->second.highest) {
157 return false;
158 }
159
160 const uint64_t offset = window->second.highest - record_sequence;
161
162 if(offset >= window_size) {
163 return true; // really old?
164 }
165
166 return (((window->second.bits >> offset) & 1) == 1);
167 }

◆ current_read_epoch()

uint16_t Botan::TLS::Datagram_Sequence_Numbers::current_read_epoch ( ) const
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 128 of file tls_seq_numbers.h.

128{ return m_read_epoch; }

◆ current_write_epoch()

uint16_t Botan::TLS::Datagram_Sequence_Numbers::current_write_epoch ( ) const
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 130 of file tls_seq_numbers.h.

130{ return m_write_epoch; }

◆ new_read_cipher_state()

void Botan::TLS::Datagram_Sequence_Numbers::new_read_cipher_state ( )
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 116 of file tls_seq_numbers.h.

116 {
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);
120 }

◆ new_write_cipher_state()

void Botan::TLS::Datagram_Sequence_Numbers::new_write_cipher_state ( )
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 122 of file tls_seq_numbers.h.

122 {
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);
126 }

◆ next_read_sequence()

uint64_t Botan::TLS::Datagram_Sequence_Numbers::next_read_sequence ( )
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 143 of file tls_seq_numbers.h.

143{ throw Invalid_State("DTLS uses explicit sequence numbers"); }

◆ next_write_sequence()

uint64_t Botan::TLS::Datagram_Sequence_Numbers::next_write_sequence ( uint16_t epoch)
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 132 of file tls_seq_numbers.h.

132 {
133 const auto i = m_write_seqs.find(epoch);
134 if(i == m_write_seqs.end()) {
135 throw Invalid_State("DTLS epoch not found");
136 }
137 if(i->second > 0x0000FFFFFFFFFFFF) {
138 throw Invalid_State("DTLS write sequence number overflow");
139 }
140 return (static_cast<uint64_t>(epoch) << 48) | i->second++;
141 }

◆ read_accept()

void Botan::TLS::Datagram_Sequence_Numbers::read_accept ( uint64_t sequence)
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 169 of file tls_seq_numbers.h.

169 {
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;
174
175 if(record_sequence > window.highest) {
176 // We've received a later sequence which advances our window
177 const uint64_t offset = record_sequence - window.highest;
178 window.highest += offset;
179
180 if(offset >= window_size) {
181 window.bits = 0;
182 } else {
183 window.bits <<= offset;
184 }
185
186 window.bits |= 0x01;
187 } else {
188 const uint64_t offset = window.highest - record_sequence;
189
190 if(offset < window_size) {
191 // We've received an old sequence but still within our window
192 window.bits |= (static_cast<uint64_t>(1) << offset);
193 } else {
194 // DTLS reconnection: recenter the window on this sequence. Bit 0
195 // marks the sequence itself as seen so an immediate replay is
196 // detected; the other branches above set this implicitly.
197 window.highest = record_sequence;
198 window.bits = 1;
199 }
200 }
201 }

◆ reset()

void Botan::TLS::Datagram_Sequence_Numbers::reset ( )
inlineoverridevirtual

Implements Botan::TLS::Connection_Sequence_Numbers.

Definition at line 107 of file tls_seq_numbers.h.

107 {
108 m_write_seqs.clear();
109 m_write_seqs[0] = 0;
110 m_write_epoch = 0;
111 m_read_epoch = 0;
112 m_read_windows.clear();
113 m_read_windows[0] = Replay_Window{};
114 }

Referenced by Datagram_Sequence_Numbers().


The documentation for this class was generated from the following file: