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