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
7 from sfa.rspecs.rspec import RSpec
8 from sfa.planetlab.vlink import VLink
9 from sfa.planetlab.topology import Topology
10 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename
16 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
18 def __init__(self, driver):
21 def get_slivers(self, xrn, node=None):
22 hrn, type = urn_to_hrn(xrn)
24 slice_name = hrn_to_pl_slicename(hrn)
25 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
26 # of doing all of this?
27 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
29 # from PLCAPI.GetSlivers.get_slivers()
30 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
31 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
32 # Build up list of users and slice attributes
34 all_slice_tag_ids = set()
36 person_ids.update(slice['person_ids'])
37 all_slice_tag_ids.update(slice['slice_tag_ids'])
38 person_ids = list(person_ids)
39 all_slice_tag_ids = list(all_slice_tag_ids)
40 # Get user information
41 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
43 for person in all_persons_list:
44 all_persons[person['person_id']] = person
46 # Build up list of keys
48 for person in all_persons.values():
49 key_ids.update(person['key_ids'])
50 key_ids = list(key_ids)
51 # Get user account keys
52 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
54 for key in all_keys_list:
55 all_keys[key['key_id']] = key
56 # Get slice attributes
57 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
59 for slice_tag in all_slice_tags_list:
60 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
65 for person_id in slice['person_ids']:
66 if person_id in all_persons:
67 person = all_persons[person_id]
68 if not person['enabled']:
70 for key_id in person['key_ids']:
71 if key_id in all_keys:
72 key = all_keys[key_id]
73 keys += [{'key_type': key['key_type'],
76 # All (per-node and global) attributes for this slice
78 for slice_tag_id in slice['slice_tag_ids']:
79 if slice_tag_id in all_slice_tags:
80 slice_tags.append(all_slice_tags[slice_tag_id])
81 # Per-node sliver attributes take precedence over global
82 # slice attributes, so set them first.
83 # Then comes nodegroup slice attributes
84 # Followed by global slice attributes
85 sliver_attributes = []
88 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
89 sliver_attributes.append(sliver_attribute['tagname'])
90 attributes.append({'tagname': sliver_attribute['tagname'],
91 'value': sliver_attribute['value']})
93 # set nodegroup slice attributes
94 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
95 # Do not set any nodegroup slice attributes for
96 # which there is at least one sliver attribute
98 if slice_tag not in slice_tags:
99 attributes.append({'tagname': slice_tag['tagname'],
100 'value': slice_tag['value']})
102 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
103 # Do not set any global slice attributes for
104 # which there is at least one sliver attribute
106 if slice_tag['tagname'] not in sliver_attributes:
107 attributes.append({'tagname': slice_tag['tagname'],
108 'value': slice_tag['value']})
110 # XXX Sanity check; though technically this should be a system invariant
111 # checked with an assertion
112 if slice['expires'] > MAXINT: slice['expires']= MAXINT
116 'name': slice['name'],
117 'slice_id': slice['slice_id'],
118 'instantiation': slice['instantiation'],
119 'expires': slice['expires'],
121 'attributes': attributes
126 def get_peer(self, xrn):
127 hrn, type = urn_to_hrn(xrn)
128 # Becaues of myplc federation, we first need to determine if this
129 # slice belongs to out local plc or a myplc peer. We will assume it
130 # is a local site, unless we find out otherwise
133 # get this slice's authority (site)
134 slice_authority = get_authority(hrn)
136 # get this site's authority (sfa root authority or sub authority)
137 site_authority = get_authority(slice_authority).lower()
139 # check if we are already peered with this site_authority, if so
140 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
141 for peer_record in peers:
142 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
143 if site_authority in names:
148 def get_sfa_peer(self, xrn):
149 hrn, type = urn_to_hrn(xrn)
151 # return the authority for this hrn or None if we are the authority
153 slice_authority = get_authority(hrn)
154 site_authority = get_authority(slice_authority)
156 if site_authority != self.driver.hrn:
157 sfa_peer = site_authority
161 def verify_slice_leases(self, slice, requested_leases, kept_leases, peer):
163 leases = self.driver.shell.GetLeases({'name':slice['name']}, ['lease_id'])
164 grain = self.driver.shell.GetLeaseGranularity()
165 current_leases = [lease['lease_id'] for lease in leases]
166 deleted_leases = list(set(current_leases).difference(kept_leases))
170 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
171 deleted=self.driver.shell.DeleteLeases(deleted_leases)
172 for lease in requested_leases:
173 added=self.driver.shell.AddLeases(lease['hostname'], slice['name'], int(lease['start_time']), int(lease['duration']) * grain + int(lease['start_time']))
176 logger.log_exc('Failed to add/remove slice leases')
181 def verify_slice_nodes(self, slice, requested_slivers, peer):
183 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
184 current_slivers = [node['hostname'] for node in nodes]
186 # remove nodes not in rspec
187 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
189 # add nodes from rspec
190 added_nodes = list(set(requested_slivers).difference(current_slivers))
194 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
195 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
196 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
199 logger.log_exc('Failed to add/remove slice from nodes')
201 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
202 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
203 return resulting_nodes
205 def free_egre_key(self):
207 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
208 used.add(int(tag['value']))
210 for i in range(1, 256):
215 raise KeyError("No more EGRE keys available")
219 def verify_slice_links(self, slice, requested_links, nodes):
221 if not requested_links:
224 # exit if links are not supported here
225 topology = Topology()
229 # build dict of nodes
233 nodes_dict[node['node_id']] = node
234 interface_ids.extend(node['interface_ids'])
235 # build dict of interfaces
236 interfaces = self.driver.shell.GetInterfaces(interface_ids)
238 for interface in interfaces:
239 interfaces_dict[interface['interface_id']] = interface
244 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
247 slice_tags.append({'name': 'netns', 'value': '1'})
250 # need to update the attribute string?
251 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
253 for link in requested_links:
254 # get the ip address of the first node in the link
255 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
256 ifname_parts = ifname1.split(':')
257 node_raw = ifname_parts[0]
259 if len(ifname_parts) > 1:
260 device = ifname_parts[1]
261 node_id = int(node_raw.replace('node', ''))
262 node = nodes_dict[node_id]
263 if1 = interfaces_dict[node['interface_ids'][0]]
265 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
267 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
269 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
270 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
272 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
276 def handle_peer(self, site, slice, persons, peer):
281 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
283 self.driver.shell.DeleteSite(site['site_id'])
289 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
291 self.driver.shell.DeleteSlice(slice['slice_id'])
295 for person in persons:
297 self.driver.shell.BindObjectToPeer('person',
298 person['person_id'], peer['shortname'], person['peer_person_id'])
300 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
302 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
304 self.driver.shell.DeleteKey(key['key_id'])
305 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
307 self.driver.shell.DeletePerson(person['person_id'])
312 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
313 (slice_hrn, type) = urn_to_hrn(slice_xrn)
314 site_hrn = get_authority(slice_hrn)
315 # login base can't be longer than 20 characters
316 slicename = hrn_to_pl_slicename(slice_hrn)
317 authority_name = slicename.split('_')[0]
318 login_base = authority_name[:20]
319 sites = self.driver.shell.GetSites(login_base)
321 # create new site record
322 site = {'name': 'geni.%s' % authority_name,
323 'abbreviated_name': authority_name,
324 'login_base': login_base,
328 'peer_site_id': None}
330 site['peer_site_id'] = slice_record.get('site_id', None)
331 site['site_id'] = self.driver.shell.AddSite(site)
332 # exempt federated sites from monitor policies
333 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
335 # # is this still necessary?
336 # # add record to the local registry
337 # if sfa_peer and slice_record:
338 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
339 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
340 # self.registry.register_peer_object(self.credential, peer_dict)
344 # unbind from peer so we can modify if necessary. Will bind back later
345 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
349 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
350 slicename = hrn_to_pl_slicename(slice_hrn)
351 parts = slicename.split("_")
352 login_base = parts[0]
353 slices = self.driver.shell.GetSlices([slicename])
355 slice = {'name': slicename,
357 'description': 'No Description'}
359 slice['slice_id'] = self.driver.shell.AddSlice(slice)
360 slice['node_ids'] = []
361 slice['person_ids'] = []
362 if peer and slice_record:
363 slice['peer_slice_id'] = slice_record.get('slice_id', None)
366 if peer and slice_record:
367 slice['peer_slice_id'] = slice_record.get('slice_id', None)
368 # unbind from peer so we can modify if necessary. Will bind back later
369 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
370 #Update existing record (e.g. expires field) it with the latest info.
371 if slice_record and slice_record.get('expires'):
372 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
373 if requested_expires and slice['expires'] != requested_expires:
374 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
378 #def get_existing_persons(self, users):
379 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
381 users_by_site = defaultdict(list)
384 user['urn'] = user['urn'].lower()
385 hrn, type = urn_to_hrn(user['urn'])
386 username = get_leaf(hrn)
387 login_base = PlXrn(xrn=user['urn']).pl_login_base()
388 user['username'] = username
389 user['site'] = login_base
392 user['email'] = user['email'].lower()
393 users_by_email[user['email']] = user
394 users_dict[user['email']] = user
396 users_by_site[user['site']].append(user)
398 # start building a list of existing users
399 existing_user_ids = []
400 existing_user_ids_filter = []
402 existing_user_ids_filter.extend(users_by_email.keys())
404 for login_base in users_by_site:
405 users = users_by_site[login_base]
407 existing_user_ids_filter.append(user['username']+'@geni.net')
408 if existing_user_ids_filter:
409 # get existing users by email
410 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
411 ['person_id', 'key_ids', 'email'])
412 existing_user_ids.extend([user['email'] for user in existing_users])
415 # get a list of user sites (based on requeste user urns
416 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
417 ['site_id', 'login_base', 'person_ids'])
418 # get all existing users at these sites
421 for site in site_list:
422 sites[site['site_id']] = site
423 site_user_ids.extend(site['person_ids'])
425 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
426 ['person_id', 'key_ids', 'email', 'site_ids'])
428 # all requested users are either existing users or new (added) users
429 for login_base in users_by_site:
430 requested_site_users = users_by_site[login_base]
431 for requested_user in requested_site_users:
433 for existing_user in existing_site_persons_list:
434 for site_id in existing_user['site_ids']:
436 site = sites[site_id]
437 if login_base == site['login_base'] and \
438 existing_user['email'].startswith(requested_user['username']+'@'):
439 existing_user_ids.append(existing_user['email'])
440 requested_user['email'] = existing_user['email']
441 users_dict[existing_user['email']] = requested_user
447 if user_found == False:
448 fake_email = requested_user['username'] + '@geni.net'
449 requested_user['email'] = fake_email
450 users_dict[fake_email] = requested_user
452 # requested slice users
453 requested_user_ids = users_dict.keys()
454 # existing slice users
455 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
456 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
457 ['person_id', 'key_ids', 'email'])
458 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
460 # users to be added, removed or updated
461 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
462 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
463 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
464 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
466 # Remove stale users (only if we are not appending).
468 append = options.get('append', True)
470 for removed_user_id in removed_user_ids:
471 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
472 # update_existing users
473 updated_users_list = [user for user in users_dict.values() if user['email'] in \
475 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
479 for added_user_id in added_user_ids:
480 added_user = users_dict[added_user_id]
481 hrn, type = urn_to_hrn(added_user['urn'])
483 'first_name': added_user.get('first_name', hrn),
484 'last_name': added_user.get('last_name', hrn),
485 'email': added_user_id,
486 'peer_person_id': None,
488 'key_ids': added_user.get('key_ids', []),
490 person['person_id'] = self.driver.shell.AddPerson(person)
492 person['peer_person_id'] = added_user['person_id']
493 added_persons.append(person)
496 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
499 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
501 for key_string in added_user.get('keys', []):
502 key = {'key':key_string, 'key_type':'ssh'}
503 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
504 person['keys'].append(key)
506 # add the registry record
508 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
509 # 'pointer': person['person_id']}
510 # self.registry.register_peer_object(self.credential, peer_dict)
512 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
513 # add person to the slice
514 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
515 # if this is a peer record then it should already be bound to a peer.
516 # no need to return worry about it getting bound later
521 def verify_keys(self, persons, users, peer, options={}):
524 for person in persons:
525 key_ids.extend(person['key_ids'])
526 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
529 keydict[key['key']] = key['key_id']
530 existing_keys = keydict.keys()
532 for person in persons:
533 persondict[person['email']] = person
539 user_keys = user.get('keys', [])
540 updated_persons.append(user)
541 for key_string in user_keys:
542 requested_keys.append(key_string)
543 if key_string not in existing_keys:
544 key = {'key': key_string, 'key_type': 'ssh'}
547 person = persondict[user['email']]
548 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
549 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
551 key_index = user_keys.index(key['key'])
552 remote_key_id = user['key_ids'][key_index]
553 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
557 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
559 # remove old keys (only if we are not appending)
560 append = options.get('append', True)
562 removed_keys = set(existing_keys).difference(requested_keys)
563 for existing_key_id in keydict:
564 if keydict[existing_key_id] in removed_keys:
567 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
568 self.driver.shell.DeleteKey(existing_key_id)
572 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
573 append = options.get('append', True)
574 # get list of attributes users ar able to manage
575 filter = {'category': '*slice*'}
577 filter['|roles'] = ['user']
578 slice_attributes = self.driver.shell.GetTagTypes(filter)
579 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
581 # get sliver attributes
582 added_slice_attributes = []
583 removed_slice_attributes = []
584 ignored_slice_attribute_names = []
585 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
587 # get attributes that should be removed
588 for slice_tag in existing_slice_attributes:
589 if slice_tag['tagname'] in ignored_slice_attribute_names:
590 # If a slice already has a admin only role it was probably given to them by an
591 # admin, so we should ignore it.
592 ignored_slice_attribute_names.append(slice_tag['tagname'])
594 # If an existing slice attribute was not found in the request it should
596 attribute_found=False
597 for requested_attribute in requested_slice_attributes:
598 if requested_attribute['name'] == slice_tag['tagname'] and \
599 requested_attribute['value'] == slice_tag['value']:
603 if not attribute_found and not append:
604 removed_slice_attributes.append(slice_tag)
606 # get attributes that should be added:
607 for requested_attribute in requested_slice_attributes:
608 # if the requested attribute wasn't found we should add it
609 if requested_attribute['name'] in valid_slice_attribute_names:
610 attribute_found = False
611 for existing_attribute in existing_slice_attributes:
612 if requested_attribute['name'] == existing_attribute['tagname'] and \
613 requested_attribute['value'] == existing_attribute['value']:
616 if not attribute_found:
617 added_slice_attributes.append(requested_attribute)
620 # remove stale attributes
621 for attribute in removed_slice_attributes:
623 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
625 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
626 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
628 # add requested_attributes
629 for attribute in added_slice_attributes:
631 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
633 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
634 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))