| 1 |
#ifndef _PROTO_PKT_TCP |
| 2 |
#define _PROTO_PKT_TCP |
| 3 |
|
| 4 |
#include "protoPktIP.h" |
| 5 |
|
| 6 |
/** |
| 7 |
* @class ProtoPktTCP |
| 8 |
* |
| 9 |
* @brief Parses TCP Packets |
| 10 |
*/ |
| 11 |
class ProtoPktTCP : public ProtoPkt |
| 12 |
{ |
| 13 |
public: |
| 14 |
ProtoPktTCP(void* bufferPtr = 0, |
| 15 |
unsigned int numBytes = 0, |
| 16 |
bool initFromBuffer = true, |
| 17 |
bool freeOnDestruct = false); |
| 18 |
~ProtoPktTCP(); |
| 19 |
|
| 20 |
enum Flag |
| 21 |
{ |
| 22 |
FLAG_FIN = 0x0001, // finished, no more data |
| 23 |
FLAG_SYN = 0x0002, // sync sequence numbers (first packet) |
| 24 |
FLAG_RST = 0x0004, // connection reset |
| 25 |
FLAG_PSH = 0x0008, // push data to receiving app |
| 26 |
FLAG_ACK = 0x0010, // ack field is valid |
| 27 |
FLAG_URG = 0x0020, // urgent field is valid |
| 28 |
FLAG_ECE = 0x0040, // if SYN, ECN capable, else congestion indication |
| 29 |
FLAG_CWR = 0x0080, // congestion window reduced |
| 30 |
FLAG_NS = 0x0100 // ECN-nonce concealment protection |
| 31 |
}; |
| 32 |
|
| 33 |
// Use these to parse the datagram |
| 34 |
bool InitFromBuffer(void* bufferPtr = NULL, |
| 35 |
unsigned int numBytes = 0, |
| 36 |
bool freeOnDestruct = false); |
| 37 |
bool InitFromPacket(ProtoPktIP& pkt); |
| 38 |
UINT16 GetSrcPort() const |
| 39 |
{return GetWord16(OFFSET_SRC);} |
| 40 |
UINT16 GetDstPort() const |
| 41 |
{return GetWord16(OFFSET_DST);} |
| 42 |
UINT32 GetSequence() const |
| 43 |
{return GetWord32(OFFSET_SEQ);} |
| 44 |
UINT32 GetAckNumber() const |
| 45 |
{return GetWord32(OFFSET_ACK);} |
| 46 |
UINT16 GetFlags() const |
| 47 |
{return (0x01ff & GetWord16(OFFSET_FLAGS));} |
| 48 |
bool FlagIsSet(Flag flag) const |
| 49 |
{return (0 != (flag & GetFlags()));} |
| 50 |
UINT16 GetWindowSize() const |
| 51 |
{return GetWord16(OFFSET_WINDOW);} |
| 52 |
UINT16 GetChecksum() const |
| 53 |
{return GetWord16(OFFSET_CHECKSUM);} |
| 54 |
UINT16 GetUrgentPointer() const |
| 55 |
{return GetWord16(OFFSET_URGENT);} |
| 56 |
bool HasOptions() const |
| 57 |
{return (OffsetPayload() > 5);} |
| 58 |
const void* GetOptions() const |
| 59 |
{return GetBuffer32(OFFSET_OPTIONS);} |
| 60 |
UINT16 GetPayloadLength() const |
| 61 |
{return (GetLength() - (OffsetPayload() << 2));} |
| 62 |
const void* GetPayload() const |
| 63 |
{return GetBuffer32(OffsetPayload());} |
| 64 |
void* AccessPayload() |
| 65 |
{return AccessBuffer32(OffsetPayload());} |
| 66 |
UINT16 ComputeChecksum(ProtoPktIP& ipPkt) const; |
| 67 |
bool ChecksumIsValid(ProtoPktIP& ipPkt) const |
| 68 |
{return (GetChecksum() == ComputeChecksum(ipPkt));} |
| 69 |
|
| 70 |
// Use these to build the datagram |
| 71 |
bool InitIntoBuffer(void* bufferPtr = 0, |
| 72 |
unsigned int numBytes = 0, |
| 73 |
bool freeOnDestruct = false); |
| 74 |
void SetSrcPort(UINT16 port) |
| 75 |
{SetWord16(OFFSET_SRC, port);} |
| 76 |
void SetDstPort(UINT16 port) |
| 77 |
{SetWord16(OFFSET_DST, port);} |
| 78 |
void SetSequence(UINT32 seq) |
| 79 |
{SetWord32(OFFSET_SEQ, seq);} |
| 80 |
void SetAckNumber(UINT32 ackNumber) |
| 81 |
{ |
| 82 |
SetFlag(FLAG_ACK); |
| 83 |
SetWord32(OFFSET_ACK, ackNumber); |
| 84 |
} |
| 85 |
void SetFlags(UINT16 flags) |
| 86 |
{ |
| 87 |
UINT16 field = 0xfe00 & GetWord16(OFFSET_FLAGS); |
| 88 |
SetWord16(OFFSET_FLAGS, field | flags); |
| 89 |
} |
| 90 |
void ClearFlags() |
| 91 |
{ |
| 92 |
UINT16 field = 0xfe00 & GetWord16(OFFSET_FLAGS); |
| 93 |
SetWord16(OFFSET_FLAGS, field); |
| 94 |
} |
| 95 |
void SetFlag(Flag flag) |
| 96 |
{ |
| 97 |
UINT16 field = GetWord16(OFFSET_FLAGS); |
| 98 |
SetWord16(OFFSET_FLAGS, field | (UINT16)flag); |
| 99 |
} |
| 100 |
void ClearFlag(Flag flag) |
| 101 |
{ |
| 102 |
UINT16 field = GetWord16(OFFSET_FLAGS); |
| 103 |
SetWord16(OFFSET_FLAGS, field & ~(UINT16)flag); |
| 104 |
} |
| 105 |
void SetWindowSize(UINT16 windowSize) |
| 106 |
{SetWord16(OFFSET_WINDOW, windowSize);} |
| 107 |
void SetChecksum(UINT16 checksum) |
| 108 |
{SetWord16(OFFSET_CHECKSUM, checksum);} |
| 109 |
void SetUrgentPointer(UINT16 value) |
| 110 |
{ |
| 111 |
SetFlag(FLAG_URG); |
| 112 |
SetWord16(OFFSET_URGENT, value); |
| 113 |
} |
| 114 |
void SetPayload(const char* payload, UINT16 numBytes) |
| 115 |
{ |
| 116 |
memcpy((char*)AccessBuffer32(OffsetPayload()), payload, numBytes); |
| 117 |
ProtoPkt::SetLength(numBytes + (OffsetPayload() << 2)); |
| 118 |
} |
| 119 |
// This must be called after payload is set |
| 120 |
void FinalizeChecksum(ProtoPktIP& ipPkt) |
| 121 |
{SetChecksum(ComputeChecksum(ipPkt));} |
| 122 |
|
| 123 |
private: |
| 124 |
enum |
| 125 |
{ |
| 126 |
OFFSET_SRC = 0, // source port number (UINT16 offset) |
| 127 |
OFFSET_DST = OFFSET_SRC + 1, // destination port number (UINT16 offset) |
| 128 |
OFFSET_SEQ = (OFFSET_DST + 1)/2, // sequence number (UINT32 offset) |
| 129 |
OFFSET_ACK = OFFSET_SEQ + 1, // acknowledgment number (UINT32 offset) |
| 130 |
OFFSET_DATA = (OFFSET_ACK+1)*4, // data offset (UINT8, upper 4 bits) |
| 131 |
OFFSET_FLAGS = (OFFSET_ACK+1)*2, // flags (UINT16, lower 9 bits) |
| 132 |
OFFSET_WINDOW = OFFSET_FLAGS + 1, // window size (UINT16 offset) |
| 133 |
OFFSET_CHECKSUM = OFFSET_WINDOW + 1, // checksum (UINT16 offset) |
| 134 |
OFFSET_URGENT = OFFSET_CHECKSUM +1, // urgent pointer (UINT16 offset) |
| 135 |
OFFSET_OPTIONS = (OFFSET_URGENT+1)/2 // options (UINT32 offset) |
| 136 |
}; |
| 137 |
|
| 138 |
unsigned int OffsetPayload() const // UINT32 offset value |
| 139 |
{return ((GetUINT8(OFFSET_DATA) >> 4) & 0x0f);} |
| 140 |
void SetDataOffset(UINT8 offset) // as a UINT32 offset value |
| 141 |
{ |
| 142 |
// Replace upper 4 bits of the data offset/reserved/ns byte |
| 143 |
UINT8 field = GetUINT8(OFFSET_DATA) & 0x0f; |
| 144 |
SetUINT8(OFFSET_DATA, ((offset & 0x0f) << 4) | field); |
| 145 |
} |
| 146 |
}; // end class ProtoPktTCP |
| 147 |
|
| 148 |
#endif // _PROTO_PKT_TCP |