1 from types import StringTypes
2 from collections import defaultdict
4 from sfa.util.xrn import get_leaf, get_authority, urn_to_hrn
5 from sfa.util.plxrn import hrn_to_pl_slicename
6 from sfa.util.policy import Policy
7 from sfa.rspecs.rspec import RSpec
8 from sfa.plc.vlink import VLink
9 from sfa.util.xrn import Xrn
15 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
17 def __init__(self, api, ttl = .5, origin_hrn=None):
19 #filepath = path + os.sep + filename
20 # self.policy = Policy(self.api)
21 self.origin_hrn = origin_hrn
22 self.registry = api.registries[api.hrn]
23 self.credential = api.getCredential()
27 def get_slivers(self, xrn, node=None):
28 hrn, type = urn_to_hrn(xrn)
30 slice_name = hrn_to_pl_slicename(hrn)
31 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
32 # of doing all of this?
33 #return self.api.driver.GetSliceTicket(self.auth, slice_name)
35 # from PLCAPI.GetSlivers.get_slivers()
36 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
37 slices = self.api.driver.GetSlices(slice_name, slice_fields)
38 # Build up list of users and slice attributes
40 all_slice_tag_ids = set()
42 person_ids.update(slice['person_ids'])
43 all_slice_tag_ids.update(slice['slice_tag_ids'])
44 person_ids = list(person_ids)
45 all_slice_tag_ids = list(all_slice_tag_ids)
46 # Get user information
47 all_persons_list = self.api.driver.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
49 for person in all_persons_list:
50 all_persons[person['person_id']] = person
52 # Build up list of keys
54 for person in all_persons.values():
55 key_ids.update(person['key_ids'])
56 key_ids = list(key_ids)
57 # Get user account keys
58 all_keys_list = self.api.driver.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
60 for key in all_keys_list:
61 all_keys[key['key_id']] = key
62 # Get slice attributes
63 all_slice_tags_list = self.api.driver.GetSliceTags(all_slice_tag_ids)
65 for slice_tag in all_slice_tags_list:
66 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
71 for person_id in slice['person_ids']:
72 if person_id in all_persons:
73 person = all_persons[person_id]
74 if not person['enabled']:
76 for key_id in person['key_ids']:
77 if key_id in all_keys:
78 key = all_keys[key_id]
79 keys += [{'key_type': key['key_type'],
82 # All (per-node and global) attributes for this slice
84 for slice_tag_id in slice['slice_tag_ids']:
85 if slice_tag_id in all_slice_tags:
86 slice_tags.append(all_slice_tags[slice_tag_id])
87 # Per-node sliver attributes take precedence over global
88 # slice attributes, so set them first.
89 # Then comes nodegroup slice attributes
90 # Followed by global slice attributes
91 sliver_attributes = []
94 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
95 sliver_attributes.append(sliver_attribute['tagname'])
96 attributes.append({'tagname': sliver_attribute['tagname'],
97 'value': sliver_attribute['value']})
99 # set nodegroup slice attributes
100 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
101 # Do not set any nodegroup slice attributes for
102 # which there is at least one sliver attribute
104 if slice_tag not in slice_tags:
105 attributes.append({'tagname': slice_tag['tagname'],
106 'value': slice_tag['value']})
108 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
109 # Do not set any global slice attributes for
110 # which there is at least one sliver attribute
112 if slice_tag['tagname'] not in sliver_attributes:
113 attributes.append({'tagname': slice_tag['tagname'],
114 'value': slice_tag['value']})
116 # XXX Sanity check; though technically this should be a system invariant
117 # checked with an assertion
118 if slice['expires'] > MAXINT: slice['expires']= MAXINT
122 'name': slice['name'],
123 'slice_id': slice['slice_id'],
124 'instantiation': slice['instantiation'],
125 'expires': slice['expires'],
127 'attributes': attributes
132 def get_peer(self, xrn):
133 hrn, type = urn_to_hrn(xrn)
134 # Becaues of myplc federation, we first need to determine if this
135 # slice belongs to out local plc or a myplc peer. We will assume it
136 # is a local site, unless we find out otherwise
139 # get this slice's authority (site)
140 slice_authority = get_authority(hrn)
142 # get this site's authority (sfa root authority or sub authority)
143 site_authority = get_authority(slice_authority).lower()
145 # check if we are already peered with this site_authority, if so
146 peers = self.api.driver.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
147 for peer_record in peers:
148 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
149 if site_authority in names:
154 def get_sfa_peer(self, xrn):
155 hrn, type = urn_to_hrn(xrn)
157 # return the authority for this hrn or None if we are the authority
159 slice_authority = get_authority(hrn)
160 site_authority = get_authority(slice_authority)
162 if site_authority != self.api.hrn:
163 sfa_peer = site_authority
167 def verify_slice_nodes(self, slice, requested_slivers, peer):
169 nodes = self.api.driver.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
170 current_slivers = [node['hostname'] for node in nodes]
172 # remove nodes not in rspec
173 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
175 # add nodes from rspec
176 added_nodes = list(set(requested_slivers).difference(current_slivers))
180 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
181 self.api.driver.AddSliceToNodes(slice['name'], added_nodes)
182 self.api.driver.DeleteSliceFromNodes(slice['name'], deleted_nodes)
185 self.api.logger.log_exc('Failed to add/remove slice from nodes')
188 def free_egre_key(self):
190 for tag in self.api.driver.GetSliceTags({'tagname': 'egre_key'}):
191 used.add(int(tag['value']))
193 for i in range(1, 256):
198 raise KeyError("No more EGRE keys available")
202 def verify_slice_links(self, slice, requested_links, nodes):
203 # nodes is undefined here
204 if not requested_links:
207 # build dict of nodes
211 nodes_dict[node['node_id']] = node
212 interface_ids.extend(node['interface_ids'])
213 # build dict of interfaces
214 interfaces = self.api.driver.GetInterfaces(interface_ids)
216 for interface in interfaces:
217 interfaces_dict[interface['interface_id']] = interface
222 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
225 slice_tags.append({'name': 'netns', 'value': '1'})
228 # need to update the attribute string?
229 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
231 for link in requested_links:
232 # get the ip address of the first node in the link
233 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
234 (node_raw, device) = ifname1.split(':')
235 node_id = int(node_raw.replace('node', ''))
236 node = nodes_dict[node_id]
237 if1 = interfaces_dict[node['interface_ids'][0]]
239 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
241 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
243 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
244 #self.api.driver.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
246 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
250 def handle_peer(self, site, slice, persons, peer):
255 self.api.driver.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
257 self.api.driver.DeleteSite(site['site_id'])
263 self.api.driver.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
265 self.api.driver.DeleteSlice(slice['slice_id'])
269 for person in persons:
271 self.api.driver.BindObjectToPeer('person',
272 person['person_id'], peer['shortname'], person['peer_person_id'])
274 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
276 self.api.driver.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
278 self.api.driver.DeleteKey(key['key_id'])
279 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
281 self.api.driver.DeletePerson(person['person_id'])
286 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
287 (slice_hrn, type) = urn_to_hrn(slice_xrn)
288 site_hrn = get_authority(slice_hrn)
289 # login base can't be longer than 20 characters
290 slicename = hrn_to_pl_slicename(slice_hrn)
291 authority_name = slicename.split('_')[0]
292 login_base = authority_name[:20]
293 sites = self.api.driver.GetSites(login_base)
295 # create new site record
296 site = {'name': 'geni.%s' % authority_name,
297 'abbreviated_name': authority_name,
298 'login_base': login_base,
302 'peer_site_id': None}
304 site['peer_site_id'] = slice_record.get('site_id', None)
305 site['site_id'] = self.api.driver.AddSite(site)
306 # exempt federated sites from monitor policies
307 self.api.driver.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
309 # # is this still necessary?
310 # # add record to the local registry
311 # if sfa_peer and slice_record:
312 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
313 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
314 # self.registry.register_peer_object(self.credential, peer_dict)
318 # unbind from peer so we can modify if necessary. Will bind back later
319 self.api.driver.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
323 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
324 slicename = hrn_to_pl_slicename(slice_hrn)
325 parts = slicename.split("_")
326 login_base = parts[0]
327 slices = self.api.driver.GetSlices([slicename])
329 slice = {'name': slicename,
330 'url': slice_record.get('url', slice_hrn),
331 'description': slice_record.get('description', slice_hrn)}
333 slice['slice_id'] = self.api.driver.AddSlice(slice)
334 slice['node_ids'] = []
335 slice['person_ids'] = []
337 slice['peer_slice_id'] = slice_record.get('slice_id', None)
338 # mark this slice as an sfa peer record
340 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
341 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
342 # self.registry.register_peer_object(self.credential, peer_dict)
346 slice['peer_slice_id'] = slice_record.get('slice_id', None)
347 # unbind from peer so we can modify if necessary. Will bind back later
348 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
349 #Update existing record (e.g. expires field) it with the latest info.
350 if slice_record and slice['expires'] != slice_record['expires']:
351 self.api.driver.UpdateSlice( slice['slice_id'], {'expires' : slice_record['expires']})
355 #def get_existing_persons(self, users):
356 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
358 users_by_site = defaultdict(list)
361 hrn, type = urn_to_hrn(user['urn'])
362 username = get_leaf(hrn)
363 login_base = get_leaf(get_authority(user['urn']))
364 user['username'] = username
365 user['site'] = login_base
368 users_by_email[user['email']] = user
369 users_dict[user['email']] = user
371 users_by_site[user['site']].append(user)
373 # start building a list of existing users
374 existing_user_ids = []
375 existing_user_ids_filter = []
377 existing_user_ids_filter.extend(users_by_email.keys())
379 for login_base in users_by_site:
380 users = users_by_site[login_base]
382 existing_user_ids_filter.append(user['username']+'@geni.net')
383 if existing_user_ids_filter:
384 # get existing users by email
385 existing_users = self.api.driver.GetPersons({'email': existing_user_ids_filter},
386 ['person_id', 'key_ids', 'email'])
387 existing_user_ids.extend([user['email'] for user in existing_users])
390 # get a list of user sites (based on requeste user urns
391 site_list = self.api.driver.GetSites(users_by_site.keys(), \
392 ['site_id', 'login_base', 'person_ids'])
393 # get all existing users at these sites
396 for site in site_list:
397 sites[site['site_id']] = site
398 site_user_ids.extend(site['person_ids'])
400 existing_site_persons_list = self.api.driver.GetPersons(site_user_ids,
401 ['person_id', 'key_ids', 'email', 'site_ids'])
403 # all requested users are either existing users or new (added) users
404 for login_base in users_by_site:
405 requested_site_users = users_by_site[login_base]
406 for requested_user in requested_site_users:
408 for existing_user in existing_site_persons_list:
409 for site_id in existing_user['site_ids']:
411 site = sites[site_id]
412 if login_base == site['login_base'] and \
413 existing_user['email'].startswith(requested_user['username']+'@'):
414 existing_user_ids.append(existing_user['email'])
415 users_dict[existing_user['email']] = requested_user
421 if user_found == False:
422 fake_email = requested_user['username'] + '@geni.net'
423 users_dict[fake_email] = requested_user
425 # requested slice users
426 requested_user_ids = users_dict.keys()
427 # existing slice users
428 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
429 existing_slice_users = self.api.driver.GetPersons(existing_slice_users_filter,
430 ['person_id', 'key_ids', 'email'])
431 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
433 # users to be added, removed or updated
434 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
435 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
436 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
437 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
439 # Remove stale users (only if we are not appending).
441 append = options.get('append', True)
443 for removed_user_id in removed_user_ids:
444 self.api.driver.DeletePersonFromSlice(removed_user_id, slice_record['name'])
445 # update_existing users
446 updated_users_list = [user for user in existing_slice_users if user['email'] in \
448 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
452 for added_user_id in added_user_ids:
453 added_user = users_dict[added_user_id]
454 hrn, type = urn_to_hrn(added_user['urn'])
456 'first_name': added_user.get('first_name', hrn),
457 'last_name': added_user.get('last_name', hrn),
458 'email': added_user_id,
459 'peer_person_id': None,
461 'key_ids': added_user.get('key_ids', []),
463 person['person_id'] = self.api.driver.AddPerson(person)
465 person['peer_person_id'] = added_user['person_id']
466 added_persons.append(person)
469 self.api.driver.UpdatePerson(person['person_id'], {'enabled': True})
472 self.api.driver.AddPersonToSite(added_user_id, added_user['site'])
474 for key_string in added_user.get('keys', []):
475 key = {'key':key_string, 'key_type':'ssh'}
476 key['key_id'] = self.api.driver.AddPersonKey(person['person_id'], key)
477 person['keys'].append(key)
479 # add the registry record
481 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
482 # 'pointer': person['person_id']}
483 # self.registry.register_peer_object(self.credential, peer_dict)
485 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
486 # add person to the slice
487 self.api.driver.AddPersonToSlice(added_slice_user_id, slice_record['name'])
488 # if this is a peer record then it should already be bound to a peer.
489 # no need to return worry about it getting bound later
494 def verify_keys(self, persons, users, peer, options={}):
497 for person in persons:
498 key_ids.extend(person['key_ids'])
499 keylist = self.api.driver.GetKeys(key_ids, ['key_id', 'key'])
502 keydict[key['key']] = key['key_id']
503 existing_keys = keydict.keys()
505 for person in persons:
506 persondict[person['email']] = person
512 user_keys = user.get('keys', [])
513 updated_persons.append(user)
514 for key_string in user_keys:
515 requested_keys.append(key_string)
516 if key_string not in existing_keys:
517 key = {'key': key_string, 'key_type': 'ssh'}
520 person = persondict[user['email']]
521 self.api.driver.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
522 key['key_id'] = self.api.driver.AddPersonKey(user['email'], key)
524 key_index = user_keys.index(key['key'])
525 remote_key_id = user['key_ids'][key_index]
526 self.api.driver.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
530 self.api.driver.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
532 # remove old keys (only if we are not appending)
533 append = options.get('append', True)
535 removed_keys = set(existing_keys).difference(requested_keys)
536 for existing_key_id in keydict:
537 if keydict[existing_key_id] in removed_keys:
540 self.api.driver.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
541 self.api.driver.DeleteKey(existing_key_id)
545 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
546 append = options.get('append', True)
547 # get list of attributes users ar able to manage
548 filter = {'category': '*slice*'}
550 filter['|roles'] = ['user']
551 slice_attributes = self.api.driver.GetTagTypes(filter)
552 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
554 # get sliver attributes
555 added_slice_attributes = []
556 removed_slice_attributes = []
557 ignored_slice_attribute_names = []
558 existing_slice_attributes = self.api.driver.GetSliceTags({'slice_id': slice['slice_id']})
560 # get attributes that should be removed
561 for slice_tag in existing_slice_attributes:
562 if slice_tag['tagname'] in ignored_slice_attribute_names:
563 # If a slice already has a admin only role it was probably given to them by an
564 # admin, so we should ignore it.
565 ignored_slice_attribute_names.append(slice_tag['tagname'])
567 # If an existing slice attribute was not found in the request it should
569 attribute_found=False
570 for requested_attribute in requested_slice_attributes:
571 if requested_attribute['name'] == slice_tag['tagname'] and \
572 requested_attribute['value'] == slice_tag['value']:
576 if not attribute_found and not append:
577 removed_slice_attributes.append(slice_tag)
579 # get attributes that should be added:
580 for requested_attribute in requested_slice_attributes:
581 # if the requested attribute wasn't found we should add it
582 if requested_attribute['name'] in valid_slice_attribute_names:
583 attribute_found = False
584 for existing_attribute in existing_slice_attributes:
585 if requested_attribute['name'] == existing_attribute['tagname'] and \
586 requested_attribute['value'] == existing_attribute['value']:
589 if not attribute_found:
590 added_slice_attributes.append(requested_attribute)
593 # remove stale attributes
594 for attribute in removed_slice_attributes:
596 self.api.driver.DeleteSliceTag(attribute['slice_tag_id'])
598 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
599 % (name, value, node_id, str(e)))
601 # add requested_attributes
602 for attribute in added_slice_attributes:
604 self.api.driver.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
606 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
607 % (name, value, node_id, str(e)))
609 def create_slice_aggregate(self, xrn, rspec):
610 hrn, type = urn_to_hrn(xrn)
611 # Determine if this is a peer slice
612 peer = self.get_peer(hrn)
613 sfa_peer = self.get_sfa_peer(hrn)
616 # Get the slice record from sfa
617 slicename = hrn_to_pl_slicename(hrn)
620 registry = self.api.registries[self.api.hrn]
621 credential = self.api.getCredential()
623 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
624 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
626 # find out where this slice is currently running
627 nodelist = self.api.driver.GetNodes(slice['node_ids'], ['hostname'])
628 hostnames = [node['hostname'] for node in nodelist]
630 # get netspec details
631 nodespecs = spec.getDictsByTagName('NodeSpec')
633 # dict in which to store slice attributes to set for the nodes
635 for nodespec in nodespecs:
636 if isinstance(nodespec['name'], list):
637 for nodename in nodespec['name']:
639 for k in nodespec.keys():
640 rspec_attribute_value = nodespec[k]
641 if (self.rspec_to_slice_tag.has_key(k)):
642 slice_tag_name = self.rspec_to_slice_tag[k]
643 nodes[nodename][slice_tag_name] = rspec_attribute_value
644 elif isinstance(nodespec['name'], StringTypes):
645 nodename = nodespec['name']
647 for k in nodespec.keys():
648 rspec_attribute_value = nodespec[k]
649 if (self.rspec_to_slice_tag.has_key(k)):
650 slice_tag_name = self.rspec_to_slice_tag[k]
651 nodes[nodename][slice_tag_name] = rspec_attribute_value
653 for k in nodespec.keys():
654 rspec_attribute_value = nodespec[k]
655 if (self.rspec_to_slice_tag.has_key(k)):
656 slice_tag_name = self.rspec_to_slice_tag[k]
657 nodes[nodename][slice_tag_name] = rspec_attribute_value
659 node_names = nodes.keys()
660 # remove nodes not in rspec
661 deleted_nodes = list(set(hostnames).difference(node_names))
662 # add nodes from rspec
663 added_nodes = list(set(node_names).difference(hostnames))
667 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer)
669 self.api.driver.AddSliceToNodes(slicename, added_nodes)
671 # Add recognized slice tags
672 for node_name in node_names:
673 node = nodes[node_name]
674 for slice_tag in node.keys():
675 value = node[slice_tag]
676 if (isinstance(value, list)):
679 self.api.driver.AddSliceTag(slicename, slice_tag, value, node_name)
681 self.api.driver.DeleteSliceFromNodes(slicename, deleted_nodes)
684 self.api.driver.BindObjectToPeer('slice', slice['slice_id'], peer, slice['peer_slice_id'])