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
|
#
# python-ipfix (c) 2013 Brian Trammell.
#
# Many thanks to the mPlane consortium (http://www.ict-mplane.eu) for
# its material support of this effort.
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Provides the PduBuffer class for decoding NetFlow V9 Protocol Data
Units (PDUs) from a stream.
"""
from . import template, types, ie
from .template import IpfixEncodeError, IpfixDecodeError
from .message import accept_all_templates
import operator
import functools
import struct
from datetime import datetime
from warnings import warn
NETFLOW9_VERSION = 9
_sethdr_st = struct.Struct("!HH")
_pduhdr_st = struct.Struct("!HHLLLL")
class PduBuffer:
"""
Implements a buffer for reading NetFlow V9 PDUs from a stream or packet.
Abstract class; use the :meth:`from_stream` to get an instance for
reading from a stream instead.
"""
def __init__(self):
"""Create a new PduBuffer instance."""
self.mbuf = memoryview(bytearray(65536))
self.length = 0
self.cur = 0
self.reccount = None
self.sequence = None
self.export_epoch = None
self.sysuptime_ms = None
self.base_epoch = None
self.odid = 0
self.templates = {}
self.accepted_tids = set()
self.sequences = {}
self.last_tuple_iterator_ielist = None
self.template_record_hook = None
def __repr__(self):
return "<PDUBuffer domain "+str(self.odid)+\
" length "+str(self.length)+addinf+">"
def _increment_sequence(self, inc = 1):
self.sequences.setdefault(self.odid, 0)
self.sequences[self.odid] += inc
def _parse_pdu_header(self):
(version, self.reccount, self.sysuptime_ms,
self.export_epoch, self.sequence, self.odid) = \
_pduhdr_st.unpack_from(self.mbuf, 0)
if version != NETFLOW9_VERSION:
raise IpfixDecodeError("Illegal or unsupported version " +
str(version))
self._increment_sequence(self.reccount)
self.basetime_epoch = self.export_epoch - (self.sysuptime_ms / 1000)
def set_iterator(self):
"""
Low-level interface to set iteration.
"""
while True:
try:
yield self.next_set()
except EOFError:
break
def record_iterator(self,
decode_fn=template.Template.decode_namedict_from,
tmplaccept_fn=accept_all_templates,
recinf=None):
"""
Low-level interface to record iteration.
Iterate over records in a PDU; the buffer must either be attached to
a stream via :meth:`attach_stream` or have been preloaded with
:meth:`from_bytes`. Automatically handles
templates in set order. By default, iterates over each record in the
stream as a dictionary mapping IE name to value
(i.e., the same as :meth:`namedict_iterator`)
:param decode_fn: Function used to decode a record;
must be an (unbound) "decode" instance method of the
:class:`ipfix.template.Template` class.
:param tmplaccept_fn: Function returning True if the given template
is of interest to the caller, False if not.
Default accepts all templates. Sets described by
templates for which this function returns False
will be skipped.
:param recinf: Record information opaquely passed to decode function
:returns: an iterator over records decoded by decode_fn.
"""
for (mbuf, offset, setid, setlen) in self.set_iterator():
setend = offset + setlen
offset += _sethdr_st.size # skip set header in decode
if setid == template.V9_TEMPLATE_SET_ID or \
setid == template.V9_OPTIONS_SET_ID:
while offset < setend:
(tmpl, offset) = template.decode_template_from(
mbuf, offset, setid)
# FIXME handle withdrawal
self.templates[(self.odid, tmpl.tid)] = tmpl
if tmplaccept_fn(tmpl):
self.accepted_tids.add((self.odid, tmpl.tid))
else:
self.accepted_tids.discard((self.odid, tmpl.tid))
if self.template_record_hook:
self.template_record_hook(self, tmpl)
elif setid < 256:
warn("skipping illegal set id "+str(setid))
else:
try:
tmpl = self.templates[(self.odid, setid)]
if (self.odid, setid) in self.accepted_tids:
while offset + tmpl.minlength <= setend:
(rec, offset) = decode_fn(tmpl, self.mbuf, offset,
recinf = recinf)
yield rec
self._increment_sequence()
elif self.ignored_data_set_hook:
# not in accepted tids - ignored data set
self.ignored_data_set_hook(self, tmpl,
self.mbuf[offset-_sethdr_st.size:setend])
except KeyError as e:
if self.unknown_data_set_hook:
# KeyError on template lookup - unknown data set
self.unknown_data_set_hook(self,
self.mbuf[offset-_sethdr_st.size:setend])
def namedict_iterator(self):
"""
Iterate over all records in the Message, as dicts mapping IE names
to values.
:returns: a name dictionary iterator
"""
return self.record_iterator(
decode_fn = template.Template.decode_namedict_from)
def active_template_ids(self):
"""
Get an iterator over all active template IDs in the current domain.
Provided to allow callers to export some or all active Templates across
multiple Messages.
:returns: a template ID iterator
"""
for tk in filter(lambda k: k[0] == self.odid, self.templates):
yield tk[1]
def _recache_accepted_tids(self, tmplaccept_fn):
for tid in self.active_template_ids():
if tmplaccept_fn(self.templates[(self.odid, tid)]):
self.accepted_tids.add((self.odid, tid))
else:
self.accepted_tids.discard((self.odid, tid))
def tuple_iterator(self, ielist):
"""
Iterate over all records in the PDU containing all the IEs in
the given ielist. Records are returned as tuples in ielist order.
:param ielist: an instance of :class:`ipfix.ie.InformationElementList`
listing IEs to return as a tuple
:returns: a tuple iterator for tuples as in ielist order
"""
tmplaccept_fn = lambda tmpl: \
functools.reduce(operator.__and__,
(ie in tmpl.ies for ie in ielist))
if ((not self.last_tuple_iterator_ielist) or
(ielist is not self.last_tuple_iterator_ielist)):
self._recache_accepted_tids(tmplaccept_fn)
self.last_tuple_iterator_ielist = ielist
return self.record_iterator(
decode_fn = template.Template.decode_tuple_from,
tmplaccept_fn = tmplaccept_fn,
recinf = ielist)
class StreamPduBuffer(PduBuffer):
"""Create a new StreamPduBuffer instance."""
def __init__(self, stream):
super().__init__()
self.stream = stream
def next_set(self):
"""
Reads the next set from the stream. Automatically reads PDU headers, as
well, since PDU headers are treated as a special case of set header in
streamed PDU reading.
Raises EOF to signal end of stream.
Yes, NetFlow V9 really is that broken as a storage format,
and this is the only way to stream it without counting records
(which we can't do in the tuple-reading case).
"""
sethdr = self.stream.read(_sethdr_st.size)
if (len(sethdr) == 0):
raise EOFError()
elif (len(sethdr) < _sethdr_st.size):
raise IpfixDecodeError("Short read in V9 set header ("+
str(len(sethdr)) +")")
self.mbuf[0:_sethdr_st.size] = sethdr
(setid, setlen) = _sethdr_st.unpack_from(self.mbuf)
while setid == NETFLOW9_VERSION:
# Actually, this is the first part of a message header.
# Grab the rest from the stream, then parse it.
resthdr = self.stream.read(_pduhdr_st.size - _sethdr_st.size)
if (len(resthdr) < _pduhdr_st.size - _sethdr_st.size):
raise IpfixDecodeError("Short read in V9 pdu header ("+
str(len(resthdr)) +")")
self.mbuf[_sethdr_st.size:_pduhdr_st.size] = resthdr
self._parse_pdu_header()
# Now try again to get a set header
self.mbuf[0:_sethdr_st.size]= self.stream.read(_sethdr_st.size)
(setid, setlen) = _sethdr_st.unpack_from(self.mbuf)
# read the set body into the buffer
setbody = self.stream.read(setlen - _sethdr_st.size)
if (len(setbody) < setlen - _sethdr_st.size):
raise IpfixDecodeError("Short read in V9 set body ("+
str(len(setbody)) +")")
self.mbuf[_sethdr_st.size:setlen] = setbody
# return pointers for set_iterator
return (self.mbuf, 0, setid, setlen)
def from_stream(stream):
"""
Get a StreamPduBuffer for a given stream
:param stream: stream to read
:return: a :class:`PduBuffer` wrapped around the stream.
"""
return StreamPduBuffer(stream)
class TimeAdapter:
"""
Wraps around a PduBuffer and adds flowStartMilliseconds and
flowEndMilliseconds Information Elements to each record, turning
the basetime-dependent timestamps common in V9 export into
absolute timestamps.
To use, create a PduBuffer, create a TimeAdapter with the PduBuffer
as the constructor argument, then iterate tuples or namedicts from
the TimeAdapter.
"""
def __init__(self, pdubuf):
self.pdubuf = pdubuf
def namedict_iterator(self):
for rec in self.pdubuf.namedict_iterator(ienames):
try:
rec["flowStartMilliseconds"] = \
types._decode_msec(rec["flowStartSysUpTime"] / 1000 +
self.pdubuf.basetime_epoch)
except KeyError:
pass
try:
rec["flowEndMilliseconds"] = \
types._decode_msec(rec["flowEndSysUpTime"] / 1000 +
self.pdubuf.basetime_epoch)
except KeyError:
pass
yield rec
def tuple_iterator(self, ielist):
flowStartSysUpTime = ie.for_spec("flowStartSysUpTime")
flowEndSysUpTime = ie.for_spec("flowEndSysUpTime")
if (flowStartSysUpTime in ielist) and \
(flowEndSysUpTime in ielist):
start_index = ielist.index(flowStartSysUpTime)
end_index = ielist.index(flowEndSysUpTime)
for rec in self.pdubuf.tuple_iterator(ielist):
start_ms = types._decode_msec(rec[start_index] / 1000 +
self.pdubuf.basetime_epoch)
end_ms = types._decode_msec(rec[end_index] / 1000 +
self.pdubuf.basetime_epoch)
yield rec + (start_ms, end_ms)
else:
for rec in self.pdubuf.tuple_iterator(ielist):
yield rec
|
