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 hostname = xrn_to_hostname(lease['component_id'])
176 # fill the requested node with nitos ids
177 requested_lease['name'] = slice['name']
178 requested_lease['hostname'] = hostname
179 requested_lease['t_from'] = int(lease['start_time'])
180 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
181 requested_leases.append(requested_lease)
185 # prepare actual slice leases by lease_id
188 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
189 't_from': lease['t_from'], 't_until': lease['t_until']}
193 deleted_leases_id = []
194 for lease_id in leases_by_id:
195 if leases_by_id[lease_id] not in requested_leases:
196 deleted_leases_id.append(lease_id)
198 kept_leases_id.append(lease_id)
199 requested_leases.remove(leases_by_id[lease_id])
200 added_leases = requested_leases
205 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
206 self.driver.shell.DeleteLeases(deleted_leases_id)
207 for lease in added_leases:
208 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
211 logger.log_exc('Failed to add/remove slice leases')
216 def verify_slice_nodes(self, slice, slivers, peer):
218 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
219 current_slivers = [node['hostname'] for node in nodes]
221 requested_slivers = []
225 if node.get('component_name'):
226 hostname = node.get('component_name').strip()
227 elif node.get('component_id'):
228 hostname = xrn_to_hostname(node.get('component_id').strip())
229 if node.get('client_id'):
230 tags.append({'slicename': slice['name'],
231 'tagname': 'client_id',
232 'value': node['client_id'],
235 requested_slivers.append(hostname)
237 # remove nodes not in rspec
238 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
240 # add nodes from rspec
241 added_nodes = list(set(requested_slivers).difference(current_slivers))
245 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
246 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
247 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
250 logger.log_exc('Failed to add/remove slice from nodes')
255 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node'])
257 logger.log_exc('Failed to add slice tag')
260 def free_egre_key(self):
262 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
263 used.add(int(tag['value']))
265 for i in range(1, 256):
270 raise KeyError("No more EGRE keys available")
274 def verify_slice_links(self, slice, requested_links, nodes):
275 # nodes is undefined here
276 if not requested_links:
279 # build dict of nodes
283 nodes_dict[node['node_id']] = node
284 interface_ids.extend(node['interface_ids'])
285 # build dict of interfaces
286 interfaces = self.driver.shell.GetInterfaces(interface_ids)
288 for interface in interfaces:
289 interfaces_dict[interface['interface_id']] = interface
294 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
297 slice_tags.append({'name': 'netns', 'value': '1'})
300 # need to update the attribute string?
301 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
303 for link in requested_links:
304 # get the ip address of the first node in the link
305 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
306 (node_raw, device) = ifname1.split(':')
307 node_id = int(node_raw.replace('node', ''))
308 node = nodes_dict[node_id]
309 if1 = interfaces_dict[node['interface_ids'][0]]
311 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
313 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
315 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
316 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
318 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
322 def handle_peer(self, site, slice, persons, peer):
327 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
329 self.driver.shell.DeleteSite(site['site_id'])
335 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
337 self.driver.shell.DeleteSlice(slice['slice_id'])
341 for person in persons:
343 self.driver.shell.BindObjectToPeer('person',
344 person['person_id'], peer['shortname'], person['peer_person_id'])
346 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
348 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
350 self.driver.shell.DeleteKey(key['key_id'])
351 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
353 self.driver.shell.DeletePerson(person['person_id'])
358 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
359 (slice_hrn, type) = urn_to_hrn(slice_xrn)
360 site_hrn = get_authority(slice_hrn)
361 # login base can't be longer than 20 characters
362 slicename = hrn_to_pl_slicename(slice_hrn)
363 authority_name = slicename.split('_')[0]
364 login_base = authority_name[:20]
365 sites = self.driver.shell.GetSites(login_base)
367 # create new site record
368 site = {'name': 'geni.%s' % authority_name,
369 'abbreviated_name': authority_name,
370 'login_base': login_base,
374 'peer_site_id': None}
376 site['peer_site_id'] = slice_record.get('site_id', None)
377 site['site_id'] = self.driver.shell.AddSite(site)
378 # exempt federated sites from monitor policies
379 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
381 # # is this still necessary?
382 # # add record to the local registry
383 # if sfa_peer and slice_record:
384 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
385 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
386 # self.registry.register_peer_object(self.credential, peer_dict)
390 # unbind from peer so we can modify if necessary. Will bind back later
391 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
395 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
396 slicename = hrn_to_pl_slicename(slice_hrn)
397 parts = slicename.split("_")
398 login_base = parts[0]
399 slices = self.driver.shell.GetSlices([slicename])
401 slice = {'name': slicename,
402 'url': slice_record.get('url', slice_hrn),
403 'description': slice_record.get('description', slice_hrn)}
405 slice['slice_id'] = self.driver.shell.AddSlice(slice)
406 slice['node_ids'] = []
407 slice['person_ids'] = []
409 slice['peer_slice_id'] = slice_record.get('slice_id', None)
410 # mark this slice as an sfa peer record
412 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
413 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
414 # self.registry.register_peer_object(self.credential, peer_dict)
418 slice['peer_slice_id'] = slice_record.get('slice_id', None)
419 # unbind from peer so we can modify if necessary. Will bind back later
420 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
421 #Update existing record (e.g. expires field) it with the latest info.
422 if slice_record.get('expires'):
423 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
424 if requested_expires and slice['expires'] != requested_expires:
425 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
429 #def get_existing_persons(self, users):
430 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
432 users_by_site = defaultdict(list)
435 user['urn'] = user['urn'].lower()
436 hrn, type = urn_to_hrn(user['urn'])
437 username = get_leaf(hrn)
438 login_base = PlXrn(xrn=user['urn']).pl_login_base()
439 user['username'] = username
440 user['site'] = login_base
443 user['email'] = user['email'].lower()
444 users_by_email[user['email']] = user
445 users_dict[user['email']] = user
447 users_by_site[user['site']].append(user)
449 # start building a list of existing users
450 existing_user_ids = []
451 existing_user_ids_filter = []
453 existing_user_ids_filter.extend(users_by_email.keys())
455 for login_base in users_by_site:
456 users = users_by_site[login_base]
458 existing_user_ids_filter.append(user['username']+'@geni.net')
459 if existing_user_ids_filter:
460 # get existing users by email
461 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
462 ['person_id', 'key_ids', 'email'])
463 existing_user_ids.extend([user['email'] for user in existing_users])
466 # get a list of user sites (based on requeste user urns
467 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
468 ['site_id', 'login_base', 'person_ids'])
469 # get all existing users at these sites
472 for site in site_list:
473 sites[site['site_id']] = site
474 site_user_ids.extend(site['person_ids'])
476 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
477 ['person_id', 'key_ids', 'email', 'site_ids'])
479 # all requested users are either existing users or new (added) users
480 for login_base in users_by_site:
481 requested_site_users = users_by_site[login_base]
482 for requested_user in requested_site_users:
484 for existing_user in existing_site_persons_list:
485 for site_id in existing_user['site_ids']:
487 site = sites[site_id]
488 if login_base == site['login_base'] and \
489 existing_user['email'].startswith(requested_user['username']+'@'):
490 existing_user_ids.append(existing_user['email'])
491 requested_user['email'] = existing_user['email']
492 users_dict[existing_user['email']] = requested_user
498 if user_found == False:
499 fake_email = requested_user['username'] + '@geni.net'
500 requested_user['email'] = fake_email
501 users_dict[fake_email] = requested_user
503 # requested slice users
504 requested_user_ids = users_dict.keys()
505 # existing slice users
506 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
507 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
508 ['person_id', 'key_ids', 'email'])
509 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
511 # users to be added, removed or updated
512 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
513 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
514 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
515 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
517 # Remove stale users (only if we are not appending).
519 append = options.get('append', True)
521 for removed_user_id in removed_user_ids:
522 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
523 # update_existing users
524 updated_users_list = [user for user in users_dict.values() if user['email'] in \
526 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
530 for added_user_id in added_user_ids:
531 added_user = users_dict[added_user_id]
532 hrn, type = urn_to_hrn(added_user['urn'])
534 'first_name': added_user.get('first_name', hrn),
535 'last_name': added_user.get('last_name', hrn),
536 'email': added_user_id,
537 'peer_person_id': None,
539 'key_ids': added_user.get('key_ids', []),
541 person['person_id'] = self.driver.shell.AddPerson(person)
543 person['peer_person_id'] = added_user['person_id']
544 added_persons.append(person)
547 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
550 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
552 for key_string in added_user.get('keys', []):
553 key = {'key':key_string, 'key_type':'ssh'}
554 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
555 person['keys'].append(key)
557 # add the registry record
559 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
560 # 'pointer': person['person_id']}
561 # self.registry.register_peer_object(self.credential, peer_dict)
563 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
564 # add person to the slice
565 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
566 # if this is a peer record then it should already be bound to a peer.
567 # no need to return worry about it getting bound later
572 def verify_keys(self, persons, users, peer, options={}):
575 for person in persons:
576 key_ids.extend(person['key_ids'])
577 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
580 keydict[key['key']] = key['key_id']
581 existing_keys = keydict.keys()
583 for person in persons:
584 persondict[person['email']] = person
590 user_keys = user.get('keys', [])
591 updated_persons.append(user)
592 for key_string in user_keys:
593 requested_keys.append(key_string)
594 if key_string not in existing_keys:
595 key = {'key': key_string, 'key_type': 'ssh'}
598 person = persondict[user['email']]
599 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
600 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
602 key_index = user_keys.index(key['key'])
603 remote_key_id = user['key_ids'][key_index]
604 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
608 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
610 # remove old keys (only if we are not appending)
611 append = options.get('append', True)
613 removed_keys = set(existing_keys).difference(requested_keys)
614 for existing_key_id in keydict:
615 if keydict[existing_key_id] in removed_keys:
618 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
619 self.driver.shell.DeleteKey(existing_key_id)
623 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
624 append = options.get('append', True)
625 # get list of attributes users ar able to manage
626 filter = {'category': '*slice*'}
628 filter['|roles'] = ['user']
629 slice_attributes = self.driver.shell.GetTagTypes(filter)
630 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
632 # get sliver attributes
633 added_slice_attributes = []
634 removed_slice_attributes = []
635 ignored_slice_attribute_names = []
636 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
638 # get attributes that should be removed
639 for slice_tag in existing_slice_attributes:
640 if slice_tag['tagname'] in ignored_slice_attribute_names:
641 # If a slice already has a admin only role it was probably given to them by an
642 # admin, so we should ignore it.
643 ignored_slice_attribute_names.append(slice_tag['tagname'])
645 # If an existing slice attribute was not found in the request it should
647 attribute_found=False
648 for requested_attribute in requested_slice_attributes:
649 if requested_attribute['name'] == slice_tag['tagname'] and \
650 requested_attribute['value'] == slice_tag['value']:
654 if not attribute_found and not append:
655 removed_slice_attributes.append(slice_tag)
657 # get attributes that should be added:
658 for requested_attribute in requested_slice_attributes:
659 # if the requested attribute wasn't found we should add it
660 if requested_attribute['name'] in valid_slice_attribute_names:
661 attribute_found = False
662 for existing_attribute in existing_slice_attributes:
663 if requested_attribute['name'] == existing_attribute['tagname'] and \
664 requested_attribute['value'] == existing_attribute['value']:
667 if not attribute_found:
668 added_slice_attributes.append(requested_attribute)
671 # remove stale attributes
672 for attribute in removed_slice_attributes:
674 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
676 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
677 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
679 # add requested_attributes
680 for attribute in added_slice_attributes:
682 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
684 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
685 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))