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
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_name = hrn_to_pl_slicename(lease['slice_id'])
173 if slice_name != slice['name']:
175 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
178 hostname = xrn_to_hostname(lease['component_id'])
179 # fill the requested node with nitos ids
180 requested_lease['name'] = slice['name']
181 requested_lease['hostname'] = hostname
182 requested_lease['t_from'] = int(lease['start_time'])
183 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
184 requested_leases.append(requested_lease)
188 # prepare actual slice leases by lease_id
191 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
192 't_from': lease['t_from'], 't_until': lease['t_until']}
196 deleted_leases_id = []
197 for lease_id in leases_by_id:
198 if leases_by_id[lease_id] not in requested_leases:
199 deleted_leases_id.append(lease_id)
201 kept_leases_id.append(lease_id)
202 requested_leases.remove(leases_by_id[lease_id])
203 added_leases = requested_leases
208 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
209 self.driver.shell.DeleteLeases(deleted_leases_id)
210 for lease in added_leases:
211 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
214 logger.log_exc('Failed to add/remove slice leases')
219 def verify_slice_nodes(self, slice, slivers, peer):
221 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
222 current_slivers = [node['hostname'] for node in nodes]
224 requested_slivers = []
228 if node.get('component_name'):
229 hostname = node.get('component_name').strip()
230 elif node.get('component_id'):
231 hostname = xrn_to_hostname(node.get('component_id').strip())
232 if node.get('client_id'):
233 tags.append({'slicename': slice['name'],
234 'tagname': 'client_id',
235 'value': node['client_id'],
238 requested_slivers.append(hostname)
240 # remove nodes not in rspec
241 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
243 # add nodes from rspec
244 added_nodes = list(set(requested_slivers).difference(current_slivers))
248 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
249 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
250 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
253 logger.log_exc('Failed to add/remove slice from nodes')
258 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node'])
260 logger.log_exc('Failed to add slice tag')
263 def free_egre_key(self):
265 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
266 used.add(int(tag['value']))
268 for i in range(1, 256):
273 raise KeyError("No more EGRE keys available")
277 def verify_slice_links(self, slice, requested_links, nodes):
278 # nodes is undefined here
279 if not requested_links:
282 # build dict of nodes
286 nodes_dict[node['node_id']] = node
287 interface_ids.extend(node['interface_ids'])
288 # build dict of interfaces
289 interfaces = self.driver.shell.GetInterfaces(interface_ids)
291 for interface in interfaces:
292 interfaces_dict[interface['interface_id']] = interface
297 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
300 slice_tags.append({'name': 'netns', 'value': '1'})
303 # need to update the attribute string?
304 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
306 for link in requested_links:
307 # get the ip address of the first node in the link
308 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
309 (node_raw, device) = ifname1.split(':')
310 node_id = int(node_raw.replace('node', ''))
311 node = nodes_dict[node_id]
312 if1 = interfaces_dict[node['interface_ids'][0]]
314 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
316 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
318 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
319 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
321 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
325 def handle_peer(self, site, slice, persons, peer):
330 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
332 self.driver.shell.DeleteSite(site['site_id'])
338 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
340 self.driver.shell.DeleteSlice(slice['slice_id'])
344 for person in persons:
346 self.driver.shell.BindObjectToPeer('person',
347 person['person_id'], peer['shortname'], person['peer_person_id'])
349 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
351 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
353 self.driver.shell.DeleteKey(key['key_id'])
354 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
356 self.driver.shell.DeletePerson(person['person_id'])
361 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
362 (slice_hrn, type) = urn_to_hrn(slice_xrn)
363 site_hrn = get_authority(slice_hrn)
364 # login base can't be longer than 20 characters
365 slicename = hrn_to_pl_slicename(slice_hrn)
366 authority_name = slicename.split('_')[0]
367 login_base = authority_name[:20]
368 sites = self.driver.shell.GetSites(login_base)
370 # create new site record
371 site = {'name': 'geni.%s' % authority_name,
372 'abbreviated_name': authority_name,
373 'login_base': login_base,
377 'peer_site_id': None}
379 site['peer_site_id'] = slice_record.get('site_id', None)
380 site['site_id'] = self.driver.shell.AddSite(site)
381 # exempt federated sites from monitor policies
382 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
384 # # is this still necessary?
385 # # add record to the local registry
386 # if sfa_peer and slice_record:
387 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
388 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
389 # self.registry.register_peer_object(self.credential, peer_dict)
393 # unbind from peer so we can modify if necessary. Will bind back later
394 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
398 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
399 slicename = hrn_to_pl_slicename(slice_hrn)
400 parts = slicename.split("_")
401 login_base = parts[0]
402 slices = self.driver.shell.GetSlices([slicename])
404 slice = {'name': slicename,
405 'url': slice_record.get('url', slice_hrn),
406 'description': slice_record.get('description', slice_hrn)}
408 slice['slice_id'] = self.driver.shell.AddSlice(slice)
409 slice['node_ids'] = []
410 slice['person_ids'] = []
412 slice['peer_slice_id'] = slice_record.get('slice_id', None)
413 # mark this slice as an sfa peer record
415 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
416 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
417 # self.registry.register_peer_object(self.credential, peer_dict)
421 slice['peer_slice_id'] = slice_record.get('slice_id', None)
422 # unbind from peer so we can modify if necessary. Will bind back later
423 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
424 #Update existing record (e.g. expires field) it with the latest info.
425 if slice_record.get('expires'):
426 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
427 if requested_expires and slice['expires'] != requested_expires:
428 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
432 #def get_existing_persons(self, users):
433 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
435 users_by_site = defaultdict(list)
438 user['urn'] = user['urn'].lower()
439 hrn, type = urn_to_hrn(user['urn'])
440 username = get_leaf(hrn)
441 login_base = PlXrn(xrn=user['urn']).pl_login_base()
442 user['username'] = username
443 user['site'] = login_base
446 user['email'] = user['email'].lower()
447 users_by_email[user['email']] = user
448 users_dict[user['email']] = user
450 users_by_site[user['site']].append(user)
452 # start building a list of existing users
453 existing_user_ids = []
454 existing_user_ids_filter = []
456 existing_user_ids_filter.extend(users_by_email.keys())
458 for login_base in users_by_site:
459 users = users_by_site[login_base]
461 existing_user_ids_filter.append(user['username']+'@geni.net')
462 if existing_user_ids_filter:
463 # get existing users by email
464 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
465 ['person_id', 'key_ids', 'email'])
466 existing_user_ids.extend([user['email'] for user in existing_users])
469 # get a list of user sites (based on requeste user urns
470 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
471 ['site_id', 'login_base', 'person_ids'])
472 # get all existing users at these sites
475 for site in site_list:
476 sites[site['site_id']] = site
477 site_user_ids.extend(site['person_ids'])
479 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
480 ['person_id', 'key_ids', 'email', 'site_ids'])
482 # all requested users are either existing users or new (added) users
483 for login_base in users_by_site:
484 requested_site_users = users_by_site[login_base]
485 for requested_user in requested_site_users:
487 for existing_user in existing_site_persons_list:
488 for site_id in existing_user['site_ids']:
490 site = sites[site_id]
491 if login_base == site['login_base'] and \
492 existing_user['email'].startswith(requested_user['username']+'@'):
493 existing_user_ids.append(existing_user['email'])
494 requested_user['email'] = existing_user['email']
495 users_dict[existing_user['email']] = requested_user
501 if user_found == False:
502 fake_email = requested_user['username'] + '@geni.net'
503 requested_user['email'] = fake_email
504 users_dict[fake_email] = requested_user
506 # requested slice users
507 requested_user_ids = users_dict.keys()
508 # existing slice users
509 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
510 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
511 ['person_id', 'key_ids', 'email'])
512 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
514 # users to be added, removed or updated
515 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
516 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
517 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
518 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
520 # Remove stale users (only if we are not appending).
522 append = options.get('append', True)
524 for removed_user_id in removed_user_ids:
525 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
526 # update_existing users
527 updated_users_list = [user for user in users_dict.values() if user['email'] in \
529 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
533 for added_user_id in added_user_ids:
534 added_user = users_dict[added_user_id]
535 hrn, type = urn_to_hrn(added_user['urn'])
537 'first_name': added_user.get('first_name', hrn),
538 'last_name': added_user.get('last_name', hrn),
539 'email': added_user_id,
540 'peer_person_id': None,
542 'key_ids': added_user.get('key_ids', []),
544 person['person_id'] = self.driver.shell.AddPerson(person)
546 person['peer_person_id'] = added_user['person_id']
547 added_persons.append(person)
550 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
553 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
555 for key_string in added_user.get('keys', []):
556 key = {'key':key_string, 'key_type':'ssh'}
557 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
558 person['keys'].append(key)
560 # add the registry record
562 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
563 # 'pointer': person['person_id']}
564 # self.registry.register_peer_object(self.credential, peer_dict)
566 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
567 # add person to the slice
568 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
569 # if this is a peer record then it should already be bound to a peer.
570 # no need to return worry about it getting bound later
575 def verify_keys(self, persons, users, peer, options={}):
578 for person in persons:
579 key_ids.extend(person['key_ids'])
580 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
583 keydict[key['key']] = key['key_id']
584 existing_keys = keydict.keys()
586 for person in persons:
587 persondict[person['email']] = person
593 user_keys = user.get('keys', [])
594 updated_persons.append(user)
595 for key_string in user_keys:
596 requested_keys.append(key_string)
597 if key_string not in existing_keys:
598 key = {'key': key_string, 'key_type': 'ssh'}
601 person = persondict[user['email']]
602 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
603 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
605 key_index = user_keys.index(key['key'])
606 remote_key_id = user['key_ids'][key_index]
607 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
611 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
613 # remove old keys (only if we are not appending)
614 append = options.get('append', True)
616 removed_keys = set(existing_keys).difference(requested_keys)
617 for existing_key_id in keydict:
618 if keydict[existing_key_id] in removed_keys:
621 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
622 self.driver.shell.DeleteKey(existing_key_id)
626 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
627 append = options.get('append', True)
628 # get list of attributes users ar able to manage
629 filter = {'category': '*slice*'}
631 filter['|roles'] = ['user']
632 slice_attributes = self.driver.shell.GetTagTypes(filter)
633 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
635 # get sliver attributes
636 added_slice_attributes = []
637 removed_slice_attributes = []
638 ignored_slice_attribute_names = []
639 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
641 # get attributes that should be removed
642 for slice_tag in existing_slice_attributes:
643 if slice_tag['tagname'] in ignored_slice_attribute_names:
644 # If a slice already has a admin only role it was probably given to them by an
645 # admin, so we should ignore it.
646 ignored_slice_attribute_names.append(slice_tag['tagname'])
648 # If an existing slice attribute was not found in the request it should
650 attribute_found=False
651 for requested_attribute in requested_slice_attributes:
652 if requested_attribute['name'] == slice_tag['tagname'] and \
653 requested_attribute['value'] == slice_tag['value']:
657 if not attribute_found and not append:
658 removed_slice_attributes.append(slice_tag)
660 # get attributes that should be added:
661 for requested_attribute in requested_slice_attributes:
662 # if the requested attribute wasn't found we should add it
663 if requested_attribute['name'] in valid_slice_attribute_names:
664 attribute_found = False
665 for existing_attribute in existing_slice_attributes:
666 if requested_attribute['name'] == existing_attribute['tagname'] and \
667 requested_attribute['value'] == existing_attribute['value']:
670 if not attribute_found:
671 added_slice_attributes.append(requested_attribute)
674 # remove stale attributes
675 for attribute in removed_slice_attributes:
677 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
679 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
680 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
682 # add requested_attributes
683 for attribute in added_slice_attributes:
685 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
687 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
688 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))