1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* TLS Record Handling
* (C) 2004-2012 Jack Lloyd
* 2016 Matthias Gierlings
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#ifndef BOTAN_TLS_RECORDS_H_
#define BOTAN_TLS_RECORDS_H_
#include <botan/tls_algos.h>
#include <botan/tls_magic.h>
#include <botan/tls_version.h>
#include <botan/aead.h>
#include <vector>
#include <chrono>
#include <functional>
namespace Botan {
namespace TLS {
class Ciphersuite;
class Session_Keys;
class Connection_Sequence_Numbers;
/**
* TLS Cipher State
*/
class Connection_Cipher_State final
{
public:
/**
* Initialize a new cipher state
*/
Connection_Cipher_State(Protocol_Version version,
Connection_Side which_side,
bool is_our_side,
const Ciphersuite& suite,
const Session_Keys& keys,
bool uses_encrypt_then_mac);
AEAD_Mode& aead()
{
BOTAN_ASSERT_NONNULL(m_aead.get());
return *m_aead.get();
}
std::vector<uint8_t> aead_nonce(uint64_t seq, RandomNumberGenerator& rng);
std::vector<uint8_t> aead_nonce(const uint8_t record[], size_t record_len, uint64_t seq);
std::vector<uint8_t> format_ad(uint64_t seq, uint8_t type,
Protocol_Version version,
uint16_t ptext_length);
size_t nonce_bytes_from_handshake() const { return m_nonce_bytes_from_handshake; }
size_t nonce_bytes_from_record() const { return m_nonce_bytes_from_record; }
Nonce_Format nonce_format() const { return m_nonce_format; }
std::chrono::seconds age() const
{
return std::chrono::duration_cast<std::chrono::seconds>(
std::chrono::system_clock::now() - m_start_time);
}
private:
std::chrono::system_clock::time_point m_start_time;
std::unique_ptr<AEAD_Mode> m_aead;
std::vector<uint8_t> m_nonce;
Nonce_Format m_nonce_format;
size_t m_nonce_bytes_from_handshake;
size_t m_nonce_bytes_from_record;
};
class Record final
{
public:
Record(secure_vector<uint8_t>& data,
uint64_t* sequence,
Protocol_Version* protocol_version,
Record_Type* type)
: m_data(data), m_sequence(sequence), m_protocol_version(protocol_version),
m_type(type), m_size(data.size()) {}
secure_vector<uint8_t>& get_data() { return m_data; }
Protocol_Version* get_protocol_version() { return m_protocol_version; }
uint64_t* get_sequence() { return m_sequence; }
Record_Type* get_type() { return m_type; }
size_t& get_size() { return m_size; }
private:
secure_vector<uint8_t>& m_data;
uint64_t* m_sequence;
Protocol_Version* m_protocol_version;
Record_Type* m_type;
size_t m_size;
};
class Record_Message final
{
public:
Record_Message(const uint8_t* data, size_t size)
: m_type(0), m_sequence(0), m_data(data), m_size(size) {}
Record_Message(uint8_t type, uint64_t sequence, const uint8_t* data, size_t size)
: m_type(type), m_sequence(sequence), m_data(data),
m_size(size) {}
uint8_t& get_type() { return m_type; }
uint64_t& get_sequence() { return m_sequence; }
const uint8_t* get_data() { return m_data; }
size_t& get_size() { return m_size; }
private:
uint8_t m_type;
uint64_t m_sequence;
const uint8_t* m_data;
size_t m_size;
};
class Record_Raw_Input final
{
public:
Record_Raw_Input(const uint8_t* data, size_t size, size_t& consumed,
bool is_datagram)
: m_data(data), m_size(size), m_consumed(consumed),
m_is_datagram(is_datagram) {}
const uint8_t*& get_data() { return m_data; }
size_t& get_size() { return m_size; }
size_t& get_consumed() { return m_consumed; }
void set_consumed(size_t consumed) { m_consumed = consumed; }
bool is_datagram() { return m_is_datagram; }
private:
const uint8_t* m_data;
size_t m_size;
size_t& m_consumed;
bool m_is_datagram;
};
/**
* Create a TLS record
* @param write_buffer the output record is placed here
* @param rec_msg is the plaintext message
* @param version is the protocol version
* @param msg_sequence is the sequence number
* @param cipherstate is the writing cipher state
* @param rng is a random number generator
*/
void write_record(secure_vector<uint8_t>& write_buffer,
Record_Message rec_msg,
Protocol_Version version,
uint64_t msg_sequence,
Connection_Cipher_State* cipherstate,
RandomNumberGenerator& rng);
// epoch -> cipher state
typedef std::function<std::shared_ptr<Connection_Cipher_State> (uint16_t)> get_cipherstate_fn;
/**
* Decode a TLS record
* @return zero if full message, else number of bytes still needed
*/
size_t read_record(secure_vector<uint8_t>& read_buffer,
Record_Raw_Input& raw_input,
Record& rec,
Connection_Sequence_Numbers* sequence_numbers,
get_cipherstate_fn get_cipherstate);
}
}
#endif
|
