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.faults import *
10 from sfa.util.record import SfaRecord
11 from sfa.util.policy import Policy
12 from sfa.plc.vlink import VLink
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()
32 def get_slivers(self, xrn, node=None):
33 hrn, type = urn_to_hrn(xrn)
35 slice_name = hrn_to_pl_slicename(hrn)
36 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
37 # of doing all of this?
38 #return self.api.GetSliceTicket(self.auth, slice_name)
40 # from PLCAPI.GetSlivers.get_slivers()
41 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
42 slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
43 # Build up list of users and slice attributes
45 all_slice_tag_ids = set()
47 person_ids.update(slice['person_ids'])
48 all_slice_tag_ids.update(slice['slice_tag_ids'])
49 person_ids = list(person_ids)
50 all_slice_tag_ids = list(all_slice_tag_ids)
51 # Get user information
52 all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
54 for person in all_persons_list:
55 all_persons[person['person_id']] = person
57 # Build up list of keys
59 for person in all_persons.values():
60 key_ids.update(person['key_ids'])
61 key_ids = list(key_ids)
62 # Get user account keys
63 all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
65 for key in all_keys_list:
66 all_keys[key['key_id']] = key
67 # Get slice attributes
68 all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
70 for slice_tag in all_slice_tags_list:
71 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
76 for person_id in slice['person_ids']:
77 if person_id in all_persons:
78 person = all_persons[person_id]
79 if not person['enabled']:
81 for key_id in person['key_ids']:
82 if key_id in all_keys:
83 key = all_keys[key_id]
84 keys += [{'key_type': key['key_type'],
87 # All (per-node and global) attributes for this slice
89 for slice_tag_id in slice['slice_tag_ids']:
90 if slice_tag_id in all_slice_tags:
91 slice_tags.append(all_slice_tags[slice_tag_id])
92 # Per-node sliver attributes take precedence over global
93 # slice attributes, so set them first.
94 # Then comes nodegroup slice attributes
95 # Followed by global slice attributes
96 sliver_attributes = []
99 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
100 sliver_attributes.append(sliver_attribute['tagname'])
101 attributes.append({'tagname': sliver_attribute['tagname'],
102 'value': sliver_attribute['value']})
104 # set nodegroup slice attributes
105 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
106 # Do not set any nodegroup slice attributes for
107 # which there is at least one sliver attribute
109 if slice_tag not in slice_tags:
110 attributes.append({'tagname': slice_tag['tagname'],
111 'value': slice_tag['value']})
113 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
114 # Do not set any global slice attributes for
115 # which there is at least one sliver attribute
117 if slice_tag['tagname'] not in sliver_attributes:
118 attributes.append({'tagname': slice_tag['tagname'],
119 'value': slice_tag['value']})
121 # XXX Sanity check; though technically this should be a system invariant
122 # checked with an assertion
123 if slice['expires'] > MAXINT: slice['expires']= MAXINT
127 'name': slice['name'],
128 'slice_id': slice['slice_id'],
129 'instantiation': slice['instantiation'],
130 'expires': slice['expires'],
132 'attributes': attributes
137 def get_peer(self, xrn):
138 hrn, type = urn_to_hrn(xrn)
139 # Becaues of myplc federation, we first need to determine if this
140 # slice belongs to out local plc or a myplc peer. We will assume it
141 # is a local site, unless we find out otherwise
144 # get this slice's authority (site)
145 slice_authority = get_authority(hrn)
147 # get this site's authority (sfa root authority or sub authority)
148 site_authority = get_authority(slice_authority).lower()
150 # check if we are already peered with this site_authority, if so
151 peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
152 for peer_record in peers:
153 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
154 if site_authority in names:
159 def get_sfa_peer(self, xrn):
160 hrn, type = urn_to_hrn(xrn)
162 # return the authority for this hrn or None if we are the authority
164 slice_authority = get_authority(hrn)
165 site_authority = get_authority(slice_authority)
167 if site_authority != self.api.hrn:
168 sfa_peer = site_authority
172 def verify_slice_nodes(self, slice, requested_slivers, peer):
174 nodes = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
175 current_slivers = [node['hostname'] for node in nodes]
177 # remove nodes not in rspec
178 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
180 # add nodes from rspec
181 added_nodes = list(set(requested_slivers).difference(current_slivers))
185 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer['shortname'])
186 self.api.plshell.AddSliceToNodes(self.api.plauth, slice['name'], added_nodes)
187 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slice['name'], deleted_nodes)
190 self.api.logger.log_exc('Failed to add/remove slice from nodes')
192 def verify_slice_links(self, slice, links, peer=None):
193 if not links or not nodes:
196 topo_rspec = VLink.get_topo_rspec(link)
199 def handle_peer(self, site, slice, persons, peer):
204 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', \
205 site['site_id'], peer['shortname'], slice['site_id'])
207 self.api.plshell.DeleteSite(self.api.plauth, site['site_id'])
213 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', \
214 slice['slice_id'], peer['shortname'], slice['slice_id'])
216 self.api.plshell.DeleteSlice(self.api.plauth, slice['slice_id'])
220 for person in persons:
222 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', \
223 person['person_id'], peer['shortname'], person['peer_person_id'])
225 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
227 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key',\
228 key['key_id'], peer['shortname'], remote_key_id)
230 self.api.plshell.DeleteKey(self.api.plauth, key['key_id'])
231 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
233 self.api.plshell.DeletePerson(self.api.plauth, person['person_id'])
238 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None):
239 (slice_hrn, type) = urn_to_hrn(slice_xrn)
240 site_hrn = get_authority(slice_hrn)
241 # login base can't be longer than 20 characters
242 slicename = hrn_to_pl_slicename(slice_hrn)
243 authority_name = slicename.split('_')[0]
244 login_base = authority_name[:20]
245 sites = self.api.plshell.GetSites(self.api.plauth, login_base)
247 # create new site record
248 site = {'name': 'geni.%s' % authority_name,
249 'abbreviated_name': authority_name,
250 'login_base': login_base,
254 'peer_site_id': None}
256 site['peer_site_id'] = slice_record.get('site_id', None)
257 site['site_id'] = self.api.plshell.AddSite(self.api.plauth, site)
258 # exempt federated sites from monitor policies
259 self.api.plshell.AddSiteTag(self.api.plauth, site['site_id'], 'exempt_site_until', "20200101")
261 # is this still necessary?
262 # add record to the local registry
263 if sfa_peer and slice_record:
264 peer_dict = {'type': 'authority', 'hrn': site_hrn, \
265 'peer_authority': sfa_peer, 'pointer': site['site_id']}
266 self.registry.register_peer_object(self.credential, peer_dict)
270 # unbind from peer so we can modify if necessary. Will bind back later
271 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site['site_id'], peer['shortname'])
275 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer):
276 slicename = hrn_to_pl_slicename(slice_hrn)
277 parts = slicename.split("_")
278 login_base = parts[0]
279 slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
281 slice = {'name': slicename,
282 'url': slice_record.get('url', slice_hrn),
283 'description': slice_record.get('description', slice_hrn)}
285 slice['slice_id'] = self.api.plshell.AddSlice(self.api.plauth, slice)
286 slice['node_ids'] = []
287 slice['person_ids'] = []
289 slice['peer_slice_id'] = slice_record.get('slice_id', None)
290 # mark this slice as an sfa peer record
292 peer_dict = {'type': 'slice', 'hrn': slice_hrn,
293 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
294 self.registry.register_peer_object(self.credential, peer_dict)
298 slice['peer_slice_id'] = slice_record.get('slice_id', None)
299 # unbind from peer so we can modify if necessary. Will bind back later
300 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice',\
301 slice['slice_id'], peer['shortname'])
302 #Update existing record (e.g. expires field) it with the latest info.
303 if slice_record and slice['expires'] != slice_record['expires']:
304 self.api.plshell.UpdateSlice(self.api.plauth, slice['slice_id'],\
305 {'expires' : slice_record['expires']})
309 #def get_existing_persons(self, users):
310 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, append=True):
312 users_by_site = defaultdict(list)
316 if 'append' in user and user['append'] == False:
319 users_by_email[user['email']] = user
320 users_dict[user['email']] = user
322 hrn, type = urn_to_hrn(user['urn'])
323 username = get_leaf(hrn)
324 login_base = get_leaf(get_authority(user['urn']))
325 user['username'] = username
326 users_by_site[login_base].append(user)
328 existing_user_ids = []
330 # get existing users by email
331 existing_users = self.api.plshell.GetPersons(self.api.plauth, \
332 {'email': users_by_email.keys()}, ['person_id', 'key_ids', 'email'])
333 existing_user_ids.extend([user['email'] for user in existing_users])
336 # get a list of user sites (based on requeste user urns
337 site_list = self.api.plshell.GetSites(self.api.plauth, users_by_site.keys(), \
338 ['site_id', 'login_base', 'person_ids'])
342 # get all existing users at these sites
343 for site in site_list:
344 sites[site['site_id']] = site
345 site_user_ids.extend(site['person_ids'])
347 existing_site_persons_list = self.api.plshell.GetPersons(self.api.plauth, \
348 site_user_ids, ['person_id', 'key_ids', 'email', 'site_ids'])
350 # all requested users are either existing users or new (added) users
351 for login_base in users_by_site:
352 requested_site_users = users_by_site[login_base]
353 for requested_user in requested_site_users:
355 for existing_user in existing_site_persons_list:
356 for site_id in existing_user['site_ids']:
357 site = sites[site_id]
358 if login_base == site['login_base'] and \
359 existing_user['email'].startswith(requested_user['username']):
360 existing_user_ids.append(existing_user['email'])
361 users_dict[existing_user['email']] = requested_user
367 if user_found == False:
368 fake_email = requested_user['username'] + '@geni.net'
369 users_dict[fake_email] = requested_user
372 # requested slice users
373 requested_user_ids = users_dict.keys()
374 # existing slice users
375 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
376 existing_slice_users = self.api.plshell.GetPersons(self.api.plauth, \
377 existing_slice_users_filter, ['person_id', 'key_ids', 'email'])
378 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
380 # users to be added, removed or updated
381 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
382 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
383 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
384 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
386 # Remove stale users (only if we are not appending).
388 for removed_user_id in removed_user_ids:
389 self.api.plshell.DeletePersonFromSlice(self.api.plauth, removed_user_id, slice_record['name'])
390 # update_existing users
391 updated_users_list = [user for user in existing_slice_users if user['email'] in \
393 self.verify_keys(existing_slice_users, updated_users_list, peer, append)
397 for added_user_id in added_user_ids:
398 added_user = users_dict[added_user_id]
399 hrn, type = urn_to_hrn(added_user['urn'])
401 'first_name': added_user.get('first_name', hrn),
402 'last_name': added_user.get('last_name', hrn),
403 'email': added_user_id,
404 'peer_person_id': None,
406 'key_ids': added_user.get('key_ids', []),
408 person['person_id'] = self.api.plshell.AddPerson(self.api.plauth, person)
410 person['peer_person_id'] = added_user['person_id']
411 added_persons.append(person)
414 self.api.plshell.UpdatePerson(self.api.plauth, person['person_id'], {'enabled': True})
417 self.api.plshell.AddPersonToSite(self.api.plauth, added_user_id, login_base)
419 for key_string in added_user.get('keys', []):
420 key = {'key':key_string, 'key_type':'ssh'}
421 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, person['person_id'], key)
422 person['keys'].append(key)
424 # add the registry record
426 peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
427 'pointer': person['person_id']}
428 self.registry.register_peer_object(self.credential, peer_dict)
430 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
431 # add person to the slice
432 self.api.plshell.AddPersonToSlice(self.api.plauth, added_slice_user_id, slice_record['name'])
433 # if this is a peer record then it should already be bound to a peer.
434 # no need to return worry about it getting bound later
439 def verify_keys(self, persons, users, peer, append=True):
442 for person in persons:
443 key_ids.extend(person['key_ids'])
444 keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key'])
447 keydict[key['key']] = key['key_id']
448 existing_keys = keydict.keys()
450 for person in persons:
451 persondict[person['email']] = person
457 user_keys = user.get('keys', [])
458 updated_persons.append(user)
459 for key_string in user_keys:
460 requested_keys.append(key_string)
461 if key_string not in existing_keys:
462 key = {'key': key_string, 'key_type': 'ssh'}
465 person = persondict[user['email']]
466 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'])
467 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, user['email'], key)
469 key_index = user_keys.index(key['key'])
470 remote_key_id = user['key_ids'][key_index]
471 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key['key_id'], peer['shortname'], remote_key_id)
475 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'], user['person_id'])
477 # remove old keys (only if we are not appending)
479 removed_keys = set(existing_keys).difference(requested_keys)
480 for existing_key_id in keydict:
481 if keydict[existing_key_id] in removed_keys:
484 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'key', existing_key_id, peer['shortname'])
485 self.api.plshell.DeleteKey(self.api.plauth, existing_key_id)
489 def verify_slice_attributes(self, slice, requested_slice_attributes):
490 # get list of attributes users ar able to manage
491 slice_attributes = self.api.plshell.GetTagTypes(self.api.plauth, {'category': '*slice*', '|roles': ['user']})
492 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
494 # get sliver attributes
495 added_slice_attributes = []
496 removed_slice_attributes = []
497 ignored_slice_attribute_names = []
498 existing_slice_attributes = self.api.plshell.GetSliceTags(self.api.plauth, {'slice_id': slice['slice_id']})
500 # get attributes that should be removed
501 for slice_tag in existing_slice_attributes:
502 if slice_tag['tagname'] in ignored_slice_attribute_names:
503 # If a slice already has a admin only role it was probably given to them by an
504 # admin, so we should ignore it.
505 ignored_slice_attribute_names.append(slice_tag['tagname'])
507 # If an existing slice attribute was not found in the request it should
509 attribute_found=False
510 for requested_attribute in requested_slice_attributes:
511 if requested_attribute['name'] == slice_tag['tagname'] and \
512 requested_attribute['value'] == slice_tag['value']:
516 if not attribute_found:
517 removed_slice_attributes.append(slice_tag)
519 # get attributes that should be added:
520 for requested_attribute in requested_slice_attributes:
521 # if the requested attribute wasn't found we should add it
522 if requested_attribute['name'] in valid_slice_attribute_names:
523 attribute_found = False
524 for existing_attribute in existing_slice_attributes:
525 if requested_attribute['name'] == existing_attribute['tagname'] and \
526 requested_attribute['value'] == existing_attribute['value']:
529 if not attribute_found:
530 added_slice_attributes.append(requested_attribute)
533 # remove stale attributes
534 for attribute in removed_slice_attributes:
536 self.api.plshell.DeleteSliceTag(self.api.plauth, attribute['slice_tag_id'])
538 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
539 % (name, value, node_id, str(e)))
541 # add requested_attributes
542 for attribute in added_slice_attributes:
544 name, value, node_id = attribute['name'], attribute['value'], attribute.get('node_id', None)
545 self.api.plshell.AddSliceTag(self.api.plauth, slice['name'], name, value, node_id)
547 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
548 % (name, value, node_id, str(e)))
550 def create_slice_aggregate(self, xrn, rspec):
551 hrn, type = urn_to_hrn(xrn)
552 # Determine if this is a peer slice
553 peer = self.get_peer(hrn)
554 sfa_peer = self.get_sfa_peer(hrn)
557 # Get the slice record from sfa
558 slicename = hrn_to_pl_slicename(hrn)
561 registry = self.api.registries[self.api.hrn]
562 credential = self.api.getCredential()
564 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
565 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
567 # find out where this slice is currently running
568 nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
569 hostnames = [node['hostname'] for node in nodelist]
571 # get netspec details
572 nodespecs = spec.getDictsByTagName('NodeSpec')
574 # dict in which to store slice attributes to set for the nodes
576 for nodespec in nodespecs:
577 if isinstance(nodespec['name'], list):
578 for nodename in nodespec['name']:
580 for k in nodespec.keys():
581 rspec_attribute_value = nodespec[k]
582 if (self.rspec_to_slice_tag.has_key(k)):
583 slice_tag_name = self.rspec_to_slice_tag[k]
584 nodes[nodename][slice_tag_name] = rspec_attribute_value
585 elif isinstance(nodespec['name'], StringTypes):
586 nodename = nodespec['name']
588 for k in nodespec.keys():
589 rspec_attribute_value = nodespec[k]
590 if (self.rspec_to_slice_tag.has_key(k)):
591 slice_tag_name = self.rspec_to_slice_tag[k]
592 nodes[nodename][slice_tag_name] = rspec_attribute_value
594 for k in nodespec.keys():
595 rspec_attribute_value = nodespec[k]
596 if (self.rspec_to_slice_tag.has_key(k)):
597 slice_tag_name = self.rspec_to_slice_tag[k]
598 nodes[nodename][slice_tag_name] = rspec_attribute_value
600 node_names = nodes.keys()
601 # remove nodes not in rspec
602 deleted_nodes = list(set(hostnames).difference(node_names))
603 # add nodes from rspec
604 added_nodes = list(set(node_names).difference(hostnames))
608 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
610 self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
612 # Add recognized slice tags
613 for node_name in node_names:
614 node = nodes[node_name]
615 for slice_tag in node.keys():
616 value = node[slice_tag]
617 if (isinstance(value, list)):
620 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
622 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
625 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])