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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* TLS Record Handling
* (C) 2004-2012 Jack Lloyd
*
* Released under the terms of the Botan license
*/
#ifndef BOTAN_TLS_RECORDS_H__
#define BOTAN_TLS_RECORDS_H__
#include <botan/tls_ciphersuite.h>
#include <botan/tls_alert.h>
#include <botan/tls_magic.h>
#include <botan/tls_version.h>
#include <botan/block_cipher.h>
#include <botan/stream_cipher.h>
#include <botan/mac.h>
#include <vector>
#include <functional>
#include <memory>
namespace Botan {
namespace TLS {
class Session_Keys;
/**
* TLS Cipher State
*/
class Connection_Cipher_State
{
public:
/**
* Initialize a new cipher state
*/
Connection_Cipher_State(Protocol_Version version,
Connection_Side side,
const Ciphersuite& suite,
const Session_Keys& keys);
BlockCipher* block_cipher() { return m_block_cipher.get(); }
StreamCipher* stream_cipher() { return m_stream_cipher.get(); }
MessageAuthenticationCode* mac() { return m_mac.get(); }
secure_vector<byte>& cbc_state() { return m_block_cipher_cbc_state; }
size_t block_size() const { return m_block_size; }
size_t mac_size() const { return m_mac->output_length(); }
size_t iv_size() const { return m_iv_size; }
private:
std::unique_ptr<BlockCipher> m_block_cipher;
secure_vector<byte> m_block_cipher_cbc_state;
std::unique_ptr<StreamCipher> m_stream_cipher;
std::unique_ptr<MessageAuthenticationCode> m_mac;
size_t m_block_size = 0;
size_t m_iv_size = 0;
};
/**
* Create a TLS record
* @param write_buffer the output record is placed here
* @param msg_type is the type of the message (handshake, alert, ...)
* @param msg is the plaintext message
* @param msg_length is the length of msg
* @param msg_sequence_number is the sequence number
* @param version is the protocol version
* @param cipherstate is the writing cipher state
* @param rng is a random number generator
* @return number of bytes written to write_buffer
*/
size_t write_record(std::vector<byte>& write_buffer,
byte msg_type, const byte msg[], size_t msg_length,
u64bit msg_sequence_number,
Protocol_Version version,
Connection_Cipher_State* cipherstate,
RandomNumberGenerator& rng);
/**
* Decode a TLS record
* @return zero if full message, else number of bytes still needed
*/
size_t read_record(std::vector<byte>& read_buffer,
size_t& read_buffer_position,
const byte input[],
size_t input_length,
size_t& input_consumed,
byte& msg_type,
std::vector<byte>& msg,
u64bit msg_sequence,
Protocol_Version version,
Connection_Cipher_State* cipherstate);
/**
* TLS Record Writer
*/
class BOTAN_DLL Record_Writer
{
public:
void send_array(byte type, const byte input[], size_t length);
void send(byte type, const std::vector<byte>& input)
{ send_array(type, &input[0], input.size()); }
void change_cipher_spec(Connection_Side side,
const Ciphersuite& suite,
const Session_Keys& keys,
byte compression_method);
void set_version(Protocol_Version version);
bool record_version_set() const { return m_version.valid(); }
void reset();
void set_maximum_fragment_size(size_t max_fragment);
Record_Writer(std::function<void (const byte[], size_t)> output_fn,
RandomNumberGenerator& rng);
Record_Writer(const Record_Writer&) = delete;
Record_Writer& operator=(const Record_Writer&) = delete;
private:
void send_record(byte type, const byte input[], size_t length);
std::function<void (const byte[], size_t)> m_output_fn;
std::vector<byte> m_writebuf;
std::unique_ptr<Connection_Cipher_State> m_write_cipherstate;
RandomNumberGenerator& m_rng;
size_t m_max_fragment = MAX_PLAINTEXT_SIZE;
u64bit m_write_seq_no = 0;
Protocol_Version m_version;
};
/**
* TLS Record Reader
*/
class BOTAN_DLL Record_Reader
{
public:
/**
* @param input new input data (may be NULL if input_size == 0)
* @param input_size size of input in bytes
* @param input_consumed is set to the number of bytes of input
* that were consumed
* @param msg_type is set to the type of the message just read if
* this function returns 0
* @param msg is set to the contents of the record
* @param msg_sequence is set to this records sequence number
* @return number of bytes still needed (minimum), or 0 if success
*/
size_t add_input(const byte input[], size_t input_size,
size_t& input_consumed,
byte& msg_type,
std::vector<byte>& msg,
u64bit& msg_sequence);
void change_cipher_spec(Connection_Side side,
const Ciphersuite& suite,
const Session_Keys& keys,
byte compression_method);
void set_version(Protocol_Version version);
Protocol_Version get_version() const;
void reset();
void set_maximum_fragment_size(size_t max_fragment);
Record_Reader();
Record_Reader(const Record_Reader&) = delete;
Record_Reader& operator=(const Record_Reader&) = delete;
private:
std::vector<byte> m_readbuf;
size_t m_readbuf_pos = 0;
std::unique_ptr<Connection_Cipher_State> m_read_cipherstate;
size_t m_max_fragment = MAX_PLAINTEXT_SIZE;
u64bit m_read_seq_no = 0;
Protocol_Version m_version;
};
}
}
#endif
|
