Registry
[sfa.git] / sfa / managers / registry_manager_slab.py
1 import types
2 import time 
3 import sys
4
5 from sfa.util.faults import *
6 from sfa.util.prefixTree import prefixTree
7 from sfa.util.record import SfaRecord
8 from sfa.util.table import SfaTable
9 from sfa.util.record import SfaRecord
10 from sfa.trust.gid import GID 
11 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn, urn_to_hrn
12 from sfa.util.plxrn import hrn_to_pl_login_base
13 from sfa.trust.credential import Credential
14 from sfa.trust.certificate import Certificate, Keypair
15 from sfa.trust.gid import create_uuid
16 from sfa.util.version import version_core
17
18 # The GENI GetVersion call
19 def GetVersion(api):
20     peers =dict ([ (peername,v._ServerProxy__host) for (peername,v) in api.registries.iteritems() 
21                    if peername != api.hrn])
22     xrn=Xrn(api.hrn)
23     return version_core({'interface':'registry',
24                          'hrn':xrn.get_hrn(),
25                          'urn':xrn.get_urn(),
26                          'peers':peers})
27
28 def get_credential(api, xrn, type, is_self=False):
29     # convert xrn to hrn     
30     if type:
31         hrn = urn_to_hrn(xrn)[0]
32     else:
33         hrn, type = urn_to_hrn(xrn)
34
35     # Is this a root or sub authority
36     auth_hrn = api.auth.get_authority(hrn)
37     print>> sys.stderr , " \r\n        REGISTRY get_credential auth_hrn" , auth_hrn         
38     if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
39         auth_hrn = hrn
40     # get record info
41     auth_info = api.auth.get_auth_info(auth_hrn)
42     table = SfaTable()
43     records = table.findObjects({'type': type, 'hrn': hrn})
44     print>> sys.stderr , " \r\n    ++    REGISTRY get_credential hrn %s records %s " %(hrn, records)      
45     if not records:
46         raise RecordNotFound(hrn)
47     record = records[0]
48
49     # verify_cancreate_credential requires that the member lists
50     # (researchers, pis, etc) be filled in
51     api.fill_record_info(record)
52     record['enabled'] = True
53     print>> sys.stderr , " \r\n    ++    REGISTRY get_credential hrn %s record['enabled'] %s is_self %s" %(hrn, record['enabled'], is_self)    
54     if record['type']=='user':
55        if not record['enabled']:
56           print>> sys.stderr , " \r\n    ++    REGISTRY get_credential hrn %s ACCOUNT Not enabled"
57           raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record['email']))
58
59     # get the callers gid
60     # if this is a self cred the record's gid is the caller's gid
61     if is_self:
62         caller_hrn = hrn
63         caller_gid = record.get_gid_object()
64         print>>sys.stderr, " \r\n REGISTRY IS SELF OK caller_hrn %s--- \r\n caller_gid %s---------" %(caller_hrn,caller_gid)
65     else:
66         print>> sys.stderr , " \r\n    ++  ELSE   "     
67         caller_gid = api.auth.client_cred.get_gid_caller() 
68         print>> sys.stderr , " \r\n    ++  ELSE  caller_gid %s record %s" %(caller_gid, record) 
69         caller_hrn = caller_gid.get_hrn()
70         print>> sys.stderr , " \r\n    ++  ELSE  caller_hrn %s " %(caller_hrn)
71                   
72     object_hrn = record.get_gid_object().get_hrn()
73     print>> sys.stderr , " \r\n    ++  ELSE object_hrn  %s " %(object_hrn)
74         
75     rights = api.auth.determine_user_rights(caller_hrn, record)
76     print>> sys.stderr , " \r\n    ++  After rights record: %s \r\n ====RIGHTS %s  " %(record , rights)
77      
78     # make sure caller has rights to this object
79     if rights.is_empty():
80         raise PermissionError(caller_hrn + " has no rights to " + record['name'])
81
82     object_gid = GID(string=record['gid'])
83     new_cred = Credential(subject = object_gid.get_subject())
84     new_cred.set_gid_caller(caller_gid)
85     new_cred.set_gid_object(object_gid)
86     new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
87     #new_cred.set_pubkey(object_gid.get_pubkey())
88     new_cred.set_privileges(rights)
89     new_cred.get_privileges().delegate_all_privileges(True)
90     if 'expires' in record:
91         new_cred.set_expiration(int(record['expires']))
92     auth_kind = "authority,ma,sa"
93     # Parent not necessary, verify with certs
94     #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
95     new_cred.encode()
96     new_cred.sign()
97
98     return new_cred.save_to_string(save_parents=True)
99
100
101 def resolve(api, xrns, type=None, full=True):
102
103     # load all known registry names into a prefix tree and attempt to find
104     # the longest matching prefix 
105     print >>sys.stderr , '\t\t REGISTRY MANAGER : resolve=========xrns ', xrns
106     if not isinstance(xrns, types.ListType):
107         if not type:
108             type = Xrn(xrns).get_type()
109         xrns = [xrns]
110     hrns = [urn_to_hrn(xrn)[0] for xrn in xrns] 
111     print >>sys.stderr , '\t\t =========hrns ', hrns
112     # create a dict where key is a registry hrn and its value is a
113     # hrns at that registry (determined by the known prefix tree).  
114     xrn_dict = {}
115     print >>sys.stderr, '\r\n REGISTRY MANAGER : resolve xrns '  , xrns #api.__dict__.keys()
116     registries = api.registries
117     tree = prefixTree()
118     registry_hrns = registries.keys()
119     print >>sys.stderr, '\r\n \t\t REGISTRY MANAGER registry_hrns'  , registry_hrns
120     tree.load(registry_hrns)
121     for xrn in xrns:
122         registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
123         print >>sys.stderr, '\t\tREGISTRY MANAGER  *****tree.best_match ', registry_hrn
124         if registry_hrn not in xrn_dict:
125             xrn_dict[registry_hrn] = []
126         xrn_dict[registry_hrn].append(xrn)
127         print >>sys.stderr, '\t\tREGISTRY MANAGER  *****xrn_dict[registry_hrn] ',xrn_dict[registry_hrn]
128     records = [] 
129
130     for registry_hrn in xrn_dict:
131         # skip the hrn without a registry hrn
132         # XX should we let the user know the authority is unknown?   
133         print >>sys.stderr, '\t\t registry_hrn in xrn_dict ', registry_hrn    
134         if not registry_hrn:
135             continue
136
137         # if the best match (longest matching hrn) is not the local registry,
138         # forward the request
139         xrns = xrn_dict[registry_hrn]
140         if registry_hrn != api.hrn:
141             credential = api.getCredential()
142             peer_records = registries[registry_hrn].Resolve(xrns, credential)
143             print >>sys.stderr , '\t\t peer_records ', peer_records
144             records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
145
146     print >>sys.stderr,'\t\t hrns ' , hrns
147     # try resolving the remaining unfound records at the local registry
148     remaining_hrns = set(hrns).difference([record['hrn'] for record in records])
149
150     # convert set to list
151     remaining_hrns = [hrn for hrn in remaining_hrns] 
152     print >>sys.stderr, '\t\t remaining_hrns', remaining_hrns
153     table = SfaTable()
154     local_records = table.findObjects({'hrn': remaining_hrns})
155
156     print >>sys.stderr, '\t\t LOCAL REC !', local_records  
157     for rec in local_records:
158         print >>sys.stderr, '\t\t resolve regmanager : rec ', rec    
159                    
160     if full:
161         print >>sys.stderr, '\r\n \r\n REGISTRY:_FULL', api     
162         api.fill_record_info(local_records)
163         
164   
165     # convert local record objects to dicts
166     records.extend([dict(record) for record in local_records])
167     print >>sys.stderr, "\r\n \t\t records extends %s" %(records)      
168     if not records:
169         raise RecordNotFound(str(hrns))
170
171     if type:
172         records = filter(lambda rec: rec['type'] in [type], records)
173
174     return records
175
176 def list(api, xrn, origin_hrn=None):
177     hrn, type = urn_to_hrn(xrn)
178     # load all know registry names into a prefix tree and attempt to find
179     # the longest matching prefix
180     records = []
181     registries = api.registries
182     registry_hrns = registries.keys()
183     tree = prefixTree()
184     tree.load(registry_hrns)
185     registry_hrn = tree.best_match(hrn)
186    
187     #if there was no match then this record belongs to an unknow registry
188     if not registry_hrn:
189         raise MissingAuthority(xrn)
190     
191     # if the best match (longest matching hrn) is not the local registry,
192     # forward the request
193     records = []    
194     if registry_hrn != api.hrn:
195         credential = api.getCredential()
196         record_list = registries[registry_hrn].List(xrn, credential)
197         records = [SfaRecord(dict=record).as_dict() for record in record_list]
198     
199     # if we still have not found the record yet, try the local registry
200     if not records:
201         if not api.auth.hierarchy.auth_exists(hrn):
202             raise MissingAuthority(hrn)
203
204         table = SfaTable()
205         records = table.find({'authority': hrn})
206
207     return records
208
209
210 def register(api, record):
211
212
213     hrn, type = record['hrn'], record['type']
214     urn = hrn_to_urn(hrn,type)
215     # validate the type
216     print>>sys.stderr, " \r\n \r\n ----------- registry_manager_sl  register hrn %s"%(hrn)
217     if type not in ['authority', 'slice', 'node', 'user']:
218         raise UnknownSfaType(type) 
219     
220     # check if record already exists
221     table = SfaTable()
222     existing_records = table.find({'type': type, 'hrn': hrn})
223     if existing_records:
224         raise ExistingRecord(hrn)
225        
226     record = SfaRecord(dict = record)
227     record['authority'] = get_authority(record['hrn'])
228     type = record['type']
229     hrn = record['hrn']
230     api.auth.verify_object_permission(hrn)
231     auth_info = api.auth.get_auth_info(record['authority'])
232     pub_key = None
233     # make sure record has a gid
234     if 'gid' not in record:
235         uuid = create_uuid()
236         pkey = Keypair(create=True)
237         if 'key' in record and record['key']:
238             if isinstance(record['key'], types.ListType):
239                 pub_key = record['key'][0]
240             else:
241                 pub_key = record['key']
242             pkey = convert_public_key(pub_key)
243
244         gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
245         gid = gid_object.save_to_string(save_parents=True)
246         record['gid'] = gid
247         record.set_gid(gid)
248
249     if type in ["authority"]:
250         # update the tree
251         if not api.auth.hierarchy.auth_exists(hrn):
252             api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
253
254         # get the GID from the newly created authority
255         gid = auth_info.get_gid_object()
256         record.set_gid(gid.save_to_string(save_parents=True))
257         pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
258         sites = api.oar.GetSites( [pl_record['login_base']])
259         if not sites:
260             pointer = api.oar.AddSite( pl_record)
261         else:
262             pointer = sites[0]['site_id']
263
264         record.set_pointer(pointer)
265         record['pointer'] = pointer
266
267     elif (type == "slice"):
268         acceptable_fields=['url', 'instantiation', 'name', 'description']
269         pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
270         print>>sys.stderr, " \r\n \r\n ----------- registry_manager_slab register  slice pl_record %s"%(pl_record)
271         for key in pl_record.keys():
272             if key not in acceptable_fields:
273                 pl_record.pop(key)
274         slices = api.users.GetSlices( [pl_record['name']])
275         if not slices:
276              pointer = api.users.AddSlice(pl_record)
277         else:
278              pointer = slices[0]['slice_id']
279         record.set_pointer(pointer)
280         record['pointer'] = pointer
281
282     elif  (type == "user"):
283         persons = api.users.GetPersons( [record['email']]) 
284         if not persons:
285            print>>sys.stderr, "  \r\n \r\n ----------- registry_manager_slab  register NO PERSON ADD TO LDAP?"
286       
287         #if not persons:
288             #pointer = api.users.AddPerson( dict(record))
289         #else:
290             #pointer = persons[0]['person_id']
291
292         if 'enabled' in record and record['enabled']:
293             api.users.UpdatePerson( pointer, {'enabled': record['enabled']})
294         # add this persons to the site only if he is being added for the first
295         # time by sfa and doesont already exist in plc
296         if not persons or not persons[0]['site_ids']:
297             login_base = get_leaf(record['authority'])
298             api.users.AddPersonToSite( pointer, login_base)
299
300         # What roles should this user have?
301         api.users.AddRoleToPerson( 'user', pointer)
302         # Add the user's key
303         if pub_key:
304             api.users.AddPersonKey( pointer, {'key_type' : 'ssh', 'key' : pub_key})
305
306     #elif (type == "node"):
307         #pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
308         #login_base = hrn_to_pl_login_base(record['authority'])
309         #nodes = api.oar.GetNodes( [pl_record['hostname']])
310         #if not nodes:
311             #pointer = api.oar.AddNode(login_base, pl_record)
312         #else:
313             #pointer = nodes[0]['node_id']
314
315     ##record['pointer'] = pointer
316     ##record.set_pointer(pointer)
317     record_id = table.insert(record)
318     record['record_id'] = record_id
319
320     # update membership for researchers, pis, owners, operators
321     api.update_membership(None, record)
322
323     return record.get_gid_object().save_to_string(save_parents=True)
324
325 def update(api, record_dict):
326     new_record = SfaRecord(dict = record_dict)
327     type = new_record['type']
328     hrn = new_record['hrn']
329     urn = hrn_to_urn(hrn,type)
330     api.auth.verify_object_permission(hrn)
331     table = SfaTable()
332     # make sure the record exists
333     records = table.findObjects({'type': type, 'hrn': hrn})
334     if not records:
335         raise RecordNotFound(hrn)
336     record = records[0]
337     record['last_updated'] = time.gmtime()
338
339     # Update_membership needs the membership lists in the existing record
340     # filled in, so it can see if members were added or removed
341     api.fill_record_info(record)
342
343     # Use the pointer from the existing record, not the one that the user
344     # gave us. This prevents the user from inserting a forged pointer
345     pointer = record['pointer']
346     # update the PLC information that was specified with the record
347
348     if (type == "authority"):
349         api.oar.UpdateSite( pointer, new_record)
350
351     elif type == "slice":
352         pl_record=api.sfa_fields_to_pl_fields(type, hrn, new_record)
353         if 'name' in pl_record:
354             pl_record.pop('name')
355             api.users.UpdateSlice( pointer, pl_record)
356
357     elif type == "user":
358         # SMBAKER: UpdatePerson only allows a limited set of fields to be
359         #    updated. Ideally we should have a more generic way of doing
360         #    this. I copied the field names from UpdatePerson.py...
361         update_fields = {}
362         all_fields = new_record
363         for key in all_fields.keys():
364             if key in ['first_name', 'last_name', 'title', 'email',
365                        'password', 'phone', 'url', 'bio', 'accepted_aup',
366                        'enabled']:
367                 update_fields[key] = all_fields[key]
368         api.users.UpdatePerson( pointer, update_fields)
369
370         if 'key' in new_record and new_record['key']:
371             # must check this key against the previous one if it exists
372             persons = api.users.GetPersons( [pointer], ['key_ids'])
373             person = persons[0]
374             keys = person['key_ids']
375             keys = api.users.GetKeys( person['key_ids'])
376             key_exists = False
377             if isinstance(new_record['key'], types.ListType):
378                 new_key = new_record['key'][0]
379             else:
380                 new_key = new_record['key']
381             
382             # Delete all stale keys
383             for key in keys:
384                 if new_record['key'] != key['key']:
385                     api.users.DeleteKey( key['key_id'])
386                 else:
387                     key_exists = True
388             if not key_exists:
389                 api.users.AddPersonKey( pointer, {'key_type': 'ssh', 'key': new_key})
390
391             # update the openssl key and gid
392             pkey = convert_public_key(new_key)
393             uuid = create_uuid()
394             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
395             gid = gid_object.save_to_string(save_parents=True)
396             record['gid'] = gid
397             record = SfaRecord(dict=record)
398             table.update(record)
399
400     elif type == "node":
401         api.oar.UpdateNode( pointer, new_record)
402
403     else:
404         raise UnknownSfaType(type)
405
406     # update membership for researchers, pis, owners, operators
407     api.update_membership(record, new_record)
408     
409     return 1 
410
411 # expecting an Xrn instance
412 def remove(api, xrn, origin_hrn=None):
413
414     table = SfaTable()
415     filter = {'hrn': xrn.get_hrn()}
416     hrn=xrn.get_hrn()
417     type=xrn.get_type()
418     if type and type not in ['all', '*']:
419         filter['type'] = type
420
421     records = table.find(filter)
422     if not records: raise RecordNotFound(hrn)
423     record = records[0]
424     type = record['type']
425
426     credential = api.getCredential()
427     registries = api.registries
428
429     # Try to remove the object from the PLCDB of federated agg.
430     # This is attempted before removing the object from the local agg's PLCDB and sfa table
431     if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
432         for registry in registries:
433             if registry not in [api.hrn]:
434                 try:
435                     result=registries[registry].remove_peer_object(credential, record, origin_hrn)
436                 except:
437                     pass
438     if type == "user":
439         persons = api.users.GetPersons(record['pointer'])
440         # only delete this person if he has site ids. if he doesnt, it probably means
441         # he was just removed from a site, not actually deleted
442         if persons and persons[0]['site_ids']:
443             api.users.DeletePerson(record['pointer'])
444     elif type == "slice":
445         if api.users.GetSlices( record['pointer']):
446             api.users.DeleteSlice( record['pointer'])
447     elif type == "node":
448         if api.oar.GetNodes( record['pointer']):
449             api.oar.DeleteNode( record['pointer'])
450     elif type == "authority":
451         if api.oar.GetSites( record['pointer']):
452             api.oar.DeleteSite( record['pointer'])
453     else:
454         raise UnknownSfaType(type)
455
456     table.remove(record)
457
458     return 1
459
460 def remove_peer_object(api, record, origin_hrn=None):
461     pass
462
463 def register_peer_object(api, record, origin_hrn=None):
464     pass