Merge branch 'master' into senslab2
[sfa.git] / sfa / plc / plslices.py
1 from types import StringTypes
2 from collections import defaultdict
3 import sys
4
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.xrn import Xrn
9
10 from sfa.rspecs.rspec import RSpec
11
12 from sfa.plc.vlink import VLink
13 from sfa.util.plxrn import hrn_to_pl_slicename
14
15 MAXINT =  2L**31-1
16
17 class PlSlices:
18
19     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20
21     def __init__(self, driver):
22         self.driver = driver
23
24     def get_slivers(self, xrn, node=None):
25         hrn, type = urn_to_hrn(xrn)
26          
27         slice_name = hrn_to_pl_slicename(hrn)
28         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
29         # of doing all of this?
30         #return self.driver.shell.GetSliceTicket(self.auth, slice_name) 
31         
32         # from PLCAPI.GetSlivers.get_slivers()
33         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
34         slices = self.driver.shell.GetSlices(slice_name, slice_fields)
35         # Build up list of users and slice attributes
36         person_ids = set()
37         all_slice_tag_ids = set()
38         for slice in slices:
39             person_ids.update(slice['person_ids'])
40             all_slice_tag_ids.update(slice['slice_tag_ids'])
41         person_ids = list(person_ids)
42         all_slice_tag_ids = list(all_slice_tag_ids)
43         # Get user information
44         all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
45         all_persons = {}
46         for person in all_persons_list:
47             all_persons[person['person_id']] = person        
48
49         # Build up list of keys
50         key_ids = set()
51         for person in all_persons.values():
52             key_ids.update(person['key_ids'])
53         key_ids = list(key_ids)
54         # Get user account keys
55         all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56         all_keys = {}
57         for key in all_keys_list:
58             all_keys[key['key_id']] = key
59         # Get slice attributes
60         all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61         all_slice_tags = {}
62         for slice_tag in all_slice_tags_list:
63             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
64            
65         slivers = []
66         for slice in slices:
67             keys = []
68             for person_id in slice['person_ids']:
69                 if person_id in all_persons:
70                     person = all_persons[person_id]
71                     if not person['enabled']:
72                         continue
73                     for key_id in person['key_ids']:
74                         if key_id in all_keys:
75                             key = all_keys[key_id]
76                             keys += [{'key_type': key['key_type'],
77                                     'key': key['key']}]
78             attributes = []
79             # All (per-node and global) attributes for this slice
80             slice_tags = []
81             for slice_tag_id in slice['slice_tag_ids']:
82                 if slice_tag_id in all_slice_tags:
83                     slice_tags.append(all_slice_tags[slice_tag_id]) 
84             # Per-node sliver attributes take precedence over global
85             # slice attributes, so set them first.
86             # Then comes nodegroup slice attributes
87             # Followed by global slice attributes
88             sliver_attributes = []
89
90             if node is not None:
91                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
92                     sliver_attributes.append(sliver_attribute['tagname'])
93                     attributes.append({'tagname': sliver_attribute['tagname'],
94                                     'value': sliver_attribute['value']})
95
96             # set nodegroup slice attributes
97             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
98                 # Do not set any nodegroup slice attributes for
99                 # which there is at least one sliver attribute
100                 # already set.
101                 if slice_tag not in slice_tags:
102                     attributes.append({'tagname': slice_tag['tagname'],
103                         'value': slice_tag['value']})
104
105             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
106                 # Do not set any global slice attributes for
107                 # which there is at least one sliver attribute
108                 # already set.
109                 if slice_tag['tagname'] not in sliver_attributes:
110                     attributes.append({'tagname': slice_tag['tagname'],
111                                    'value': slice_tag['value']})
112
113             # XXX Sanity check; though technically this should be a system invariant
114             # checked with an assertion
115             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
116             
117             slivers.append({
118                 'hrn': hrn,
119                 'name': slice['name'],
120                 'slice_id': slice['slice_id'],
121                 'instantiation': slice['instantiation'],
122                 'expires': slice['expires'],
123                 'keys': keys,
124                 'attributes': attributes
125             })
126
127         return slivers
128  
129     def get_peer(self, xrn):
130         hrn, type = urn_to_hrn(xrn)
131         # Becaues of myplc federation,  we first need to determine if this
132         # slice belongs to out local plc or a myplc peer. We will assume it 
133         # is a local site, unless we find out otherwise  
134         peer = None
135         print>>sys.stderr, " \r\n \r\n \tplslices.py get_peer slice_authority  "
136         # get this slice's authority (site)
137         slice_authority = get_authority(hrn)
138
139         # get this site's authority (sfa root authority or sub authority)
140         site_authority = get_authority(slice_authority).lower()
141         print>>sys.stderr, " \r\n \r\n \tplslices.py get_peer slice_authority  %s site_authority %s" %(slice_authority,site_authority) 
142         # check if we are already peered with this site_authority, if so
143         peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
144         for peer_record in peers:
145             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
146             if site_authority in names:
147                 peer = peer_record
148
149         return peer
150
151     def get_sfa_peer(self, xrn):
152         hrn, type = urn_to_hrn(xrn)
153
154         # return the authority for this hrn or None if we are the authority
155         sfa_peer = None
156         slice_authority = get_authority(hrn)
157         site_authority = get_authority(slice_authority)
158
159         if site_authority != self.driver.hrn:
160             sfa_peer = site_authority
161
162         return sfa_peer
163
164     def verify_slice_nodes(self, slice, requested_slivers, peer):
165         
166         nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
167         current_slivers = [node['hostname'] for node in nodes]
168
169         # remove nodes not in rspec
170         deleted_nodes = list(set(current_slivers).difference(requested_slivers))
171
172         # add nodes from rspec
173         added_nodes = list(set(requested_slivers).difference(current_slivers))        
174
175         try:
176             if peer:
177                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
178             self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
179             self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
180
181         except: 
182             logger.log_exc('Failed to add/remove slice from nodes')
183         return nodes
184
185     def free_egre_key(self):
186         used = set()
187         for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
188                 used.add(int(tag['value']))
189
190         for i in range(1, 256):
191             if i not in used:
192                 key = i
193                 break
194         else:
195             raise KeyError("No more EGRE keys available")
196
197         return str(key)
198
199     def verify_slice_links(self, slice, requested_links, nodes):
200         # nodes is undefined here
201         if not requested_links:
202             return
203    
204         # build dict of nodes 
205         nodes_dict = {}
206         interface_ids = []
207         for node in nodes:
208             nodes_dict[node['node_id']] = node
209             interface_ids.extend(node['interface_ids'])
210         # build dict of interfaces
211         interfaces = self.driver.shell.GetInterfaces(interface_ids)
212         interfaces_dict = {}
213         for interface in interfaces:
214             interfaces_dict[interface['interface_id']] = interface 
215
216         slice_tags = []
217         
218         # set egre key
219         slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
220     
221         # set netns
222         slice_tags.append({'name': 'netns', 'value': '1'})
223
224         # set cap_net_admin 
225         # need to update the attribute string?
226         slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'}) 
227         
228         for link in requested_links:
229             # get the ip address of the first node in the link
230             ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
231             (node_raw, device) = ifname1.split(':')
232             node_id = int(node_raw.replace('node', ''))
233             node = nodes_dict[node_id]
234             if1 = interfaces_dict[node['interface_ids'][0]]
235             ipaddr = if1['ip']
236             topo_rspec = VLink.get_topo_rspec(link, ipaddr)
237             # set topo_rspec tag
238             slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
239             # set vini_topo tag
240             slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
241             #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id) 
242
243         self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
244                         
245         
246
247     def handle_peer(self, site, slice, persons, peer):
248         if peer:
249             # bind site
250             try:
251                 if site:
252                     self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
253             except Exception,e:
254                 self.driver.shell.DeleteSite(site['site_id'])
255                 raise e
256             
257             # bind slice
258             try:
259                 if slice:
260                     self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
261             except Exception,e:
262                 self.driver.shell.DeleteSlice(slice['slice_id'])
263                 raise e 
264
265             # bind persons
266             for person in persons:
267                 try:
268                     self.driver.shell.BindObjectToPeer('person', 
269                                                      person['person_id'], peer['shortname'], person['peer_person_id'])
270
271                     for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
272                         try:
273                             self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
274                         except:
275                             self.driver.shell.DeleteKey(key['key_id'])
276                             logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
277                 except Exception,e:
278                     self.driver.shell.DeletePerson(person['person_id'])
279                     raise e       
280
281         return slice
282
283     def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
284         (slice_hrn, type) = urn_to_hrn(slice_xrn)
285         site_hrn = get_authority(slice_hrn)
286         # login base can't be longer than 20 characters
287         slicename = hrn_to_pl_slicename(slice_hrn)
288         authority_name = slicename.split('_')[0]
289         login_base = authority_name[:20]
290         sites = self.driver.shell.GetSites(login_base)
291         if not sites:
292             # create new site record
293             site = {'name': 'geni.%s' % authority_name,
294                     'abbreviated_name': authority_name,
295                     'login_base': login_base,
296                     'max_slices': 100,
297                     'max_slivers': 1000,
298                     'enabled': True,
299                     'peer_site_id': None}
300             if peer:
301                 site['peer_site_id'] = slice_record.get('site_id', None)
302             site['site_id'] = self.driver.shell.AddSite(site)
303             # exempt federated sites from monitor policies
304             self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
305             
306 #            # is this still necessary?
307 #            # add record to the local registry 
308 #            if sfa_peer and slice_record:
309 #                peer_dict = {'type': 'authority', 'hrn': site_hrn, \
310 #                             'peer_authority': sfa_peer, 'pointer': site['site_id']}
311 #                self.registry.register_peer_object(self.credential, peer_dict)
312         else:
313             site =  sites[0]
314             if peer:
315                 # unbind from peer so we can modify if necessary. Will bind back later
316                 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname']) 
317         
318         return site        
319
320     def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
321         slicename = hrn_to_pl_slicename(slice_hrn)
322         parts = slicename.split("_")
323         login_base = parts[0]
324         slices = self.driver.shell.GetSlices([slicename]) 
325         if not slices:
326             slice = {'name': slicename,
327                      'url': slice_record.get('url', slice_hrn), 
328                      'description': slice_record.get('description', slice_hrn)}
329             # add the slice                          
330             slice['slice_id'] = self.driver.shell.AddSlice(slice)
331             slice['node_ids'] = []
332             slice['person_ids'] = []
333             if peer:
334                 slice['peer_slice_id'] = slice_record.get('slice_id', None) 
335             # mark this slice as an sfa peer record
336 #            if sfa_peer:
337 #                peer_dict = {'type': 'slice', 'hrn': slice_hrn, 
338 #                             'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
339 #                self.registry.register_peer_object(self.credential, peer_dict)
340         else:
341             slice = slices[0]
342             if peer:
343                 slice['peer_slice_id'] = slice_record.get('slice_id', None)
344                 # unbind from peer so we can modify if necessary. Will bind back later
345                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
346                 #Update existing record (e.g. expires field) it with the latest info.
347             if slice_record and slice['expires'] != slice_record['expires']:
348                 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : slice_record['expires']})
349        
350         return slice
351
352     #def get_existing_persons(self, users):
353     def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
354         users_by_email = {}
355         users_by_site = defaultdict(list)
356         users_dict = {} 
357         for user in users:
358             hrn, type = urn_to_hrn(user['urn'])
359             username = get_leaf(hrn)
360             login_base = get_leaf(get_authority(user['urn']))
361             user['username'] = username
362             user['site'] = login_base
363
364             if 'email' in user:
365                 users_by_email[user['email']] = user
366                 users_dict[user['email']] = user
367             else:
368                 users_by_site[user['site']].append(user)
369
370         # start building a list of existing users
371         existing_user_ids = []
372         existing_user_ids_filter = []
373         if users_by_email:
374             existing_user_ids_filter.extend(users_by_email.keys())
375         if users_by_site:
376             for login_base in users_by_site:
377                 users = users_by_site[login_base]
378                 for user in users:      
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])
385         
386         if users_by_site:
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
391             sites = {}
392             site_user_ids = []
393             for site in site_list:
394                 sites[site['site_id']] = site
395                 site_user_ids.extend(site['person_ids'])
396
397             existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,  
398                                                                     ['person_id', 'key_ids', 'email', 'site_ids'])
399
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:
404                     user_found = False
405                     for existing_user in existing_site_persons_list:
406                         for site_id in existing_user['site_ids']:
407                             if site_id in sites:
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                                     users_dict[existing_user['email']] = requested_user
413                                     user_found = True
414                                     break
415                         if user_found:
416                             break
417       
418                     if user_found == False:
419                         fake_email = requested_user['username'] + '@geni.net'
420                         users_dict[fake_email] = requested_user
421                 
422         # requested slice users        
423         requested_user_ids = users_dict.keys()
424         # existing slice users
425         existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
426         existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
427                                                           ['person_id', 'key_ids', 'email'])
428         existing_slice_user_ids = [user['email'] for user in existing_slice_users]
429         
430         # users to be added, removed or updated
431         added_user_ids = set(requested_user_ids).difference(existing_user_ids)
432         added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
433         removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
434         updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
435
436         # Remove stale users (only if we are not appending).
437         # Append by default.
438         append = options.get('append', True)
439         if append == False:
440             for removed_user_id in removed_user_ids:
441                 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
442         # update_existing users
443         updated_users_list = [user for user in existing_slice_users if user['email'] in \
444           updated_user_ids]
445         self.verify_keys(existing_slice_users, updated_users_list, peer, options)
446
447         added_persons = []
448         # add new users
449         for added_user_id in added_user_ids:
450             added_user = users_dict[added_user_id]
451             hrn, type = urn_to_hrn(added_user['urn'])  
452             person = {
453                 'first_name': added_user.get('first_name', hrn),
454                 'last_name': added_user.get('last_name', hrn),
455                 'email': added_user_id,
456                 'peer_person_id': None,
457                 'keys': [],
458                 'key_ids': added_user.get('key_ids', []),
459             }
460             person['person_id'] = self.driver.shell.AddPerson(person)
461             if peer:
462                 person['peer_person_id'] = added_user['person_id']
463             added_persons.append(person)
464            
465             # enable the account 
466             self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
467             
468             # add person to site
469             self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
470
471             for key_string in added_user.get('keys', []):
472                 key = {'key':key_string, 'key_type':'ssh'}
473                 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
474                 person['keys'].append(key)
475
476             # add the registry record
477 #            if sfa_peer:
478 #                peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
479 #                    'pointer': person['person_id']}
480 #                self.registry.register_peer_object(self.credential, peer_dict)
481     
482         for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
483             # add person to the slice 
484             self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
485             # if this is a peer record then it should already be bound to a peer.
486             # no need to return worry about it getting bound later 
487
488         return added_persons
489             
490
491     def verify_keys(self, persons, users, peer, options={}):
492         # existing keys 
493         key_ids = []
494         for person in persons:
495             key_ids.extend(person['key_ids'])
496         keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
497         keydict = {}
498         for key in keylist:
499             keydict[key['key']] = key['key_id']     
500         existing_keys = keydict.keys()
501         persondict = {}
502         for person in persons:
503             persondict[person['email']] = person    
504     
505         # add new keys
506         requested_keys = []
507         updated_persons = []
508         for user in users:
509             user_keys = user.get('keys', [])
510             updated_persons.append(user)
511             for key_string in user_keys:
512                 requested_keys.append(key_string)
513                 if key_string not in existing_keys:
514                     key = {'key': key_string, 'key_type': 'ssh'}
515                     try:
516                         if peer:
517                             person = persondict[user['email']]
518                             self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
519                         key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
520                         if peer:
521                             key_index = user_keys.index(key['key'])
522                             remote_key_id = user['key_ids'][key_index]
523                             self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
524                             
525                     finally:
526                         if peer:
527                             self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
528         
529         # remove old keys (only if we are not appending)
530         append = options.get('append', True)
531         if append == False: 
532             removed_keys = set(existing_keys).difference(requested_keys)
533             for existing_key_id in keydict:
534                 if keydict[existing_key_id] in removed_keys:
535                     try:
536                         if peer:
537                             self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
538                         self.driver.shell.DeleteKey(existing_key_id)
539                     except:
540                         pass   
541
542     def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
543         append = options.get('append', True)
544         # get list of attributes users ar able to manage
545         filter = {'category': '*slice*'}
546         if not admin:
547             filter['|roles'] = ['user']
548         slice_attributes = self.driver.shell.GetTagTypes(filter)
549         valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
550
551         # get sliver attributes
552         added_slice_attributes = []
553         removed_slice_attributes = []
554         ignored_slice_attribute_names = []
555         existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
556         
557         # get attributes that should be removed
558         for slice_tag in existing_slice_attributes:
559             if slice_tag['tagname'] in ignored_slice_attribute_names:
560                 # If a slice already has a admin only role it was probably given to them by an
561                 # admin, so we should ignore it.
562                 ignored_slice_attribute_names.append(slice_tag['tagname'])
563             else:
564                 # If an existing slice attribute was not found in the request it should
565                 # be removed
566                 attribute_found=False
567                 for requested_attribute in requested_slice_attributes:
568                     if requested_attribute['name'] == slice_tag['tagname'] and \
569                        requested_attribute['value'] == slice_tag['value']:
570                         attribute_found=True
571                         break
572
573             if not attribute_found and not append:
574                 removed_slice_attributes.append(slice_tag)
575         
576         # get attributes that should be added:
577         for requested_attribute in requested_slice_attributes:
578             # if the requested attribute wasn't found  we should add it
579             if requested_attribute['name'] in valid_slice_attribute_names:
580                 attribute_found = False
581                 for existing_attribute in existing_slice_attributes:
582                     if requested_attribute['name'] == existing_attribute['tagname'] and \
583                        requested_attribute['value'] == existing_attribute['value']:
584                         attribute_found=True
585                         break
586                 if not attribute_found:
587                     added_slice_attributes.append(requested_attribute)
588
589
590         # remove stale attributes
591         for attribute in removed_slice_attributes:
592             try:
593                 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
594             except Exception, e:
595                 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
596                                 % (name, value,  node_id, str(e)))
597
598         # add requested_attributes
599         for attribute in added_slice_attributes:
600             try:
601                 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
602             except Exception, e:
603                 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
604                                 % (name, value,  node_id, str(e)))
605