fe9d2e94698985c83b298f355a33fb7350354e0e
[sfa.git] / sfa / managers / registry_manager.py
1 import types
2 # for get_key_from_incoming_ip
3 import tempfile
4 import os
5 import commands
6
7 from sfa.util.faults import RecordNotFound, AccountNotEnabled, PermissionError, MissingAuthority, \
8     UnknownSfaType, ExistingRecord, NonExistingRecord
9 from sfa.util.sfatime import utcparse, datetime_to_epoch
10 from sfa.util.prefixTree import prefixTree
11 from sfa.util.xrn import Xrn, get_authority, hrn_to_urn, urn_to_hrn
12 from sfa.util.version import version_core
13 from sfa.util.sfalogging import logger
14
15 from sfa.trust.gid import GID 
16 from sfa.trust.credential import Credential
17 from sfa.trust.certificate import Certificate, Keypair, convert_public_key
18 from sfa.trust.gid import create_uuid
19
20 from sfa.storage.model import make_record, RegRecord, RegAuthority, RegUser, RegSlice, RegKey
21 from sfa.storage.alchemy import dbsession
22
23 class RegistryManager:
24
25     def __init__ (self, config): pass
26
27     # The GENI GetVersion call
28     def GetVersion(self, api, options):
29         peers = dict ( [ (hrn,interface.get_url()) for (hrn,interface) in api.registries.iteritems() 
30                        if hrn != api.hrn])
31         xrn=Xrn(api.hrn)
32         return version_core({'interface':'registry',
33                              'sfa': 2,
34                              'geni_api': 2,
35                              'hrn':xrn.get_hrn(),
36                              'urn':xrn.get_urn(),
37                              'peers':peers})
38     
39     def GetCredential(self, api, xrn, type, caller_xrn=None):
40         # convert xrn to hrn     
41         if type:
42             hrn = urn_to_hrn(xrn)[0]
43         else:
44             hrn, type = urn_to_hrn(xrn)
45             
46         # Is this a root or sub authority
47         auth_hrn = api.auth.get_authority(hrn)
48         if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
49             auth_hrn = hrn
50         auth_info = api.auth.get_auth_info(auth_hrn)
51         # get record info
52         record=dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
53         if not record:
54             raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
55
56         # xxx for the record only
57         # used to call this, which was wrong, now all needed data is natively is our DB
58         # self.driver.augment_records_with_testbed_info (record.__dict__)
59         # likewise, we deprecate is_enabled which was not really useful
60         # if not self.driver.is_enabled (record.__dict__): ...
61         # xxx for the record only
62     
63         # get the callers gid
64         # if caller_xrn is not specified assume the caller is the record
65         # object itself.
66         if not caller_xrn:
67             caller_hrn = hrn
68             caller_gid = record.get_gid_object()
69         else:
70             caller_hrn, caller_type = urn_to_hrn(caller_xrn)
71             if caller_type:
72                 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn,type=caller_type).first()
73             else:
74                 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn).first()
75             if not caller_record:
76                 raise RecordNotFound("Unable to associated caller (hrn=%s, type=%s) with credential for (hrn: %s, type: %s)"%(caller_hrn, caller_type, hrn, type))
77             caller_gid = GID(string=caller_record.gid)
78  
79         object_hrn = record.get_gid_object().get_hrn()
80         # call the builtin authorization/credential generation engine
81         rights = api.auth.determine_user_rights(caller_hrn, record)
82         # make sure caller has rights to this object
83         if rights.is_empty():
84             raise PermissionError("%s has no rights to %s (%s)" % \
85                                   (caller_hrn, object_hrn, xrn))    
86         object_gid = GID(string=record.gid)
87         new_cred = Credential(subject = object_gid.get_subject())
88         new_cred.set_gid_caller(caller_gid)
89         new_cred.set_gid_object(object_gid)
90         new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
91         #new_cred.set_pubkey(object_gid.get_pubkey())
92         new_cred.set_privileges(rights)
93         new_cred.get_privileges().delegate_all_privileges(True)
94         if hasattr(record,'expires'):
95             date = utcparse(record.expires)
96             expires = datetime_to_epoch(date)
97             new_cred.set_expiration(int(expires))
98         auth_kind = "authority,ma,sa"
99         # Parent not necessary, verify with certs
100         #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
101         new_cred.encode()
102         new_cred.sign()
103     
104         return new_cred.save_to_string(save_parents=True)
105     
106     
107     def Resolve(self, api, xrns, type=None, full=True):
108     
109         if not isinstance(xrns, types.ListType):
110             # try to infer type if not set and we get a single input
111             if not type:
112                 type = Xrn(xrns).get_type()
113             xrns = [xrns]
114         hrns = [urn_to_hrn(xrn)[0] for xrn in xrns] 
115
116         # load all known registry names into a prefix tree and attempt to find
117         # the longest matching prefix
118         # create a dict where key is a registry hrn and its value is a list
119         # of hrns at that registry (determined by the known prefix tree).  
120         xrn_dict = {}
121         registries = api.registries
122         tree = prefixTree()
123         registry_hrns = registries.keys()
124         tree.load(registry_hrns)
125         for xrn in xrns:
126             registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
127             if registry_hrn not in xrn_dict:
128                 xrn_dict[registry_hrn] = []
129             xrn_dict[registry_hrn].append(xrn)
130             
131         records = [] 
132         for registry_hrn in xrn_dict:
133             # skip the hrn without a registry hrn
134             # XX should we let the user know the authority is unknown?       
135             if not registry_hrn:
136                 continue
137     
138             # if the best match (longest matching hrn) is not the local registry,
139             # forward the request
140             xrns = xrn_dict[registry_hrn]
141             if registry_hrn != api.hrn:
142                 credential = api.getCredential()
143                 interface = api.registries[registry_hrn]
144                 server_proxy = api.server_proxy(interface, credential)
145                 peer_records = server_proxy.Resolve(xrns, credential,type)
146                 # pass foreign records as-is
147                 # previous code used to read
148                 # records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
149                 # not sure why the records coming through xmlrpc had to be processed at all
150                 records.extend(peer_records)
151     
152         # try resolving the remaining unfound records at the local registry
153         local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
154         # 
155         local_records = dbsession.query(RegRecord).filter(RegRecord.hrn.in_(local_hrns))
156         if type:
157             local_records = local_records.filter_by(type=type)
158         local_records=local_records.all()
159         logger.info("Resolve: local_records=%s (type=%s)"%(local_records,type))
160         local_dicts = [ record.__dict__ for record in local_records ]
161         
162         if full:
163             # in full mode we get as much info as we can, which involves contacting the 
164             # testbed for getting implementation details about the record
165             self.driver.augment_records_with_testbed_info(local_dicts)
166             # also we fill the 'url' field for known authorities
167             # used to be in the driver code, sounds like a poorman thing though
168             def solve_neighbour_url (record):
169                 if not record.type.startswith('authority'): return 
170                 hrn=record.hrn
171                 for neighbour_dict in [ api.aggregates, api.registries ]:
172                     if hrn in neighbour_dict:
173                         record.url=neighbour_dict[hrn].get_url()
174                         return 
175             for record in local_records: solve_neighbour_url (record)
176         
177         # convert local record objects to dicts for xmlrpc
178         # xxx somehow here calling dict(record) issues a weird error
179         # however record.todict() seems to work fine
180         # records.extend( [ dict(record) for record in local_records ] )
181         records.extend( [ record.todict() for record in local_records ] )    
182         if not records:
183             raise RecordNotFound(str(hrns))
184     
185         return records
186     
187     def List (self, api, xrn, origin_hrn=None):
188         hrn, type = urn_to_hrn(xrn)
189         recursive = False
190         if hrn.endswith('*'):
191             hrn = hrn[:-1]
192             recursive = True
193         # load all know registry names into a prefix tree and attempt to find
194         # the longest matching prefix
195         registries = api.registries
196         registry_hrns = registries.keys()
197         tree = prefixTree()
198         tree.load(registry_hrns)
199         registry_hrn = tree.best_match(hrn)
200        
201         #if there was no match then this record belongs to an unknow registry
202         if not registry_hrn:
203             raise MissingAuthority(xrn)
204         # if the best match (longest matching hrn) is not the local registry,
205         # forward the request
206         record_dicts = []    
207         if registry_hrn != api.hrn:
208             credential = api.getCredential()
209             interface = api.registries[registry_hrn]
210             server_proxy = api.server_proxy(interface, credential)
211             record_list = server_proxy.List(xrn, credential)
212             # same as above, no need to process what comes from through xmlrpc
213             # pass foreign records as-is
214             record_dicts = record_list
215         
216         # if we still have not found the record yet, try the local registry
217         if not record_dicts:
218             if not api.auth.hierarchy.auth_exists(hrn):
219                 raise MissingAuthority(hrn)
220             if recursive:
221                 records = dbsession.query(RegRecord).filter(RegRecord.hrn.startswith(hrn))
222             else:
223                 records = dbsession.query(RegRecord).filter_by(authority=hrn)
224             record_dicts=[ record.todict() for record in records ]
225     
226         return record_dicts
227     
228     
229     def CreateGid(self, api, xrn, cert):
230         # get the authority
231         authority = Xrn(xrn=xrn).get_authority_hrn()
232         auth_info = api.auth.get_auth_info(authority)
233         if not cert:
234             pkey = Keypair(create=True)
235         else:
236             certificate = Certificate(string=cert)
237             pkey = certificate.get_pubkey()    
238         gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey) 
239         return gid.save_to_string(save_parents=True)
240     
241     ####################
242     # utility for handling relationships among the SFA objects 
243     # given that the SFA db does not handle this sort of relationsships
244     # it will rely on side-effects in the testbed to keep this persistent
245     
246     # subject_record describes the subject of the relationships
247     # ref_record contains the target values for the various relationships we need to manage
248     # (to begin with, this is just the slice x person relationship)
249     def update_driver_relations (self, subject_obj, ref_obj):
250         type=subject_obj.type
251         #for (k,v) in subject_obj.__dict__.items(): print k,'=',v
252         if type=='slice' and hasattr(ref_obj,'researcher'):
253             self.update_driver_relation(subject_obj, ref_obj.researcher, 'user', 'researcher')
254         elif type=='authority' and hasattr(ref_obj,'pi'):
255             self.update_driver_relation(subject_obj,ref_obj.pi, 'user', 'pi')
256         
257     # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
258     # hrns is the list of hrns that should be linked to the subject from now on
259     # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
260     def update_driver_relation (self, record_obj, hrns, target_type, relation_name):
261         # locate the linked objects in our db
262         subject_type=record_obj.type
263         subject_id=record_obj.pointer
264         # get the 'pointer' field of all matching records
265         link_id_tuples = dbsession.query(RegRecord.pointer).filter_by(type=target_type).filter(RegRecord.hrn.in_(hrns)).all()
266         # sqlalchemy returns named tuples for columns
267         link_ids = [ tuple.pointer for tuple in link_id_tuples ]
268         self.driver.update_relation (subject_type, target_type, relation_name, subject_id, link_ids)
269
270     def Register(self, api, record_dict):
271     
272         hrn, type = record_dict['hrn'], record_dict['type']
273         urn = hrn_to_urn(hrn,type)
274         # validate the type
275         if type not in ['authority', 'slice', 'node', 'user']:
276             raise UnknownSfaType(type) 
277         
278         # check if record_dict already exists
279         existing_records = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).all()
280         if existing_records:
281             raise ExistingRecord(hrn)
282            
283         assert ('type' in record_dict)
284         # returns the right type of RegRecord according to type in record
285         record = make_record(dict=record_dict)
286         record.just_created()
287         record.authority = get_authority(record.hrn)
288         auth_info = api.auth.get_auth_info(record.authority)
289         pub_key = None
290         # make sure record has a gid
291         if not record.gid:
292             uuid = create_uuid()
293             pkey = Keypair(create=True)
294             if getattr(record,'keys',None):
295                 pub_key=record.keys
296                 # use only first key in record
297                 if isinstance(record.keys, types.ListType):
298                     pub_key = record.keys[0]
299                 pkey = convert_public_key(pub_key)
300     
301             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
302             gid = gid_object.save_to_string(save_parents=True)
303             record.gid = gid
304     
305         if isinstance (record, RegAuthority):
306             # update the tree
307             if not api.auth.hierarchy.auth_exists(hrn):
308                 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
309     
310             # get the GID from the newly created authority
311             gid = auth_info.get_gid_object()
312             record.gid=gid.save_to_string(save_parents=True)
313
314         elif isinstance (record, RegSlice):
315             # locate objects for relationships
316             if hasattr (record, 'researcher'):
317                 # we get the list of researcher hrns as
318                 researcher_hrns = record.researcher
319                 # strip that in case we have <researcher> words </researcher>
320                 researcher_hrns = [ x.strip() for x in researcher_hrns ]
321                 logger.info ("incoming researchers %s"%researcher_hrns)
322                 request = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns))
323                 logger.info ("%d incoming hrns, %d matches found"%(len(researcher_hrns),request.count()))
324                 researchers = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns)).all()
325                 record.reg_researchers = researchers
326         
327         elif isinstance (record, RegUser):
328             # create RegKey objects for incoming keys
329             if hasattr(record,'keys'): 
330                 logger.debug ("creating %d keys for user %s"%(len(record.keys),record.hrn))
331                 record.reg_keys = [ RegKey (key) for key in record.keys ]
332             
333         # update testbed-specific data if needed
334         pointer = self.driver.register (record.__dict__, hrn, pub_key)
335
336         record.pointer=pointer
337         dbsession.add(record)
338         dbsession.commit()
339     
340         # update membership for researchers, pis, owners, operators
341         self.update_driver_relations (record, record)
342         
343         return record.get_gid_object().save_to_string(save_parents=True)
344     
345     def Update(self, api, record_dict):
346         assert ('type' in record_dict)
347         new_record=RegRecord(dict=record_dict)
348         type = new_record.type
349         hrn = new_record.hrn
350         
351         # make sure the record exists
352         record = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
353         if not record:
354             raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
355         record.just_updated()
356     
357         # validate the type
358         if type not in ['authority', 'slice', 'node', 'user']:
359             raise UnknownSfaType(type) 
360
361         # Use the pointer from the existing record, not the one that the user
362         # gave us. This prevents the user from inserting a forged pointer
363         pointer = record.pointer
364     
365         # is the a change in keys ?
366         new_key=None
367         if type=='user':
368             if getattr(new_key,'keys',None):
369                 new_key=new_record.keys
370                 if isinstance (new_key,types.ListType):
371                     new_key=new_key[0]
372
373         # update the PLC information that was specified with the record
374         if not self.driver.update (record.__dict__, new_record.__dict__, hrn, new_key):
375             logger.warning("driver.update failed")
376     
377         # take new_key into account
378         if new_key:
379             # update the openssl key and gid
380             pkey = convert_public_key(new_key)
381             uuid = create_uuid()
382             urn = hrn_to_urn(hrn,type)
383             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
384             gid = gid_object.save_to_string(save_parents=True)
385             record.gid = gid
386             dsession.commit()
387         
388         # update membership for researchers, pis, owners, operators
389         self.update_driver_relations (record, new_record)
390         
391         return 1 
392     
393     # expecting an Xrn instance
394     def Remove(self, api, xrn, origin_hrn=None):
395         hrn=xrn.get_hrn()
396         type=xrn.get_type()
397         request=dbsession.query(RegRecord).filter_by(hrn=hrn)
398         if type and type not in ['all', '*']:
399             request=request.filter_by(type=type)
400     
401         record = request.first()
402         if not record:
403             msg="Could not find hrn %s"%hrn
404             if type: msg += " type=%s"%type
405             raise RecordNotFound(msg)
406
407         type = record.type
408         if type not in ['slice', 'user', 'node', 'authority'] :
409             raise UnknownSfaType(type)
410
411         credential = api.getCredential()
412         registries = api.registries
413     
414         # Try to remove the object from the PLCDB of federated agg.
415         # This is attempted before removing the object from the local agg's PLCDB and sfa table
416         if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
417             for registry in registries:
418                 if registry not in [api.hrn]:
419                     try:
420                         result=registries[registry].remove_peer_object(credential, record, origin_hrn)
421                     except:
422                         pass
423
424         # call testbed callback first
425         # IIUC this is done on the local testbed TOO because of the refreshpeer link
426         if not self.driver.remove(record.__dict__):
427             logger.warning("driver.remove failed")
428
429         # delete from sfa db
430         dbsession.delete(record)
431         dbsession.commit()
432     
433         return 1
434
435     # This is a PLC-specific thing, won't work with other platforms
436     def get_key_from_incoming_ip (self, api):
437         # verify that the callers's ip address exist in the db and is an interface
438         # for a node in the db
439         (ip, port) = api.remote_addr
440         interfaces = self.driver.shell.GetInterfaces({'ip': ip}, ['node_id'])
441         if not interfaces:
442             raise NonExistingRecord("no such ip %(ip)s" % locals())
443         nodes = self.driver.shell.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
444         if not nodes:
445             raise NonExistingRecord("no such node using ip %(ip)s" % locals())
446         node = nodes[0]
447        
448         # look up the sfa record
449         record=dbsession.query(RegRecord).filter_by(type='node',pointer=node['node_id']).first()
450         if not record:
451             raise RecordNotFound("node with pointer %s"%node['node_id'])
452         
453         # generate a new keypair and gid
454         uuid = create_uuid()
455         pkey = Keypair(create=True)
456         urn = hrn_to_urn(record.hrn, record.type)
457         gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
458         gid = gid_object.save_to_string(save_parents=True)
459         record.gid = gid
460
461         # update the record
462         dbsession.commit()
463   
464         # attempt the scp the key
465         # and gid onto the node
466         # this will only work for planetlab based components
467         (kfd, key_filename) = tempfile.mkstemp() 
468         (gfd, gid_filename) = tempfile.mkstemp() 
469         pkey.save_to_file(key_filename)
470         gid_object.save_to_file(gid_filename, save_parents=True)
471         host = node['hostname']
472         key_dest="/etc/sfa/node.key"
473         gid_dest="/etc/sfa/node.gid" 
474         scp = "/usr/bin/scp" 
475         #identity = "/etc/planetlab/root_ssh_key.rsa"
476         identity = "/etc/sfa/root_ssh_key"
477         scp_options=" -i %(identity)s " % locals()
478         scp_options+="-o StrictHostKeyChecking=no " % locals()
479         scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
480                          locals()
481         scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
482                          locals()    
483
484         all_commands = [scp_key_command, scp_gid_command]
485         
486         for command in all_commands:
487             (status, output) = commands.getstatusoutput(command)
488             if status:
489                 raise Exception, output
490
491         for filename in [key_filename, gid_filename]:
492             os.unlink(filename)
493
494         return 1