6 from types import StringTypes
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn, urn_to_hrn
8 from sfa.util.plxrn import hrn_to_pl_slicename, hrn_to_pl_login_base
9 from sfa.util.specdict import *
10 from sfa.util.faults import *
11 from sfa.util.record import SfaRecord
12 from sfa.util.policy import Policy
13 from sfa.util.prefixTree import prefixTree
14 from collections import defaultdict
20 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
22 def __init__(self, api, ttl = .5, origin_hrn=None):
24 #filepath = path + os.sep + filename
25 self.policy = Policy(self.api)
26 self.origin_hrn = origin_hrn
27 self.registry = api.registries[api.hrn]
28 self.credential = api.getCredential()
30 def get_slivers(self, xrn, node=None):
31 hrn, type = urn_to_hrn(xrn)
33 slice_name = hrn_to_pl_slicename(hrn)
34 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
35 # of doing all of this?
36 #return self.api.GetSliceTicket(self.auth, slice_name)
38 # from PLCAPI.GetSlivers.get_slivers()
39 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
40 slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
41 # Build up list of users and slice attributes
43 all_slice_tag_ids = set()
45 person_ids.update(slice['person_ids'])
46 all_slice_tag_ids.update(slice['slice_tag_ids'])
47 person_ids = list(person_ids)
48 all_slice_tag_ids = list(all_slice_tag_ids)
49 # Get user information
50 all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
52 for person in all_persons_list:
53 all_persons[person['person_id']] = person
55 # Build up list of keys
57 for person in all_persons.values():
58 key_ids.update(person['key_ids'])
59 key_ids = list(key_ids)
60 # Get user account keys
61 all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
63 for key in all_keys_list:
64 all_keys[key['key_id']] = key
65 # Get slice attributes
66 all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
68 for slice_tag in all_slice_tags_list:
69 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
74 for person_id in slice['person_ids']:
75 if person_id in all_persons:
76 person = all_persons[person_id]
77 if not person['enabled']:
79 for key_id in person['key_ids']:
80 if key_id in all_keys:
81 key = all_keys[key_id]
82 keys += [{'key_type': key['key_type'],
85 # All (per-node and global) attributes for this slice
87 for slice_tag_id in slice['slice_tag_ids']:
88 if slice_tag_id in all_slice_tags:
89 slice_tags.append(all_slice_tags[slice_tag_id])
90 # Per-node sliver attributes take precedence over global
91 # slice attributes, so set them first.
92 # Then comes nodegroup slice attributes
93 # Followed by global slice attributes
94 sliver_attributes = []
97 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
98 sliver_attributes.append(sliver_attribute['tagname'])
99 attributes.append({'tagname': sliver_attribute['tagname'],
100 'value': sliver_attribute['value']})
102 # set nodegroup slice attributes
103 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
104 # Do not set any nodegroup slice attributes for
105 # which there is at least one sliver attribute
107 if slice_tag not in slice_tags:
108 attributes.append({'tagname': slice_tag['tagname'],
109 'value': slice_tag['value']})
111 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
112 # Do not set any global slice attributes for
113 # which there is at least one sliver attribute
115 if slice_tag['tagname'] not in sliver_attributes:
116 attributes.append({'tagname': slice_tag['tagname'],
117 'value': slice_tag['value']})
119 # XXX Sanity check; though technically this should be a system invariant
120 # checked with an assertion
121 if slice['expires'] > MAXINT: slice['expires']= MAXINT
125 'name': slice['name'],
126 'slice_id': slice['slice_id'],
127 'instantiation': slice['instantiation'],
128 'expires': slice['expires'],
130 'attributes': attributes
135 def get_peer(self, xrn):
136 hrn, type = urn_to_hrn(xrn)
137 # Becaues of myplc federation, we first need to determine if this
138 # slice belongs to out local plc or a myplc peer. We will assume it
139 # is a local site, unless we find out otherwise
142 # get this slice's authority (site)
143 slice_authority = get_authority(hrn)
145 # get this site's authority (sfa root authority or sub authority)
146 site_authority = get_authority(slice_authority).lower()
148 # check if we are already peered with this site_authority, if so
149 peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
150 for peer_record in peers:
151 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
152 if site_authority in names:
157 def get_sfa_peer(self, xrn):
158 hrn, type = urn_to_hrn(xrn)
160 # return the authority for this hrn or None if we are the authority
162 slice_authority = get_authority(hrn)
163 site_authority = get_authority(slice_authority)
165 if site_authority != self.api.hrn:
166 sfa_peer = site_authority
170 def verify_slice_nodes(self, slice, requested_slivers, peer):
172 nodes = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
173 current_slivers = [node['hostname'] for node in nodes]
175 # remove nodes not in rspec
176 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
178 # add nodes from rspec
179 added_nodes = list(set(requested_slivers).difference(current_slivers))
183 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer['shortname'])
184 self.api.plshell.AddSliceToNodes(self.api.plauth, slice['name'], added_nodes)
185 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slice['name'], deleted_nodes)
188 self.api.logger.log_exc('Failed to add/remove slice from nodes')
190 def handle_peer(self, site, slice, persons, peer):
195 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', \
196 site['site_id'], peer['shortname'], slice['site_id'])
198 self.api.plshell.DeleteSite(self.api.plauth, site['site_id'])
204 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', \
205 slice['slice_id'], peer['shortname'], slice['slice_id'])
207 self.api.plshell.DeleteSlice(self.api.plauth, slice['slice_id'])
211 for person in persons:
213 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', \
214 person['person_id'], peer['shortname'], person['peer_person_id'])
216 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
218 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key',\
219 key['key_id'], peer['shortname'], remote_key_id)
221 self.api.plshell.DeleteKey(self.api.plauth, key['key_id'])
222 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
224 self.api.plshell.DeletePerson(self.api.plauth, person['person_id'])
229 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None):
230 (slice_hrn, type) = urn_to_hrn(slice_xrn)
231 site_hrn = get_authority(slice_hrn)
232 # login base can't be longer than 20 characters
233 slicename = hrn_to_pl_slicename(slice_hrn)
234 authority_name = slicename.split('_')[0]
235 login_base = authority_name[:20]
236 sites = self.api.plshell.GetSites(self.api.plauth, login_base)
238 # create new site record
239 site = {'name': 'geni.%s' % authority_name,
240 'abbreviated_name': authority_name,
241 'login_base': login_base,
245 'peer_site_id': None}
247 site['peer_site_id'] = slice_record.get('site_id', None)
248 site['site_id'] = self.api.plshell.AddSite(self.api.plauth, site)
249 # exempt federated sites from monitor policies
250 self.api.plshell.AddSiteTag(self.api.plauth, site['site_id'], 'exempt_site_until', "20200101")
252 # is this still necessary?
253 # add record to the local registry
254 if sfa_peer and slice_record:
255 peer_dict = {'type': 'authority', 'hrn': site_hrn, \
256 'peer_authority': sfa_peer, 'pointer': site['site_id']}
257 self.registry.register_peer_object(self.credential, peer_dict)
261 # unbind from peer so we can modify if necessary. Will bind back later
262 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site['site_id'], peer['shortname'])
266 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer):
267 slicename = hrn_to_pl_slicename(slice_hrn)
268 parts = slicename.split("_")
269 login_base = parts[0]
270 slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
272 slice = {'name': slicename,
273 'url': slice_record.get('url', slice_hrn),
274 'description': slice_record.get('description', slice_hrn)}
276 slice['slice_id'] = self.api.plshell.AddSlice(self.api.plauth, slice)
277 slice['node_ids'] = []
278 slice['person_ids'] = []
280 slice['peer_slice_id'] = slice_record.get('slice_id', None)
281 # mark this slice as an sfa peer record
283 peer_dict = {'type': 'slice', 'hrn': slice_hrn,
284 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
285 self.registry.register_peer_object(self.credential, peer_dict)
289 slice['peer_slice_id'] = slice_record.get('slice_id', None)
290 # unbind from peer so we can modify if necessary. Will bind back later
291 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice',\
292 slice['slice_id'], peer['shortname'])
293 #Update existing record (e.g. expires field) it with the latest info.
294 if slice_record and slice['expires'] != slice_record['expires']:
295 self.api.plshell.UpdateSlice(self.api.plauth, slice['slice_id'],\
296 {'expires' : slice_record['expires']})
300 #def get_existing_persons(self, users):
301 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, append=True):
303 users_by_site = defaultdict(list)
307 if 'append' in user and user['append'] == False:
310 users_by_email[user['email']] = user
311 users_dict[user['email']] = user
313 hrn, type = urn_to_hrn(user['urn'])
314 username = get_leaf(hrn)
315 login_base = get_leaf(get_authority(user['urn']))
316 user['username'] = username
317 users_by_site[login_base].append(user)
319 existing_user_ids = []
321 # get existing users by email
322 existing_users = self.api.plshell.GetPersons(self.api.plauth, \
323 {'email': users_by_email.keys()}, ['person_id', 'key_ids', 'email'])
324 existing_user_ids.extend([user['email'] for user in existing_users])
327 # get a list of user sites (based on requeste user urns
328 site_list = self.api.plshell.GetSites(self.api.plauth, users_by_site.keys(), \
329 ['site_id', 'login_base', 'person_ids'])
333 # get all existing users at these sites
334 for site in site_list:
335 sites[site['site_id']] = site
336 site_user_ids.extend(site['person_ids'])
338 existing_site_persons_list = self.api.plshell.GetPersons(self.api.plauth, \
339 site_user_ids, ['person_id', 'key_ids', 'email', 'site_ids'])
341 # all requested users are either existing users or new (added) users
342 for login_base in users_by_site:
343 requested_site_users = users_by_site[login_base]
344 for requested_user in requested_site_users:
346 for existing_user in existing_site_persons_list:
347 for site_id in existing_user['site_ids']:
348 site = sites[site_id]
349 if login_base == site['login_base'] and \
350 existing_user['email'].startswith(requested_user['username']):
351 existing_user_ids.append(existing_user['email'])
352 users_dict[existing_user['email']] = requested_user
358 if user_found == False:
359 fake_email = requested_user['username'] + '@geni.net'
360 users_dict[fake_email] = requested_user
363 # requested slice users
364 requested_user_ids = users_dict.keys()
365 # existing slice users
366 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
367 existing_slice_users = self.api.plshell.GetPersons(self.api.plauth, \
368 existing_slice_users_filter, ['person_id', 'key_ids', 'email'])
369 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
371 # users to be added, removed or updated
372 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
373 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
374 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
375 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
377 # Remove stale users (only if we are not appending).
379 for removed_user_id in removed_user_ids:
380 self.api.plshell.DeletePersonFromSlice(self.api.plauth, removed_user_id, slice_record['name'])
381 # update_existing users
382 updated_users_list = [user for user in existing_slice_users if user['email'] in \
384 self.verify_keys(existing_slice_users, updated_users_list, peer, append)
388 for added_user_id in added_user_ids:
389 added_user = users_dict[added_user_id]
390 hrn, type = urn_to_hrn(added_user['urn'])
392 'first_name': added_user.get('first_name', hrn),
393 'last_name': added_user.get('last_name', hrn),
394 'email': added_user_id,
395 'peer_person_id': None,
397 'key_ids': added_user.get('key_ids', []),
399 person['person_id'] = self.api.plshell.AddPerson(self.api.plauth, person)
401 person['peer_person_id'] = added_user['person_id']
402 added_persons.append(person)
405 self.api.plshell.UpdatePerson(self.api.plauth, person['person_id'], {'enabled': True})
408 self.api.plshell.AddPersonToSite(self.api.plauth, added_user_id, login_base)
410 for key_string in added_user.get('keys', []):
411 key = {'key':key_string, 'key_type':'ssh'}
412 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, person['person_id'], key)
413 person['keys'].append(key)
415 # add the registry record
417 peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
418 'pointer': person['person_id']}
419 self.registry.register_peer_object(self.credential, peer_dict)
421 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
422 # add person to the slice
423 self.api.plshell.AddPersonToSlice(self.api.plauth, added_slice_user_id, slice_record['name'])
424 # if this is a peer record then it should already be bound to a peer.
425 # no need to return worry about it getting bound later
430 def verify_keys(self, persons, users, peer, append=True):
433 for person in persons:
434 key_ids.extend(person['key_ids'])
435 keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key'])
438 keydict[key['key']] = key['key_id']
439 existing_keys = keydict.keys()
441 for person in persons:
442 persondict[person['email']] = person
448 user_keys = user.get('keys', [])
449 updated_persons.append(user)
450 for key_string in user_keys:
451 requested_keys.append(key_string)
452 if key_string not in existing_keys:
453 key = {'key': key_string, 'key_type': 'ssh'}
456 person = persondict[user['email']]
457 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'])
458 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, user['email'], key)
460 key_index = user_keys.index(key['key'])
461 remote_key_id = user['key_ids'][key_index]
462 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key['key_id'], peer['shortname'], remote_key_id)
466 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'], user['person_id'])
468 # remove old keys (only if we are not appending)
470 removed_keys = set(existing_keys).difference(requested_keys)
471 for existing_key_id in keydict:
472 if keydict[existing_key_id] in removed_keys:
475 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'key', existing_key_id, peer['shortname'])
476 self.api.plshell.DeleteKey(self.api.plauth, existing_key_id)
480 def verify_slice_attributes(self, slice, requested_slice_attributes):
481 # get list of attributes users ar able to manage
482 slice_attributes = self.api.plshell.GetTagTypes(self.api.plauth, {'category': '*slice*', '|roles': ['user']})
483 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
485 # get sliver attributes
486 added_slice_attributes = []
487 removed_slice_attributes = []
488 ignored_slice_attribute_names = []
489 existing_slice_attributes = self.api.plshell.GetSliceTags(self.api.plauth, {'slice_id': slice['slice_id']})
491 # get attributes that should be removed
492 for slice_tag in existing_slice_attributes:
493 if slice_tag['tagname'] in ignored_slice_attribute_names:
494 # If a slice already has a admin only role it was probably given to them by an
495 # admin, so we should ignore it.
496 ignored_slice_attribute_names.append(slice_tag['tagname'])
498 # If an existing slice attribute was not found in the request it should
500 attribute_found=False
501 for requested_attribute in requested_slice_attributes:
502 if requested_attribute['name'] == slice_tag['tagname'] and \
503 requested_attribute['value'] == slice_tag['value']:
507 if not attribute_found:
508 removed_slice_attributes.append(slice_tag)
510 # get attributes that should be added:
511 for requested_attribute in requested_slice_attributes:
512 # if the requested attribute wasn't found we should add it
513 if requested_attribute['name'] in valid_slice_attribute_names:
514 attribute_found = False
515 for existing_attribute in existing_slice_attributes:
516 if requested_attribute['name'] == existing_attribute['tagname'] and \
517 requested_attribute['value'] == existing_attribute['value']:
520 if not attribute_found:
521 added_slice_attributes.append(requested_attribute)
524 # remove stale attributes
525 for attribute in removed_slice_attributes:
527 self.api.plshell.DeleteSliceTag(self.api.plauth, attribute['slice_tag_id'])
529 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
530 % (name, value, node_id, str(e)))
532 # add requested_attributes
533 for attribute in added_slice_attributes:
535 name, value, node_id = attribute['name'], attribute['value'], attribute.get('node_id', None)
536 self.api.plshell.AddSliceTag(self.api.plauth, slice['name'], name, value, node_id)
538 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
539 % (name, value, node_id, str(e)))
541 def create_slice_aggregate(self, xrn, rspec):
542 hrn, type = urn_to_hrn(xrn)
543 # Determine if this is a peer slice
544 peer = self.get_peer(hrn)
545 sfa_peer = self.get_sfa_peer(hrn)
548 # Get the slice record from sfa
549 slicename = hrn_to_pl_slicename(hrn)
552 registry = self.api.registries[self.api.hrn]
553 credential = self.api.getCredential()
555 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
556 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
558 # find out where this slice is currently running
559 nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
560 hostnames = [node['hostname'] for node in nodelist]
562 # get netspec details
563 nodespecs = spec.getDictsByTagName('NodeSpec')
565 # dict in which to store slice attributes to set for the nodes
567 for nodespec in nodespecs:
568 if isinstance(nodespec['name'], list):
569 for nodename in nodespec['name']:
571 for k in nodespec.keys():
572 rspec_attribute_value = nodespec[k]
573 if (self.rspec_to_slice_tag.has_key(k)):
574 slice_tag_name = self.rspec_to_slice_tag[k]
575 nodes[nodename][slice_tag_name] = rspec_attribute_value
576 elif isinstance(nodespec['name'], StringTypes):
577 nodename = nodespec['name']
579 for k in nodespec.keys():
580 rspec_attribute_value = nodespec[k]
581 if (self.rspec_to_slice_tag.has_key(k)):
582 slice_tag_name = self.rspec_to_slice_tag[k]
583 nodes[nodename][slice_tag_name] = rspec_attribute_value
585 for k in nodespec.keys():
586 rspec_attribute_value = nodespec[k]
587 if (self.rspec_to_slice_tag.has_key(k)):
588 slice_tag_name = self.rspec_to_slice_tag[k]
589 nodes[nodename][slice_tag_name] = rspec_attribute_value
591 node_names = nodes.keys()
592 # remove nodes not in rspec
593 deleted_nodes = list(set(hostnames).difference(node_names))
594 # add nodes from rspec
595 added_nodes = list(set(node_names).difference(hostnames))
599 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
601 self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
603 # Add recognized slice tags
604 for node_name in node_names:
605 node = nodes[node_name]
606 for slice_tag in node.keys():
607 value = node[slice_tag]
608 if (isinstance(value, list)):
611 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
613 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
616 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])