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
8 from sfa.plc.vlink import VLink
14 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
16 def __init__(self, api, ttl = .5, origin_hrn=None):
18 #filepath = path + os.sep + filename
19 self.policy = Policy(self.api)
20 self.origin_hrn = origin_hrn
21 self.registry = api.registries[api.hrn]
22 self.credential = api.getCredential()
26 def get_slivers(self, xrn, node=None):
27 hrn, type = urn_to_hrn(xrn)
29 slice_name = hrn_to_pl_slicename(hrn)
30 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
31 # of doing all of this?
32 #return self.api.GetSliceTicket(self.auth, slice_name)
34 # from PLCAPI.GetSlivers.get_slivers()
35 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
36 slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
37 # Build up list of users and slice attributes
39 all_slice_tag_ids = set()
41 person_ids.update(slice['person_ids'])
42 all_slice_tag_ids.update(slice['slice_tag_ids'])
43 person_ids = list(person_ids)
44 all_slice_tag_ids = list(all_slice_tag_ids)
45 # Get user information
46 all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
48 for person in all_persons_list:
49 all_persons[person['person_id']] = person
51 # Build up list of keys
53 for person in all_persons.values():
54 key_ids.update(person['key_ids'])
55 key_ids = list(key_ids)
56 # Get user account keys
57 all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
59 for key in all_keys_list:
60 all_keys[key['key_id']] = key
61 # Get slice attributes
62 all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
64 for slice_tag in all_slice_tags_list:
65 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
70 for person_id in slice['person_ids']:
71 if person_id in all_persons:
72 person = all_persons[person_id]
73 if not person['enabled']:
75 for key_id in person['key_ids']:
76 if key_id in all_keys:
77 key = all_keys[key_id]
78 keys += [{'key_type': key['key_type'],
81 # All (per-node and global) attributes for this slice
83 for slice_tag_id in slice['slice_tag_ids']:
84 if slice_tag_id in all_slice_tags:
85 slice_tags.append(all_slice_tags[slice_tag_id])
86 # Per-node sliver attributes take precedence over global
87 # slice attributes, so set them first.
88 # Then comes nodegroup slice attributes
89 # Followed by global slice attributes
90 sliver_attributes = []
93 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
94 sliver_attributes.append(sliver_attribute['tagname'])
95 attributes.append({'tagname': sliver_attribute['tagname'],
96 'value': sliver_attribute['value']})
98 # set nodegroup slice attributes
99 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
100 # Do not set any nodegroup slice attributes for
101 # which there is at least one sliver attribute
103 if slice_tag not in slice_tags:
104 attributes.append({'tagname': slice_tag['tagname'],
105 'value': slice_tag['value']})
107 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
108 # Do not set any global slice attributes for
109 # which there is at least one sliver attribute
111 if slice_tag['tagname'] not in sliver_attributes:
112 attributes.append({'tagname': slice_tag['tagname'],
113 'value': slice_tag['value']})
115 # XXX Sanity check; though technically this should be a system invariant
116 # checked with an assertion
117 if slice['expires'] > MAXINT: slice['expires']= MAXINT
121 'name': slice['name'],
122 'slice_id': slice['slice_id'],
123 'instantiation': slice['instantiation'],
124 'expires': slice['expires'],
126 'attributes': attributes
131 def get_peer(self, xrn):
132 hrn, type = urn_to_hrn(xrn)
133 # Becaues of myplc federation, we first need to determine if this
134 # slice belongs to out local plc or a myplc peer. We will assume it
135 # is a local site, unless we find out otherwise
138 # get this slice's authority (site)
139 slice_authority = get_authority(hrn)
141 # get this site's authority (sfa root authority or sub authority)
142 site_authority = get_authority(slice_authority).lower()
144 # check if we are already peered with this site_authority, if so
145 peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
146 for peer_record in peers:
147 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
148 if site_authority in names:
153 def get_sfa_peer(self, xrn):
154 hrn, type = urn_to_hrn(xrn)
156 # return the authority for this hrn or None if we are the authority
158 slice_authority = get_authority(hrn)
159 site_authority = get_authority(slice_authority)
161 if site_authority != self.api.hrn:
162 sfa_peer = site_authority
166 def verify_slice_nodes(self, slice, requested_slivers, peer):
168 nodes = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
169 current_slivers = [node['hostname'] for node in nodes]
171 # remove nodes not in rspec
172 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
174 # add nodes from rspec
175 added_nodes = list(set(requested_slivers).difference(current_slivers))
179 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer['shortname'])
180 self.api.plshell.AddSliceToNodes(self.api.plauth, slice['name'], added_nodes)
181 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slice['name'], deleted_nodes)
184 self.api.logger.log_exc('Failed to add/remove slice from nodes')
186 def verify_slice_links(self, slice, links, aggregate):
187 # nodes is undefined here
188 if not links or not nodes:
191 topo_rspec = VLink.get_topo_rspec(link)
194 def handle_peer(self, site, slice, persons, peer):
199 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', \
200 site['site_id'], peer['shortname'], slice['site_id'])
202 self.api.plshell.DeleteSite(self.api.plauth, site['site_id'])
208 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', \
209 slice['slice_id'], peer['shortname'], slice['slice_id'])
211 self.api.plshell.DeleteSlice(self.api.plauth, slice['slice_id'])
215 for person in persons:
217 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', \
218 person['person_id'], peer['shortname'], person['peer_person_id'])
220 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
222 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key',\
223 key['key_id'], peer['shortname'], remote_key_id)
225 self.api.plshell.DeleteKey(self.api.plauth, key['key_id'])
226 self.api.logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
228 self.api.plshell.DeletePerson(self.api.plauth, person['person_id'])
233 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None):
234 (slice_hrn, type) = urn_to_hrn(slice_xrn)
235 site_hrn = get_authority(slice_hrn)
236 # login base can't be longer than 20 characters
237 slicename = hrn_to_pl_slicename(slice_hrn)
238 authority_name = slicename.split('_')[0]
239 login_base = authority_name[:20]
240 sites = self.api.plshell.GetSites(self.api.plauth, login_base)
242 # create new site record
243 site = {'name': 'geni.%s' % authority_name,
244 'abbreviated_name': authority_name,
245 'login_base': login_base,
249 'peer_site_id': None}
251 site['peer_site_id'] = slice_record.get('site_id', None)
252 site['site_id'] = self.api.plshell.AddSite(self.api.plauth, site)
253 # exempt federated sites from monitor policies
254 self.api.plshell.AddSiteTag(self.api.plauth, site['site_id'], 'exempt_site_until', "20200101")
256 # is this still necessary?
257 # add record to the local registry
258 if sfa_peer and slice_record:
259 peer_dict = {'type': 'authority', 'hrn': site_hrn, \
260 'peer_authority': sfa_peer, 'pointer': site['site_id']}
261 self.registry.register_peer_object(self.credential, peer_dict)
265 # unbind from peer so we can modify if necessary. Will bind back later
266 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site['site_id'], peer['shortname'])
270 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer):
271 slicename = hrn_to_pl_slicename(slice_hrn)
272 parts = slicename.split("_")
273 login_base = parts[0]
274 slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
276 slice = {'name': slicename,
277 'url': slice_record.get('url', slice_hrn),
278 'description': slice_record.get('description', slice_hrn)}
280 slice['slice_id'] = self.api.plshell.AddSlice(self.api.plauth, slice)
281 slice['node_ids'] = []
282 slice['person_ids'] = []
284 slice['peer_slice_id'] = slice_record.get('slice_id', None)
285 # mark this slice as an sfa peer record
287 peer_dict = {'type': 'slice', 'hrn': slice_hrn,
288 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
289 self.registry.register_peer_object(self.credential, peer_dict)
293 slice['peer_slice_id'] = slice_record.get('slice_id', None)
294 # unbind from peer so we can modify if necessary. Will bind back later
295 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice',\
296 slice['slice_id'], peer['shortname'])
297 #Update existing record (e.g. expires field) it with the latest info.
298 if slice_record and slice['expires'] != slice_record['expires']:
299 self.api.plshell.UpdateSlice(self.api.plauth, slice['slice_id'],\
300 {'expires' : slice_record['expires']})
304 #def get_existing_persons(self, users):
305 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, append=True):
307 users_by_site = defaultdict(list)
311 if 'append' in user and user['append'] == False:
314 users_by_email[user['email']] = user
315 users_dict[user['email']] = user
317 hrn, type = urn_to_hrn(user['urn'])
318 username = get_leaf(hrn)
319 login_base = get_leaf(get_authority(user['urn']))
320 user['username'] = username
321 users_by_site[login_base].append(user)
323 existing_user_ids = []
325 # get existing users by email
326 existing_users = self.api.plshell.GetPersons(self.api.plauth, \
327 {'email': users_by_email.keys()}, ['person_id', 'key_ids', 'email'])
328 existing_user_ids.extend([user['email'] for user in existing_users])
331 # get a list of user sites (based on requeste user urns
332 site_list = self.api.plshell.GetSites(self.api.plauth, users_by_site.keys(), \
333 ['site_id', 'login_base', 'person_ids'])
337 # get all existing users at these sites
338 for site in site_list:
339 sites[site['site_id']] = site
340 site_user_ids.extend(site['person_ids'])
342 existing_site_persons_list = self.api.plshell.GetPersons(self.api.plauth, \
343 site_user_ids, ['person_id', 'key_ids', 'email', 'site_ids'])
345 # all requested users are either existing users or new (added) users
346 for login_base in users_by_site:
347 requested_site_users = users_by_site[login_base]
348 for requested_user in requested_site_users:
350 for existing_user in existing_site_persons_list:
351 for site_id in existing_user['site_ids']:
352 site = sites[site_id]
353 if login_base == site['login_base'] and \
354 existing_user['email'].startswith(requested_user['username']):
355 existing_user_ids.append(existing_user['email'])
356 users_dict[existing_user['email']] = requested_user
362 if user_found == False:
363 fake_email = requested_user['username'] + '@geni.net'
364 users_dict[fake_email] = requested_user
367 # requested slice users
368 requested_user_ids = users_dict.keys()
369 # existing slice users
370 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
371 existing_slice_users = self.api.plshell.GetPersons(self.api.plauth, \
372 existing_slice_users_filter, ['person_id', 'key_ids', 'email'])
373 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
375 # users to be added, removed or updated
376 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
377 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
378 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
379 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
381 # Remove stale users (only if we are not appending).
383 for removed_user_id in removed_user_ids:
384 self.api.plshell.DeletePersonFromSlice(self.api.plauth, removed_user_id, slice_record['name'])
385 # update_existing users
386 updated_users_list = [user for user in existing_slice_users if user['email'] in \
388 self.verify_keys(existing_slice_users, updated_users_list, peer, append)
392 for added_user_id in added_user_ids:
393 added_user = users_dict[added_user_id]
394 hrn, type = urn_to_hrn(added_user['urn'])
396 'first_name': added_user.get('first_name', hrn),
397 'last_name': added_user.get('last_name', hrn),
398 'email': added_user_id,
399 'peer_person_id': None,
401 'key_ids': added_user.get('key_ids', []),
403 person['person_id'] = self.api.plshell.AddPerson(self.api.plauth, person)
405 person['peer_person_id'] = added_user['person_id']
406 added_persons.append(person)
409 self.api.plshell.UpdatePerson(self.api.plauth, person['person_id'], {'enabled': True})
412 self.api.plshell.AddPersonToSite(self.api.plauth, added_user_id, login_base)
414 for key_string in added_user.get('keys', []):
415 key = {'key':key_string, 'key_type':'ssh'}
416 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, person['person_id'], key)
417 person['keys'].append(key)
419 # add the registry record
421 peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
422 'pointer': person['person_id']}
423 self.registry.register_peer_object(self.credential, peer_dict)
425 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
426 # add person to the slice
427 self.api.plshell.AddPersonToSlice(self.api.plauth, added_slice_user_id, slice_record['name'])
428 # if this is a peer record then it should already be bound to a peer.
429 # no need to return worry about it getting bound later
434 def verify_keys(self, persons, users, peer, append=True):
437 for person in persons:
438 key_ids.extend(person['key_ids'])
439 keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key'])
442 keydict[key['key']] = key['key_id']
443 existing_keys = keydict.keys()
445 for person in persons:
446 persondict[person['email']] = person
452 user_keys = user.get('keys', [])
453 updated_persons.append(user)
454 for key_string in user_keys:
455 requested_keys.append(key_string)
456 if key_string not in existing_keys:
457 key = {'key': key_string, 'key_type': 'ssh'}
460 person = persondict[user['email']]
461 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'])
462 key['key_id'] = self.api.plshell.AddPersonKey(self.api.plauth, user['email'], key)
464 key_index = user_keys.index(key['key'])
465 remote_key_id = user['key_ids'][key_index]
466 self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key['key_id'], peer['shortname'], remote_key_id)
470 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person['person_id'], peer['shortname'], user['person_id'])
472 # remove old keys (only if we are not appending)
474 removed_keys = set(existing_keys).difference(requested_keys)
475 for existing_key_id in keydict:
476 if keydict[existing_key_id] in removed_keys:
479 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'key', existing_key_id, peer['shortname'])
480 self.api.plshell.DeleteKey(self.api.plauth, existing_key_id)
484 def verify_slice_attributes(self, slice, requested_slice_attributes):
485 # get list of attributes users ar able to manage
486 slice_attributes = self.api.plshell.GetTagTypes(self.api.plauth, {'category': '*slice*', '|roles': ['user']})
487 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
489 # get sliver attributes
490 added_slice_attributes = []
491 removed_slice_attributes = []
492 ignored_slice_attribute_names = []
493 existing_slice_attributes = self.api.plshell.GetSliceTags(self.api.plauth, {'slice_id': slice['slice_id']})
495 # get attributes that should be removed
496 for slice_tag in existing_slice_attributes:
497 if slice_tag['tagname'] in ignored_slice_attribute_names:
498 # If a slice already has a admin only role it was probably given to them by an
499 # admin, so we should ignore it.
500 ignored_slice_attribute_names.append(slice_tag['tagname'])
502 # If an existing slice attribute was not found in the request it should
504 attribute_found=False
505 for requested_attribute in requested_slice_attributes:
506 if requested_attribute['name'] == slice_tag['tagname'] and \
507 requested_attribute['value'] == slice_tag['value']:
511 if not attribute_found:
512 removed_slice_attributes.append(slice_tag)
514 # get attributes that should be added:
515 for requested_attribute in requested_slice_attributes:
516 # if the requested attribute wasn't found we should add it
517 if requested_attribute['name'] in valid_slice_attribute_names:
518 attribute_found = False
519 for existing_attribute in existing_slice_attributes:
520 if requested_attribute['name'] == existing_attribute['tagname'] and \
521 requested_attribute['value'] == existing_attribute['value']:
524 if not attribute_found:
525 added_slice_attributes.append(requested_attribute)
528 # remove stale attributes
529 for attribute in removed_slice_attributes:
531 self.api.plshell.DeleteSliceTag(self.api.plauth, attribute['slice_tag_id'])
533 self.api.logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
534 % (name, value, node_id, str(e)))
536 # add requested_attributes
537 for attribute in added_slice_attributes:
539 name, value, node_id = attribute['name'], attribute['value'], attribute.get('node_id', None)
540 self.api.plshell.AddSliceTag(self.api.plauth, slice['name'], name, value, node_id)
542 self.api.logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
543 % (name, value, node_id, str(e)))
545 def create_slice_aggregate(self, xrn, rspec):
546 hrn, type = urn_to_hrn(xrn)
547 # Determine if this is a peer slice
548 peer = self.get_peer(hrn)
549 sfa_peer = self.get_sfa_peer(hrn)
552 # Get the slice record from sfa
553 slicename = hrn_to_pl_slicename(hrn)
556 registry = self.api.registries[self.api.hrn]
557 credential = self.api.getCredential()
559 site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
560 slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
562 # find out where this slice is currently running
563 nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
564 hostnames = [node['hostname'] for node in nodelist]
566 # get netspec details
567 nodespecs = spec.getDictsByTagName('NodeSpec')
569 # dict in which to store slice attributes to set for the nodes
571 for nodespec in nodespecs:
572 if isinstance(nodespec['name'], list):
573 for nodename in nodespec['name']:
575 for k in nodespec.keys():
576 rspec_attribute_value = nodespec[k]
577 if (self.rspec_to_slice_tag.has_key(k)):
578 slice_tag_name = self.rspec_to_slice_tag[k]
579 nodes[nodename][slice_tag_name] = rspec_attribute_value
580 elif isinstance(nodespec['name'], StringTypes):
581 nodename = nodespec['name']
583 for k in nodespec.keys():
584 rspec_attribute_value = nodespec[k]
585 if (self.rspec_to_slice_tag.has_key(k)):
586 slice_tag_name = self.rspec_to_slice_tag[k]
587 nodes[nodename][slice_tag_name] = rspec_attribute_value
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 node_names = nodes.keys()
596 # remove nodes not in rspec
597 deleted_nodes = list(set(hostnames).difference(node_names))
598 # add nodes from rspec
599 added_nodes = list(set(node_names).difference(hostnames))
603 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
605 self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
607 # Add recognized slice tags
608 for node_name in node_names:
609 node = nodes[node_name]
610 for slice_tag in node.keys():
611 value = node[slice_tag]
612 if (isinstance(value, list)):
615 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
617 self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
620 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])