1 from types import StringTypes
2 from collections import defaultdict
5 from sfa.util.sfatime import utcparse, datetime_to_epoch
6 from sfa.util.sfalogging import logger
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
9 from sfa.rspecs.rspec import RSpec
11 from sfa.planetlab.vlink import VLink
12 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname
20 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
22 def __init__(self, driver):
25 def get_slivers(self, xrn, node=None):
26 hrn, type = urn_to_hrn(xrn)
28 slice_name = hrn_to_pl_slicename(hrn)
29 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
30 # of doing all of this?
31 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
33 # from PLCAPI.GetSlivers.get_slivers()
34 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
35 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
36 # Build up list of users and slice attributes
38 all_slice_tag_ids = set()
40 person_ids.update(slice['person_ids'])
41 all_slice_tag_ids.update(slice['slice_tag_ids'])
42 person_ids = list(person_ids)
43 all_slice_tag_ids = list(all_slice_tag_ids)
44 # Get user information
45 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
47 for person in all_persons_list:
48 all_persons[person['person_id']] = person
50 # Build up list of keys
52 for person in all_persons.values():
53 key_ids.update(person['key_ids'])
54 key_ids = list(key_ids)
55 # Get user account keys
56 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
58 for key in all_keys_list:
59 all_keys[key['key_id']] = key
60 # Get slice attributes
61 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
63 for slice_tag in all_slice_tags_list:
64 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
69 for person_id in slice['person_ids']:
70 if person_id in all_persons:
71 person = all_persons[person_id]
72 if not person['enabled']:
74 for key_id in person['key_ids']:
75 if key_id in all_keys:
76 key = all_keys[key_id]
77 keys += [{'key_type': key['key_type'],
80 # All (per-node and global) attributes for this slice
82 for slice_tag_id in slice['slice_tag_ids']:
83 if slice_tag_id in all_slice_tags:
84 slice_tags.append(all_slice_tags[slice_tag_id])
85 # Per-node sliver attributes take precedence over global
86 # slice attributes, so set them first.
87 # Then comes nodegroup slice attributes
88 # Followed by global slice attributes
89 sliver_attributes = []
92 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
93 sliver_attributes.append(sliver_attribute['tagname'])
94 attributes.append({'tagname': sliver_attribute['tagname'],
95 'value': sliver_attribute['value']})
97 # set nodegroup slice attributes
98 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
99 # Do not set any nodegroup slice attributes for
100 # which there is at least one sliver attribute
102 if slice_tag not in slice_tags:
103 attributes.append({'tagname': slice_tag['tagname'],
104 'value': slice_tag['value']})
106 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
107 # Do not set any global slice attributes for
108 # which there is at least one sliver attribute
110 if slice_tag['tagname'] not in sliver_attributes:
111 attributes.append({'tagname': slice_tag['tagname'],
112 'value': slice_tag['value']})
114 # XXX Sanity check; though technically this should be a system invariant
115 # checked with an assertion
116 if slice['expires'] > MAXINT: slice['expires']= MAXINT
120 'name': slice['name'],
121 'slice_id': slice['slice_id'],
122 'instantiation': slice['instantiation'],
123 'expires': slice['expires'],
125 'attributes': attributes
130 def get_peer(self, xrn):
131 hrn, type = urn_to_hrn(xrn)
132 # Becaues of myplc federation, we first need to determine if this
133 # slice belongs to out local plc or a myplc peer. We will assume it
134 # 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()
141 # check if we are already peered with this site_authority, if so
142 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
143 for peer_record in peers:
144 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
145 if site_authority in names:
150 def get_sfa_peer(self, xrn):
151 hrn, type = urn_to_hrn(xrn)
153 # return the authority for this hrn or None if we are the authority
155 slice_authority = get_authority(hrn)
156 site_authority = get_authority(slice_authority)
158 if site_authority != self.driver.hrn:
159 sfa_peer = site_authority
163 def verify_slice_leases(self, slice, rspec_requested_leases, peer):
165 leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
166 grain = self.driver.shell.GetLeaseGranularity()
168 requested_leases = []
169 for lease in rspec_requested_leases:
171 slice_name = hrn_to_pl_slicename(lease['slice_id'])
172 if slice_name != slice['name']:
174 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
177 hostname = xrn_to_hostname(lease['component_id'])
178 # fill the requested node with nitos ids
179 requested_lease['name'] = slice['name']
180 requested_lease['hostname'] = hostname
181 requested_lease['t_from'] = int(lease['start_time'])
182 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
183 requested_leases.append(requested_lease)
187 # prepare actual slice leases by lease_id
190 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
191 't_from': lease['t_from'], 't_until': lease['t_until']}
195 deleted_leases_id = []
196 for lease_id in leases_by_id:
197 if leases_by_id[lease_id] not in requested_leases:
198 deleted_leases_id.append(lease_id)
200 kept_leases_id.append(lease_id)
201 requested_leases.remove(leases_by_id[lease_id])
202 added_leases = requested_leases
207 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
208 self.driver.shell.DeleteLeases(deleted_leases_id)
209 for lease in added_leases:
210 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
213 logger.log_exc('Failed to add/remove slice leases')
218 def verify_slice_nodes(self, slice, slivers, peer):
220 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
221 current_slivers = [node['hostname'] for node in nodes]
223 requested_slivers = []
227 if node.get('component_name'):
228 hostname = node.get('component_name').strip()
229 elif node.get('component_id'):
230 hostname = xrn_to_hostname(node.get('component_id').strip())
231 if node.get('client_id'):
232 tags.append({'slicename': slice['name'],
233 'tagname': 'client_id',
234 'value': node['client_id'],
237 requested_slivers.append(hostname)
239 # remove nodes not in rspec
240 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
242 # add nodes from rspec
243 added_nodes = list(set(requested_slivers).difference(current_slivers))
247 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
248 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
249 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
252 logger.log_exc('Failed to add/remove slice from nodes')
257 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node'])
259 logger.log_exc('Failed to add slice tag')
262 def free_egre_key(self):
264 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
265 used.add(int(tag['value']))
267 for i in range(1, 256):
272 raise KeyError("No more EGRE keys available")
276 def verify_slice_links(self, slice, requested_links, nodes):
277 # nodes is undefined here
278 if not requested_links:
281 # build dict of nodes
285 nodes_dict[node['node_id']] = node
286 interface_ids.extend(node['interface_ids'])
287 # build dict of interfaces
288 interfaces = self.driver.shell.GetInterfaces(interface_ids)
290 for interface in interfaces:
291 interfaces_dict[interface['interface_id']] = interface
296 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
299 slice_tags.append({'name': 'netns', 'value': '1'})
302 # need to update the attribute string?
303 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
305 for link in requested_links:
306 # get the ip address of the first node in the link
307 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
308 (node_raw, device) = ifname1.split(':')
309 node_id = int(node_raw.replace('node', ''))
310 node = nodes_dict[node_id]
311 if1 = interfaces_dict[node['interface_ids'][0]]
313 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
315 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
317 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
318 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
320 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
324 def handle_peer(self, site, slice, persons, peer):
329 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
331 self.driver.shell.DeleteSite(site['site_id'])
337 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
339 self.driver.shell.DeleteSlice(slice['slice_id'])
343 for person in persons:
345 self.driver.shell.BindObjectToPeer('person',
346 person['person_id'], peer['shortname'], person['peer_person_id'])
348 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
350 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
352 self.driver.shell.DeleteKey(key['key_id'])
353 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
355 self.driver.shell.DeletePerson(person['person_id'])
360 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
361 (slice_hrn, type) = urn_to_hrn(slice_xrn)
362 site_hrn = get_authority(slice_hrn)
363 # login base can't be longer than 20 characters
364 slicename = hrn_to_pl_slicename(slice_hrn)
365 authority_name = slicename.split('_')[0]
366 login_base = authority_name[:20]
367 sites = self.driver.shell.GetSites(login_base)
369 # create new site record
370 site = {'name': 'geni.%s' % authority_name,
371 'abbreviated_name': authority_name,
372 'login_base': login_base,
376 'peer_site_id': None}
378 site['peer_site_id'] = slice_record.get('site_id', None)
379 site['site_id'] = self.driver.shell.AddSite(site)
380 # exempt federated sites from monitor policies
381 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
383 # # is this still necessary?
384 # # add record to the local registry
385 # if sfa_peer and slice_record:
386 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
387 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
388 # self.registry.register_peer_object(self.credential, peer_dict)
392 # unbind from peer so we can modify if necessary. Will bind back later
393 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
397 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
398 slicename = hrn_to_pl_slicename(slice_hrn)
399 parts = slicename.split("_")
400 login_base = parts[0]
401 slices = self.driver.shell.GetSlices([slicename])
403 slice = {'name': slicename,
404 'url': slice_record.get('url', slice_hrn),
405 'description': slice_record.get('description', slice_hrn)}
407 slice['slice_id'] = self.driver.shell.AddSlice(slice)
408 slice['node_ids'] = []
409 slice['person_ids'] = []
411 slice['peer_slice_id'] = slice_record.get('slice_id', None)
412 # mark this slice as an sfa peer record
414 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
415 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
416 # self.registry.register_peer_object(self.credential, peer_dict)
420 slice['peer_slice_id'] = slice_record.get('slice_id', None)
421 # unbind from peer so we can modify if necessary. Will bind back later
422 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
423 #Update existing record (e.g. expires field) it with the latest info.
424 if slice_record.get('expires'):
425 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
426 if requested_expires and slice['expires'] != requested_expires:
427 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
431 #def get_existing_persons(self, users):
432 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
434 users_by_site = defaultdict(list)
437 user['urn'] = user['urn'].lower()
438 hrn, type = urn_to_hrn(user['urn'])
439 username = get_leaf(hrn)
440 login_base = PlXrn(xrn=user['urn']).pl_login_base()
441 user['username'] = username
442 user['site'] = login_base
445 user['email'] = user['email'].lower()
446 users_by_email[user['email']] = user
447 users_dict[user['email']] = user
449 users_by_site[user['site']].append(user)
451 # start building a list of existing users
452 existing_user_ids = []
453 existing_user_ids_filter = []
455 existing_user_ids_filter.extend(users_by_email.keys())
457 for login_base in users_by_site:
458 users = users_by_site[login_base]
460 existing_user_ids_filter.append(user['username']+'@geni.net')
461 if existing_user_ids_filter:
462 # get existing users by email
463 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
464 ['person_id', 'key_ids', 'email'])
465 existing_user_ids.extend([user['email'] for user in existing_users])
468 # get a list of user sites (based on requeste user urns
469 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
470 ['site_id', 'login_base', 'person_ids'])
471 # get all existing users at these sites
474 for site in site_list:
475 sites[site['site_id']] = site
476 site_user_ids.extend(site['person_ids'])
478 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
479 ['person_id', 'key_ids', 'email', 'site_ids'])
481 # all requested users are either existing users or new (added) users
482 for login_base in users_by_site:
483 requested_site_users = users_by_site[login_base]
484 for requested_user in requested_site_users:
486 for existing_user in existing_site_persons_list:
487 for site_id in existing_user['site_ids']:
489 site = sites[site_id]
490 if login_base == site['login_base'] and \
491 existing_user['email'].startswith(requested_user['username']+'@'):
492 existing_user_ids.append(existing_user['email'])
493 requested_user['email'] = existing_user['email']
494 users_dict[existing_user['email']] = requested_user
500 if user_found == False:
501 fake_email = requested_user['username'] + '@geni.net'
502 requested_user['email'] = fake_email
503 users_dict[fake_email] = requested_user
505 # requested slice users
506 requested_user_ids = users_dict.keys()
507 # existing slice users
508 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
509 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
510 ['person_id', 'key_ids', 'email'])
511 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
513 # users to be added, removed or updated
514 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
515 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
516 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
517 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
519 # Remove stale users (only if we are not appending).
521 append = options.get('append', True)
523 for removed_user_id in removed_user_ids:
524 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
525 # update_existing users
526 updated_users_list = [user for user in users_dict.values() if user['email'] in \
528 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
532 for added_user_id in added_user_ids:
533 added_user = users_dict[added_user_id]
534 hrn, type = urn_to_hrn(added_user['urn'])
536 'first_name': added_user.get('first_name', hrn),
537 'last_name': added_user.get('last_name', hrn),
538 'email': added_user_id,
539 'peer_person_id': None,
541 'key_ids': added_user.get('key_ids', []),
543 person['person_id'] = self.driver.shell.AddPerson(person)
545 person['peer_person_id'] = added_user['person_id']
546 added_persons.append(person)
549 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
552 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
554 for key_string in added_user.get('keys', []):
555 key = {'key':key_string, 'key_type':'ssh'}
556 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
557 person['keys'].append(key)
559 # add the registry record
561 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
562 # 'pointer': person['person_id']}
563 # self.registry.register_peer_object(self.credential, peer_dict)
565 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
566 # add person to the slice
567 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
568 # if this is a peer record then it should already be bound to a peer.
569 # no need to return worry about it getting bound later
574 def verify_keys(self, persons, users, peer, options={}):
577 for person in persons:
578 key_ids.extend(person['key_ids'])
579 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
582 keydict[key['key']] = key['key_id']
583 existing_keys = keydict.keys()
585 for person in persons:
586 persondict[person['email']] = person
592 user_keys = user.get('keys', [])
593 updated_persons.append(user)
594 for key_string in user_keys:
595 requested_keys.append(key_string)
596 if key_string not in existing_keys:
597 key = {'key': key_string, 'key_type': 'ssh'}
600 person = persondict[user['email']]
601 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
602 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
604 key_index = user_keys.index(key['key'])
605 remote_key_id = user['key_ids'][key_index]
606 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
610 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
612 # remove old keys (only if we are not appending)
613 append = options.get('append', True)
615 removed_keys = set(existing_keys).difference(requested_keys)
616 for existing_key_id in keydict:
617 if keydict[existing_key_id] in removed_keys:
620 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
621 self.driver.shell.DeleteKey(existing_key_id)
625 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
626 append = options.get('append', True)
627 # get list of attributes users ar able to manage
628 filter = {'category': '*slice*'}
630 filter['|roles'] = ['user']
631 slice_attributes = self.driver.shell.GetTagTypes(filter)
632 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
634 # get sliver attributes
635 added_slice_attributes = []
636 removed_slice_attributes = []
637 ignored_slice_attribute_names = []
638 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
640 # get attributes that should be removed
641 for slice_tag in existing_slice_attributes:
642 if slice_tag['tagname'] in ignored_slice_attribute_names:
643 # If a slice already has a admin only role it was probably given to them by an
644 # admin, so we should ignore it.
645 ignored_slice_attribute_names.append(slice_tag['tagname'])
647 # If an existing slice attribute was not found in the request it should
649 attribute_found=False
650 for requested_attribute in requested_slice_attributes:
651 if requested_attribute['name'] == slice_tag['tagname'] and \
652 requested_attribute['value'] == slice_tag['value']:
656 if not attribute_found and not append:
657 removed_slice_attributes.append(slice_tag)
659 # get attributes that should be added:
660 for requested_attribute in requested_slice_attributes:
661 # if the requested attribute wasn't found we should add it
662 if requested_attribute['name'] in valid_slice_attribute_names:
663 attribute_found = False
664 for existing_attribute in existing_slice_attributes:
665 if requested_attribute['name'] == existing_attribute['tagname'] and \
666 requested_attribute['value'] == existing_attribute['value']:
669 if not attribute_found:
670 added_slice_attributes.append(requested_attribute)
673 # remove stale attributes
674 for attribute in removed_slice_attributes:
676 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
678 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
679 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
681 # add requested_attributes
682 for attribute in added_slice_attributes:
684 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
686 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
687 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))