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.plc.vlink import VLink
14 from sfa.util.prefixTree import prefixTree
15 from collections import defaultdict
21 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
23 def __init__(self, api, ttl = .5, origin_hrn=None):
25 #filepath = path + os.sep + filename
26 self.policy = Policy(self.api)
27 self.origin_hrn = origin_hrn
28 self.registry = api.registries[api.hrn]
29 self.credential = api.getCredential()
33 def get_slivers(self, xrn, node=None):
34 hrn, type = urn_to_hrn(xrn)
36 slice_name = hrn_to_pl_slicename(hrn)
37 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
38 # of doing all of this?
39 #return self.api.GetSliceTicket(self.auth, slice_name)
41 # from PLCAPI.GetSlivers.get_slivers()
42 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
43 slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
44 # Build up list of users and slice attributes
46 all_slice_tag_ids = set()
48 person_ids.update(slice['person_ids'])
49 all_slice_tag_ids.update(slice['slice_tag_ids'])
50 person_ids = list(person_ids)
51 all_slice_tag_ids = list(all_slice_tag_ids)
52 # Get user information
53 all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
55 for person in all_persons_list:
56 all_persons[person['person_id']] = person
58 # Build up list of keys
60 for person in all_persons.values():
61 key_ids.update(person['key_ids'])
62 key_ids = list(key_ids)
63 # Get user account keys
64 all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
66 for key in all_keys_list:
67 all_keys[key['key_id']] = key
68 # Get slice attributes
69 all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
71 for slice_tag in all_slice_tags_list:
72 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
77 for person_id in slice['person_ids']:
78 if person_id in all_persons:
79 person = all_persons[person_id]
80 if not person['enabled']:
82 for key_id in person['key_ids']:
83 if key_id in all_keys:
84 key = all_keys[key_id]
85 keys += [{'key_type': key['key_type'],
88 # All (per-node and global) attributes for this slice
90 for slice_tag_id in slice['slice_tag_ids']:
91 if slice_tag_id in all_slice_tags:
92 slice_tags.append(all_slice_tags[slice_tag_id])
93 # Per-node sliver attributes take precedence over global
94 # slice attributes, so set them first.
95 # Then comes nodegroup slice attributes
96 # Followed by global slice attributes
97 sliver_attributes = []
100 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
101 sliver_attributes.append(sliver_attribute['tagname'])
102 attributes.append({'tagname': sliver_attribute['tagname'],
103 'value': sliver_attribute['value']})
105 # set nodegroup slice attributes
106 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
107 # Do not set any nodegroup slice attributes for
108 # which there is at least one sliver attribute
110 if slice_tag not in slice_tags:
111 attributes.append({'tagname': slice_tag['tagname'],
112 'value': slice_tag['value']})
114 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
115 # Do not set any global slice attributes for
116 # which there is at least one sliver attribute
118 if slice_tag['tagname'] not in sliver_attributes:
119 attributes.append({'tagname': slice_tag['tagname'],
120 'value': slice_tag['value']})
122 # XXX Sanity check; though technically this should be a system invariant
123 # checked with an assertion
124 if slice['expires'] > MAXINT: slice['expires']= MAXINT
128 'name': slice['name'],
129 'slice_id': slice['slice_id'],
130 'instantiation': slice['instantiation'],
131 'expires': slice['expires'],
133 'attributes': attributes
138 def get_peer(self, xrn):
139 hrn, type = urn_to_hrn(xrn)
140 # Becaues of myplc federation, we first need to determine if this
141 # slice belongs to out local plc or a myplc peer. We will assume it
142 # is a local site, unless we find out otherwise
145 # get this slice's authority (site)
146 slice_authority = get_authority(hrn)
148 # get this site's authority (sfa root authority or sub authority)
149 site_authority = get_authority(slice_authority).lower()
151 # check if we are already peered with this site_authority, if so
152 peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
153 for peer_record in peers:
154 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
155 if site_authority in names:
160 def get_sfa_peer(self, xrn):
161 hrn, type = urn_to_hrn(xrn)
163 # return the authority for this hrn or None if we are the authority
165 slice_authority = get_authority(hrn)
166 site_authority = get_authority(slice_authority)
168 if site_authority != self.api.hrn:
169 sfa_peer = site_authority
173 def verify_slice_nodes(self, slice, requested_slivers, peer):
175 nodes = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
176 current_slivers = [node['hostname'] for node in nodes]
178 # remove nodes not in rspec
179 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
181 # add nodes from rspec
182 added_nodes = list(set(requested_slivers).difference(current_slivers))
186 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer['shortname'])
187 self.api.plshell.AddSliceToNodes(self.api.plauth, slice['name'], added_nodes)
188 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slice['name'], deleted_nodes)
191 self.api.logger.log_exc('Failed to add/remove slice from nodes')
193 def verify_slice_links(self, slice, links, peer=None):
194 if not links or not nodes:
197 topo_rspec = VLink.get_topo_rspec(link)
200 def handle_peer(self, site, slice, persons, peer):
205 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', \
206 site['site_id'], peer['shortname'], slice['site_id'])
208 self.api.plshell.DeleteSite(self.api.plauth, site['site_id'])
214 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', \
215 slice['slice_id'], peer['shortname'], slice['slice_id'])
217 self.api.plshell.DeleteSlice(self.api.plauth, slice['slice_id'])
221 for person in persons:
223 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', \
224 person['person_id'], peer['shortname'], person['peer_person_id'])
226 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
228 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key',\
229 key['key_id'], peer['shortname'], remote_key_id)
231 self.api.plshell.DeleteKey(self.api.plauth, key['key_id'])
232 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
234 self.api.plshell.DeletePerson(self.api.plauth, person['person_id'])
239 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None):
240 (slice_hrn, type) = urn_to_hrn(slice_xrn)
241 site_hrn = get_authority(slice_hrn)
242 # login base can't be longer than 20 characters
243 slicename = hrn_to_pl_slicename(slice_hrn)
244 authority_name = slicename.split('_')[0]
245 login_base = authority_name[:20]
246 sites = self.api.plshell.GetSites(self.api.plauth, login_base)
248 # create new site record
249 site = {'name': 'geni.%s' % authority_name,
250 'abbreviated_name': authority_name,
251 'login_base': login_base,
255 'peer_site_id': None}
257 site['peer_site_id'] = slice_record.get('site_id', None)
258 site['site_id'] = self.api.plshell.AddSite(self.api.plauth, site)
259 # exempt federated sites from monitor policies
260 self.api.plshell.AddSiteTag(self.api.plauth, site['site_id'], 'exempt_site_until', "20200101")
262 # is this still necessary?
263 # add record to the local registry
264 if sfa_peer and slice_record:
265 peer_dict = {'type': 'authority', 'hrn': site_hrn, \
266 'peer_authority': sfa_peer, 'pointer': site['site_id']}
267 self.registry.register_peer_object(self.credential, peer_dict)
271 # unbind from peer so we can modify if necessary. Will bind back later
272 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site['site_id'], peer['shortname'])
276 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer):
277 slicename = hrn_to_pl_slicename(slice_hrn)
278 parts = slicename.split("_")
279 login_base = parts[0]
280 slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
282 slice = {'name': slicename,
283 'url': slice_record.get('url', slice_hrn),
284 'description': slice_record.get('description', slice_hrn)}
286 slice['slice_id'] = self.api.plshell.AddSlice(self.api.plauth, slice)
287 slice['node_ids'] = []
288 slice['person_ids'] = []
290 slice['peer_slice_id'] = slice_record.get('slice_id', None)
291 # mark this slice as an sfa peer record
293 peer_dict = {'type': 'slice', 'hrn': slice_hrn,
294 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
295 self.registry.register_peer_object(self.credential, peer_dict)
299 slice['peer_slice_id'] = slice_record.get('slice_id', None)
300 # unbind from peer so we can modify if necessary. Will bind back later
301 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice',\
302 slice['slice_id'], peer['shortname'])
303 #Update existing record (e.g. expires field) it with the latest info.
304 if slice_record and slice['expires'] != slice_record['expires']:
305 self.api.plshell.UpdateSlice(self.api.plauth, slice['slice_id'],\
306 {'expires' : slice_record['expires']})
310 #def get_existing_persons(self, users):
311 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, append=True):
313 users_by_site = defaultdict(list)
317 if 'append' in user and user['append'] == False:
320 users_by_email[user['email']] = user
321 users_dict[user['email']] = user
323 hrn, type = urn_to_hrn(user['urn'])
324 username = get_leaf(hrn)
325 login_base = get_leaf(get_authority(user['urn']))
326 user['username'] = username
327 users_by_site[login_base].append(user)
329 existing_user_ids = []
331 # get existing users by email
332 existing_users = self.api.plshell.GetPersons(self.api.plauth, \
333 {'email': users_by_email.keys()}, ['person_id', 'key_ids', 'email'])
334 existing_user_ids.extend([user['email'] for user in existing_users])
337 # get a list of user sites (based on requeste user urns
338 site_list = self.api.plshell.GetSites(self.api.plauth, users_by_site.keys(), \
339 ['site_id', 'login_base', 'person_ids'])
343 # get all existing users at these sites
344 for site in site_list:
345 sites[site['site_id']] = site
346 site_user_ids.extend(site['person_ids'])
348 existing_site_persons_list = self.api.plshell.GetPersons(self.api.plauth, \
349 site_user_ids, ['person_id', 'key_ids', 'email', 'site_ids'])
351 # all requested users are either existing users or new (added) users
352 for login_base in users_by_site:
353 requested_site_users = users_by_site[login_base]
354 for requested_user in requested_site_users:
356 for existing_user in existing_site_persons_list:
357 for site_id in existing_user['site_ids']:
358 site = sites[site_id]
359 if login_base == site['login_base'] and \
360 existing_user['email'].startswith(requested_user['username']):
361 existing_user_ids.append(existing_user['email'])
362 users_dict[existing_user['email']] = requested_user
368 if user_found == False:
369 fake_email = requested_user['username'] + '@geni.net'
370 users_dict[fake_email] = requested_user
373 # requested slice users
374 requested_user_ids = users_dict.keys()
375 # existing slice users
376 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
377 existing_slice_users = self.api.plshell.GetPersons(self.api.plauth, \
378 existing_slice_users_filter, ['person_id', 'key_ids', 'email'])
379 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
381 # users to be added, removed or updated
382 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
383 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
384 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
385 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
387 # Remove stale users (only if we are not appending).
389 for removed_user_id in removed_user_ids:
390 self.api.plshell.DeletePersonFromSlice(self.api.plauth, removed_user_id, slice_record['name'])
391 # update_existing users
392 updated_users_list = [user for user in existing_slice_users if user['email'] in \
394 self.verify_keys(existing_slice_users, updated_users_list, peer, append)
398 for added_user_id in added_user_ids:
399 added_user = users_dict[added_user_id]
400 hrn, type = urn_to_hrn(added_user['urn'])
402 'first_name': added_user.get('first_name', hrn),
403 'last_name': added_user.get('last_name', hrn),
404 'email': added_user_id,
405 'peer_person_id': None,
407 'key_ids': added_user.get('key_ids', []),
409 person['person_id'] = self.api.plshell.AddPerson(self.api.plauth, person)
411 person['peer_person_id'] = added_user['person_id']
412 added_persons.append(person)
415 self.api.plshell.UpdatePerson(self.api.plauth, person['person_id'], {'enabled': True})
418 self.api.plshell.AddPersonToSite(self.api.plauth, added_user_id, login_base)
420 for key_string in added_user.get('keys', []):
421 key = {'key':key_string, 'key_type':'ssh'}
422 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, person['person_id'], key)
423 person['keys'].append(key)
425 # add the registry record
427 peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
428 'pointer': person['person_id']}
429 self.registry.register_peer_object(self.credential, peer_dict)
431 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
432 # add person to the slice
433 self.api.plshell.AddPersonToSlice(self.api.plauth, added_slice_user_id, slice_record['name'])
434 # if this is a peer record then it should already be bound to a peer.
435 # no need to return worry about it getting bound later
440 def verify_keys(self, persons, users, peer, append=True):
443 for person in persons:
444 key_ids.extend(person['key_ids'])
445 keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key'])
448 keydict[key['key']] = key['key_id']
449 existing_keys = keydict.keys()
451 for person in persons:
452 persondict[person['email']] = person
458 user_keys = user.get('keys', [])
459 updated_persons.append(user)
460 for key_string in user_keys:
461 requested_keys.append(key_string)
462 if key_string not in existing_keys:
463 key = {'key': key_string, 'key_type': 'ssh'}
466 person = persondict[user['email']]
467 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'])
468 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, user['email'], key)
470 key_index = user_keys.index(key['key'])
471 remote_key_id = user['key_ids'][key_index]
472 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key['key_id'], peer['shortname'], remote_key_id)
476 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'], user['person_id'])
478 # remove old keys (only if we are not appending)
480 removed_keys = set(existing_keys).difference(requested_keys)
481 for existing_key_id in keydict:
482 if keydict[existing_key_id] in removed_keys:
485 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'key', existing_key_id, peer['shortname'])
486 self.api.plshell.DeleteKey(self.api.plauth, existing_key_id)
490 def verify_slice_attributes(self, slice, requested_slice_attributes):
491 # get list of attributes users ar able to manage
492 slice_attributes = self.api.plshell.GetTagTypes(self.api.plauth, {'category': '*slice*', '|roles': ['user']})
493 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
495 # get sliver attributes
496 added_slice_attributes = []
497 removed_slice_attributes = []
498 ignored_slice_attribute_names = []
499 existing_slice_attributes = self.api.plshell.GetSliceTags(self.api.plauth, {'slice_id': slice['slice_id']})
501 # get attributes that should be removed
502 for slice_tag in existing_slice_attributes:
503 if slice_tag['tagname'] in ignored_slice_attribute_names:
504 # If a slice already has a admin only role it was probably given to them by an
505 # admin, so we should ignore it.
506 ignored_slice_attribute_names.append(slice_tag['tagname'])
508 # If an existing slice attribute was not found in the request it should
510 attribute_found=False
511 for requested_attribute in requested_slice_attributes:
512 if requested_attribute['name'] == slice_tag['tagname'] and \
513 requested_attribute['value'] == slice_tag['value']:
517 if not attribute_found:
518 removed_slice_attributes.append(slice_tag)
520 # get attributes that should be added:
521 for requested_attribute in requested_slice_attributes:
522 # if the requested attribute wasn't found we should add it
523 if requested_attribute['name'] in valid_slice_attribute_names:
524 attribute_found = False
525 for existing_attribute in existing_slice_attributes:
526 if requested_attribute['name'] == existing_attribute['tagname'] and \
527 requested_attribute['value'] == existing_attribute['value']:
530 if not attribute_found:
531 added_slice_attributes.append(requested_attribute)
534 # remove stale attributes
535 for attribute in removed_slice_attributes:
537 self.api.plshell.DeleteSliceTag(self.api.plauth, attribute['slice_tag_id'])
539 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
540 % (name, value, node_id, str(e)))
542 # add requested_attributes
543 for attribute in added_slice_attributes:
545 name, value, node_id = attribute['name'], attribute['value'], attribute.get('node_id', None)
546 self.api.plshell.AddSliceTag(self.api.plauth, slice['name'], name, value, node_id)
548 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
549 % (name, value, node_id, str(e)))
551 def create_slice_aggregate(self, xrn, rspec):
552 hrn, type = urn_to_hrn(xrn)
553 # Determine if this is a peer slice
554 peer = self.get_peer(hrn)
555 sfa_peer = self.get_sfa_peer(hrn)
558 # Get the slice record from sfa
559 slicename = hrn_to_pl_slicename(hrn)
562 registry = self.api.registries[self.api.hrn]
563 credential = self.api.getCredential()
565 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
566 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
568 # find out where this slice is currently running
569 nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
570 hostnames = [node['hostname'] for node in nodelist]
572 # get netspec details
573 nodespecs = spec.getDictsByTagName('NodeSpec')
575 # dict in which to store slice attributes to set for the nodes
577 for nodespec in nodespecs:
578 if isinstance(nodespec['name'], list):
579 for nodename in nodespec['name']:
581 for k in nodespec.keys():
582 rspec_attribute_value = nodespec[k]
583 if (self.rspec_to_slice_tag.has_key(k)):
584 slice_tag_name = self.rspec_to_slice_tag[k]
585 nodes[nodename][slice_tag_name] = rspec_attribute_value
586 elif isinstance(nodespec['name'], StringTypes):
587 nodename = nodespec['name']
589 for k in nodespec.keys():
590 rspec_attribute_value = nodespec[k]
591 if (self.rspec_to_slice_tag.has_key(k)):
592 slice_tag_name = self.rspec_to_slice_tag[k]
593 nodes[nodename][slice_tag_name] = rspec_attribute_value
595 for k in nodespec.keys():
596 rspec_attribute_value = nodespec[k]
597 if (self.rspec_to_slice_tag.has_key(k)):
598 slice_tag_name = self.rspec_to_slice_tag[k]
599 nodes[nodename][slice_tag_name] = rspec_attribute_value
601 node_names = nodes.keys()
602 # remove nodes not in rspec
603 deleted_nodes = list(set(hostnames).difference(node_names))
604 # add nodes from rspec
605 added_nodes = list(set(node_names).difference(hostnames))
609 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
611 self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
613 # Add recognized slice tags
614 for node_name in node_names:
615 node = nodes[node_name]
616 for slice_tag in node.keys():
617 value = node[slice_tag]
618 if (isinstance(value, list)):
621 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
623 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
626 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])