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
202
203
|
/*
* TLS Session Management
* (C) 2011 Jack Lloyd
*
* Released under the terms of the Botan license
*/
#ifndef TLS_SESSION_STATE_H_
#define TLS_SESSION_STATE_H_
#include <botan/x509cert.h>
#include <botan/tls_magic.h>
#include <botan/secmem.h>
#include <botan/hex.h>
#include <map>
#include <ctime>
namespace Botan {
/**
* Class representing a TLS session state
*/
class BOTAN_DLL TLS_Session_Params
{
public:
/**
* Uninitialized session
*/
TLS_Session_Params() :
session_start_time(0),
session_version(0),
session_ciphersuite(0),
session_compression_method(0),
session_connection_side(static_cast<Connection_Side>(0))
{}
/**
* New session (sets session start time)
*/
TLS_Session_Params(const MemoryRegion<byte>& session_id,
const MemoryRegion<byte>& master_secret,
Version_Code version,
u16bit ciphersuite,
byte compression_method,
Connection_Side side,
const std::vector<X509_Certificate>& peer_certs,
const std::string& sni_hostname = "",
const std::string& srp_identifier = "");
/**
* Load a session from BER (created by BER_encode)
*/
TLS_Session_Params(const byte ber[], size_t ber_len);
/**
* Encode this session data for storage
* @warning if the master secret is compromised so is the
* session traffic
*/
SecureVector<byte> BER_encode() const;
/**
* Get the version of the saved session
*/
Version_Code version() const
{ return static_cast<Version_Code>(session_version); }
/**
* Get the ciphersuite of the saved session
*/
u16bit ciphersuite() const { return session_ciphersuite; }
/**
* Get the compression method used in the saved session
*/
byte compression_method() const { return session_compression_method; }
/**
* Get which side of the connection the resumed session we are/were
* acting as.
*/
Connection_Side side() const { return session_connection_side; }
/**
* Get the SNI hostname (if sent by the client in the initial handshake)
*/
std::string sni_hostname() const { return session_sni_hostname; }
/**
* Get the SRP identity (if sent by the client in the initial handshake)
*/
std::string srp_identifier() const { return session_srp_identifier; }
/**
* Get the saved master secret
*/
const SecureVector<byte>& master_secret() const
{ return session_master_secret; }
/**
* Get the session identifier
*/
const MemoryVector<byte>& session_id() const
{ return session_identifier; }
/**
* Get the time this session began (seconds since Epoch)
*/
u64bit start_time() const { return session_start_time; }
private:
enum { TLS_SESSION_PARAM_STRUCT_VERSION = 1 };
u64bit session_start_time;
MemoryVector<byte> session_identifier;
SecureVector<byte> session_master_secret;
u16bit session_version;
u16bit session_ciphersuite;
byte session_compression_method;
Connection_Side session_connection_side;
MemoryVector<byte> session_peer_certificate; // optional
std::string session_sni_hostname; // optional
std::string session_srp_identifier; // optional
};
/**
* TLS_Session_Manager is an interface to systems which can save
* session parameters for support session resumption.
*
* Implementations should strive to be thread safe
*/
class BOTAN_DLL TLS_Session_Manager
{
public:
/**
* Try to load a saved session
* @param session_id the session identifier we are trying to resume
* @param params will be set to the saved session data (if found),
or not modified if not found
* @return true if params was modified
*/
virtual bool find(const MemoryVector<byte>& session_id,
TLS_Session_Params& params) = 0;
/**
* Prohibit resumption of this session. Effectively an erase.
*/
virtual void prohibit_resumption(const MemoryVector<byte>& session_id) = 0;
/**
* Save a session on a best effort basis; the manager may not in
* fact be able to save the session for whatever reason, this is
* not an error. Caller cannot assume that calling save followed
* immediately by find will result in a successful lookup.
*
* @param session_id the session identifier
* @param params to save
*/
virtual void save(const TLS_Session_Params& params) = 0;
virtual ~TLS_Session_Manager() {}
};
/**
* A simple implementation of TLS_Session_Manager that just saves
* values in memory, with no persistance abilities
*
* @todo add locking
*/
class BOTAN_DLL TLS_Session_Manager_In_Memory : public TLS_Session_Manager
{
public:
/**
* @param max_sessions a hint on the maximum number of sessions
* to save at any one time. (If zero, don't cap at all)
* @param session_lifetime sesions are expired after this many
* seconds have elapsed.
*/
TLS_Session_Manager_In_Memory(size_t max_sessions = 1000,
size_t session_lifetime = 300) :
max_sessions(max_sessions),
session_lifetime(session_lifetime)
{}
bool find(const MemoryVector<byte>& session_id,
TLS_Session_Params& params);
void prohibit_resumption(const MemoryVector<byte>& session_id);
void save(const TLS_Session_Params& session_data);
private:
size_t max_sessions, session_lifetime;
std::map<std::string, TLS_Session_Params> sessions;
};
}
#endif
|
