Merge branch 'master' into senslab2
[sfa.git] / sfa / planetlab / plslices.py
1 from types import StringTypes
2 from collections import defaultdict
3 import sys
4
5 from sfa.util.sfatime import utcparse, datetime_to_epoch
6 from sfa.util.sfalogging import logger
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
8
9 from sfa.rspecs.rspec import RSpec
10
11 from sfa.planetlab.vlink import VLink
12 from sfa.planetlab.plxrn import PlXrn, 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         # get this slice's authority (site)
135         slice_authority = get_authority(hrn)
136
137         # get this site's authority (sfa root authority or sub authority)
138         site_authority = get_authority(slice_authority).lower()
139         # check if we are already peered with this site_authority, if so
140         peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
141         for peer_record in peers:
142             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
143             if site_authority in names:
144                 peer = peer_record
145
146         return peer
147
148     def get_sfa_peer(self, xrn):
149         hrn, type = urn_to_hrn(xrn)
150
151         # return the authority for this hrn or None if we are the authority
152         sfa_peer = None
153         slice_authority = get_authority(hrn)
154         site_authority = get_authority(slice_authority)
155
156         if site_authority != self.driver.hrn:
157             sfa_peer = site_authority
158
159         return sfa_peer
160
161     def verify_slice_nodes(self, slice, requested_slivers, peer):
162         
163         nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
164         current_slivers = [node['hostname'] for node in nodes]
165
166         # remove nodes not in rspec
167         deleted_nodes = list(set(current_slivers).difference(requested_slivers))
168
169         # add nodes from rspec
170         added_nodes = list(set(requested_slivers).difference(current_slivers))        
171
172         try:
173             if peer:
174                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
175             self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
176             self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
177
178         except: 
179             logger.log_exc('Failed to add/remove slice from nodes')
180         return nodes
181
182     def free_egre_key(self):
183         used = set()
184         for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
185                 used.add(int(tag['value']))
186
187         for i in range(1, 256):
188             if i not in used:
189                 key = i
190                 break
191         else:
192             raise KeyError("No more EGRE keys available")
193
194         return str(key)
195
196     def verify_slice_links(self, slice, requested_links, nodes):
197         # nodes is undefined here
198         if not requested_links:
199             return
200    
201         # build dict of nodes 
202         nodes_dict = {}
203         interface_ids = []
204         for node in nodes:
205             nodes_dict[node['node_id']] = node
206             interface_ids.extend(node['interface_ids'])
207         # build dict of interfaces
208         interfaces = self.driver.shell.GetInterfaces(interface_ids)
209         interfaces_dict = {}
210         for interface in interfaces:
211             interfaces_dict[interface['interface_id']] = interface 
212
213         slice_tags = []
214         
215         # set egre key
216         slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
217     
218         # set netns
219         slice_tags.append({'name': 'netns', 'value': '1'})
220
221         # set cap_net_admin 
222         # need to update the attribute string?
223         slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'}) 
224         
225         for link in requested_links:
226             # get the ip address of the first node in the link
227             ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
228             (node_raw, device) = ifname1.split(':')
229             node_id = int(node_raw.replace('node', ''))
230             node = nodes_dict[node_id]
231             if1 = interfaces_dict[node['interface_ids'][0]]
232             ipaddr = if1['ip']
233             topo_rspec = VLink.get_topo_rspec(link, ipaddr)
234             # set topo_rspec tag
235             slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
236             # set vini_topo tag
237             slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
238             #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id) 
239
240         self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
241                         
242         
243
244     def handle_peer(self, site, slice, persons, peer):
245         if peer:
246             # bind site
247             try:
248                 if site:
249                     self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
250             except Exception,e:
251                 self.driver.shell.DeleteSite(site['site_id'])
252                 raise e
253             
254             # bind slice
255             try:
256                 if slice:
257                     self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
258             except Exception,e:
259                 self.driver.shell.DeleteSlice(slice['slice_id'])
260                 raise e 
261
262             # bind persons
263             for person in persons:
264                 try:
265                     self.driver.shell.BindObjectToPeer('person', 
266                                                      person['person_id'], peer['shortname'], person['peer_person_id'])
267
268                     for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
269                         try:
270                             self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
271                         except:
272                             self.driver.shell.DeleteKey(key['key_id'])
273                             logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
274                 except Exception,e:
275                     self.driver.shell.DeletePerson(person['person_id'])
276                     raise e       
277
278         return slice
279
280     def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
281         (slice_hrn, type) = urn_to_hrn(slice_xrn)
282         site_hrn = get_authority(slice_hrn)
283         # login base can't be longer than 20 characters
284         slicename = hrn_to_pl_slicename(slice_hrn)
285         authority_name = slicename.split('_')[0]
286         login_base = authority_name[:20]
287         sites = self.driver.shell.GetSites(login_base)
288         if not sites:
289             # create new site record
290             site = {'name': 'geni.%s' % authority_name,
291                     'abbreviated_name': authority_name,
292                     'login_base': login_base,
293                     'max_slices': 100,
294                     'max_slivers': 1000,
295                     'enabled': True,
296                     'peer_site_id': None}
297             if peer:
298                 site['peer_site_id'] = slice_record.get('site_id', None)
299             site['site_id'] = self.driver.shell.AddSite(site)
300             # exempt federated sites from monitor policies
301             self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
302             
303 #            # is this still necessary?
304 #            # add record to the local registry 
305 #            if sfa_peer and slice_record:
306 #                peer_dict = {'type': 'authority', 'hrn': site_hrn, \
307 #                             'peer_authority': sfa_peer, 'pointer': site['site_id']}
308 #                self.registry.register_peer_object(self.credential, peer_dict)
309         else:
310             site =  sites[0]
311             if peer:
312                 # unbind from peer so we can modify if necessary. Will bind back later
313                 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname']) 
314         
315         return site        
316
317     def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
318         slicename = hrn_to_pl_slicename(slice_hrn)
319         parts = slicename.split("_")
320         login_base = parts[0]
321         slices = self.driver.shell.GetSlices([slicename]) 
322         if not slices:
323             slice = {'name': slicename,
324                      'url': slice_record.get('url', slice_hrn), 
325                      'description': slice_record.get('description', slice_hrn)}
326             # add the slice                          
327             slice['slice_id'] = self.driver.shell.AddSlice(slice)
328             slice['node_ids'] = []
329             slice['person_ids'] = []
330             if peer:
331                 slice['peer_slice_id'] = slice_record.get('slice_id', None) 
332             # mark this slice as an sfa peer record
333 #            if sfa_peer:
334 #                peer_dict = {'type': 'slice', 'hrn': slice_hrn, 
335 #                             'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
336 #                self.registry.register_peer_object(self.credential, peer_dict)
337         else:
338             slice = slices[0]
339             if peer:
340                 slice['peer_slice_id'] = slice_record.get('slice_id', None)
341                 # unbind from peer so we can modify if necessary. Will bind back later
342                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
343                 #Update existing record (e.g. expires field) it with the latest info.
344             if slice_record.get('expires'):
345                 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
346                 if requested_expires and slice['expires'] != requested_expires:
347                     self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_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 = PlXrn(xrn=user['urn']).pl_login_base()
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                                     requested_user['email'] = 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                         requested_user['email'] = fake_email
421                         users_dict[fake_email] = requested_user
422                 
423         # requested slice users        
424         requested_user_ids = users_dict.keys()
425         # existing slice users
426         existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
427         existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
428                                                           ['person_id', 'key_ids', 'email'])
429         existing_slice_user_ids = [user['email'] for user in existing_slice_users]
430         
431         # users to be added, removed or updated
432         added_user_ids = set(requested_user_ids).difference(existing_user_ids)
433         added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
434         removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
435         updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
436
437         # Remove stale users (only if we are not appending).
438         # Append by default.
439         append = options.get('append', True)
440         if append == False:
441             for removed_user_id in removed_user_ids:
442                 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
443         # update_existing users
444         updated_users_list = [user for user in users_dict.values() if user['email'] in \
445           updated_user_ids]
446         self.verify_keys(existing_slice_users, updated_users_list, peer, options)
447
448         added_persons = []
449         # add new users
450         for added_user_id in added_user_ids:
451             added_user = users_dict[added_user_id]
452             hrn, type = urn_to_hrn(added_user['urn'])  
453             person = {
454                 'first_name': added_user.get('first_name', hrn),
455                 'last_name': added_user.get('last_name', hrn),
456                 'email': added_user_id,
457                 'peer_person_id': None,
458                 'keys': [],
459                 'key_ids': added_user.get('key_ids', []),
460             }
461             person['person_id'] = self.driver.shell.AddPerson(person)
462             if peer:
463                 person['peer_person_id'] = added_user['person_id']
464             added_persons.append(person)
465            
466             # enable the account 
467             self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
468             
469             # add person to site
470             self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
471
472             for key_string in added_user.get('keys', []):
473                 key = {'key':key_string, 'key_type':'ssh'}
474                 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
475                 person['keys'].append(key)
476
477             # add the registry record
478 #            if sfa_peer:
479 #                peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
480 #                    'pointer': person['person_id']}
481 #                self.registry.register_peer_object(self.credential, peer_dict)
482     
483         for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
484             # add person to the slice 
485             self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
486             # if this is a peer record then it should already be bound to a peer.
487             # no need to return worry about it getting bound later 
488
489         return added_persons
490             
491
492     def verify_keys(self, persons, users, peer, options={}):
493         # existing keys 
494         key_ids = []
495         for person in persons:
496             key_ids.extend(person['key_ids'])
497         keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
498         keydict = {}
499         for key in keylist:
500             keydict[key['key']] = key['key_id']     
501         existing_keys = keydict.keys()
502         persondict = {}
503         for person in persons:
504             persondict[person['email']] = person    
505     
506         # add new keys
507         requested_keys = []
508         updated_persons = []
509         for user in users:
510             user_keys = user.get('keys', [])
511             updated_persons.append(user)
512             for key_string in user_keys:
513                 requested_keys.append(key_string)
514                 if key_string not in existing_keys:
515                     key = {'key': key_string, 'key_type': 'ssh'}
516                     try:
517                         if peer:
518                             person = persondict[user['email']]
519                             self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
520                         key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
521                         if peer:
522                             key_index = user_keys.index(key['key'])
523                             remote_key_id = user['key_ids'][key_index]
524                             self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
525                             
526                     finally:
527                         if peer:
528                             self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
529         
530         # remove old keys (only if we are not appending)
531         append = options.get('append', True)
532         if append == False: 
533             removed_keys = set(existing_keys).difference(requested_keys)
534             for existing_key_id in keydict:
535                 if keydict[existing_key_id] in removed_keys:
536                     try:
537                         if peer:
538                             self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
539                         self.driver.shell.DeleteKey(existing_key_id)
540                     except:
541                         pass   
542
543     def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
544         append = options.get('append', True)
545         # get list of attributes users ar able to manage
546         filter = {'category': '*slice*'}
547         if not admin:
548             filter['|roles'] = ['user']
549         slice_attributes = self.driver.shell.GetTagTypes(filter)
550         valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
551
552         # get sliver attributes
553         added_slice_attributes = []
554         removed_slice_attributes = []
555         ignored_slice_attribute_names = []
556         existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
557         
558         # get attributes that should be removed
559         for slice_tag in existing_slice_attributes:
560             if slice_tag['tagname'] in ignored_slice_attribute_names:
561                 # If a slice already has a admin only role it was probably given to them by an
562                 # admin, so we should ignore it.
563                 ignored_slice_attribute_names.append(slice_tag['tagname'])
564             else:
565                 # If an existing slice attribute was not found in the request it should
566                 # be removed
567                 attribute_found=False
568                 for requested_attribute in requested_slice_attributes:
569                     if requested_attribute['name'] == slice_tag['tagname'] and \
570                        requested_attribute['value'] == slice_tag['value']:
571                         attribute_found=True
572                         break
573
574             if not attribute_found and not append:
575                 removed_slice_attributes.append(slice_tag)
576         
577         # get attributes that should be added:
578         for requested_attribute in requested_slice_attributes:
579             # if the requested attribute wasn't found  we should add it
580             if requested_attribute['name'] in valid_slice_attribute_names:
581                 attribute_found = False
582                 for existing_attribute in existing_slice_attributes:
583                     if requested_attribute['name'] == existing_attribute['tagname'] and \
584                        requested_attribute['value'] == existing_attribute['value']:
585                         attribute_found=True
586                         break
587                 if not attribute_found:
588                     added_slice_attributes.append(requested_attribute)
589
590
591         # remove stale attributes
592         for attribute in removed_slice_attributes:
593             try:
594                 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
595             except Exception, e:
596                 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
597                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
598
599         # add requested_attributes
600         for attribute in added_slice_attributes:
601             try:
602                 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
603             except Exception, e:
604                 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
605                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
606