2 # -*- coding: utf-8 -*-
5 # Copyright 2016, I2T Research Group (UPV/EHU)
6 # This file is part of openvim
9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
10 # not use this file except in compliance with the License. You may obtain
11 # a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
18 # License for the specific language governing permissions and limitations
21 # For those usages not covered by the Apache License, Version 2.0 please
22 # contact with: alaitz.mendiola@ehu.eus or alaitz.mendiola@gmail.com
26 ImplementS the pluging for the Open Network Operating System (ONOS) openflow
27 controller. It creates the class OF_conn to create dataplane connections
28 with static rules based on packet destination MAC address
31 __author__
="Alaitz Mendiola"
32 __date__
="$22-nov-2016$"
39 from osm_ro
.wim
.openflow_conn
import OpenflowConn
, OpenflowConnException
, OpenflowConnConnectionException
, \
40 OpenflowConnUnexpectedResponse
, OpenflowConnAuthException
, OpenflowConnNotFoundException
, \
41 OpenflowConnConflictException
, OpenflowConnNotSupportedException
, OpenflowConnNotImplemented
44 class OfConnOnos(OpenflowConn
):
46 ONOS connector. No MAC learning is used
48 def __init__(self
, params
):
50 :param params: dictionary with the following keys:
51 of_dpid: DPID to use for this controller ?? Does a controller have a dpid?
52 url: must be [http://HOST:PORT/]
53 of_user: user credentials, can be missing or None
54 of_password: password credentials
55 of_debug: debug level for logging. Default to ERROR
56 other keys are ignored
57 Raise an exception if same parameter is missing or wrong
60 OpenflowConn
.__init
__(self
, params
)
63 url
= params
.get("of_url")
65 raise ValueError("'url' must be provided")
66 if not url
.startswith("http"):
68 if not url
.endswith("/"):
70 self
.url
= url
+ "onos/v1/"
74 self
.headers
= {'content-type':'application/json','accept':'application/json',}
77 self
.pp2ofi
={} # From Physical Port to OpenFlow Index
78 self
.ofi2pp
={} # From OpenFlow Index to Physical Port
80 self
.dpid
= str(params
["of_dpid"])
81 self
.id = 'of:'+str(self
.dpid
.replace(':', ''))
83 # TODO This may not be straightforward
84 if params
.get("of_user"):
85 of_password
=params
.get("of_password", "")
86 self
.auth
= base64
.b64encode(bytes(params
["of_user"] + ":" + of_password
, "utf-8"))
87 self
.auth
= self
.auth
.decode()
88 self
.headers
['authorization'] = 'Basic ' + self
.auth
90 self
.logger
= logging
.getLogger('SDN.onosOF')
91 self
.logger
.setLevel( getattr(logging
, params
.get("of_debug", "ERROR")) )
92 self
.ip_address
= None
94 def get_of_switches(self
):
96 Obtain a a list of switches or DPID detected by this controller
97 :return: list where each element a tuple pair (DPID, IP address)
98 Raise a openflowconnUnexpectedResponse expection in case of failure
101 self
.headers
['content-type'] = 'text/plain'
102 of_response
= requests
.get(self
.url
+ "devices", headers
=self
.headers
)
103 error_text
= "Openflow response %d: %s" % (of_response
.status_code
, of_response
.text
)
104 if of_response
.status_code
!= 200:
105 self
.logger
.warning("get_of_switches " + error_text
)
106 raise OpenflowConnUnexpectedResponse(error_text
)
108 self
.logger
.debug("get_of_switches " + error_text
)
109 info
= of_response
.json()
111 if type(info
) != dict:
112 self
.logger
.error("get_of_switches. Unexpected response, not a dict: %s", str(info
))
113 raise OpenflowConnUnexpectedResponse("Unexpected response, not a dict. Wrong version?")
115 node_list
= info
.get('devices')
117 if type(node_list
) is not list:
119 "get_of_switches. Unexpected response, at 'devices', not found or not a list: %s",
120 str(type(node_list
)))
121 raise OpenflowConnUnexpectedResponse("Unexpected response, at 'devices', not found "
122 "or not a list. Wrong version?")
125 for node
in node_list
:
126 node_id
= node
.get('id')
128 self
.logger
.error("get_of_switches. Unexpected response at 'device':'id', not found: %s",
130 raise OpenflowConnUnexpectedResponse("Unexpected response at 'device':'id', "
131 "not found . Wrong version?")
133 node_ip_address
= node
.get('annotations').get('managementAddress')
134 if node_ip_address
is None:
136 "get_of_switches. Unexpected response at 'device':'managementAddress', not found: %s",
138 raise OpenflowConnUnexpectedResponse(
139 "Unexpected response at 'device':'managementAddress', not found. Wrong version?")
141 node_id_hex
= hex(int(node_id
.split(':')[1])).split('x')[1].zfill(16)
144 (':'.join(a
+ b
for a
, b
in zip(node_id_hex
[::2], node_id_hex
[1::2])), node_ip_address
))
147 except requests
.exceptions
.RequestException
as e
:
148 error_text
= type(e
).__name
__ + ": " + str(e
)
149 self
.logger
.error("get_of_switches " + error_text
)
150 raise OpenflowConnConnectionException(error_text
)
151 except ValueError as e
:
152 # ValueError in the case that JSON can not be decoded
153 error_text
= type(e
).__name
__ + ": " + str(e
)
154 self
.logger
.error("get_of_switches " + error_text
)
155 raise OpenflowConnUnexpectedResponse(error_text
)
157 def obtain_port_correspondence(self
):
159 Obtain the correspondence between physical and openflow port names
160 :return: dictionary with physical name as key, openflow name as value
161 Raise a openflowconnUnexpectedResponse expection in case of failure
164 self
.headers
['content-type'] = 'text/plain'
165 of_response
= requests
.get(self
.url
+ "devices/" + self
.id + "/ports", headers
=self
.headers
)
166 error_text
= "Openflow response %d: %s" % (of_response
.status_code
, of_response
.text
)
167 if of_response
.status_code
!= 200:
168 self
.logger
.warning("obtain_port_correspondence " + error_text
)
169 raise OpenflowConnUnexpectedResponse(error_text
)
171 self
.logger
.debug("obtain_port_correspondence " + error_text
)
172 info
= of_response
.json()
174 node_connector_list
= info
.get('ports')
175 if type(node_connector_list
) is not list:
177 "obtain_port_correspondence. Unexpected response at 'ports', not found or not a list: %s",
178 str(node_connector_list
))
179 raise OpenflowConnUnexpectedResponse("Unexpected response at 'ports', not found or not "
180 "a list. Wrong version?")
182 for node_connector
in node_connector_list
:
183 if node_connector
['port'] != "local":
184 self
.pp2ofi
[str(node_connector
['annotations']['portName'])] = str(node_connector
['port'])
185 self
.ofi2pp
[str(node_connector
['port'])] = str(node_connector
['annotations']['portName'])
187 node_ip_address
= info
['annotations']['managementAddress']
188 if node_ip_address
is None:
190 "obtain_port_correspondence. Unexpected response at 'managementAddress', not found: %s",
192 raise OpenflowConnUnexpectedResponse("Unexpected response at 'managementAddress', "
193 "not found. Wrong version?")
194 self
.ip_address
= node_ip_address
196 # print self.name, ": obtain_port_correspondence ports:", self.pp2ofi
198 except requests
.exceptions
.RequestException
as e
:
199 error_text
= type(e
).__name
__ + ": " + str(e
)
200 self
.logger
.error("obtain_port_correspondence " + error_text
)
201 raise OpenflowConnConnectionException(error_text
)
202 except ValueError as e
:
203 # ValueError in the case that JSON can not be decoded
204 error_text
= type(e
).__name
__ + ": " + str(e
)
205 self
.logger
.error("obtain_port_correspondence " + error_text
)
206 raise OpenflowConnUnexpectedResponse(error_text
)
208 def get_of_rules(self
, translate_of_ports
=True):
210 Obtain the rules inserted at openflow controller
211 :param translate_of_ports: if True it translates ports from openflow index to physical switch name
212 :return: list where each item is a dictionary with the following content:
213 priority: rule priority
214 name: rule name (present also as the master dict key)
215 ingress_port: match input port of the rule
216 dst_mac: match destination mac address of the rule, can be missing or None if not apply
217 vlan_id: match vlan tag of the rule, can be missing or None if not apply
218 actions: list of actions, composed by a pair tuples:
219 (vlan, None/int): for stripping/setting a vlan tag
220 (out, port): send to this port
222 Raise a openflowconnUnexpectedResponse expection in case of failure
227 if len(self
.ofi2pp
) == 0:
228 self
.obtain_port_correspondence()
231 self
.headers
['content-type'] = 'text/plain'
232 of_response
= requests
.get(self
.url
+ "flows/" + self
.id, headers
=self
.headers
)
233 error_text
= "Openflow response %d: %s" % (of_response
.status_code
, of_response
.text
)
235 # The configured page does not exist if there are no rules installed. In that case we return an empty dict
236 if of_response
.status_code
== 404:
239 elif of_response
.status_code
!= 200:
240 self
.logger
.warning("get_of_rules " + error_text
)
241 raise OpenflowConnUnexpectedResponse(error_text
)
242 self
.logger
.debug("get_of_rules " + error_text
)
244 info
= of_response
.json()
246 if type(info
) != dict:
247 self
.logger
.error("get_of_rules. Unexpected response, not a dict: %s", str(info
))
248 raise OpenflowConnUnexpectedResponse("Unexpected openflow response, not a dict. "
251 flow_list
= info
.get('flows')
253 if flow_list
is None:
256 if type(flow_list
) is not list:
258 "get_of_rules. Unexpected response at 'flows', not a list: %s",
259 str(type(flow_list
)))
260 raise OpenflowConnUnexpectedResponse("Unexpected response at 'flows', not a list. "
263 rules
= [] # Response list
264 for flow
in flow_list
:
265 if not ('id' in flow
and 'selector' in flow
and 'treatment' in flow
and \
266 'instructions' in flow
['treatment'] and 'criteria' in \
268 raise OpenflowConnUnexpectedResponse("unexpected openflow response, one or more "
269 "elements are missing. Wrong version?")
272 rule
['switch'] = self
.dpid
273 rule
['priority'] = flow
.get('priority')
274 rule
['name'] = flow
['id']
276 for criteria
in flow
['selector']['criteria']:
277 if criteria
['type'] == 'IN_PORT':
278 in_port
= str(criteria
['port'])
279 if in_port
!= "CONTROLLER":
280 if not in_port
in self
.ofi2pp
:
281 raise OpenflowConnUnexpectedResponse("Error: Ingress port {} is not "
282 "in switch port list".format(in_port
))
283 if translate_of_ports
:
284 in_port
= self
.ofi2pp
[in_port
]
285 rule
['ingress_port'] = in_port
287 elif criteria
['type'] == 'VLAN_VID':
288 rule
['vlan_id'] = criteria
['vlanId']
290 elif criteria
['type'] == 'ETH_DST':
291 rule
['dst_mac'] = str(criteria
['mac']).lower()
294 for instruction
in flow
['treatment']['instructions']:
295 if instruction
['type'] == "OUTPUT":
296 out_port
= str(instruction
['port'])
297 if out_port
!= "CONTROLLER":
298 if not out_port
in self
.ofi2pp
:
299 raise OpenflowConnUnexpectedResponse("Error: Output port {} is not in "
300 "switch port list".format(out_port
))
302 if translate_of_ports
:
303 out_port
= self
.ofi2pp
[out_port
]
305 actions
.append( ('out', out_port
) )
307 if instruction
['type'] == "L2MODIFICATION" and instruction
['subtype'] == "VLAN_POP":
308 actions
.append( ('vlan', 'None') )
309 if instruction
['type'] == "L2MODIFICATION" and instruction
['subtype'] == "VLAN_ID":
310 actions
.append( ('vlan', instruction
['vlanId']) )
312 rule
['actions'] = actions
316 except requests
.exceptions
.RequestException
as e
:
317 # ValueError in the case that JSON can not be decoded
318 error_text
= type(e
).__name
__ + ": " + str(e
)
319 self
.logger
.error("get_of_rules " + error_text
)
320 raise OpenflowConnConnectionException(error_text
)
321 except ValueError as e
:
322 # ValueError in the case that JSON can not be decoded
323 error_text
= type(e
).__name
__ + ": " + str(e
)
324 self
.logger
.error("get_of_rules " + error_text
)
325 raise OpenflowConnUnexpectedResponse(error_text
)
327 def del_flow(self
, flow_name
):
329 Delete an existing rule
331 :return: Raise a openflowconnUnexpectedResponse expection in case of failure
335 self
.headers
['content-type'] = None
336 of_response
= requests
.delete(self
.url
+ "flows/" + self
.id + "/" + flow_name
, headers
=self
.headers
)
337 error_text
= "Openflow response %d: %s" % (of_response
.status_code
, of_response
.text
)
339 if of_response
.status_code
!= 204:
340 self
.logger
.warning("del_flow " + error_text
)
341 raise OpenflowConnUnexpectedResponse(error_text
)
343 self
.logger
.debug("del_flow OK " + error_text
)
346 except requests
.exceptions
.RequestException
as e
:
347 error_text
= type(e
).__name
__ + ": " + str(e
)
348 self
.logger
.error("del_flow " + error_text
)
349 raise OpenflowConnConnectionException(error_text
)
351 def new_flow(self
, data
):
353 Insert a new static rule
354 :param data: dictionary with the following content:
355 priority: rule priority
357 ingress_port: match input port of the rule
358 dst_mac: match destination mac address of the rule, missing or None if not apply
359 vlan_id: match vlan tag of the rule, missing or None if not apply
360 actions: list of actions, composed by a pair tuples with these posibilities:
361 ('vlan', None/int): for stripping/setting a vlan tag
362 ('out', port): send to this port
363 :return: Raise a openflowconnUnexpectedResponse expection in case of failure
367 if len(self
.pp2ofi
) == 0:
368 self
.obtain_port_correspondence()
370 # Build the dictionary with the flow rule information for ONOS
372 #flow['id'] = data['name']
374 flow
['priority'] = data
.get('priority')
376 flow
['isPermanent'] = "true"
377 flow
['appId'] = 10 # FIXME We should create an appId for OSM
378 flow
['selector'] = dict()
379 flow
['selector']['criteria'] = list()
381 # Flow rule matching criteria
382 if not data
['ingress_port'] in self
.pp2ofi
:
383 error_text
= 'Error. Port ' + data
['ingress_port'] + ' is not present in the switch'
384 self
.logger
.warning("new_flow " + error_text
)
385 raise OpenflowConnUnexpectedResponse(error_text
)
387 ingress_port_criteria
= dict()
388 ingress_port_criteria
['type'] = "IN_PORT"
389 ingress_port_criteria
['port'] = self
.pp2ofi
[data
['ingress_port']]
390 flow
['selector']['criteria'].append(ingress_port_criteria
)
392 if 'dst_mac' in data
:
393 dst_mac_criteria
= dict()
394 dst_mac_criteria
["type"] = "ETH_DST"
395 dst_mac_criteria
["mac"] = data
['dst_mac']
396 flow
['selector']['criteria'].append(dst_mac_criteria
)
398 if data
.get('vlan_id'):
399 vlan_criteria
= dict()
400 vlan_criteria
["type"] = "VLAN_VID"
401 vlan_criteria
["vlanId"] = int(data
['vlan_id'])
402 flow
['selector']['criteria'].append(vlan_criteria
)
404 # Flow rule treatment
405 flow
['treatment'] = dict()
406 flow
['treatment']['instructions'] = list()
407 flow
['treatment']['deferred'] = list()
409 for action
in data
['actions']:
411 if action
[0] == "vlan":
412 new_action
['type'] = "L2MODIFICATION"
413 if action
[1] == None:
414 new_action
['subtype'] = "VLAN_POP"
416 new_action
['subtype'] = "VLAN_ID"
417 new_action
['vlanId'] = int(action
[1])
418 elif action
[0] == 'out':
419 new_action
['type'] = "OUTPUT"
420 if not action
[1] in self
.pp2ofi
:
421 error_msj
= 'Port '+ action
[1] + ' is not present in the switch'
422 raise OpenflowConnUnexpectedResponse(error_msj
)
423 new_action
['port'] = self
.pp2ofi
[action
[1]]
425 error_msj
= "Unknown item '%s' in action list" % action
[0]
426 self
.logger
.error("new_flow " + error_msj
)
427 raise OpenflowConnUnexpectedResponse(error_msj
)
429 flow
['treatment']['instructions'].append(new_action
)
431 self
.headers
['content-type'] = 'application/json'
432 path
= self
.url
+ "flows/" + self
.id
433 of_response
= requests
.post(path
, headers
=self
.headers
, data
=json
.dumps(flow
) )
435 error_text
= "Openflow response %d: %s" % (of_response
.status_code
, of_response
.text
)
436 if of_response
.status_code
!= 201:
437 self
.logger
.warning("new_flow " + error_text
)
438 raise OpenflowConnUnexpectedResponse(error_text
)
440 flowId
= of_response
.headers
['location'][path
.__len
__() + 1:]
442 data
['name'] = flowId
444 self
.logger
.debug("new_flow OK " + error_text
)
447 except requests
.exceptions
.RequestException
as e
:
448 error_text
= type(e
).__name
__ + ": " + str(e
)
449 self
.logger
.error("new_flow " + error_text
)
450 raise OpenflowConnConnectionException(error_text
)
452 def clear_all_flows(self
):
454 Delete all existing rules
455 :return: Raise a openflowconnUnexpectedResponse expection in case of failure
458 rules
= self
.get_of_rules(True)
463 self
.logger
.debug("clear_all_flows OK ")
466 except requests
.exceptions
.RequestException
as e
:
467 error_text
= type(e
).__name
__ + ": " + str(e
)
468 self
.logger
.error("clear_all_flows " + error_text
)
469 raise OpenflowConnConnectionException(error_text
)