1 from types import StringTypes
2 from collections import defaultdict
4 from sfa.util.xrn import get_leaf, get_authority, urn_to_hrn
5 from sfa.util.plxrn import hrn_to_pl_slicename
6 from sfa.util.policy import Policy
7 from sfa.rspecs.rspec import RSpec
8 from sfa.plc.vlink import VLink
9 from sfa.util.xrn import Xrn
15 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
17 def __init__(self, api, ttl = .5, origin_hrn=None):
19 #filepath = path + os.sep + filename
20 self.policy = Policy(self.api)
21 self.origin_hrn = origin_hrn
22 self.registry = api.registries[api.hrn]
23 self.credential = api.getCredential()
27 def get_slivers(self, xrn, node=None):
28 hrn, type = urn_to_hrn(xrn)
30 slice_name = hrn_to_pl_slicename(hrn)
31 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
32 # of doing all of this?
33 #return self.api.driver.GetSliceTicket(self.auth, slice_name)
35 # from PLCAPI.GetSlivers.get_slivers()
36 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
37 slices = self.api.driver.GetSlices(slice_name, slice_fields)
38 # Build up list of users and slice attributes
40 all_slice_tag_ids = set()
42 person_ids.update(slice['person_ids'])
43 all_slice_tag_ids.update(slice['slice_tag_ids'])
44 person_ids = list(person_ids)
45 all_slice_tag_ids = list(all_slice_tag_ids)
46 # Get user information
47 all_persons_list = self.api.driver.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
49 for person in all_persons_list:
50 all_persons[person['person_id']] = person
52 # Build up list of keys
54 for person in all_persons.values():
55 key_ids.update(person['key_ids'])
56 key_ids = list(key_ids)
57 # Get user account keys
58 all_keys_list = self.api.driver.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
60 for key in all_keys_list:
61 all_keys[key['key_id']] = key
62 # Get slice attributes
63 all_slice_tags_list = self.api.driver.GetSliceTags(all_slice_tag_ids)
65 for slice_tag in all_slice_tags_list:
66 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
71 for person_id in slice['person_ids']:
72 if person_id in all_persons:
73 person = all_persons[person_id]
74 if not person['enabled']:
76 for key_id in person['key_ids']:
77 if key_id in all_keys:
78 key = all_keys[key_id]
79 keys += [{'key_type': key['key_type'],
82 # All (per-node and global) attributes for this slice
84 for slice_tag_id in slice['slice_tag_ids']:
85 if slice_tag_id in all_slice_tags:
86 slice_tags.append(all_slice_tags[slice_tag_id])
87 # Per-node sliver attributes take precedence over global
88 # slice attributes, so set them first.
89 # Then comes nodegroup slice attributes
90 # Followed by global slice attributes
91 sliver_attributes = []
94 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
95 sliver_attributes.append(sliver_attribute['tagname'])
96 attributes.append({'tagname': sliver_attribute['tagname'],
97 'value': sliver_attribute['value']})
99 # set nodegroup slice attributes
100 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
101 # Do not set any nodegroup slice attributes for
102 # which there is at least one sliver attribute
104 if slice_tag not in slice_tags:
105 attributes.append({'tagname': slice_tag['tagname'],
106 'value': slice_tag['value']})
108 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
109 # Do not set any global slice attributes for
110 # which there is at least one sliver attribute
112 if slice_tag['tagname'] not in sliver_attributes:
113 attributes.append({'tagname': slice_tag['tagname'],
114 'value': slice_tag['value']})
116 # XXX Sanity check; though technically this should be a system invariant
117 # checked with an assertion
118 if slice['expires'] > MAXINT: slice['expires']= MAXINT
122 'name': slice['name'],
123 'slice_id': slice['slice_id'],
124 'instantiation': slice['instantiation'],
125 'expires': slice['expires'],
127 'attributes': attributes
132 def get_peer(self, xrn):
133 hrn, type = urn_to_hrn(xrn)
134 # Becaues of myplc federation, we first need to determine if this
135 # slice belongs to out local plc or a myplc peer. We will assume it
136 # is a local site, unless we find out otherwise
139 # get this slice's authority (site)
140 slice_authority = get_authority(hrn)
142 # get this site's authority (sfa root authority or sub authority)
143 site_authority = get_authority(slice_authority).lower()
145 # check if we are already peered with this site_authority, if so
146 peers = self.api.driver.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
147 for peer_record in peers:
148 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
149 if site_authority in names:
154 def get_sfa_peer(self, xrn):
155 hrn, type = urn_to_hrn(xrn)
157 # return the authority for this hrn or None if we are the authority
159 slice_authority = get_authority(hrn)
160 site_authority = get_authority(slice_authority)
162 if site_authority != self.api.hrn:
163 sfa_peer = site_authority
167 def verify_slice_nodes(self, slice, requested_slivers, peer):
169 nodes = self.api.driver.GetNodes(slice['node_ids'], ['hostname'])
170 current_slivers = [node['hostname'] for node in nodes]
172 # remove nodes not in rspec
173 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
175 # add nodes from rspec
176 added_nodes = list(set(requested_slivers).difference(current_slivers))
180 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
181 self.api.driver.AddSliceToNodes(slice['name'], added_nodes)
182 self.api.driver.DeleteSliceFromNodes(slice['name'], deleted_nodes)
185 self.api.logger.log_exc('Failed to add/remove slice from nodes')
187 def free_egre_key(self):
189 for tag in self.api.driver.GetSliceTags({'tagname': 'egre_key'}):
190 used.add(int(tag['value']))
192 for i in range(1, 256):
197 raise KeyError("No more EGRE keys available")
201 def verify_slice_links(self, slice, links, aggregate):
202 # nodes is undefined here
209 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
212 slice_tags.append({'name': 'netns', 'value': '1'})
215 # need to update the attribute string?
216 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
219 # get the ip address of the first node in the link
220 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
221 (node, device) = ifname1.split(':')
222 node_id = int(node.replace('node', ''))
223 node = aggregate.nodes[node_id]
224 if1 = aggregate.interfaces[node['interface_ids'][0]]
226 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
228 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
230 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
231 #self.api.driver.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
233 self.verify_slice_attributes(slice, slice_tags, append=True, admin=True)
237 def handle_peer(self, site, slice, persons, peer):
242 self.api.driver.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
244 self.api.driver.DeleteSite(site['site_id'])
250 self.api.driver.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
252 self.api.driver.DeleteSlice(slice['slice_id'])
256 for person in persons:
258 self.api.driver.BindObjectToPeer('person',
259 person['person_id'], peer['shortname'], person['peer_person_id'])
261 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
263 self.api.driver.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
265 self.api.driver.DeleteKey(key['key_id'])
266 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
268 self.api.driver.DeletePerson(person['person_id'])
273 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None):
274 (slice_hrn, type) = urn_to_hrn(slice_xrn)
275 site_hrn = get_authority(slice_hrn)
276 # login base can't be longer than 20 characters
277 slicename = hrn_to_pl_slicename(slice_hrn)
278 authority_name = slicename.split('_')[0]
279 login_base = authority_name[:20]
280 sites = self.api.driver.GetSites(login_base)
282 # create new site record
283 site = {'name': 'geni.%s' % authority_name,
284 'abbreviated_name': authority_name,
285 'login_base': login_base,
289 'peer_site_id': None}
291 site['peer_site_id'] = slice_record.get('site_id', None)
292 site['site_id'] = self.api.driver.AddSite(site)
293 # exempt federated sites from monitor policies
294 self.api.driver.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
296 # is this still necessary?
297 # add record to the local registry
298 if sfa_peer and slice_record:
299 peer_dict = {'type': 'authority', 'hrn': site_hrn, \
300 'peer_authority': sfa_peer, 'pointer': site['site_id']}
301 self.registry.register_peer_object(self.credential, peer_dict)
305 # unbind from peer so we can modify if necessary. Will bind back later
306 self.api.driver.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
310 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer):
311 slicename = hrn_to_pl_slicename(slice_hrn)
312 parts = slicename.split("_")
313 login_base = parts[0]
314 slices = self.api.driver.GetSlices([slicename])
316 slice = {'name': slicename,
317 'url': slice_record.get('url', slice_hrn),
318 'description': slice_record.get('description', slice_hrn)}
320 slice['slice_id'] = self.api.driver.AddSlice(slice)
321 slice['node_ids'] = []
322 slice['person_ids'] = []
324 slice['peer_slice_id'] = slice_record.get('slice_id', None)
325 # mark this slice as an sfa peer record
327 peer_dict = {'type': 'slice', 'hrn': slice_hrn,
328 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
329 self.registry.register_peer_object(self.credential, peer_dict)
333 slice['peer_slice_id'] = slice_record.get('slice_id', None)
334 # unbind from peer so we can modify if necessary. Will bind back later
335 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
336 #Update existing record (e.g. expires field) it with the latest info.
337 if slice_record and slice['expires'] != slice_record['expires']:
338 self.api.driver.UpdateSlice( slice['slice_id'], {'expires' : slice_record['expires']})
342 #def get_existing_persons(self, users):
343 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, append=True):
345 users_by_site = defaultdict(list)
349 if 'append' in user and user['append'] == False:
352 users_by_email[user['email']] = user
353 users_dict[user['email']] = user
355 hrn, type = urn_to_hrn(user['urn'])
356 username = get_leaf(hrn)
357 login_base = get_leaf(get_authority(user['urn']))
358 user['username'] = username
359 users_by_site[login_base].append(user)
361 existing_user_ids = []
363 # get existing users by email
364 existing_users = self.api.driver.GetPersons({'email': users_by_email.keys()},
365 ['person_id', 'key_ids', 'email'])
366 existing_user_ids.extend([user['email'] for user in existing_users])
369 # get a list of user sites (based on requeste user urns
370 site_list = self.api.driver.GetSites(users_by_site.keys(), \
371 ['site_id', 'login_base', 'person_ids'])
375 # get all existing users at these sites
376 for site in site_list:
377 sites[site['site_id']] = site
378 site_user_ids.extend(site['person_ids'])
380 existing_site_persons_list = self.api.driver.GetPersons(site_user_ids,
381 ['person_id', 'key_ids', 'email', 'site_ids'])
383 # all requested users are either existing users or new (added) users
384 for login_base in users_by_site:
385 requested_site_users = users_by_site[login_base]
386 for requested_user in requested_site_users:
388 for existing_user in existing_site_persons_list:
389 for site_id in existing_user['site_ids']:
390 site = sites[site_id]
391 if login_base == site['login_base'] and \
392 existing_user['email'].startswith(requested_user['username']):
393 existing_user_ids.append(existing_user['email'])
394 users_dict[existing_user['email']] = requested_user
400 if user_found == False:
401 fake_email = requested_user['username'] + '@geni.net'
402 users_dict[fake_email] = requested_user
405 # requested slice users
406 requested_user_ids = users_dict.keys()
407 # existing slice users
408 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
409 existing_slice_users = self.api.driver.GetPersons(existing_slice_users_filter,
410 ['person_id', 'key_ids', 'email'])
411 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
413 # users to be added, removed or updated
414 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
415 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
416 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
417 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
419 # Remove stale users (only if we are not appending).
421 for removed_user_id in removed_user_ids:
422 self.api.driver.DeletePersonFromSlice(removed_user_id, slice_record['name'])
423 # update_existing users
424 updated_users_list = [user for user in existing_slice_users if user['email'] in \
426 self.verify_keys(existing_slice_users, updated_users_list, peer, append)
430 for added_user_id in added_user_ids:
431 added_user = users_dict[added_user_id]
432 hrn, type = urn_to_hrn(added_user['urn'])
434 'first_name': added_user.get('first_name', hrn),
435 'last_name': added_user.get('last_name', hrn),
436 'email': added_user_id,
437 'peer_person_id': None,
439 'key_ids': added_user.get('key_ids', []),
441 person['person_id'] = self.api.driver.AddPerson(person)
443 person['peer_person_id'] = added_user['person_id']
444 added_persons.append(person)
447 self.api.driver.UpdatePerson(person['person_id'], {'enabled': True})
450 self.api.driver.AddPersonToSite(added_user_id, login_base)
452 for key_string in added_user.get('keys', []):
453 key = {'key':key_string, 'key_type':'ssh'}
454 key['key_id'] = self.api.driver.AddPersonKey(person['person_id'], key)
455 person['keys'].append(key)
457 # add the registry record
459 peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
460 'pointer': person['person_id']}
461 self.registry.register_peer_object(self.credential, peer_dict)
463 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
464 # add person to the slice
465 self.api.driver.AddPersonToSlice(added_slice_user_id, slice_record['name'])
466 # if this is a peer record then it should already be bound to a peer.
467 # no need to return worry about it getting bound later
472 def verify_keys(self, persons, users, peer, append=True):
475 for person in persons:
476 key_ids.extend(person['key_ids'])
477 keylist = self.api.driver.GetKeys(key_ids, ['key_id', 'key'])
480 keydict[key['key']] = key['key_id']
481 existing_keys = keydict.keys()
483 for person in persons:
484 persondict[person['email']] = person
490 user_keys = user.get('keys', [])
491 updated_persons.append(user)
492 for key_string in user_keys:
493 requested_keys.append(key_string)
494 if key_string not in existing_keys:
495 key = {'key': key_string, 'key_type': 'ssh'}
498 person = persondict[user['email']]
499 self.api.driver.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
500 key['key_id'] = self.api.driver.AddPersonKey(user['email'], key)
502 key_index = user_keys.index(key['key'])
503 remote_key_id = user['key_ids'][key_index]
504 self.api.driver.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
508 self.api.driver.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
510 # remove old keys (only if we are not appending)
512 removed_keys = set(existing_keys).difference(requested_keys)
513 for existing_key_id in keydict:
514 if keydict[existing_key_id] in removed_keys:
517 self.api.driver.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
518 self.api.driver.DeleteKey(existing_key_id)
522 def verify_slice_attributes(self, slice, requested_slice_attributes, append=False, admin=False):
523 # get list of attributes users ar able to manage
524 filter = {'category': '*slice*'}
526 filter['|roles'] = ['user']
527 slice_attributes = self.api.driver.GetTagTypes(filter)
528 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
530 # get sliver attributes
531 added_slice_attributes = []
532 removed_slice_attributes = []
533 ignored_slice_attribute_names = []
534 existing_slice_attributes = self.api.driver.GetSliceTags({'slice_id': slice['slice_id']})
536 # get attributes that should be removed
537 for slice_tag in existing_slice_attributes:
538 if slice_tag['tagname'] in ignored_slice_attribute_names:
539 # If a slice already has a admin only role it was probably given to them by an
540 # admin, so we should ignore it.
541 ignored_slice_attribute_names.append(slice_tag['tagname'])
543 # If an existing slice attribute was not found in the request it should
545 attribute_found=False
546 for requested_attribute in requested_slice_attributes:
547 if requested_attribute['name'] == slice_tag['tagname'] and \
548 requested_attribute['value'] == slice_tag['value']:
552 if not attribute_found and not append:
553 removed_slice_attributes.append(slice_tag)
555 # get attributes that should be added:
556 for requested_attribute in requested_slice_attributes:
557 # if the requested attribute wasn't found we should add it
558 if requested_attribute['name'] in valid_slice_attribute_names:
559 attribute_found = False
560 for existing_attribute in existing_slice_attributes:
561 if requested_attribute['name'] == existing_attribute['tagname'] and \
562 requested_attribute['value'] == existing_attribute['value']:
565 if not attribute_found:
566 added_slice_attributes.append(requested_attribute)
569 # remove stale attributes
570 for attribute in removed_slice_attributes:
572 self.api.driver.DeleteSliceTag(attribute['slice_tag_id'])
574 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
575 % (name, value, node_id, str(e)))
577 # add requested_attributes
578 for attribute in added_slice_attributes:
580 self.api.driver.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
582 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
583 % (name, value, node_id, str(e)))
585 def create_slice_aggregate(self, xrn, rspec):
586 hrn, type = urn_to_hrn(xrn)
587 # Determine if this is a peer slice
588 peer = self.get_peer(hrn)
589 sfa_peer = self.get_sfa_peer(hrn)
592 # Get the slice record from sfa
593 slicename = hrn_to_pl_slicename(hrn)
596 registry = self.api.registries[self.api.hrn]
597 credential = self.api.getCredential()
599 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
600 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
602 # find out where this slice is currently running
603 nodelist = self.api.driver.GetNodes(slice['node_ids'], ['hostname'])
604 hostnames = [node['hostname'] for node in nodelist]
606 # get netspec details
607 nodespecs = spec.getDictsByTagName('NodeSpec')
609 # dict in which to store slice attributes to set for the nodes
611 for nodespec in nodespecs:
612 if isinstance(nodespec['name'], list):
613 for nodename in nodespec['name']:
615 for k in nodespec.keys():
616 rspec_attribute_value = nodespec[k]
617 if (self.rspec_to_slice_tag.has_key(k)):
618 slice_tag_name = self.rspec_to_slice_tag[k]
619 nodes[nodename][slice_tag_name] = rspec_attribute_value
620 elif isinstance(nodespec['name'], StringTypes):
621 nodename = nodespec['name']
623 for k in nodespec.keys():
624 rspec_attribute_value = nodespec[k]
625 if (self.rspec_to_slice_tag.has_key(k)):
626 slice_tag_name = self.rspec_to_slice_tag[k]
627 nodes[nodename][slice_tag_name] = rspec_attribute_value
629 for k in nodespec.keys():
630 rspec_attribute_value = nodespec[k]
631 if (self.rspec_to_slice_tag.has_key(k)):
632 slice_tag_name = self.rspec_to_slice_tag[k]
633 nodes[nodename][slice_tag_name] = rspec_attribute_value
635 node_names = nodes.keys()
636 # remove nodes not in rspec
637 deleted_nodes = list(set(hostnames).difference(node_names))
638 # add nodes from rspec
639 added_nodes = list(set(node_names).difference(hostnames))
643 self.api.driver.UnBindObjectFromPeer('slice', slice['slice_id'], peer)
645 self.api.driver.AddSliceToNodes(slicename, added_nodes)
647 # Add recognized slice tags
648 for node_name in node_names:
649 node = nodes[node_name]
650 for slice_tag in node.keys():
651 value = node[slice_tag]
652 if (isinstance(value, list)):
655 self.api.driver.AddSliceTag(slicename, slice_tag, value, node_name)
657 self.api.driver.DeleteSliceFromNodes(slicename, deleted_nodes)
660 self.api.driver.BindObjectToPeer('slice', slice['slice_id'], peer, slice['peer_slice_id'])