-
Notifications
You must be signed in to change notification settings - Fork 1
/
SSLHandshake.h
946 lines (770 loc) · 32.8 KB
/
SSLHandshake.h
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
#ifndef PACKETPP_SSL_HANDSHAKE_MESSAGE
#define PACKETPP_SSL_HANDSHAKE_MESSAGE
#include <SSLCommon.h>
#include <PointerVector.h>
/**
* @file
* See detailed explanation of the TLS/SSL protocol support in PcapPlusPlus in SSLLayer.h
*/
/**
* \namespace pcpp
* \brief The main namespace for the PcapPlusPlus lib
*/
namespace pcpp
{
/**
* @class SSLCipherSuite
* Represents a cipher-suite and enables access all information about it such as all algorithms it encapsulates,
* its ID (as appears in the client-hello or server-hello messages),
* its name (e.g "TLS_DH_RSA_WITH_CAMELLIA_128_CBC_SHA") etc. PcapPlusPlus contains static instances of this type
* for all known cipher-suites and enables access to them through name or ID (see getCipherSuiteByID() and
* getCipherSuiteByName() ). List of cipher-suite was taken from here:
* http://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml
*/
class SSLCipherSuite
{
public:
/**
* A c'tor for this class, should never be used by a user
* @param[in] id Cipher-suite ID
* @param[in] keyExAlg Key-exchange algorithm used in this cipher-suite
* @param[in] authAlg Authentication algorithm used in this cipher-suite
* @param[in] symKeyAlg Symmetric key algorithm used in this cipher-suite
* @param[in] MACAlg MAC algorithm used in this cipher-suite
* @param[in] name String representation of this cipher-suite
*/
SSLCipherSuite(uint16_t id, SSLKeyExchangeAlgorithm keyExAlg,
SSLAuthenticationAlgorithm authAlg,
SSLSymetricEncryptionAlgorithm symKeyAlg,
SSLHashingAlgorithm MACAlg,
const char* name)
: m_Id(id), m_KeyExAlg(keyExAlg), m_AuthAlg(authAlg), m_SymKeyAlg(symKeyAlg), m_MACAlg(MACAlg), m_Name(name) {}
/**
* @return Cipher-suite ID
*/
inline uint16_t getID() { return m_Id; }
/**
* @return String representation of this cipher-suite
*/
inline std::string asString() { return m_Name; }
/**
* @return Key-exchange algorithm used in this cipher-suite
*/
inline SSLKeyExchangeAlgorithm getKeyExchangeAlg() { return m_KeyExAlg; }
/**
* @return Authentication algorithm used in this cipher-suite
*/
inline SSLAuthenticationAlgorithm getAuthAlg() { return m_AuthAlg; }
/**
* @return Symmetric key algorithm used in this cipher-suite
*/
inline SSLSymetricEncryptionAlgorithm getSymKeyAlg() { return m_SymKeyAlg; }
/**
* @return MAC algorithm used in this cipher-suite
*/
inline SSLHashingAlgorithm getMACAlg() { return m_MACAlg; }
/**
* A static method that returns a cipher-suite instance by ID
* @param[in] id Cipher-suite ID
* @return A cipher-suite instance matching this ID or NULL if ID not found
*/
static SSLCipherSuite* getCipherSuiteByID(uint16_t id);
/**
* A static method that returns a cipher-suite instance by name
* @param[in] name Cipher-suite name (e.g "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA")
* @return A cipher-suite instance matching this name or NULL if name not found
*/
static SSLCipherSuite* getCipherSuiteByName(std::string name);
private:
uint16_t m_Id;
SSLKeyExchangeAlgorithm m_KeyExAlg;
SSLAuthenticationAlgorithm m_AuthAlg;
SSLSymetricEncryptionAlgorithm m_SymKeyAlg;
SSLHashingAlgorithm m_MACAlg;
std::string m_Name;
};
/**
* @class SSLExtension
* Represents a SSL/TLS extension. This is a base class that can represent any type of extension. Inherited classes may
* contain parsing logic for specific extensions. This class provides capabilities such as getting the extension type,
* length and viewing the extension data as raw (byte array)
*/
class SSLExtension
{
public:
/**
* C'tor for this class
* @param[in] data The raw data for the extension
*/
SSLExtension(uint8_t* data);
virtual ~SSLExtension() { }
/**
* @return The type of the extension as enum
*/
SSLExtensionType getType();
/**
* @return The type of the extension as a numeric value
*/
uint16_t getTypeAsInt();
/**
* @return The length of the extension data in bytes (not including the type and length fields)
*/
uint16_t getLength();
/**
* @return The total length of the extension, including type and length fields and the extension data field
*/
uint16_t getTotalLength();
/**
* @return A pointer to the raw data of the extension
*/
uint8_t* getData();
protected:
/**
* @struct SSLExtensionStruct
* Represents the common fields of the extension
*/
struct SSLExtensionStruct
{
/** Extension type */
uint16_t extensionType;
/** Extension length */
uint16_t extensionDataLength;
/** Extension data as raw (byte array) */
uint8_t extensionData[];
};
uint8_t* m_RawData;
inline SSLExtensionStruct* getExtensionStruct() { return (SSLExtensionStruct*)m_RawData; }
};
/**
* @class SSLServerNameIndicationExtension
* Represents SSL/TLS Server Name Indication extension. Inherits from SSLExtension and add parsing of the hostname
* written in the extension data
*/
class SSLServerNameIndicationExtension : public SSLExtension
{
public:
/**
* C'tor for this class
* @param[in] data The raw data for the extension
*/
SSLServerNameIndicationExtension(uint8_t* data) : SSLExtension(data) {}
/**
* @return The hostname written in the extension data
*/
std::string getHostName();
};
/**
* @class SSLx509Certificate
* Represents a x509v3 certificate. the SSLCertificateMessage class returns an instance of this class as the certificate.
* Currently this class doesn't do much as it doesn't parse the certificate. It only acts as container to the raw data
* and returns general info as data as raw, length, etc. In the future I may add full parsing of the certificate
*/
class SSLx509Certificate
{
public:
/**
* C'tor for this class
* @param[in] data The raw data of the certificate
* @param[in] dataLen The length in bytes of the raw data
* @param[in] allDataExists Certificate messages usually spread on more than 1 packet. So a certificate is likely
* to split between 2 packets or more. This field indicates whether the raw data contains all ceritificate data
* of just a part of it
*/
SSLx509Certificate(uint8_t* data, size_t dataLen, bool allDataExists)
: m_Data(data), m_DataLen(dataLen), m_AllDataExists(allDataExists) {}
/**
* @return A pointer to the raw data
*/
uint8_t* getData() { return m_Data; }
/**
* @return Raw data length
*/
size_t getDataLength() { return m_DataLen; }
/**
* Certificate messages usually spread on more than 1 packet. So a certificate is likely to split between 2 packets
* or more. This method provides an indication whether all certificate data exists or only part of it
* @return True if this data contains all certificate data, false otherwise
*/
bool allDataExists() { return m_AllDataExists; }
private:
uint8_t* m_Data;
size_t m_DataLen;
bool m_AllDataExists;
};
class SSLHandshakeLayer;
/**
* @class SSLHandshakeMessage
* A base class for SSL/TLS handshake messages. This is an abstract class and cannot be instantiated. SSL/TLS handshake
* messages are contained in SSLHandshakeLayer, meaning a SSLHandshakeLayer instance can contain one or more SSLHandshakeMessage
* instances. For example: one SSLHandshakeLayer may contain a server-hello, certificate,
* server-key-exchange, and server-hello-done messages (although it's not such a common case, most handshake layers
* contain 1 handshake message only)
*/
class SSLHandshakeMessage
{
public:
virtual ~SSLHandshakeMessage() {}
/**
* A factory method for creating instances of handshake messages from raw data
* @param[in] data The raw data containing 1 handshake message
* @param[in] dataLen Raw data length in bytes
* @param[in] container A pointer to the SSLHandshakeLayer instance which will contain the created message.
* This parameter is required because the handshake message includes a pointer to its container
*/
static SSLHandshakeMessage* createHandhakeMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
/**
* @return The handshake message type
*/
virtual SSLHandshakeType getHandshakeType();
/**
* @return The handshake message length in bytes. Notice that sometimes the handshake message is divided between
* several packets, in this case this method will return the length of part of the message in the current packet
*/
virtual size_t getMessageLength();
/**
* @return True if current packet contains the entire message or false otherwise. This method is important
* because sometimes handshake messages are divided in consequent packets (happens a lot in certificate messages
* which usually contain several KB of data which is larger than standard packet size, so the message is divided between
* several packets)
*/
virtual bool isMessageComplete();
/**
* @return A pointer to the SSLHandshakeLayer instance containing this message
*/
inline SSLHandshakeLayer* getContainingLayer() { return m_Container; }
/**
* @return A string representation of the message type (e.g "Client Hello message")
*/
virtual std::string toString() = 0;
protected:
SSLHandshakeMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
uint8_t* m_Data;
size_t m_DataLen;
SSLHandshakeLayer* m_Container;
};
/**
* @class SSLClientHelloMessage
* Represents a client-hello message (type 1). Inherits from SSLHandshakeMessage and adds parsing of all fields
* of this message including the message extensions, cipher-suite list, etc.
*/
class SSLClientHelloMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and shouldn't be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLClientHelloMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
virtual ~SSLClientHelloMessage() {}
/**
* @return A struct containing common fields for client-hello and server-hello messages. Notice this points directly
* to the data, so every change will change the actual packet data
*/
inline ssl_tls_client_server_hello* getClientHelloHeader() { return (ssl_tls_client_server_hello*)m_Data; }
/**
* @return Handshake SSL/TLS version (notice it may be different than SSLLayer#getRecordVersion(). Each client-hello
* or server-hello message has both record version and handshake version and they may differ from one another)
*/
SSLVersion getHandshakeVersion();
/**
* @return Session ID length in bytes. If server-hello message doesn't include session ID 0 will be returned
*/
uint8_t getSessionIDLength();
/**
* @return Session ID as byte array. If server-hello message doesn't include session ID NULL will be returned
*/
uint8_t* getSessionID();
/**
* @return The number of cipher-suites included in this message
*/
int getCipherSuiteCount();
/**
* Get a pointer to a cipher-suite by index. The cipher-suites are numbered according to their order of appearance
* in the message. If index is out of bounds (less than 0 or larger than total amount of cipher suites) NULL will be
* returned
* @param[in] index The index of the cipher-suite to return
* @return The pointer to the cipher-suite object or NULL if index is out of bounds
*/
SSLCipherSuite* getCipherSuite(int index);
/**
* @return The value of the compression method byte
*/
uint8_t getCompressionMethodsValue();
/**
* @return The number of extensions in this message
*/
int getExtensionCount();
/**
* @return The size (in bytes) of all extensions data in this message. Extracted from the "extensions length" field
*/
uint16_t getExtensionsLenth();
/**
* Get a pointer to an extension by index. The extensions are numbered according to their order of appearance
* in the message. If index is out of bounds (less than 0 or larger than total amount of extensions) NULL will be
* returned
* @param[in] index The index of the extension to return
* @return The pointer to the extension or NULL if index is out of bounds
*/
SSLExtension* getExtension(int index);
/**
* Get a pointer to an extension by numeric type field. Every extension has a 2-byte numeric value representing
* its type (for example: renegotiation info extension type is 0x1ff). This method gets the type and returns a
* pointer to the extension object
* @param[in] type The 2-byte numeric type of the extension
* @return A pointer to the extension object of NULL if this type doesn't exist in this message
*/
SSLExtension* getExtensionOfType(uint16_t type);
/**
* Get a pointer to an extension by its enum type
* @param[in] type The type of extension to return
* @return A pointer to the extension object or NULL if this type doesn't exist in this message
*/
SSLExtension* getExtensionOfType(SSLExtensionType type);
/**
* Get a pointer to an extension by its class type. This is a templated method that is used with the type of the
* requested extension and returns the first extension instance of this type
* @return A pointer to the extension object or NULL if this extension type doesn't exist in this message
*
*/
template<class TExtension>
TExtension* getExtensionOfType();
// implement abstract methods
std::string toString();
private:
PointerVector<SSLExtension> m_ExtensionList;
};
/**
* @class SSLServerHelloMessage
* Represents SSL/TLS server-hello message (type 2). Inherits from SSLHandshakeMessage and adds parsing of all fields
* of this message including the message extensions, cipher-suite, etc.
*/
class SSLServerHelloMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and shouldn't be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLServerHelloMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
virtual ~SSLServerHelloMessage() {}
/**
* @return A struct containing common fields for client-hello and server-hello messages. Notice this points directly
* to the data, so every change will change the actual packet data
*/
inline ssl_tls_client_server_hello* getServerHelloHeader() { return (ssl_tls_client_server_hello*)m_Data; }
/**
* @return Handshake SSL/TLS version (notice it may be different than SSLLayer#getRecordVersion(). Each client-hello
* or server-hello message has both record version and handshake version and they may differ from one another)
*/
SSLVersion getHandshakeVersion();
/**
* @return Session ID length in bytes. If server-hello message doesn't include session ID 0 will be returned
*/
uint8_t getSessionIDLength();
/**
* @return Session ID as byte array. If server-hello message doesn't include session ID NULL will be returned
*/
uint8_t* getSessionID();
/**
* @return A pointer to the cipher suite encapsulated in this message (server-hello message contains one
* cipher-suite, the one that will be used to for encryption between client and server)
*/
SSLCipherSuite* getCipherSuite();
/**
* @return The value of the compression method byte
*/
uint8_t getCompressionMethodsValue();
/**
* @return The number of extensions in this message
*/
int getExtensionCount();
/**
* @return The size (in bytes) of all extensions data in this message. Extracted from the "extensions length" field
*/
uint16_t getExtensionsLenth();
/**
* Get a pointer to an extension by index. The extensions are numbered according to their order of appearance
* in the message. If index is out of bounds (less than 0 or larger than total amount of extensions) NULL will be
* returned
* @param[in] index The index of the extension to return
* @return The pointer to the extension or NULL if index is out of bounds
*/
SSLExtension* getExtension(int index);
/**
* Get a pointer to an extension by numeric type field. Every extension has a 2-byte numeric value representing
* its type (for example: renegotiation info extension type is 0x1ff). This method gets the type and returns a
* pointer to the extension object
* @param[in] type The 2-byte numeric type of the extension
* @return A pointer to the extension object of NULL if this type doesn't exist in this message
*/
SSLExtension* getExtensionOfType(uint16_t type);
/**
* Get a pointer to an extension by its enum type
* @param[in] type The type of extension to return
* @return A pointer to the extension object or NULL if this type doesn't exist in this message
*/
SSLExtension* getExtensionOfType(SSLExtensionType type);
/**
* Get a pointer to an extension by its class type. This is a templated method that is used with the type of the
* requested extension and returns the first extension instance of this type
* @return A pointer to the extension object or NULL if this extension type doesn't exist in this message
*
*/
template<class TExtension>
TExtension* getExtensionOfType();
// implement abstract methods
std::string toString();
private:
PointerVector<SSLExtension> m_ExtensionList;
};
/**
* @class SSLCertificateMessage
* Represents SSL/TLS certificate message (type 11). Inherits from SSLHandshakeMessage and adds parsing functionality
* such as extracting the certificates data. Notice that in most cases this message is spread over more than 1 packet
* as its size is too big for a single packet. So SSLCertificateMessage instance will be created just for the first
* part of the message - the one encapsulated in the first packet. Other parts (encapsulated in the following packets)
* won't be recognized as SSLCertificateMessage messages
*/
class SSLCertificateMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLCertificateMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
virtual ~SSLCertificateMessage() {}
/**
* @return The number of certificates encapsulated in this message (as written in the 'length' field of the
* message). Notice that because the message may spread over several packets, not all certificates will necessarily
* be in this packet. So, for example, there may be a case where this method return 3 (message contains 3
* certificates) but this message actually contains only 1 certificate as the other 2 are spread over the other
* packets
*/
int getNumOfCertificates();
/**
* Get a certificate by index
* @param[in] index The index of the certificate to retrieve
* @return A pointer to the certificate object. Notice that if index < 0 or index > num of certificates encapsulated
* in current packet a NULL value will be returned
*/
SSLx509Certificate* getCertificate(int index);
// implement abstract methods
std::string toString();
private:
PointerVector<SSLx509Certificate> m_CertificateList;
};
/**
* @class SSLHelloRequestMessage
* Represents SSL/TLS hello-request message (type 0). This message has no additional payload except for the common payload
* described in SSLHandshakeMessage
*/
class SSLHelloRequestMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLHelloRequestMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLHelloRequestMessage() {}
// implement abstract methods
std::string toString();
};
/**
* @class SSLServerKeyExchangeMessage
* Represents SSL/TLS server-key-exchange message (type 12). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as getting the server key exchange params as raw data (parsing of this may be added in the
* future)
*/
class SSLServerKeyExchangeMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLServerKeyExchangeMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
~SSLServerKeyExchangeMessage() {}
/**
* @return A pointer to the raw data of the server key exchange params. Currently this data can only returned as
* raw, parsing may be added in the future. Notice that if the message is spread over more than 1 packet in a way
* params doesn't exist in the first packet, NULL will be returned
*/
uint8_t* getServerKeyExchangeParams();
/**
* @return The size of the params field. Notice that if the message is spread over more than 1 packet in a way the
* ssl_tls_handshake_layer cannot be parsed from the packet, 0 will be returned. Also, if only part of the params
* exist in current packet (and the rest are on consequent packets), the size that will be returned is the size
* of the part that exists in the current packet (and not total size of params)
*/
size_t getServerKeyExchangeParamsLength();
// implement abstract methods
std::string toString();
};
/**
* @class SSLClientKeyExchangeMessage
* Represents SSL/TLS client-key-exchange message (type 16). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as getting the server key exchange params as raw data (parsing of this may be added in the
* future)
*/
class SSLClientKeyExchangeMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLClientKeyExchangeMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
~SSLClientKeyExchangeMessage() {}
/**
* @return A pointer to the raw data of the server key exchange params. Currently this data can only be returned
* as raw, parsing may be added in the future. Notice that if the message is spread over more than 1 packet in
* a way params doesn't exist in the first packet, NULL will be returned
*/
uint8_t* getClientKeyExchangeParams();
/**
* @return The size of the params field. Notice that if the message is spread over more than 1 packet in a way the
* ssl_tls_handshake_layer cannot be parsed from the packet, 0 will be returned. Also, if only part of the params
* exist in current packet (and the rest are on consequent packets), the size that will be returned is the size
* of the part that exists in the current packet (and not the total size of params)
*/
size_t getClientKeyExchangeParamsLength();
// implement abstract methods
std::string toString();
};
/**
* @class SSLCertificateRequestMessage
* Represents SSL/TLS certificate-request message (type 13). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as retrieving client certificate types and authority data
*/
class SSLCertificateRequestMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLCertificateRequestMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container);
~SSLCertificateRequestMessage() {}
/**
* @return A reference to a vector containing all client certificate types exist in this message
*/
std::vector<SSLClientCertificateType>& getCertificateTypes();
/**
* @return A pointer to the certificate authority data as raw data (byte array). Parsing of this data may be added
* in the future. Notice that if this message is spread over several packets in a way none of the certificate
* authority data exists in this packet, NULL will be returned
*/
uint8_t* getCertificateAuthorityData();
/**
* @return The length of certificate authority data returned by getCertificateAuthorityData(). Notice that if
* this message is spread over several packets in a way none of certificate authority data exists in the current
* packet, 0 will be returned. Also, if some of the data exists in the consequent packets, the length that will be
* returned is the length of data exists in the current packet only (and not the total length)
*/
size_t getCertificateAuthorityLength();
// implement abstract methods
std::string toString();
private:
std::vector<SSLClientCertificateType> m_ClientCertificateTypes;
};
/**
* @class SSLServerHelloDoneMessage
* Represents SSL/TLS server-hello-done message (type 14). This message has no additional payload except for the common
* payload described in SSLHandshakeMessage
*/
class SSLServerHelloDoneMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLServerHelloDoneMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLServerHelloDoneMessage() {}
// implement abstract methods
std::string toString();
};
/**
* @class SSLCertificateVerifyMessage
* Represents SSL/TLS certificate-verify message (type 15). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as retrieving signed hash data as raw data (parsing may be added in the future)
* @todo This message type wasn't tested in unit-tests
*/
class SSLCertificateVerifyMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLCertificateVerifyMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLCertificateVerifyMessage() {}
/**
* @return A pointer to the signed hash data as raw data (byte array). Parsing of this data may be added
* in the future. Notice that if this message is spread over several packets in a way none of the signed hash data
* exists in this packet, NULL will be returned
*/
uint8_t* getSignedHash();
/**
* @return The length of signed hash data returned by getSignedHash(). Notice that if this message is spread over
* several packets in a way none of this data exists in the current packet, 0 will be returned. Also, if some of
* the data exists in the consequent packets, the length that will be returned will be the length of data exists in
* the current packet only (and not the total length)
*/
size_t getSignedHashLength();
// implement abstract methods
std::string toString();
};
/**
* @class SSLFinishedMessage
* Represents SSL/TLS finished message (type 20). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as retrieving signed hash data as raw data (parsing may be added in the future)
* @todo This message type wasn't tested in unit-tests
*/
class SSLFinishedMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLFinishedMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLFinishedMessage() {}
/**
* @return A pointer to the signed hash data as raw data (byte array). Parsing of this data may be added
* in the future. Notice that if this message is spread over several packets in a way none of the signed hash data
* exists in this packet, NULL will be returned
*/
uint8_t* getSignedHash();
/**
* @return The length of signed hash data returned by getSignedHash(). Notice that if the message is spread over
* several packets in a way none of this data exists in the current packet, 0 will be returned. Also, if some of
* the data exists in the consequent packets, the length that will be returned will be the length of data exists
* in the current packet only (and not the total length)
*/
size_t getSignedHashLength();
// implement abstract methods
std::string toString();
};
/**
* @class SSLNewSessionTicketMessage
* Represents SSL/TLS new-session-ticket message (type 4). Inherits from SSLHandshakeMessage and adds parsing
* functionality such as retrieving session ticket data as raw data (parsing may be added in the future)
*/
class SSLNewSessionTicketMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLNewSessionTicketMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLNewSessionTicketMessage() {}
/**
* @return A pointer to the session ticket data as raw data (byte array). Parsing of this data may be added
* in the future. Notice that if this message is spread over several packets in a way none of the signed hash data
* exists in current packet, NULL will be returned
*/
uint8_t* getSessionTicketData();
/**
* @return The length of session ticket data returned by getSessionTicketData(). Notice that if this message is
* spread over several packets in a way none of this data exists in the current packet, 0 will be returned. Also,
* if some of the data exist in the consequent packets, the length that will be returned will be the length of the
* data existing in the current packet only (and not the total length)
*/
size_t getSessionTicketDataLength();
// implement abstract methods
std::string toString();
};
/**
* @class SSLUnknownMessage
* Represents an unknown type of message or an encrypted message that PcapPlusPlus can't determine its type. In these
* cases length can't always be determined from the message itself (especially if the message is encrypted), so
* the length of this message will always be the size counted from message start until the end of the layer
*/
class SSLUnknownMessage : public SSLHandshakeMessage
{
public:
/**
* C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and should be used
* by a user
* @param[in] data The message as raw data
* @param[in] dataLen Message raw data length in bytes
* @param[in] container The SSL handshake layer which shall contain this message
*/
SSLUnknownMessage(uint8_t* data, size_t dataLen, SSLHandshakeLayer* container) : SSLHandshakeMessage(data, dataLen, container) {}
virtual ~SSLUnknownMessage() {}
// implement virtual and abstract methods
/**
* @return Always ::SSL_HANDSHAKE_UNKNOWN (overridden from SSLHandshakeMessage)
*/
SSLHandshakeType getHandshakeType();
/**
* @return The length of the data from message start until the end of the layer. Since it's an unknown type
* or an encrypted message the length parsed from the message can't be guaranteed to be the correct length. That's
* why the length returned is the size until the end of the layer
*/
size_t getMessageLength();
std::string toString();
};
template<class TExtension>
TExtension* SSLClientHelloMessage::getExtensionOfType()
{
size_t vecSize = m_ExtensionList.size();
for (size_t i = 0; i < vecSize; i++)
{
SSLExtension* curElem = m_ExtensionList.at(i);
if (dynamic_cast<TExtension*>(curElem) != NULL)
return (TExtension*)curElem;
}
return NULL;
}
template<class TExtension>
TExtension* SSLServerHelloMessage::getExtensionOfType()
{
size_t vecSize = m_ExtensionList.size();
for (size_t i = 0; i < vecSize; i++)
{
SSLExtension* curElem = m_ExtensionList.at(i);
if (dynamic_cast<TExtension*>(curElem) != NULL)
return (TExtension*)curElem;
}
return NULL;
}
} // namespace pcpp
#endif /* PACKETPP_SSL_HANDSHAKE_MESSAGE */