Botan 3.9.0
Crypto and TLS for C&
tls_handshake_io.h
Go to the documentation of this file.
1/*
2* TLS Handshake Serialization
3* (C) 2012,2014 Jack Lloyd
4*
5* Botan is released under the Simplified BSD License (see license.txt)
6*/
7
8#ifndef BOTAN_TLS_HANDSHAKE_IO_H_
9#define BOTAN_TLS_HANDSHAKE_IO_H_
10
11#include <botan/tls_magic.h>
12#include <botan/tls_version.h>
13#include <botan/internal/tls_channel_impl.h>
14#include <deque>
15#include <functional>
16#include <map>
17#include <set>
18#include <utility>
19#include <vector>
20
21namespace Botan::TLS {
22
24
25/**
26* Handshake IO Interface
27*
28* This interface abstracts over stream and datagram processing of handshake
29* messages. It receives individual records from the channel via `add_record` and provides a
30* sending interface via a callback function provided by the channel.
31*
32* Handshake message headers are parsed and removed in `get_next_record`. The
33* result is provided back to the channel via
34* `Handshake_State::get_next_handshake_msg`.
35*
36* `send` is used by individual handshake message implementations, which send
37* themselves, as well as both client and server to dispatch CCS messaged (and
38* Hello_Verify_Request in the server case). Before calling the `writer_fn`,
39* `format` is called to add the handshake message header (except for CCS).
40*
41* The buffer returned by `send` is used to update the transcript record hash
42* (where desired).
43*/
45 public:
47
48 virtual std::vector<uint8_t> send(const Handshake_Message& msg) = 0;
49
50 virtual std::vector<uint8_t> send_under_epoch(const Handshake_Message& msg, uint16_t epoch) = 0;
51
52 virtual bool timeout_check() = 0;
53
54 virtual bool have_more_data() const = 0;
55
56 virtual std::vector<uint8_t> format(const std::vector<uint8_t>& handshake_msg,
57 Handshake_Type handshake_type) const = 0;
58
59 virtual void add_record(const uint8_t record[],
60 size_t record_len,
61 Record_Type type,
62 uint64_t sequence_number) = 0;
63
64 /**
65 * Returns (HANDSHAKE_NONE, std::vector<>()) if no message currently available
66 */
67 virtual std::pair<Handshake_Type, std::vector<uint8_t>> get_next_record(bool expecting_ccs) = 0;
68
69 Handshake_IO() = default;
70
71 Handshake_IO(const Handshake_IO&) = delete;
75
76 virtual ~Handshake_IO() = default;
77};
78
79/**
80* Handshake IO for stream-based handshakes
81*/
82class Stream_Handshake_IO final : public Handshake_IO {
83 public:
84 typedef std::function<void(Record_Type, const std::vector<uint8_t>&)> writer_fn;
85
86 explicit Stream_Handshake_IO(writer_fn writer) : m_send_hs(std::move(writer)) {}
87
89
90 bool timeout_check() override { return false; }
91
92 bool have_more_data() const override { return !m_queue.empty(); }
93
94 std::vector<uint8_t> send(const Handshake_Message& msg) override;
95
96 std::vector<uint8_t> send_under_epoch(const Handshake_Message& msg, uint16_t epoch) override;
97
98 std::vector<uint8_t> format(const std::vector<uint8_t>& handshake_msg,
99 Handshake_Type handshake_type) const override;
100
101 void add_record(const uint8_t record[], size_t record_len, Record_Type type, uint64_t sequence_number) override;
102
103 std::pair<Handshake_Type, std::vector<uint8_t>> get_next_record(bool expecting_ccs) override;
104
105 private:
106 std::deque<uint8_t> m_queue;
107 writer_fn m_send_hs;
108};
109
110/**
111* Handshake IO for datagram-based handshakes
112*/
114 public:
115 typedef std::function<void(uint16_t, Record_Type, const std::vector<uint8_t>&)> writer_fn;
116
119 uint16_t mtu,
120 uint64_t initial_timeout_ms,
121 uint64_t max_timeout_ms) :
122 m_seqs(seq),
123 m_flights(1),
124 m_initial_timeout(initial_timeout_ms),
125 m_max_timeout(max_timeout_ms),
126 m_send_hs(std::move(writer)),
127 m_mtu(mtu) {}
128
130
131 bool timeout_check() override;
132
133 bool have_more_data() const override;
134
135 std::vector<uint8_t> send(const Handshake_Message& msg) override;
136
137 std::vector<uint8_t> send_under_epoch(const Handshake_Message& msg, uint16_t epoch) override;
138
139 std::vector<uint8_t> format(const std::vector<uint8_t>& handshake_msg,
140 Handshake_Type handshake_type) const override;
141
142 void add_record(const uint8_t record[], size_t record_len, Record_Type type, uint64_t sequence_number) override;
143
144 std::pair<Handshake_Type, std::vector<uint8_t>> get_next_record(bool expecting_ccs) override;
145
146 private:
147 void retransmit_flight(size_t flight);
148 void retransmit_last_flight();
149
150 std::vector<uint8_t> format_fragment(const uint8_t fragment[],
151 size_t fragment_len,
152 uint16_t frag_offset,
153 uint16_t msg_len,
154 Handshake_Type type,
155 uint16_t msg_sequence) const;
156
157 std::vector<uint8_t> format_w_seq(const std::vector<uint8_t>& handshake_msg,
158 Handshake_Type handshake_type,
159 uint16_t msg_sequence) const;
160
161 std::vector<uint8_t> send_message(uint16_t msg_seq,
162 uint16_t epoch,
163 Handshake_Type msg_type,
164 const std::vector<uint8_t>& msg);
165
166 class Handshake_Reassembly final {
167 public:
168 void add_fragment(const uint8_t fragment[],
169 size_t fragment_length,
170 size_t fragment_offset,
171 uint16_t epoch,
172 Handshake_Type msg_type,
173 size_t msg_length);
174
175 bool complete() const;
176
177 uint16_t epoch() const { return m_epoch; }
178
179 std::pair<Handshake_Type, std::vector<uint8_t>> message() const;
180
181 private:
183 size_t m_msg_length = 0;
184 uint16_t m_epoch = 0;
185
186 // vector<bool> m_seen;
187 // vector<uint8_t> m_fragments
188 std::map<size_t, uint8_t> m_fragments;
189 std::vector<uint8_t> m_message;
190 };
191
192 struct Message_Info final {
193 Message_Info(uint16_t e, Handshake_Type mt, const std::vector<uint8_t>& msg) :
194 epoch(e), msg_type(mt), msg_bits(msg) {}
195
196 Message_Info() : epoch(0xFFFF), msg_type(Handshake_Type::None) {}
197
198 uint16_t epoch; // NOLINT(*non-private-member-variable*)
199 Handshake_Type msg_type; // NOLINT(*non-private-member-variable*)
200 std::vector<uint8_t> msg_bits; // NOLINT(*non-private-member-variable*)
201 };
202
203 class Connection_Sequence_Numbers& m_seqs;
204 std::map<uint16_t, Handshake_Reassembly> m_messages;
205 std::set<uint16_t> m_ccs_epochs;
206 std::vector<std::vector<uint16_t>> m_flights;
207 std::map<uint16_t, Message_Info> m_flight_data;
208
209 uint64_t m_initial_timeout = 0;
210 uint64_t m_max_timeout = 0;
211
212 uint64_t m_last_write = 0;
213 uint64_t m_next_timeout = 0;
214
215 uint16_t m_in_message_seq = 0;
216 uint16_t m_out_message_seq = 0;
217
218 writer_fn m_send_hs;
219 uint16_t m_mtu;
220};
221
222} // namespace Botan::TLS
223
224#endif
std::vector< uint8_t > send_under_epoch(const Handshake_Message &msg, uint16_t epoch) override
void add_record(const uint8_t record[], size_t record_len, Record_Type type, uint64_t sequence_number) override
std::pair< Handshake_Type, std::vector< uint8_t > > get_next_record(bool expecting_ccs) override
std::vector< uint8_t > format(const std::vector< uint8_t > &handshake_msg, Handshake_Type handshake_type) const override
Protocol_Version initial_record_version() const override
std::vector< uint8_t > send(const Handshake_Message &msg) override
Datagram_Handshake_IO(writer_fn writer, class Connection_Sequence_Numbers &seq, uint16_t mtu, uint64_t initial_timeout_ms, uint64_t max_timeout_ms)
std::function< void(uint16_t, Record_Type, const std::vector< uint8_t > &)> writer_fn
Handshake_IO & operator=(Handshake_IO &&)=delete
virtual std::vector< uint8_t > send_under_epoch(const Handshake_Message &msg, uint16_t epoch)=0
Handshake_IO(const Handshake_IO &)=delete
virtual bool timeout_check()=0
virtual std::vector< uint8_t > send(const Handshake_Message &msg)=0
Handshake_IO & operator=(const Handshake_IO &)=delete
virtual void add_record(const uint8_t record[], size_t record_len, Record_Type type, uint64_t sequence_number)=0
virtual Protocol_Version initial_record_version() const =0
Handshake_IO(Handshake_IO &&)=delete
virtual std::vector< uint8_t > format(const std::vector< uint8_t > &handshake_msg, Handshake_Type handshake_type) const =0
virtual ~Handshake_IO()=default
virtual bool have_more_data() const =0
virtual std::pair< Handshake_Type, std::vector< uint8_t > > get_next_record(bool expecting_ccs)=0
bool have_more_data() const override
std::vector< uint8_t > send_under_epoch(const Handshake_Message &msg, uint16_t epoch) override
std::vector< uint8_t > format(const std::vector< uint8_t > &handshake_msg, Handshake_Type handshake_type) const override
Protocol_Version initial_record_version() const override
std::pair< Handshake_Type, std::vector< uint8_t > > get_next_record(bool expecting_ccs) override
std::function< void(Record_Type, const std::vector< uint8_t > &)> writer_fn
std::vector< uint8_t > send(const Handshake_Message &msg) override
void add_record(const uint8_t record[], size_t record_len, Record_Type type, uint64_t sequence_number) override