2 from types import StringTypes
3 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
8 from sfa.rspecs.rspec import RSpec
9 from sfa.planetlab.vlink import VLink
10 from sfa.planetlab.topology import Topology
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname
12 from sfa.storage.model import SliverAllocation
13 from sfa.storage.alchemy import dbsession
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_urn, slice, rspec_nodes, peer):
222 for node in rspec_nodes:
223 hostname = node.get('component_name')
224 client_id = node.get('client_id')
225 component_id = node.get('component_id').strip()
227 hostname = hostname.strip()
229 hostname = xrn_to_hostname(component_id)
231 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
233 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
234 current_slivers = [node['hostname'] for node in nodes]
236 # remove nodes not in rspec
237 deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
239 # add nodes from rspec
240 added_nodes = list(set(slivers.keys()).difference(current_slivers))
244 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
245 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
246 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
249 logger.log_exc('Failed to add/remove slice from nodes')
251 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
252 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
254 # update sliver allocations
255 for node in resulting_nodes:
256 client_id = slivers[node['hostname']]['client_id']
257 component_id = slivers[node['hostname']]['component_id']
258 sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
259 sliver_id = Xrn(sliver_hrn, type='sliver').urn
260 record = SliverAllocation(sliver_id=sliver_id, client_id=client_id,
261 component_id=component_id,
262 slice_urn = slice_urn,
263 allocation_state='geni_allocated')
265 return resulting_nodes
267 def free_egre_key(self):
269 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
270 used.add(int(tag['value']))
272 for i in range(1, 256):
277 raise KeyError("No more EGRE keys available")
281 def verify_slice_links(self, slice, requested_links, nodes):
283 if not requested_links:
286 # exit if links are not supported here
287 topology = Topology()
291 # build dict of nodes
295 nodes_dict[node['node_id']] = node
296 interface_ids.extend(node['interface_ids'])
297 # build dict of interfaces
298 interfaces = self.driver.shell.GetInterfaces(interface_ids)
300 for interface in interfaces:
301 interfaces_dict[interface['interface_id']] = interface
306 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
309 slice_tags.append({'name': 'netns', 'value': '1'})
312 # need to update the attribute string?
313 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
315 for link in requested_links:
316 # get the ip address of the first node in the link
317 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
319 ifname_parts = ifname1.split(':')
320 node_raw = ifname_parts[0]
322 if len(ifname_parts) > 1:
323 device = ifname_parts[1]
324 node_id = int(node_raw.replace('node', ''))
325 node = nodes_dict[node_id]
326 if1 = interfaces_dict[node['interface_ids'][0]]
328 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
330 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
332 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
333 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
335 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
339 def handle_peer(self, site, slice, persons, peer):
344 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
346 self.driver.shell.DeleteSite(site['site_id'])
352 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
354 self.driver.shell.DeleteSlice(slice['slice_id'])
358 for person in persons:
360 self.driver.shell.BindObjectToPeer('person',
361 person['person_id'], peer['shortname'], person['peer_person_id'])
363 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
365 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
367 self.driver.shell.DeleteKey(key['key_id'])
368 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
370 self.driver.shell.DeletePerson(person['person_id'])
375 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
376 (slice_hrn, type) = urn_to_hrn(slice_xrn)
377 site_hrn = get_authority(slice_hrn)
378 # login base can't be longer than 20 characters
379 slicename = hrn_to_pl_slicename(slice_hrn)
380 authority_name = slicename.split('_')[0]
381 login_base = authority_name[:20]
382 sites = self.driver.shell.GetSites(login_base)
384 # create new site record
385 site = {'name': 'geni.%s' % authority_name,
386 'abbreviated_name': authority_name,
387 'login_base': login_base,
391 'peer_site_id': None}
393 site['peer_site_id'] = slice_record.get('site_id', None)
394 site['site_id'] = self.driver.shell.AddSite(site)
395 # exempt federated sites from monitor policies
396 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
398 # # is this still necessary?
399 # # add record to the local registry
400 # if sfa_peer and slice_record:
401 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
402 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
403 # self.registry.register_peer_object(self.credential, peer_dict)
407 # unbind from peer so we can modify if necessary. Will bind back later
408 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
412 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, expiration, options={}):
413 slicename = hrn_to_pl_slicename(slice_hrn)
414 parts = slicename.split("_")
415 login_base = parts[0]
416 slices = self.driver.shell.GetSlices([slicename])
417 expires = int(datetime_to_epoch(utcparse(expiration)))
419 slice = {'name': slicename,
421 'description': 'No Description'}
423 slice['slice_id'] = self.driver.shell.AddSlice(slice)
424 slice['node_ids'] = []
425 slice['person_ids'] = []
426 if peer and slice_record:
427 slice['peer_slice_id'] = slice_record.get('slice_id', None)
429 self.driver.shell.UpdateSlice(slice['slice_id'], {'expires': expires})
432 if peer and slice_record:
433 slice['peer_slice_id'] = slice_record.get('slice_id', None)
434 # unbind from peer so we can modify if necessary. Will bind back later
435 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
437 #Update expiration if necessary
438 if slice['expires'] != expires:
439 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : expires})
443 #def get_existing_persons(self, users):
444 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
446 users_by_site = defaultdict(list)
449 user['urn'] = user['urn'].lower()
450 hrn, type = urn_to_hrn(user['urn'])
451 username = get_leaf(hrn)
452 login_base = PlXrn(xrn=user['urn']).pl_login_base()
453 user['username'] = username
454 user['site'] = login_base
457 user['email'] = user['email'].lower()
458 users_by_email[user['email']] = user
459 users_dict[user['email']] = user
461 users_by_site[user['site']].append(user)
463 # start building a list of existing users
464 existing_user_ids = []
465 existing_user_ids_filter = []
467 existing_user_ids_filter.extend(users_by_email.keys())
469 for login_base in users_by_site:
470 users = users_by_site[login_base]
472 existing_user_ids_filter.append(user['username']+'@geni.net')
473 if existing_user_ids_filter:
474 # get existing users by email
475 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
476 ['person_id', 'key_ids', 'email'])
477 existing_user_ids.extend([user['email'] for user in existing_users])
480 # get a list of user sites (based on requeste user urns
481 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
482 ['site_id', 'login_base', 'person_ids'])
483 # get all existing users at these sites
486 for site in site_list:
487 sites[site['site_id']] = site
488 site_user_ids.extend(site['person_ids'])
490 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
491 ['person_id', 'key_ids', 'email', 'site_ids'])
493 # all requested users are either existing users or new (added) users
494 for login_base in users_by_site:
495 requested_site_users = users_by_site[login_base]
496 for requested_user in requested_site_users:
498 for existing_user in existing_site_persons_list:
499 for site_id in existing_user['site_ids']:
501 site = sites[site_id]
502 if login_base == site['login_base'] and \
503 existing_user['email'].startswith(requested_user['username']+'@'):
504 existing_user_ids.append(existing_user['email'])
505 requested_user['email'] = existing_user['email']
506 users_dict[existing_user['email']] = requested_user
512 if user_found == False:
513 fake_email = requested_user['username'] + '@geni.net'
514 requested_user['email'] = fake_email
515 users_dict[fake_email] = requested_user
517 # requested slice users
518 requested_user_ids = users_dict.keys()
519 # existing slice users
520 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
521 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
522 ['person_id', 'key_ids', 'email'])
523 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
525 # users to be added, removed or updated
526 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
527 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
528 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
529 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
531 # Remove stale users (only if we are not appending).
533 append = options.get('append', True)
535 for removed_user_id in removed_user_ids:
536 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
537 # update_existing users
538 updated_users_list = [user for user in users_dict.values() if user['email'] in \
540 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
544 for added_user_id in added_user_ids:
545 added_user = users_dict[added_user_id]
546 hrn, type = urn_to_hrn(added_user['urn'])
548 'first_name': added_user.get('first_name', hrn),
549 'last_name': added_user.get('last_name', hrn),
550 'email': added_user_id,
551 'peer_person_id': None,
553 #'key_ids': added_user.get('key_ids', []),
555 person['person_id'] = self.driver.shell.AddPerson(person)
557 person['peer_person_id'] = added_user['person_id']
558 added_persons.append(person)
561 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
564 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
566 for key_string in added_user.get('keys', []):
567 key = {'key':key_string, 'key_type':'ssh'}
568 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
569 person['keys'].append(key)
571 # add the registry record
573 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
574 # 'pointer': person['person_id']}
575 # self.registry.register_peer_object(self.credential, peer_dict)
577 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
578 # add person to the slice
579 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
580 # if this is a peer record then it should already be bound to a peer.
581 # no need to return worry about it getting bound later
586 def verify_keys(self, persons, users, peer, options={}):
589 for person in persons:
590 key_ids.extend(person['key_ids'])
591 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
594 keydict[key['key']] = key['key_id']
595 existing_keys = keydict.keys()
597 for person in persons:
598 persondict[person['email']] = person
604 user_keys = user.get('keys', [])
605 updated_persons.append(user)
606 for key_string in user_keys:
607 requested_keys.append(key_string)
608 if key_string not in existing_keys:
609 key = {'key': key_string, 'key_type': 'ssh'}
612 person = persondict[user['email']]
613 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
614 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
616 key_index = user_keys.index(key['key'])
617 remote_key_id = user['key_ids'][key_index]
618 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
622 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
624 # remove old keys (only if we are not appending)
625 append = options.get('append', True)
627 removed_keys = set(existing_keys).difference(requested_keys)
628 for existing_key_id in keydict:
629 if keydict[existing_key_id] in removed_keys:
632 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
633 self.driver.shell.DeleteKey(existing_key_id)
637 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
638 append = options.get('append', True)
639 # get list of attributes users ar able to manage
640 filter = {'category': '*slice*'}
642 filter['|roles'] = ['user']
643 slice_attributes = self.driver.shell.GetTagTypes(filter)
644 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
646 # get sliver attributes
647 added_slice_attributes = []
648 removed_slice_attributes = []
649 ignored_slice_attribute_names = []
650 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
652 # get attributes that should be removed
653 for slice_tag in existing_slice_attributes:
654 if slice_tag['tagname'] in ignored_slice_attribute_names:
655 # If a slice already has a admin only role it was probably given to them by an
656 # admin, so we should ignore it.
657 ignored_slice_attribute_names.append(slice_tag['tagname'])
659 # If an existing slice attribute was not found in the request it should
661 attribute_found=False
662 for requested_attribute in requested_slice_attributes:
663 if requested_attribute['name'] == slice_tag['tagname'] and \
664 requested_attribute['value'] == slice_tag['value']:
668 if not attribute_found and not append:
669 removed_slice_attributes.append(slice_tag)
671 # get attributes that should be added:
672 for requested_attribute in requested_slice_attributes:
673 # if the requested attribute wasn't found we should add it
674 if requested_attribute['name'] in valid_slice_attribute_names:
675 attribute_found = False
676 for existing_attribute in existing_slice_attributes:
677 if requested_attribute['name'] == existing_attribute['tagname'] and \
678 requested_attribute['value'] == existing_attribute['value']:
681 if not attribute_found:
682 added_slice_attributes.append(requested_attribute)
685 # remove stale attributes
686 for attribute in removed_slice_attributes:
688 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
690 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
691 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
693 # add requested_attributes
694 for attribute in added_slice_attributes:
696 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
698 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
699 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))