summaryrefslogtreecommitdiff
path: root/tcp-reassembly.py
blob: c4aa596d33a30be71989d02f7fbe0ae5621729d9 (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
#!/usr/bin/env python
# Reads a pcap and shows sequence issues (retransmissions, out-of-order, etc).
import argparse
import sys

from scapy.all import *


def identify(pkt):
    ip = pkt[IP]
    tcp = ip[TCP]
    addr = '%s-%d-%s-%d' % (ip.src, tcp.sport, ip.dst, tcp.dport)
    return addr.replace(':', '_')


parser = argparse.ArgumentParser()
parser.add_argument("-s", dest="stream", type=int, help="Select stream number")
parser.add_argument("-r", dest="input_file", required=True, help="Input pcap")
args = parser.parse_args()

# map (ip.src)-(tcp.srcport)-(ip.dst)-(tcp.dstport) -> [<packet>..]
tcp_packets = {}
stream_ids = []

# Group packets per TCP/IP tuple
pkts = rdpcap(args.input_file)
for pktno, pkt in enumerate(pkts, 1):
    if not TCP in pkt:
        continue
    tcp = pkt[TCP]
    if type(tcp.payload) != Raw:
        continue
    payload = tcp.payload.load
    if not payload:
        continue
    address = identify(pkt)
    if address not in stream_ids:
        stream_ids.append(address)
    tcp_packets.setdefault(address, []).append((pktno, pkt))

# Select packet
if not tcp_packets:
    sys.exit("No TCP data packets found")
elif args.stream is not None:
    try:
        stream = stream_ids[args.stream]
        mypackets = tcp_packets[stream]
    except KeyError:
        sys.exit("Requested stream %d was not found", args.stream)
elif len(tcp_packets) == 1:
    mypackets = next(iter(tcp_packets.values()))
else:
    print("Too many addresses, select one of them:")
    print("%4s %-42s %7s %s" % ("Strm", "Addr", "Count", "Bytes"))
    for stream, address in enumerate(stream_ids):
        mypkts = tcp_packets[address]
        pkts_count = len(mypkts)
        pkts_bytes = sum(len(mypkt[TCP].payload.load)
                         for pktno, mypkt in mypkts)
        print("%3d %-43s %7d %d" % (stream, address, pkts_count, pkts_bytes))
    sys.exit(1)


def relative_tcp_seq_no(firstseq):
    def seqno_func(pkt):
        tcp = pkt[TCP]
        seq = tcp.seq - firstseq
        if seq < 0:
            seq += 2**32
        # Sort larger (retransmitted) segments first such that smaller one that
        # are embedded in that one are ignored.
        return (seq, -len(tcp.payload.load))
    return seqno_func


# Fix broken interpretation due to a Scapy bug
# https://github.com/secdev/scapy/pull/1512
for i, (pktno, pkt) in enumerate(mypackets):
    if pkt[IP].len == 0:
        pkt.load += pkt[Padding].load
        del pkt[Padding]
        pkt[IP].len = None
        mypackets[i] = pktno, Ether(bytes(pkt))
        assert mypackets[i][1][IP].len != 0


class SegmentInfo(object):
    def __init__(self, seq, nextseq):
        self.seq = seq
        self.nextseq = nextseq
        self.seglen = nextseq - seq


class Stream(object):
    def __init__(self):
        self.segments = []
        self.unhandled_segments = []
        self.iseq = None
        self.nextseq = None
        self.errors = {}

    def add_segment(self, pktno, pkt):
        self.segments.append((pktno, pkt))
        assert pkt.seq <= self.nextseq
        assert type(pkt[TCP].payload == Raw)
        self.nextseq = pkt.seq + len(pkt[TCP].payload.load)

    def add(self, pktno, pkt):
        assert type(pkt[TCP].payload == Raw)
        segdata = pkt[TCP].payload.load
        seglen = len(segdata)
        seq = pkt.seq
        nextseq = pkt.seq + seglen

        is_initial = self.nextseq is None
        # Set initial seqno
        if self.iseq is None:
            self.iseq = pkt.seq
            self.nextseq = nextseq

        # Ignore segments with no data
        if seglen == 0:
            return

        # Handle normal case
        if is_initial:
            # Handle initial packet
            self.add_segment(pktno, pkt)
            return
        elif seq == self.nextseq:
            # Handle sequential packets
            self.add_segment(pktno, pkt)
            self.process_unhandled()
            return

        # Handle error cases
        if nextseq <= self.nextseq:
            # Ignore full retransmissions
            assert seq < self.nextseq
            self.errors[pktno] = "Retransmission"
            # TODO check overlap conflicts for (seq, nextseq)
        elif seq > self.nextseq:
            # Handle gap segment (possibly lost segment before or OoO)
            # (possible overlap with previous unhandled segments)
            self.errors[pktno] = "Out-of-Order (%d > %d)" % (
                seq - self.iseq, self.nextseq - self.iseq)
            # TODO check overlap conflicts for (seq, nextseq)
            overlap_error = self.has_overlap(seq, nextseq)
            if overlap_error == 1:
                self.errors[pktno] += " / Partial Retransmission"
            elif overlap_error == 2:
                self.errors[pktno] += " / Retransmission"
            if overlap_error != 2:
                # potential new data, so save it.
                self.add_unhandled(pktno, seq, nextseq, pkt)
        else:
            # Else partial overlap. Find out if it is retrans + extra data
            # (possible overlap with previous unhandled segments)
            # This could result in removing segments from "unhandled_segments"
            # and must add to "segments".
            assert seq < self.nextseq
            # TODO check overlap conflicts for (seq, self.nextseq)
            overlap_error = self.has_overlap(self.nextseq, nextseq)
            if overlap_error != 2:
                self.errors[pktno] = "Partial Retransmission"
                self.add_unhandled(pktno, seq, nextseq, pkt)
                self.process_unhandled()
            else:
                self.errors[pktno] = "Retransmission"

    def has_overlap(self, seq, nextseq):
        """
        Returns 0 if there is no overlap.
        Returns 1 if there is a partial overlap (partial retransmission).
        Returns 2 if there is a full overlap (retransmission).
        """
        assert seq < nextseq
        newseq = seq
        for pktno, pkt in self.unhandled_segments:
            if pkt.seq > nextseq:
                # Note: could have continued searching in order to detect
                # conflicting overlaps.
                break
            pkt_nextseq = pkt.seq + len(pkt[TCP].payload.load)
            newseq = max(newseq, pkt_nextseq)
            if newseq >= nextseq:
                # Full overlap
                return 2
        if newseq > seq:
            # partial overlap
            return 1
        else:
            # no overlap
            return 0

    def process_unhandled(self):
        """Try to reassemble segments."""
        errors = []
        remove = 0
        for pktno, pkt in self.unhandled_segments:
            if pkt.seq > self.nextseq:
                break

            nextseq = pkt.seq + len(pkt[TCP].load)
            if pkt.seq == self.nextseq:
                # perfect adjacent
                self.add_segment(pktno, pkt)
            else:
                assert pkt.seq < self.nextseq
                overlap = self.nextseq - pkt.seq
                # partial overlap
                # pkt.load[:overlap]
                errors.append("Overlap: %d - %d (%d bytes)" % (pkt.seq,
                                                               self.nextseq, overlap))
                # XXX append partial? Or leave up to reassembly API?
                self.add_segment(pktno, pkt)
            remove += 1
        self.unhandled_segments = self.unhandled_segments[remove:]
        if errors:
            error = ", ".join(errors)
            if pktno in self.errors:
                self.errors[pktno] += " / " + error
            else:
                self.errors[pktno] = error

    def add_unhandled(self, pktno, seq, nextseq, pkt):
        """Remembers a segment for later use."""
        assert seq < nextseq

        # Ensure that for each segment x, y:
        # x.seq < y.seq or (x.seq == y.seq and x.nextseq <= y.nextseq)
        insertPos = 0
        for i, (pktno2, pkt2) in enumerate(self.unhandled_segments):
            if seq > pkt2.seq:
                break
            if seq == pkt2.seq and nextseq > pkt2.nextseq:
                break
            insertPos = i
        self.unhandled_segments.insert(insertPos, (pktno, pkt))

    def get_overlaps_for(self, pktno, pkt):
        """Find all overlapping segments for pktno."""
        seq = pkt.seq
        nextseq = seq + len(pkt[TCP].payload.load)
        overlaps = []
        for pktno2, pkt2 in self.segments:
            if pktno2 >= pktno:
                # only consider preceding packets that were seen
                break
            seq2 = pkt2.seq
            nextseq2 = seq2 + len(pkt2[TCP].payload.load)
            # if overlap:
            left, right = max(seq, seq2), min(nextseq, nextseq2)
            if left < right:
                overlaps += ["%d:(%d,%d:%d)" % (pktno2, left - self.iseq,
                                                right - self.iseq, right - left)]
        return ", ".join(overlaps)


stream = Stream()
for pktno, pkt in mypackets:
    stream.add(pktno, pkt)
    print("%3d " % (pktno), end="")
    seglen = len(pkt[TCP].load)
    print("seq=%-5d nextseq=%-5d len=%-4d " %
          (pkt.seq - stream.iseq, pkt.seq + seglen - stream.iseq, seglen), end="")
    error = stream.errors.get(pktno)
    if error:
        if 'Retransmission' in error:
            error += ' | ' + stream.get_overlaps_for(pktno, pkt)
        print(error)
    else:
        print("OK")