1 from types import StringTypes
2 from collections import defaultdict
4 from sfa.util.sfatime import utcparse, datetime_to_epoch
5 from sfa.util.sfalogging import logger
6 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
7 #from sfa.util.policy import Policy
8 from sfa.util.plxrn import PlXrn
9 from sfa.rspecs.rspec import RSpec
10 from sfa.plc.vlink import VLink
11 from sfa.util.plxrn import hrn_to_pl_slicename
17 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
19 def __init__(self, driver):
22 def get_slivers(self, xrn, node=None):
23 hrn, type = urn_to_hrn(xrn)
25 slice_name = hrn_to_pl_slicename(hrn)
26 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
27 # of doing all of this?
28 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
30 # from PLCAPI.GetSlivers.get_slivers()
31 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
32 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
33 # Build up list of users and slice attributes
35 all_slice_tag_ids = set()
37 person_ids.update(slice['person_ids'])
38 all_slice_tag_ids.update(slice['slice_tag_ids'])
39 person_ids = list(person_ids)
40 all_slice_tag_ids = list(all_slice_tag_ids)
41 # Get user information
42 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
44 for person in all_persons_list:
45 all_persons[person['person_id']] = person
47 # Build up list of keys
49 for person in all_persons.values():
50 key_ids.update(person['key_ids'])
51 key_ids = list(key_ids)
52 # Get user account keys
53 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
55 for key in all_keys_list:
56 all_keys[key['key_id']] = key
57 # Get slice attributes
58 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
60 for slice_tag in all_slice_tags_list:
61 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
66 for person_id in slice['person_ids']:
67 if person_id in all_persons:
68 person = all_persons[person_id]
69 if not person['enabled']:
71 for key_id in person['key_ids']:
72 if key_id in all_keys:
73 key = all_keys[key_id]
74 keys += [{'key_type': key['key_type'],
77 # All (per-node and global) attributes for this slice
79 for slice_tag_id in slice['slice_tag_ids']:
80 if slice_tag_id in all_slice_tags:
81 slice_tags.append(all_slice_tags[slice_tag_id])
82 # Per-node sliver attributes take precedence over global
83 # slice attributes, so set them first.
84 # Then comes nodegroup slice attributes
85 # Followed by global slice attributes
86 sliver_attributes = []
89 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
90 sliver_attributes.append(sliver_attribute['tagname'])
91 attributes.append({'tagname': sliver_attribute['tagname'],
92 'value': sliver_attribute['value']})
94 # set nodegroup slice attributes
95 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
96 # Do not set any nodegroup slice attributes for
97 # which there is at least one sliver attribute
99 if slice_tag not in slice_tags:
100 attributes.append({'tagname': slice_tag['tagname'],
101 'value': slice_tag['value']})
103 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
104 # Do not set any global slice attributes for
105 # which there is at least one sliver attribute
107 if slice_tag['tagname'] not in sliver_attributes:
108 attributes.append({'tagname': slice_tag['tagname'],
109 'value': slice_tag['value']})
111 # XXX Sanity check; though technically this should be a system invariant
112 # checked with an assertion
113 if slice['expires'] > MAXINT: slice['expires']= MAXINT
117 'name': slice['name'],
118 'slice_id': slice['slice_id'],
119 'instantiation': slice['instantiation'],
120 'expires': slice['expires'],
122 'attributes': attributes
127 def get_peer(self, xrn):
128 hrn, type = urn_to_hrn(xrn)
129 # Becaues of myplc federation, we first need to determine if this
130 # slice belongs to out local plc or a myplc peer. We will assume it
131 # is a local site, unless we find out otherwise
134 # get this slice's authority (site)
135 slice_authority = get_authority(hrn)
137 # get this site's authority (sfa root authority or sub authority)
138 site_authority = get_authority(slice_authority).lower()
140 # check if we are already peered with this site_authority, if so
141 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
142 for peer_record in peers:
143 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
144 if site_authority in names:
149 def get_sfa_peer(self, xrn):
150 hrn, type = urn_to_hrn(xrn)
152 # return the authority for this hrn or None if we are the authority
154 slice_authority = get_authority(hrn)
155 site_authority = get_authority(slice_authority)
157 if site_authority != self.driver.hrn:
158 sfa_peer = site_authority
162 def verify_slice_nodes(self, slice, requested_slivers, peer):
164 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
165 current_slivers = [node['hostname'] for node in nodes]
167 # remove nodes not in rspec
168 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
170 # add nodes from rspec
171 added_nodes = list(set(requested_slivers).difference(current_slivers))
175 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
176 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
177 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
180 logger.log_exc('Failed to add/remove slice from nodes')
183 def free_egre_key(self):
185 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
186 used.add(int(tag['value']))
188 for i in range(1, 256):
193 raise KeyError("No more EGRE keys available")
197 def verify_slice_links(self, slice, requested_links, nodes):
198 # nodes is undefined here
199 if not requested_links:
202 # build dict of nodes
206 nodes_dict[node['node_id']] = node
207 interface_ids.extend(node['interface_ids'])
208 # build dict of interfaces
209 interfaces = self.driver.shell.GetInterfaces(interface_ids)
211 for interface in interfaces:
212 interfaces_dict[interface['interface_id']] = interface
217 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
220 slice_tags.append({'name': 'netns', 'value': '1'})
223 # need to update the attribute string?
224 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
226 for link in requested_links:
227 # get the ip address of the first node in the link
228 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
229 (node_raw, device) = ifname1.split(':')
230 node_id = int(node_raw.replace('node', ''))
231 node = nodes_dict[node_id]
232 if1 = interfaces_dict[node['interface_ids'][0]]
234 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
236 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
238 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
239 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
241 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
245 def handle_peer(self, site, slice, persons, peer):
250 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
252 self.driver.shell.DeleteSite(site['site_id'])
258 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
260 self.driver.shell.DeleteSlice(slice['slice_id'])
264 for person in persons:
266 self.driver.shell.BindObjectToPeer('person',
267 person['person_id'], peer['shortname'], person['peer_person_id'])
269 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
271 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
273 self.driver.shell.DeleteKey(key['key_id'])
274 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
276 self.driver.shell.DeletePerson(person['person_id'])
281 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
282 (slice_hrn, type) = urn_to_hrn(slice_xrn)
283 site_hrn = get_authority(slice_hrn)
284 # login base can't be longer than 20 characters
285 slicename = hrn_to_pl_slicename(slice_hrn)
286 authority_name = slicename.split('_')[0]
287 login_base = authority_name[:20]
288 sites = self.driver.shell.GetSites(login_base)
290 # create new site record
291 site = {'name': 'geni.%s' % authority_name,
292 'abbreviated_name': authority_name,
293 'login_base': login_base,
297 'peer_site_id': None}
299 site['peer_site_id'] = slice_record.get('site_id', None)
300 site['site_id'] = self.driver.shell.AddSite(site)
301 # exempt federated sites from monitor policies
302 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
304 # # is this still necessary?
305 # # add record to the local registry
306 # if sfa_peer and slice_record:
307 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
308 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
309 # self.registry.register_peer_object(self.credential, peer_dict)
313 # unbind from peer so we can modify if necessary. Will bind back later
314 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
318 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
319 slicename = hrn_to_pl_slicename(slice_hrn)
320 parts = slicename.split("_")
321 login_base = parts[0]
322 slices = self.driver.shell.GetSlices([slicename])
324 slice = {'name': slicename,
325 'url': slice_record.get('url', slice_hrn),
326 'description': slice_record.get('description', slice_hrn)}
328 slice['slice_id'] = self.driver.shell.AddSlice(slice)
329 slice['node_ids'] = []
330 slice['person_ids'] = []
332 slice['peer_slice_id'] = slice_record.get('slice_id', None)
333 # mark this slice as an sfa peer record
335 # peer_dict = {'type': 'slice', 'hrn': slice_hrn,
336 # 'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
337 # self.registry.register_peer_object(self.credential, peer_dict)
341 slice['peer_slice_id'] = slice_record.get('slice_id', None)
342 # unbind from peer so we can modify if necessary. Will bind back later
343 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
344 #Update existing record (e.g. expires field) it with the latest info.
345 if slice_record.get('expires'):
346 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
347 if requested_expires and slice['expires'] != requested_expires:
348 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
352 #def get_existing_persons(self, users):
353 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
355 users_by_site = defaultdict(list)
358 hrn, type = urn_to_hrn(user['urn'])
359 username = get_leaf(hrn)
360 login_base = PlXrn(xrn=user['urn']).pl_login_base()
361 user['username'] = username
362 user['site'] = login_base
365 users_by_email[user['email']] = user
366 users_dict[user['email']] = user
368 users_by_site[user['site']].append(user)
370 # start building a list of existing users
371 existing_user_ids = []
372 existing_user_ids_filter = []
374 existing_user_ids_filter.extend(users_by_email.keys())
376 for login_base in users_by_site:
377 users = users_by_site[login_base]
379 existing_user_ids_filter.append(user['username']+'@geni.net')
380 if existing_user_ids_filter:
381 # get existing users by email
382 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
383 ['person_id', 'key_ids', 'email'])
384 existing_user_ids.extend([user['email'] for user in existing_users])
387 # get a list of user sites (based on requeste user urns
388 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
389 ['site_id', 'login_base', 'person_ids'])
390 # get all existing users at these sites
393 for site in site_list:
394 sites[site['site_id']] = site
395 site_user_ids.extend(site['person_ids'])
397 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
398 ['person_id', 'key_ids', 'email', 'site_ids'])
400 # all requested users are either existing users or new (added) users
401 for login_base in users_by_site:
402 requested_site_users = users_by_site[login_base]
403 for requested_user in requested_site_users:
405 for existing_user in existing_site_persons_list:
406 for site_id in existing_user['site_ids']:
408 site = sites[site_id]
409 if login_base == site['login_base'] and \
410 existing_user['email'].startswith(requested_user['username']+'@'):
411 existing_user_ids.append(existing_user['email'])
412 requested_user['email'] = existing_user['email']
413 users_dict[existing_user['email']] = requested_user
419 if user_found == False:
420 fake_email = requested_user['username'] + '@geni.net'
421 requested_user['email'] = fake_email
422 users_dict[fake_email] = requested_user
424 # requested slice users
425 requested_user_ids = users_dict.keys()
426 # existing slice users
427 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
428 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
429 ['person_id', 'key_ids', 'email'])
430 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
432 # users to be added, removed or updated
433 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
434 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
435 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
436 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
438 # Remove stale users (only if we are not appending).
440 append = options.get('append', True)
442 for removed_user_id in removed_user_ids:
443 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
444 # update_existing users
445 updated_users_list = [user for user in users_dict.values() if user['email'] in \
447 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
451 for added_user_id in added_user_ids:
452 added_user = users_dict[added_user_id]
453 hrn, type = urn_to_hrn(added_user['urn'])
455 'first_name': added_user.get('first_name', hrn),
456 'last_name': added_user.get('last_name', hrn),
457 'email': added_user_id,
458 'peer_person_id': None,
460 'key_ids': added_user.get('key_ids', []),
462 person['person_id'] = self.driver.shell.AddPerson(person)
464 person['peer_person_id'] = added_user['person_id']
465 added_persons.append(person)
468 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
471 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
473 for key_string in added_user.get('keys', []):
474 key = {'key':key_string, 'key_type':'ssh'}
475 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
476 person['keys'].append(key)
478 # add the registry record
480 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
481 # 'pointer': person['person_id']}
482 # self.registry.register_peer_object(self.credential, peer_dict)
484 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
485 # add person to the slice
486 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
487 # if this is a peer record then it should already be bound to a peer.
488 # no need to return worry about it getting bound later
493 def verify_keys(self, persons, users, peer, options={}):
496 for person in persons:
497 key_ids.extend(person['key_ids'])
498 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
501 keydict[key['key']] = key['key_id']
502 existing_keys = keydict.keys()
504 for person in persons:
505 persondict[person['email']] = person
511 user_keys = user.get('keys', [])
512 updated_persons.append(user)
513 for key_string in user_keys:
514 requested_keys.append(key_string)
515 if key_string not in existing_keys:
516 key = {'key': key_string, 'key_type': 'ssh'}
519 person = persondict[user['email']]
520 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
521 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
523 key_index = user_keys.index(key['key'])
524 remote_key_id = user['key_ids'][key_index]
525 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
529 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
531 # remove old keys (only if we are not appending)
532 append = options.get('append', True)
534 removed_keys = set(existing_keys).difference(requested_keys)
535 for existing_key_id in keydict:
536 if keydict[existing_key_id] in removed_keys:
539 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
540 self.driver.shell.DeleteKey(existing_key_id)
544 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
545 append = options.get('append', True)
546 # get list of attributes users ar able to manage
547 filter = {'category': '*slice*'}
549 filter['|roles'] = ['user']
550 slice_attributes = self.driver.shell.GetTagTypes(filter)
551 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
553 # get sliver attributes
554 added_slice_attributes = []
555 removed_slice_attributes = []
556 ignored_slice_attribute_names = []
557 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
559 # get attributes that should be removed
560 for slice_tag in existing_slice_attributes:
561 if slice_tag['tagname'] in ignored_slice_attribute_names:
562 # If a slice already has a admin only role it was probably given to them by an
563 # admin, so we should ignore it.
564 ignored_slice_attribute_names.append(slice_tag['tagname'])
566 # If an existing slice attribute was not found in the request it should
568 attribute_found=False
569 for requested_attribute in requested_slice_attributes:
570 if requested_attribute['name'] == slice_tag['tagname'] and \
571 requested_attribute['value'] == slice_tag['value']:
575 if not attribute_found and not append:
576 removed_slice_attributes.append(slice_tag)
578 # get attributes that should be added:
579 for requested_attribute in requested_slice_attributes:
580 # if the requested attribute wasn't found we should add it
581 if requested_attribute['name'] in valid_slice_attribute_names:
582 attribute_found = False
583 for existing_attribute in existing_slice_attributes:
584 if requested_attribute['name'] == existing_attribute['tagname'] and \
585 requested_attribute['value'] == existing_attribute['value']:
588 if not attribute_found:
589 added_slice_attributes.append(requested_attribute)
592 # remove stale attributes
593 for attribute in removed_slice_attributes:
595 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
597 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
598 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
600 # add requested_attributes
601 for attribute in added_slice_attributes:
603 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
605 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
606 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))