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
|
import os
import sys
stl_pathname = os.path.abspath(os.path.join(os.pardir, os.pardir))
sys.path.append(stl_pathname)
import trex_stl_lib
from trex_stl_lib.api import *
from copy import deepcopy
import sys
import tempfile
import hashlib
import binascii
from pprint import pprint
try:
from cStringIO import StringIO
except ImportError:
from io import StringIO
"""
**** output redirection template ****
old_stdout = sys.stdout
sys.stdout = mystdout = StringIO()
ls()
sys.stdout = old_stdout
a= mystdout.getvalue()
f = open('scapy_supported_formats.txt','w')
f.write(a)
f.close()
"""
class ScapyException(Exception): pass
class Scapy_service:
#----------------------------------------------------------------------------------------------------
class scapyRegex:
def __init__(self,FieldName,regex='empty'):
self.FieldName = FieldName
self.regex = regex
def stringRegex(self):
return self.regex
#----------------------------------------------------------------------------------------------------
def __init__(self):
self.Raw = {'Raw':''}
self.high_level_protocols = ['Raw']
self.transport_protocols = {'TCP':self.Raw,'UDP':self.Raw}
self.network_protocols = {'IP':self.transport_protocols ,'ARP':''}
self.low_level_protocols = { 'Ether': self.network_protocols }
self.regexDB= {'MACField' : self.scapyRegex('MACField','^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$'),
'IPField' : self.scapyRegex('IPField','^(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9])\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[0-9])$')}
self.all_protocols = self.build_lib()
self.protocol_tree = {'ALL':{'Ether':{'ARP':{},'IP':{'TCP':{'RAW':'payload'},'UDP':{'RAW':'payload'}}}}}
def protocol_struct(self,protocol=''):
if '_' in protocol:
return []
if not protocol=='':
if protocol not in self.all_protocols:
return 'protocol not supported'
protocol = eval(protocol)
old_stdout = sys.stdout
sys.stdout = mystdout = StringIO()
if not protocol=='':
ls(protocol)
else:
ls()
sys.stdout = old_stdout
protocol_data= mystdout.getvalue()
return protocol_data
def build_lib(self):
lib = self.protocol_struct()
lib = lib.split('\n')
all_protocols=[]
for entry in lib:
entry = entry.split(':')
all_protocols.append(entry[0].strip())
del all_protocols[len(all_protocols)-1]
return all_protocols
def parse_description_line(self,line):
line_arr = [x.strip() for x in re.split(': | = ',line)]
return tuple(line_arr)
def parse_entire_description(self,description):
description = description.split('\n')
description_list = [self.parse_description_line(x) for x in description]
del description_list[len(description_list)-1]
return description_list
def get_protocol_details(self,p_name):
protocol_str = self.protocol_struct(p_name)
if protocol_str=='protocol not supported':
return 'protocol not supported'
if len(protocol_str) is 0:
return []
tupled_protocol = self.parse_entire_description(protocol_str)
return tupled_protocol
def print_tree(self):
pprint(self.protocol_tree)
def get_all_protocols(self):
return self.all_protocols
def get_tree(self):
return self.protocol_tree
def get_all_db(self):
db = {}
for pro in self.all_protocols:
details = self.get_protocol_details(pro)
db[pro] = details
return db
def get_all_fields(self):
fields = []
for pro in self.all_protocols:
details = self.get_protocol_details(pro)
for i in range(0,len(details),1):
if len(details[i]) is 3:
fields.append(details[i][1])
uniqeFields = list(set(fields))
fieldDict = {}
for f in uniqeFields:
if f in self.regexDB:
fieldDict[f] = self.regexDB[f].stringRegex()
else:
fieldDict[f] = self.scapyRegex(f).stringRegex()
return fieldDict
def show2_to_dict(self,pkt):
old_stdout = sys.stdout
sys.stdout = mystdout = StringIO()
pkt.show2()
sys.stdout = old_stdout
show2data = mystdout.getvalue() #show2 data
listedShow2Data = show2data.split('###')
show2Dict = {}
for i in range(1,len(listedShow2Data)-1,2):
protocol_fields = listedShow2Data[i+1]
protocol_fields = protocol_fields.split('\n')[1:-1]
protocol_fields = [f.strip() for f in protocol_fields]
protocol_fields_dict = {}
for f in protocol_fields:
field_data = f.split('=')
if len(field_data)!= 1 :
field_name = field_data[0].strip()
protocol_fields_dict[field_name] = field_data[1].strip()
layer_name = re.sub(r'\W+', '',listedShow2Data[i]) #clear layer name to include only alpha-numeric
show2Dict[layer_name] = protocol_fields_dict
return show2Dict
#pkt_desc as string
#dictionary of offsets per protocol. tuple for each field: (name, offset, size) at json format
def get_all_pkt_offsets(self,pkt_desc):
pkt_protocols = pkt_desc.split('/')
scapy_pkt = eval(pkt_desc)
scapy_pkt.build()
total_protocols = len(pkt_protocols)
res = {}
for i in range(total_protocols):
fields = {}
for field in scapy_pkt.fields_desc:
size = field.get_size_bytes()
layer_name = pkt_protocols[i].partition('(')[0] #clear layer name to include only alpha-numeric
layer_name = re.sub(r'\W+', '',layer_name)
if field.name is 'load':
layer_name ='Raw'
size = len(scapy_pkt)
fields[field.name]=[field.offset, size]
fields['global_offset'] = scapy_pkt.offset
res[layer_name] = fields
scapy_pkt=scapy_pkt.payload
return res
# pkt_descriptor in string format
def build_pkt(self,pkt_descriptor):
pkt = eval(pkt_descriptor)
show2data = self.show2_to_dict(pkt)
bufferData = str(pkt) #pkt buffer
bufferData = binascii.b2a_base64(bufferData)
pkt_offsets = self.get_all_pkt_offsets(pkt_descriptor)
res = {}
res['show2'] = show2data
res['buffer'] = bufferData
res['offsets'] = pkt_offsets
return res
#input: container
#output: md5 encoded in base64
def get_md5(self,container):
container = json.dumps(container)
m = hashlib.md5()
m.update(container.encode('ascii'))
res_md5 = binascii.b2a_base64(m.digest())
return res_md5
def get_all(self):
fields=self.get_all_fields()
db=self.get_all_db()
fields_md5 = self.get_md5(fields)
db_md5 = self.get_md5(db)
res = {}
res['db'] = db
res['fields'] = fields
res['db_md5'] = db_md5
res['fields_md5'] = fields_md5
return res
#input in string encoded base64
def check_update(self,db_md5,field_md5):
fields=self.get_all_fields()
db=self.get_all_db()
current_db_md5 = self.get_md5(db)
current_field_md5 = self.get_md5(fields)
res = []
if field_md5 == current_field_md5:
if db_md5 == current_db_md5:
return True
else:
raise ScapyException("Protocol DB is not up to date")
else:
raise ScapyException("Fields DB is not up to date")
def get_version(self):
return {'built_by':'itraviv','version':'v1.0'}
def supported_methods(self,method_name=''):
if method_name=='':
methods = {}
for f in dir(Scapy_service):
if inspect.ismethod(eval('Scapy_service.'+f)):
methods[f] = inspect.getargspec(eval('Scapy_service.'+f))[0]
return methods
if method_name in dir(Scapy_service):
return True
return False
|
