|
1
|
|
|
"""Main module of amlight/sdntrace_cp Kytos Network Application. |
|
2
|
|
|
|
|
3
|
|
|
Run tracepaths on OpenFlow in the Control Plane |
|
4
|
|
|
""" |
|
5
|
|
|
|
|
6
|
1 |
|
import ipaddress |
|
7
|
1 |
|
import pathlib |
|
8
|
1 |
|
from datetime import datetime |
|
9
|
|
|
|
|
10
|
1 |
|
import tenacity |
|
11
|
1 |
|
from flask import jsonify |
|
12
|
1 |
|
from kytos.core import KytosNApp, log, rest |
|
13
|
1 |
|
from kytos.core.helpers import load_spec, validate_openapi |
|
14
|
1 |
|
from napps.amlight.sdntrace_cp.utils import (convert_entries, |
|
15
|
|
|
convert_list_entries, |
|
16
|
|
|
find_endpoint, get_stored_flows, |
|
17
|
|
|
match_field_dl_vlan, prepare_json) |
|
18
|
1 |
|
from werkzeug.exceptions import FailedDependency |
|
19
|
|
|
|
|
20
|
|
|
|
|
21
|
1 |
|
class Main(KytosNApp): |
|
22
|
|
|
"""Main class of amlight/sdntrace_cp NApp. |
|
23
|
|
|
|
|
24
|
|
|
This application gets the list of flows from the switches |
|
25
|
|
|
and uses it to trace paths without using the data plane. |
|
26
|
|
|
""" |
|
27
|
|
|
|
|
28
|
1 |
|
spec = load_spec(pathlib.Path(__file__).parent / "openapi.yml") |
|
29
|
|
|
|
|
30
|
1 |
|
def setup(self): |
|
31
|
|
|
"""Replace the '__init__' method for the KytosNApp subclass. |
|
32
|
|
|
|
|
33
|
|
|
The setup method is automatically called by the controller when your |
|
34
|
|
|
application is loaded. |
|
35
|
|
|
|
|
36
|
|
|
""" |
|
37
|
1 |
|
log.info("Starting Kytos SDNTrace CP App!") |
|
38
|
|
|
|
|
39
|
1 |
|
def execute(self): |
|
40
|
|
|
"""This method is executed right after the setup method execution. |
|
41
|
|
|
|
|
42
|
|
|
You can also use this method in loop mode if you add to the above setup |
|
43
|
|
|
method a line like the following example: |
|
44
|
|
|
|
|
45
|
|
|
self.execute_as_loop(30) # 30-second interval. |
|
46
|
|
|
""" |
|
47
|
|
|
|
|
48
|
1 |
|
def shutdown(self): |
|
49
|
|
|
"""This method is executed when your napp is unloaded. |
|
50
|
|
|
|
|
51
|
|
|
If you have some cleanup procedure, insert it here. |
|
52
|
|
|
""" |
|
53
|
|
|
|
|
54
|
1 |
|
@rest('/v1/trace', methods=['PUT']) |
|
55
|
1 |
|
@validate_openapi(spec) |
|
56
|
1 |
|
def trace(self, data): |
|
57
|
|
|
"""Trace a path.""" |
|
58
|
1 |
|
result = [] |
|
59
|
1 |
|
entries = convert_entries(data) |
|
60
|
1 |
|
try: |
|
61
|
1 |
|
stored_flows = get_stored_flows() |
|
62
|
1 |
|
except tenacity.RetryError as exc: |
|
63
|
|
|
raise FailedDependency("It couldn't get stored_flows") from exc |
|
64
|
|
|
else: |
|
65
|
1 |
|
result = self.tracepath(entries, stored_flows) |
|
66
|
1 |
|
return jsonify(prepare_json(result)) |
|
67
|
|
|
|
|
68
|
1 |
|
@rest('/v1/traces', methods=['PUT']) |
|
69
|
1 |
|
@validate_openapi(spec) |
|
70
|
1 |
|
def get_traces(self, data): |
|
71
|
|
|
"""For bulk requests.""" |
|
72
|
1 |
|
entries = convert_list_entries(data) |
|
73
|
1 |
|
results = [] |
|
74
|
1 |
|
try: |
|
75
|
1 |
|
stored_flows = get_stored_flows() |
|
76
|
1 |
|
except tenacity.RetryError as exc: |
|
77
|
|
|
raise FailedDependency("It couldn't get stored_flows") from exc |
|
78
|
1 |
|
for entry in entries: |
|
79
|
1 |
|
results.append(self.tracepath(entry, stored_flows)) |
|
80
|
1 |
|
temp = prepare_json(results) |
|
81
|
1 |
|
return jsonify(temp) |
|
82
|
|
|
|
|
83
|
1 |
|
def tracepath(self, entries, stored_flows): |
|
84
|
|
|
"""Trace a path for a packet represented by entries.""" |
|
85
|
|
|
# pylint: disable=too-many-branches |
|
86
|
1 |
|
trace_result = [] |
|
87
|
1 |
|
trace_type = 'starting' |
|
88
|
1 |
|
do_trace = True |
|
89
|
1 |
|
while do_trace: |
|
90
|
1 |
|
if 'dpid' not in entries or 'in_port' not in entries: |
|
91
|
|
|
break |
|
92
|
1 |
|
trace_step = {'in': {'dpid': entries['dpid'], |
|
93
|
|
|
'port': entries['in_port'], |
|
94
|
|
|
'time': str(datetime.now()), |
|
95
|
|
|
'type': trace_type}} |
|
96
|
1 |
|
if 'dl_vlan' in entries: |
|
97
|
1 |
|
trace_step['in'].update({'vlan': entries['dl_vlan'][-1]}) |
|
98
|
|
|
|
|
99
|
1 |
|
switch = self.controller.get_switch_by_dpid(entries['dpid']) |
|
100
|
1 |
|
if not switch: |
|
101
|
1 |
|
trace_step['in']['type'] = 'last' |
|
102
|
1 |
|
trace_result.append(trace_step) |
|
103
|
1 |
|
break |
|
104
|
1 |
|
result = self.trace_step(switch, entries, stored_flows) |
|
105
|
1 |
|
if result: |
|
106
|
1 |
|
out = {'port': result['out_port']} |
|
107
|
1 |
|
if 'dl_vlan' in result['entries']: |
|
108
|
1 |
|
out.update({'vlan': result['entries']['dl_vlan'][-1]}) |
|
109
|
1 |
|
trace_step.update({ |
|
110
|
|
|
'out': out |
|
111
|
|
|
}) |
|
112
|
1 |
|
if 'dpid' in result: |
|
113
|
1 |
|
next_step = {'dpid': result['dpid'], |
|
114
|
|
|
'port': result['in_port']} |
|
115
|
1 |
|
entries = result['entries'] |
|
116
|
1 |
|
entries['dpid'] = result['dpid'] |
|
117
|
1 |
|
entries['in_port'] = result['in_port'] |
|
118
|
1 |
|
if self.has_loop(next_step, trace_result): |
|
119
|
1 |
|
trace_step['in']['type'] = 'loop' |
|
120
|
1 |
|
do_trace = False |
|
121
|
|
|
else: |
|
122
|
1 |
|
trace_type = 'intermediary' |
|
123
|
|
|
else: |
|
124
|
1 |
|
trace_step['in']['type'] = 'last' |
|
125
|
1 |
|
do_trace = False |
|
126
|
|
|
else: |
|
127
|
1 |
|
trace_step['in']['type'] = 'incomplete' |
|
128
|
1 |
|
do_trace = False |
|
129
|
1 |
|
if 'out' in trace_step and trace_step['out']: |
|
130
|
1 |
|
if self.check_loop_trace_step(trace_step, trace_result): |
|
131
|
1 |
|
do_trace = False |
|
132
|
1 |
|
trace_result.append(trace_step) |
|
133
|
1 |
|
return trace_result |
|
134
|
|
|
|
|
135
|
1 |
|
@staticmethod |
|
136
|
1 |
|
def check_loop_trace_step(trace_step, trace_result): |
|
137
|
|
|
"""Check if there is a loop in the trace and add the step.""" |
|
138
|
|
|
# outgoing interface is the same as the input interface |
|
139
|
1 |
|
if not trace_result and \ |
|
140
|
|
|
trace_step['in']['type'] == 'last' and \ |
|
141
|
|
|
trace_step['in']['port'] == trace_step['out']['port']: |
|
142
|
1 |
|
trace_step['in']['type'] = 'loop' |
|
143
|
1 |
|
return True |
|
144
|
1 |
|
if trace_result and \ |
|
145
|
|
|
trace_result[0]['in']['dpid'] == trace_step['in']['dpid'] and \ |
|
146
|
|
|
trace_result[0]['in']['port'] == trace_step['out']['port']: |
|
147
|
1 |
|
trace_step['in']['type'] = 'loop' |
|
148
|
1 |
|
return True |
|
149
|
1 |
|
return False |
|
150
|
|
|
|
|
151
|
1 |
|
@staticmethod |
|
152
|
1 |
|
def has_loop(trace_step, trace_result): |
|
153
|
|
|
"""Check if there is a loop in the trace result.""" |
|
154
|
1 |
|
for trace in trace_result: |
|
155
|
1 |
|
if trace['in']['dpid'] == trace_step['dpid'] and \ |
|
156
|
|
|
trace['in']['port'] == trace_step['port']: |
|
157
|
1 |
|
return True |
|
158
|
1 |
|
return False |
|
159
|
|
|
|
|
160
|
1 |
|
def trace_step(self, switch, entries, stored_flows): |
|
161
|
|
|
"""Perform a trace step. |
|
162
|
|
|
|
|
163
|
|
|
Match the given fields against the switch's list of flows.""" |
|
164
|
1 |
|
flow, entries, port = self.match_and_apply( |
|
165
|
|
|
switch, |
|
166
|
|
|
entries, |
|
167
|
|
|
stored_flows |
|
168
|
|
|
) |
|
169
|
|
|
|
|
170
|
1 |
|
if not flow or not port: |
|
171
|
1 |
|
return None |
|
172
|
|
|
|
|
173
|
1 |
|
endpoint = find_endpoint(switch, port) |
|
174
|
1 |
|
if endpoint is None: |
|
175
|
|
|
log.warning(f"Port {port} not found on switch {switch}") |
|
176
|
|
|
return None |
|
177
|
1 |
|
endpoint = endpoint['endpoint'] |
|
178
|
1 |
|
if endpoint is None: |
|
179
|
1 |
|
return {'out_port': port, |
|
180
|
|
|
'entries': entries} |
|
181
|
|
|
|
|
182
|
1 |
|
return {'dpid': endpoint.switch.dpid, |
|
183
|
|
|
'in_port': endpoint.port_number, |
|
184
|
|
|
'out_port': port, |
|
185
|
|
|
'entries': entries} |
|
186
|
|
|
|
|
187
|
1 |
|
@classmethod |
|
188
|
1 |
|
def do_match(cls, flow, args): |
|
189
|
|
|
"""Match a packet against this flow (OF1.3).""" |
|
190
|
|
|
# pylint: disable=consider-using-dict-items |
|
191
|
|
|
# pylint: disable=too-many-return-statements |
|
192
|
1 |
|
if ('match' not in flow['flow']) or (len(flow['flow']['match']) == 0): |
|
193
|
1 |
|
return False |
|
194
|
1 |
|
for name in flow['flow']['match']: |
|
195
|
1 |
|
field_flow = flow['flow']['match'][name] |
|
196
|
1 |
|
if name == 'dl_vlan': |
|
197
|
1 |
|
field = args.get(name) |
|
198
|
1 |
|
if field: |
|
199
|
1 |
|
field = field[-1] |
|
200
|
1 |
|
if not match_field_dl_vlan(field, field_flow): |
|
201
|
1 |
|
return False |
|
202
|
|
|
continue |
|
203
|
1 |
|
if name not in args: |
|
204
|
|
|
return False |
|
205
|
1 |
|
field = args[name] |
|
206
|
1 |
|
if name not in ('ipv4_src', 'ipv4_dst', 'ipv6_src', 'ipv6_dst'): |
|
207
|
1 |
|
if field_flow != field: |
|
208
|
1 |
|
return False |
|
209
|
|
|
else: |
|
210
|
|
|
packet_ip = int(ipaddress.ip_address(field)) |
|
211
|
|
|
ip_addr = flow['flow']['match'][name] |
|
212
|
|
|
if packet_ip & ip_addr.netmask != ip_addr.address: |
|
213
|
|
|
return False |
|
214
|
1 |
|
return flow |
|
215
|
|
|
|
|
216
|
1 |
|
def match_flows(self, switch, args, stored_flows, many=True): |
|
217
|
|
|
# pylint: disable=bad-staticmethod-argument |
|
218
|
|
|
""" |
|
219
|
|
|
Match the packet in request against the stored flows from flow_manager. |
|
220
|
|
|
Try the match with each flow, in other. If many is True, tries the |
|
221
|
|
|
match with all flows, if False, tries until the first match. |
|
222
|
|
|
:param args: packet data |
|
223
|
|
|
:param many: Boolean, indicating whether to continue after matching the |
|
224
|
|
|
first flow or not |
|
225
|
|
|
:return: If many, the list of matched flows, or the matched flow |
|
226
|
|
|
""" |
|
227
|
1 |
|
if switch.dpid not in stored_flows: |
|
228
|
|
|
return None |
|
229
|
1 |
|
response = [] |
|
230
|
1 |
|
if switch.dpid not in stored_flows: |
|
231
|
|
|
return None |
|
232
|
1 |
|
try: |
|
233
|
1 |
|
for flow in stored_flows[switch.dpid]: |
|
234
|
1 |
|
match = Main.do_match(flow, args) |
|
235
|
1 |
|
if match: |
|
236
|
1 |
|
if many: |
|
237
|
|
|
response.append(match) |
|
238
|
|
|
else: |
|
239
|
1 |
|
response = match |
|
240
|
1 |
|
break |
|
241
|
|
|
except AttributeError: |
|
242
|
|
|
return None |
|
243
|
1 |
|
if not many and isinstance(response, list): |
|
244
|
1 |
|
return None |
|
245
|
1 |
|
return response |
|
246
|
|
|
|
|
247
|
|
|
# pylint: disable=redefined-outer-name |
|
248
|
1 |
|
def match_and_apply(self, switch, args, stored_flows): |
|
249
|
|
|
# pylint: disable=bad-staticmethod-argument |
|
250
|
|
|
"""Match flows and apply actions. |
|
251
|
|
|
Match given packet (in args) against |
|
252
|
|
|
the stored flows (from flow_manager) and, |
|
253
|
|
|
if a match flow is found, apply its actions.""" |
|
254
|
1 |
|
flow = self.match_flows(switch, args, stored_flows, False) |
|
255
|
1 |
|
port = None |
|
256
|
1 |
|
actions = [] |
|
257
|
|
|
# pylint: disable=too-many-nested-blocks |
|
258
|
1 |
|
if not flow or switch.ofp_version != '0x04': |
|
259
|
1 |
|
return flow, args, port |
|
260
|
1 |
|
if 'actions' in flow['flow']: |
|
261
|
1 |
|
actions = flow['flow']['actions'] |
|
262
|
1 |
|
for action in actions: |
|
263
|
1 |
|
action_type = action['action_type'] |
|
264
|
1 |
|
if action_type == 'output': |
|
265
|
1 |
|
port = action['port'] |
|
266
|
1 |
|
if action_type == 'push_vlan': |
|
267
|
1 |
|
if 'dl_vlan' not in args: |
|
268
|
|
|
args['dl_vlan'] = [] |
|
269
|
1 |
|
args['dl_vlan'].append(0) |
|
270
|
1 |
|
if action_type == 'pop_vlan': |
|
271
|
1 |
|
if 'dl_vlan' in args: |
|
272
|
1 |
|
args['dl_vlan'].pop() |
|
273
|
1 |
|
if len(args['dl_vlan']) == 0: |
|
274
|
1 |
|
del args['dl_vlan'] |
|
275
|
1 |
|
if action_type == 'set_vlan': |
|
276
|
1 |
|
args['dl_vlan'][-1] = action['vlan_id'] |
|
277
|
|
|
return flow, args, port |
|
278
|
|
|
|
kytos-ng /
sdntrace_cp
