1 from types import StringTypes
2 from collections import defaultdict
4 from sfa.util.sfatime import utcparse, datetime_to_epoch
5 from sfa.util.sfalogging import logger
6 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
8 from sfa.rspecs.rspec import RSpec
10 from sfa.planetlab.vlink import VLink
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname, xrn_to_ext_slicename, hrn_to_ext_loginbase, top_auth
19 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
21 def __init__(self, driver):
24 def get_slivers(self, xrn, node=None):
25 hrn, type = urn_to_hrn(xrn)
27 slice_name = hrn_to_pl_slicename(hrn)
28 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
29 # of doing all of this?
30 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
32 # from PLCAPI.GetSlivers.get_slivers()
33 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
34 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
35 # Build up list of users and slice attributes
37 all_slice_tag_ids = set()
39 person_ids.update(slice['person_ids'])
40 all_slice_tag_ids.update(slice['slice_tag_ids'])
41 person_ids = list(person_ids)
42 all_slice_tag_ids = list(all_slice_tag_ids)
43 # Get user information
44 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
46 for person in all_persons_list:
47 all_persons[person['person_id']] = person
49 # Build up list of keys
51 for person in all_persons.values():
52 key_ids.update(person['key_ids'])
53 key_ids = list(key_ids)
54 # Get user account keys
55 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
57 for key in all_keys_list:
58 all_keys[key['key_id']] = key
59 # Get slice attributes
60 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
62 for slice_tag in all_slice_tags_list:
63 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
68 for person_id in slice['person_ids']:
69 if person_id in all_persons:
70 person = all_persons[person_id]
71 if not person['enabled']:
73 for key_id in person['key_ids']:
74 if key_id in all_keys:
75 key = all_keys[key_id]
76 keys += [{'key_type': key['key_type'],
79 # All (per-node and global) attributes for this slice
81 for slice_tag_id in slice['slice_tag_ids']:
82 if slice_tag_id in all_slice_tags:
83 slice_tags.append(all_slice_tags[slice_tag_id])
84 # Per-node sliver attributes take precedence over global
85 # slice attributes, so set them first.
86 # Then comes nodegroup slice attributes
87 # Followed by global slice attributes
88 sliver_attributes = []
91 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
92 sliver_attributes.append(sliver_attribute['tagname'])
93 attributes.append({'tagname': sliver_attribute['tagname'],
94 'value': sliver_attribute['value']})
96 # set nodegroup slice attributes
97 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
98 # Do not set any nodegroup slice attributes for
99 # which there is at least one sliver attribute
101 if slice_tag not in slice_tags:
102 attributes.append({'tagname': slice_tag['tagname'],
103 'value': slice_tag['value']})
105 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
106 # Do not set any global slice attributes for
107 # which there is at least one sliver attribute
109 if slice_tag['tagname'] not in sliver_attributes:
110 attributes.append({'tagname': slice_tag['tagname'],
111 'value': slice_tag['value']})
113 # XXX Sanity check; though technically this should be a system invariant
114 # checked with an assertion
115 if slice['expires'] > MAXINT: slice['expires']= MAXINT
119 'name': slice['name'],
120 'slice_id': slice['slice_id'],
121 'instantiation': slice['instantiation'],
122 'expires': slice['expires'],
124 'attributes': attributes
129 def get_peer(self, xrn):
130 hrn, type = urn_to_hrn(xrn)
131 # Becaues of myplc federation, we first need to determine if this
132 # slice belongs to out local plc or a myplc peer. We will assume it
133 # is a local site, unless we find out otherwise
136 # get this slice's authority (site)
137 slice_authority = get_authority(hrn)
139 # get this site's authority (sfa root authority or sub authority)
140 site_authority = get_authority(slice_authority).lower()
142 # check if we are already peered with this site_authority, if so
143 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
144 for peer_record in peers:
145 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
146 if site_authority in names:
151 def get_sfa_peer(self, xrn):
152 hrn, type = urn_to_hrn(xrn)
154 # return the authority for this hrn or None if we are the authority
156 slice_authority = get_authority(hrn)
157 site_authority = get_authority(slice_authority)
159 if site_authority != self.driver.hrn:
160 sfa_peer = site_authority
164 def verify_slice_leases(self, slice, rspec_requested_leases, peer):
166 leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
167 grain = self.driver.shell.GetLeaseGranularity()
169 requested_leases = []
170 for lease in rspec_requested_leases:
172 slice_hrn, _ = urn_to_hrn(lease['slice_id'])
173 top_auth_hrn = top_auth(slice_hrn)
174 if top_auth_hrn == self.driver.hrn:
175 slice_name = hrn_to_pl_slicename(lease['slice_id'])
177 slice_name = xrn_to_ext_slicename(lease['slice_id'])
178 if slice_name != slice['name']:
180 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
183 hostname = xrn_to_hostname(lease['component_id'])
184 # fill the requested node with nitos ids
185 requested_lease['name'] = slice['name']
186 requested_lease['hostname'] = hostname
187 requested_lease['t_from'] = int(lease['start_time'])
188 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
189 requested_leases.append(requested_lease)
193 # prepare actual slice leases by lease_id
196 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
197 't_from': lease['t_from'], 't_until': lease['t_until']}
201 deleted_leases_id = []
202 for lease_id in leases_by_id:
203 if leases_by_id[lease_id] not in requested_leases:
204 deleted_leases_id.append(lease_id)
206 kept_leases_id.append(lease_id)
207 requested_leases.remove(leases_by_id[lease_id])
208 added_leases = requested_leases
213 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
214 self.driver.shell.DeleteLeases(deleted_leases_id)
215 for lease in added_leases:
216 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
219 logger.log_exc('Failed to add/remove slice leases')
224 def verify_slice_nodes(self, slice, slivers, peer):
226 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
227 current_slivers = [node['hostname'] for node in nodes]
229 requested_slivers = []
233 if node.get('component_name'):
234 hostname = node.get('component_name').strip()
235 elif node.get('component_id'):
236 hostname = xrn_to_hostname(node.get('component_id').strip())
237 if node.get('client_id'):
238 tags.append({'slicename': slice['name'],
239 'tagname': 'client_id',
240 'value': node['client_id'],
243 requested_slivers.append(hostname)
245 # remove nodes not in rspec
246 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
248 # add nodes from rspec
249 added_nodes = list(set(requested_slivers).difference(current_slivers))
253 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
254 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
255 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
258 logger.log_exc('Failed to add/remove slice from nodes')
263 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node'])
265 logger.log_exc('Failed to add slice tag')
268 def free_egre_key(self):
270 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
271 used.add(int(tag['value']))
273 for i in range(1, 256):
278 raise KeyError("No more EGRE keys available")
282 def verify_slice_links(self, slice, requested_links, nodes):
283 # nodes is undefined here
284 if not requested_links:
287 # build dict of nodes
291 nodes_dict[node['node_id']] = node
292 interface_ids.extend(node['interface_ids'])
293 # build dict of interfaces
294 interfaces = self.driver.shell.GetInterfaces(interface_ids)
296 for interface in interfaces:
297 interfaces_dict[interface['interface_id']] = interface
302 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
305 slice_tags.append({'name': 'netns', 'value': '1'})
308 # need to update the attribute string?
309 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
311 for link in requested_links:
312 # get the ip address of the first node in the link
313 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
314 (node_raw, device) = ifname1.split(':')
315 node_id = int(node_raw.replace('node', ''))
316 node = nodes_dict[node_id]
317 if1 = interfaces_dict[node['interface_ids'][0]]
319 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
321 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
323 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
324 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
326 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
330 def handle_peer(self, site, slice, persons, peer):
335 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
337 self.driver.shell.DeleteSite(site['site_id'])
343 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
345 self.driver.shell.DeleteSlice(slice['slice_id'])
349 for person in persons:
351 self.driver.shell.BindObjectToPeer('person',
352 person['person_id'], peer['shortname'], person['peer_person_id'])
354 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
356 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
358 self.driver.shell.DeleteKey(key['key_id'])
359 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
361 self.driver.shell.DeletePerson(person['person_id'])
366 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
367 (slice_hrn, type) = urn_to_hrn(slice_xrn)
368 top_auth_hrn = top_auth(slice_hrn)
369 if top_auth_hrn == self.driver.hrn:
370 # login base can't be longer than 20 characters
371 slicename = hrn_to_pl_slicename(slice_hrn)
372 authority_name = slicename.split('_')[0]
373 login_base = authority_name[:20]
375 login_base = hrn_to_ext_loginbase(slice_hrn)
376 authority_name = login_base
378 sites = self.driver.shell.GetSites(login_base)
380 # create new site record
381 site = {'name': 'sfa.%s' % authority_name,
382 'abbreviated_name': authority_name,
383 'login_base': login_base,
387 'peer_site_id': None}
389 site['peer_site_id'] = slice_record.get('site_id', None)
390 site['site_id'] = self.driver.shell.AddSite(site)
391 # exempt federated sites from monitor policies
392 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
394 # # is this still necessary?
395 # # add record to the local registry
396 # if sfa_peer and slice_record:
397 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
398 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
399 # self.registry.register_peer_object(self.credential, peer_dict)
403 # unbind from peer so we can modify if necessary. Will bind back later
404 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
408 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
409 top_auth_hrn = top_auth(slice_hrn)
410 if top_auth_hrn == self.driver.hrn:
411 slice_name = hrn_to_pl_slicename(slice_hrn)
412 parts = slice_name.split("_")
413 login_base = parts[0]
415 login_base = hrn_to_ext_loginbase(slice_hrn)
416 slice_name = xrn_to_ext_slicename(slice_hrn)
418 slices = self.driver.shell.GetSlices([slice_name])
420 slice = {'name': slice_name,
421 'url': slice_record.get('url', slice_hrn),
422 'description': slice_record.get('description', slice_hrn)}
424 slice['slice_id'] = self.driver.shell.AddSlice(slice)
426 self.driver.shell.SetSliceHrn(int(slice['slice_id']), slice_hrn)
428 slice['node_ids'] = []
429 slice['person_ids'] = []
431 slice['peer_slice_id'] = slice_record.get('slice_id', None)
432 # mark this slice as an sfa peer record
434 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
435 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
436 # self.registry.register_peer_object(self.credential, peer_dict)
440 if self.driver.shell.GetSliceHrn(slice['slice_id']) != slice_hrn:
441 self.driver.shell.SetSliceHrn(slice['slice_id'], slice_hrn)
444 slice['peer_slice_id'] = slice_record.get('slice_id', None)
445 # unbind from peer so we can modify if necessary. Will bind back later
446 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
447 #Update existing record (e.g. expires field) it with the latest info.
448 if slice_record and slice_record.get('expires'):
449 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
450 if requested_expires and slice['expires'] != requested_expires:
451 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
455 #def get_existing_persons(self, users):
456 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
458 users_by_site = defaultdict(list)
461 user['urn'] = user['urn'].lower()
462 hrn, type = urn_to_hrn(user['urn'])
463 username = get_leaf(hrn)
464 user['username'] = username
466 top_auth_hrn = top_auth(hrn)
468 if top_auth_hrn == self.driver.hrn:
469 login_base = PlXrn(xrn=user['urn']).pl_login_base()
471 login_base = hrn_to_ext_loginbase(hrn)
473 user['site'] = login_base
475 user['email'] = user['email'].lower()
476 users_by_email[user['email']] = user
477 users_dict[user['email']] = user
479 users_by_site[user['site']].append(user)
481 # start building a list of existing users
482 existing_user_ids = []
483 existing_user_ids_filter = []
485 existing_user_ids_filter.extend(users_by_email.keys())
487 for login_base in users_by_site:
488 users = users_by_site[login_base]
490 existing_user_ids_filter.append(user['username']+'@geni.net')
491 if existing_user_ids_filter:
492 # get existing users by email
493 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
494 ['person_id', 'key_ids', 'email'])
495 existing_user_ids.extend([user['email'] for user in existing_users])
498 # get a list of user sites (based on requeste user urns
499 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
500 ['site_id', 'login_base', 'person_ids'])
501 # get all existing users at these sites
504 for site in site_list:
505 sites[site['site_id']] = site
506 site_user_ids.extend(site['person_ids'])
508 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
509 ['person_id', 'key_ids', 'email', 'site_ids'])
511 # all requested users are either existing users or new (added) users
512 for login_base in users_by_site:
513 requested_site_users = users_by_site[login_base]
514 for requested_user in requested_site_users:
516 for existing_user in existing_site_persons_list:
517 for site_id in existing_user['site_ids']:
519 site = sites[site_id]
520 if login_base == site['login_base'] and \
521 existing_user['email'].startswith(requested_user['username']+'@'):
522 existing_user_ids.append(existing_user['email'])
523 requested_user['email'] = existing_user['email']
524 users_dict[existing_user['email']] = requested_user
530 if user_found == False:
531 fake_email = requested_user['username'] + '@geni.net'
532 requested_user['email'] = fake_email
533 users_dict[fake_email] = requested_user
535 # requested slice users
536 requested_user_ids = users_dict.keys()
537 # existing slice users
538 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
539 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
540 ['person_id', 'key_ids', 'email'])
541 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
543 # users to be added, removed or updated
544 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
545 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
546 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
547 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
549 # Remove stale users (only if we are not appending).
551 append = options.get('append', True)
553 for removed_user_id in removed_user_ids:
554 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
555 # update_existing users
556 updated_users_list = [user for user in users_dict.values() if user['email'] in \
558 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
562 for added_user_id in added_user_ids:
563 added_user = users_dict[added_user_id]
564 hrn, type = urn_to_hrn(added_user['urn'])
566 'first_name': added_user.get('first_name', hrn),
567 'last_name': added_user.get('last_name', hrn),
568 'email': added_user_id,
569 #'peer_person_id': None,
571 #'key_ids': added_user.get('key_ids', []),
573 person['person_id'] = self.driver.shell.AddPerson(person)
574 self.driver.shell.AddRoleToPerson('user', int(person['person_id']))
576 if self.driver.shell.GetPersonHrn(int(person['person_id'])) != hrn:
577 self.driver.shell.SetPersonHrn(int(person['person_id']), hrn)
580 person['peer_person_id'] = added_user['person_id']
581 added_persons.append(person)
584 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
587 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
589 for key_string in added_user.get('keys', []):
590 key = {'key':key_string, 'key_type':'ssh'}
591 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
592 if 'keys' not in person:
594 person['keys'].append(key)
596 # add the registry record
598 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
599 # 'pointer': person['person_id']}
600 # self.registry.register_peer_object(self.credential, peer_dict)
602 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
603 # add person to the slice
604 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
605 # if this is a peer record then it should already be bound to a peer.
606 # no need to return worry about it getting bound later
611 def verify_keys(self, persons, users, peer, options={}):
614 for person in persons:
615 key_ids.extend(person['key_ids'])
616 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
619 keydict[key['key']] = key['key_id']
620 existing_keys = keydict.keys()
622 for person in persons:
623 persondict[person['email']] = person
629 user_keys = user.get('keys', [])
630 updated_persons.append(user)
631 for key_string in user_keys:
632 requested_keys.append(key_string)
633 if key_string not in existing_keys:
634 key = {'key': key_string, 'key_type': 'ssh'}
637 person = persondict[user['email']]
638 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
639 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
641 key_index = user_keys.index(key['key'])
642 remote_key_id = user['key_ids'][key_index]
643 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
647 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
649 # remove old keys (only if we are not appending)
650 append = options.get('append', True)
652 removed_keys = set(existing_keys).difference(requested_keys)
653 for existing_key_id in keydict:
654 if keydict[existing_key_id] in removed_keys:
657 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
658 self.driver.shell.DeleteKey(existing_key_id)
662 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
663 append = options.get('append', True)
664 # get list of attributes users ar able to manage
665 filter = {'category': '*slice*'}
667 filter['|roles'] = ['user']
668 slice_attributes = self.driver.shell.GetTagTypes(filter)
669 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
671 # get sliver attributes
672 added_slice_attributes = []
673 removed_slice_attributes = []
674 ignored_slice_attribute_names = []
675 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
677 # get attributes that should be removed
678 for slice_tag in existing_slice_attributes:
679 if slice_tag['tagname'] in ignored_slice_attribute_names:
680 # If a slice already has a admin only role it was probably given to them by an
681 # admin, so we should ignore it.
682 ignored_slice_attribute_names.append(slice_tag['tagname'])
684 # If an existing slice attribute was not found in the request it should
686 attribute_found=False
687 for requested_attribute in requested_slice_attributes:
688 if requested_attribute['name'] == slice_tag['tagname'] and \
689 requested_attribute['value'] == slice_tag['value']:
693 if not attribute_found and not append:
694 removed_slice_attributes.append(slice_tag)
696 # get attributes that should be added:
697 for requested_attribute in requested_slice_attributes:
698 # if the requested attribute wasn't found we should add it
699 if requested_attribute['name'] in valid_slice_attribute_names:
700 attribute_found = False
701 for existing_attribute in existing_slice_attributes:
702 if requested_attribute['name'] == existing_attribute['tagname'] and \
703 requested_attribute['value'] == existing_attribute['value']:
706 if not attribute_found:
707 added_slice_attributes.append(requested_attribute)
710 # remove stale attributes
711 for attribute in removed_slice_attributes:
713 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
715 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
716 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
718 # add requested_attributes
719 for attribute in added_slice_attributes:
721 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
723 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
724 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))