aboutsummaryrefslogtreecommitdiffstats
path: root/src/ssl/tls_messages.h
blob: 1f72c05f755d125ac386504a6039a2a7601777c0 (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/**
* TLS Messages
* (C) 2004-2010 Jack Lloyd
*
* Released under the terms of the Botan license
*/

#ifndef BOTAN_TLS_MESSAGES_H__
#define BOTAN_TLS_MESSAGES_H__

#include <botan/tls_record.h>
#include <botan/handshake_hash.h>
#include <botan/tls_policy.h>
#include <botan/bigint.h>
#include <botan/pkcs8.h>
#include <botan/x509cert.h>
#include <vector>

namespace Botan {

/**
* TLS Handshake Message Base Class
*/
class BOTAN_DLL HandshakeMessage
   {
   public:
      void send(Record_Writer&, HandshakeHash&) const;

      virtual Handshake_Type type() const = 0;

      virtual ~HandshakeMessage() {}
   private:
      HandshakeMessage& operator=(const HandshakeMessage&) { return (*this); }
      virtual SecureVector<byte> serialize() const = 0;
      virtual void deserialize(const MemoryRegion<byte>&) = 0;
   };

/**
* Client Hello Message
*/
class BOTAN_DLL Client_Hello : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return CLIENT_HELLO; }
      Version_Code version() const { return c_version; }
      SecureVector<byte> session_id() const { return sess_id; }
      std::vector<u16bit> ciphersuites() const { return suites; }
      std::vector<byte> compression_algos() const { return comp_algos; }

      SecureVector<byte> random() const { return c_random; }

      std::string hostname() const { return requested_hostname; }

      bool offered_suite(u16bit) const;

      Client_Hello(RandomNumberGenerator& rng,
                   Record_Writer&, const TLS_Policy*, HandshakeHash&);

      Client_Hello(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      Version_Code c_version;
      SecureVector<byte> sess_id, c_random;
      std::vector<u16bit> suites;
      std::vector<byte> comp_algos;
      std::string requested_hostname;
   };

/**
* Client Key Exchange Message
*/
class BOTAN_DLL Client_Key_Exchange : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return CLIENT_KEX; }

      SecureVector<byte> pre_master_secret() const;

      SecureVector<byte> pre_master_secret(RandomNumberGenerator& rng,
                                           const Private_Key* key,
                                           Version_Code version);

      Client_Key_Exchange(RandomNumberGenerator& rng,
                          Record_Writer& output,
                          HandshakeHash& hash,
                          const Public_Key* my_key,
                          Version_Code using_version,
                          Version_Code pref_version);

      Client_Key_Exchange(const MemoryRegion<byte>& buf,
                          const CipherSuite& suite,
                          Version_Code using_version);
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      SecureVector<byte> key_material, pre_master;
      bool include_length;
   };

/**
* Certificate Message
*/
class BOTAN_DLL Certificate : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return CERTIFICATE; }
      std::vector<X509_Certificate> cert_chain() const { return certs; }

      Certificate(Record_Writer&, const std::vector<X509_Certificate>&,
                  HandshakeHash&);
      Certificate(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);
      std::vector<X509_Certificate> certs;
   };

/**
* Certificate Request Message
*/
class BOTAN_DLL Certificate_Req : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return CERTIFICATE_REQUEST; }

      std::vector<Certificate_Type> acceptable_types() const { return types; }
      std::vector<X509_DN> acceptable_CAs() const { return names; }

      /* TODO
      Certificate_Req(Record_Writer&, HandshakeHash&,
                      const X509_Certificate&);
      */
      Certificate_Req(Record_Writer&, HandshakeHash&,
                      const std::vector<X509_Certificate>&);

      Certificate_Req(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      std::vector<X509_DN> names;
      std::vector<Certificate_Type> types;
   };

/**
* Certificate Verify Message
*/
class BOTAN_DLL Certificate_Verify : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return CERTIFICATE_VERIFY; }

      bool verify(const X509_Certificate&, HandshakeHash&);

      Certificate_Verify(RandomNumberGenerator& rng,
                         Record_Writer&, HandshakeHash&,
                         const Private_Key*);

      Certificate_Verify(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      SecureVector<byte> signature;
   };

/**
* Finished Message
*/
class BOTAN_DLL Finished : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return FINISHED; }

      bool verify(const MemoryRegion<byte>&, Version_Code,
                  const HandshakeHash&, Connection_Side);

      Finished(Record_Writer&, Version_Code, Connection_Side,
               const MemoryRegion<byte>&, HandshakeHash&);
      Finished(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      SecureVector<byte> compute_verify(const MemoryRegion<byte>&,
                                        HandshakeHash, Connection_Side,
                                        Version_Code);

      Connection_Side side;
      SecureVector<byte> verification_data;
   };

/**
* Hello Request Message
*/
class BOTAN_DLL Hello_Request : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return HELLO_REQUEST; }

      Hello_Request(Record_Writer&);
      Hello_Request(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);
   };

/**
* Server Hello Message
*/
class BOTAN_DLL Server_Hello : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return SERVER_HELLO; }
      Version_Code version() { return s_version; }
      SecureVector<byte> session_id() const { return sess_id; }
      u16bit ciphersuite() const { return suite; }
      byte compression_algo() const { return comp_algo; }

      SecureVector<byte> random() const { return s_random; }

      Server_Hello(RandomNumberGenerator& rng,
                   Record_Writer&, const TLS_Policy*,
                   const std::vector<X509_Certificate>&,
                   const Client_Hello&, Version_Code, HandshakeHash&);

      Server_Hello(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);

      Version_Code s_version;
      SecureVector<byte> sess_id, s_random;
      u16bit suite;
      byte comp_algo;
   };

/**
* Server Key Exchange Message
*/
class BOTAN_DLL Server_Key_Exchange : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return SERVER_KEX; }
      Public_Key* key() const;

      bool verify(const X509_Certificate&, const MemoryRegion<byte>&,
                  const MemoryRegion<byte>&) const;

      Server_Key_Exchange(RandomNumberGenerator& rng,
                          Record_Writer&, const Public_Key*,
                          const Private_Key*, const MemoryRegion<byte>&,
                          const MemoryRegion<byte>&, HandshakeHash&);

      Server_Key_Exchange(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      SecureVector<byte> serialize_params() const;
      void deserialize(const MemoryRegion<byte>&);

      std::vector<BigInt> params;
      SecureVector<byte> signature;
   };

/**
* Server Hello Done Message
*/
class BOTAN_DLL Server_Hello_Done : public HandshakeMessage
   {
   public:
      Handshake_Type type() const { return SERVER_HELLO_DONE; }

      Server_Hello_Done(Record_Writer&, HandshakeHash&);
      Server_Hello_Done(const MemoryRegion<byte>& buf) { deserialize(buf); }
   private:
      SecureVector<byte> serialize() const;
      void deserialize(const MemoryRegion<byte>&);
   };

}

#endif