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
11 from sfa.storage.model import SliverAllocation
12 from sfa.storage.alchemy import dbsession
18 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20 def __init__(self, driver):
23 def get_slivers(self, xrn, node=None):
24 hrn, type = urn_to_hrn(xrn)
26 slice_name = hrn_to_pl_slicename(hrn)
27 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
28 # of doing all of this?
29 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
31 # from PLCAPI.GetSlivers.get_slivers()
32 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
33 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
34 # Build up list of users and slice attributes
36 all_slice_tag_ids = set()
38 person_ids.update(slice['person_ids'])
39 all_slice_tag_ids.update(slice['slice_tag_ids'])
40 person_ids = list(person_ids)
41 all_slice_tag_ids = list(all_slice_tag_ids)
42 # Get user information
43 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
45 for person in all_persons_list:
46 all_persons[person['person_id']] = person
48 # Build up list of keys
50 for person in all_persons.values():
51 key_ids.update(person['key_ids'])
52 key_ids = list(key_ids)
53 # Get user account keys
54 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56 for key in all_keys_list:
57 all_keys[key['key_id']] = key
58 # Get slice attributes
59 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61 for slice_tag in all_slice_tags_list:
62 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
67 for person_id in slice['person_ids']:
68 if person_id in all_persons:
69 person = all_persons[person_id]
70 if not person['enabled']:
72 for key_id in person['key_ids']:
73 if key_id in all_keys:
74 key = all_keys[key_id]
75 keys += [{'key_type': key['key_type'],
78 # All (per-node and global) attributes for this slice
80 for slice_tag_id in slice['slice_tag_ids']:
81 if slice_tag_id in all_slice_tags:
82 slice_tags.append(all_slice_tags[slice_tag_id])
83 # Per-node sliver attributes take precedence over global
84 # slice attributes, so set them first.
85 # Then comes nodegroup slice attributes
86 # Followed by global slice attributes
87 sliver_attributes = []
90 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
91 sliver_attributes.append(sliver_attribute['tagname'])
92 attributes.append({'tagname': sliver_attribute['tagname'],
93 'value': sliver_attribute['value']})
95 # set nodegroup slice attributes
96 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
97 # Do not set any nodegroup slice attributes for
98 # which there is at least one sliver attribute
100 if slice_tag not in slice_tags:
101 attributes.append({'tagname': slice_tag['tagname'],
102 'value': slice_tag['value']})
104 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
105 # Do not set any global slice attributes for
106 # which there is at least one sliver attribute
108 if slice_tag['tagname'] not in sliver_attributes:
109 attributes.append({'tagname': slice_tag['tagname'],
110 'value': slice_tag['value']})
112 # XXX Sanity check; though technically this should be a system invariant
113 # checked with an assertion
114 if slice['expires'] > MAXINT: slice['expires']= MAXINT
118 'name': slice['name'],
119 'slice_id': slice['slice_id'],
120 'instantiation': slice['instantiation'],
121 'expires': slice['expires'],
123 'attributes': attributes
128 def get_peer(self, xrn):
129 hrn, type = urn_to_hrn(xrn)
130 # Becaues of myplc federation, we first need to determine if this
131 # slice belongs to out local plc or a myplc peer. We will assume it
132 # is a local site, unless we find out otherwise
135 # get this slice's authority (site)
136 slice_authority = get_authority(hrn)
138 # get this site's authority (sfa root authority or sub authority)
139 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_urn, slice, rspec_nodes, peer):
221 for node in rspec_nodes:
222 hostname = node.get('component_name')
223 client_id = node.get('client_id')
224 component_id = node.get('component_id').strip()
226 hostname = hostname.strip()
228 hostname = xrn_to_hostname(component_id)
230 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
232 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
233 current_slivers = [node['hostname'] for node in nodes]
235 # remove nodes not in rspec
236 deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
238 # add nodes from rspec
239 added_nodes = list(set(slivers.keys()).difference(current_slivers))
243 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
244 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
245 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
248 logger.log_exc('Failed to add/remove slice from nodes')
250 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
251 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
253 # update sliver allocations
254 for node in resulting_nodes:
255 client_id = slivers[node['hostname']]['client_id']
256 component_id = slivers[node['hostname']]['component_id']
257 sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
258 sliver_id = Xrn(sliver_hrn, type='sliver').urn
259 record = SliverAllocation(sliver_id=sliver_id, client_id=client_id,
260 component_id=component_id,
261 slice_urn = slice_urn,
262 allocation_state='geni_allocated')
264 return resulting_nodes
266 def free_egre_key(self):
268 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
269 used.add(int(tag['value']))
271 for i in range(1, 256):
276 raise KeyError("No more EGRE keys available")
280 def verify_slice_links(self, slice, requested_links, nodes):
282 if not requested_links:
285 # exit if links are not supported here
286 topology = Topology()
290 # build dict of nodes
294 nodes_dict[node['node_id']] = node
295 interface_ids.extend(node['interface_ids'])
296 # build dict of interfaces
297 interfaces = self.driver.shell.GetInterfaces(interface_ids)
299 for interface in interfaces:
300 interfaces_dict[interface['interface_id']] = interface
305 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
308 slice_tags.append({'name': 'netns', 'value': '1'})
311 # need to update the attribute string?
312 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
314 for link in requested_links:
315 # get the ip address of the first node in the link
316 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
317 ifname_parts = ifname1.split(':')
318 node_raw = ifname_parts[0]
320 if len(ifname_parts) > 1:
321 device = ifname_parts[1]
322 node_id = int(node_raw.replace('node', ''))
323 node = nodes_dict[node_id]
324 if1 = interfaces_dict[node['interface_ids'][0]]
326 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
328 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
330 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
331 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
333 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
337 def handle_peer(self, site, slice, persons, peer):
342 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
344 self.driver.shell.DeleteSite(site['site_id'])
350 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
352 self.driver.shell.DeleteSlice(slice['slice_id'])
356 for person in persons:
358 self.driver.shell.BindObjectToPeer('person',
359 person['person_id'], peer['shortname'], person['peer_person_id'])
361 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
363 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
365 self.driver.shell.DeleteKey(key['key_id'])
366 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
368 self.driver.shell.DeletePerson(person['person_id'])
373 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
374 (slice_hrn, type) = urn_to_hrn(slice_xrn)
375 site_hrn = get_authority(slice_hrn)
376 # login base can't be longer than 20 characters
377 slicename = hrn_to_pl_slicename(slice_hrn)
378 authority_name = slicename.split('_')[0]
379 login_base = authority_name[:20]
380 sites = self.driver.shell.GetSites(login_base)
382 # create new site record
383 site = {'name': 'geni.%s' % authority_name,
384 'abbreviated_name': authority_name,
385 'login_base': login_base,
389 'peer_site_id': None}
391 site['peer_site_id'] = slice_record.get('site_id', None)
392 site['site_id'] = self.driver.shell.AddSite(site)
393 # exempt federated sites from monitor policies
394 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
396 # # is this still necessary?
397 # # add record to the local registry
398 # if sfa_peer and slice_record:
399 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
400 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
401 # self.registry.register_peer_object(self.credential, peer_dict)
405 # unbind from peer so we can modify if necessary. Will bind back later
406 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
410 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, expiration, options={}):
411 slicename = hrn_to_pl_slicename(slice_hrn)
412 parts = slicename.split("_")
413 login_base = parts[0]
414 slices = self.driver.shell.GetSlices([slicename])
415 expires = int(datetime_to_epoch(utcparse(expiration)))
417 slice = {'name': slicename,
419 'description': 'No Description'}
421 slice['slice_id'] = self.driver.shell.AddSlice(slice)
422 slice['node_ids'] = []
423 slice['person_ids'] = []
424 if peer and slice_record:
425 slice['peer_slice_id'] = slice_record.get('slice_id', None)
427 self.driver.shell.UpdateSlice(slice['slice_id'], {'expires': expires})
430 if peer and slice_record:
431 slice['peer_slice_id'] = slice_record.get('slice_id', None)
432 # unbind from peer so we can modify if necessary. Will bind back later
433 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
435 #Update expiration if necessary
436 if slice['expires'] != expires:
437 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : expires})
441 #def get_existing_persons(self, users):
442 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
444 users_by_site = defaultdict(list)
447 user['urn'] = user['urn'].lower()
448 hrn, type = urn_to_hrn(user['urn'])
449 username = get_leaf(hrn)
450 login_base = PlXrn(xrn=user['urn']).pl_login_base()
451 user['username'] = username
452 user['site'] = login_base
455 user['email'] = user['email'].lower()
456 users_by_email[user['email']] = user
457 users_dict[user['email']] = user
459 users_by_site[user['site']].append(user)
461 # start building a list of existing users
462 existing_user_ids = []
463 existing_user_ids_filter = []
465 existing_user_ids_filter.extend(users_by_email.keys())
467 for login_base in users_by_site:
468 users = users_by_site[login_base]
470 existing_user_ids_filter.append(user['username']+'@geni.net')
471 if existing_user_ids_filter:
472 # get existing users by email
473 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
474 ['person_id', 'key_ids', 'email'])
475 existing_user_ids.extend([user['email'] for user in existing_users])
478 # get a list of user sites (based on requeste user urns
479 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
480 ['site_id', 'login_base', 'person_ids'])
481 # get all existing users at these sites
484 for site in site_list:
485 sites[site['site_id']] = site
486 site_user_ids.extend(site['person_ids'])
488 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
489 ['person_id', 'key_ids', 'email', 'site_ids'])
491 # all requested users are either existing users or new (added) users
492 for login_base in users_by_site:
493 requested_site_users = users_by_site[login_base]
494 for requested_user in requested_site_users:
496 for existing_user in existing_site_persons_list:
497 for site_id in existing_user['site_ids']:
499 site = sites[site_id]
500 if login_base == site['login_base'] and \
501 existing_user['email'].startswith(requested_user['username']+'@'):
502 existing_user_ids.append(existing_user['email'])
503 requested_user['email'] = existing_user['email']
504 users_dict[existing_user['email']] = requested_user
510 if user_found == False:
511 fake_email = requested_user['username'] + '@geni.net'
512 requested_user['email'] = fake_email
513 users_dict[fake_email] = requested_user
515 # requested slice users
516 requested_user_ids = users_dict.keys()
517 # existing slice users
518 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
519 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
520 ['person_id', 'key_ids', 'email'])
521 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
523 # users to be added, removed or updated
524 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
525 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
526 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
527 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
529 # Remove stale users (only if we are not appending).
531 append = options.get('append', True)
533 for removed_user_id in removed_user_ids:
534 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
535 # update_existing users
536 updated_users_list = [user for user in users_dict.values() if user['email'] in \
538 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
542 for added_user_id in added_user_ids:
543 added_user = users_dict[added_user_id]
544 hrn, type = urn_to_hrn(added_user['urn'])
546 'first_name': added_user.get('first_name', hrn),
547 'last_name': added_user.get('last_name', hrn),
548 'email': added_user_id,
549 'peer_person_id': None,
551 'key_ids': added_user.get('key_ids', []),
553 person['person_id'] = self.driver.shell.AddPerson(person)
555 person['peer_person_id'] = added_user['person_id']
556 added_persons.append(person)
559 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
562 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
564 for key_string in added_user.get('keys', []):
565 key = {'key':key_string, 'key_type':'ssh'}
566 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
567 person['keys'].append(key)
569 # add the registry record
571 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
572 # 'pointer': person['person_id']}
573 # self.registry.register_peer_object(self.credential, peer_dict)
575 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
576 # add person to the slice
577 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
578 # if this is a peer record then it should already be bound to a peer.
579 # no need to return worry about it getting bound later
584 def verify_keys(self, persons, users, peer, options={}):
587 for person in persons:
588 key_ids.extend(person['key_ids'])
589 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
592 keydict[key['key']] = key['key_id']
593 existing_keys = keydict.keys()
595 for person in persons:
596 persondict[person['email']] = person
602 user_keys = user.get('keys', [])
603 updated_persons.append(user)
604 for key_string in user_keys:
605 requested_keys.append(key_string)
606 if key_string not in existing_keys:
607 key = {'key': key_string, 'key_type': 'ssh'}
610 person = persondict[user['email']]
611 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
612 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
614 key_index = user_keys.index(key['key'])
615 remote_key_id = user['key_ids'][key_index]
616 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
620 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
622 # remove old keys (only if we are not appending)
623 append = options.get('append', True)
625 removed_keys = set(existing_keys).difference(requested_keys)
626 for existing_key_id in keydict:
627 if keydict[existing_key_id] in removed_keys:
630 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
631 self.driver.shell.DeleteKey(existing_key_id)
635 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
636 append = options.get('append', True)
637 # get list of attributes users ar able to manage
638 filter = {'category': '*slice*'}
640 filter['|roles'] = ['user']
641 slice_attributes = self.driver.shell.GetTagTypes(filter)
642 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
644 # get sliver attributes
645 added_slice_attributes = []
646 removed_slice_attributes = []
647 ignored_slice_attribute_names = []
648 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
650 # get attributes that should be removed
651 for slice_tag in existing_slice_attributes:
652 if slice_tag['tagname'] in ignored_slice_attribute_names:
653 # If a slice already has a admin only role it was probably given to them by an
654 # admin, so we should ignore it.
655 ignored_slice_attribute_names.append(slice_tag['tagname'])
657 # If an existing slice attribute was not found in the request it should
659 attribute_found=False
660 for requested_attribute in requested_slice_attributes:
661 if requested_attribute['name'] == slice_tag['tagname'] and \
662 requested_attribute['value'] == slice_tag['value']:
666 if not attribute_found and not append:
667 removed_slice_attributes.append(slice_tag)
669 # get attributes that should be added:
670 for requested_attribute in requested_slice_attributes:
671 # if the requested attribute wasn't found we should add it
672 if requested_attribute['name'] in valid_slice_attribute_names:
673 attribute_found = False
674 for existing_attribute in existing_slice_attributes:
675 if requested_attribute['name'] == existing_attribute['tagname'] and \
676 requested_attribute['value'] == existing_attribute['value']:
679 if not attribute_found:
680 added_slice_attributes.append(requested_attribute)
683 # remove stale attributes
684 for attribute in removed_slice_attributes:
686 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
688 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
689 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
691 # add requested_attributes
692 for attribute in added_slice_attributes:
694 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
696 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
697 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))