6 # read the planetlab database and update the local registry database accordingly
7 # (in other words, with this testbed, the SFA registry is *not* authoritative)
8 # so we update the following collections
9 # . authorities (from pl sites)
10 # . node (from pl nodes)
11 # . users+keys (from pl persons and attached keys)
12 # known limitation : *one* of the ssh keys is chosen at random here
13 # xxx todo/check xxx at the very least, when a key is known to the registry
14 # and is still current in plc
15 # then we should definitely make sure to keep that one in sfa...
16 # . slice+researchers (from pl slices and attached users)
21 from sfa.util.config import Config
22 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn
24 from sfa.trust.gid import create_uuid
25 from sfa.trust.certificate import convert_public_key, Keypair
27 from sfa.storage.alchemy import dbsession
28 from sfa.storage.model import RegRecord, RegAuthority, RegSlice, RegNode, RegUser, RegKey
30 from sfa.planetlab.plshell import PlShell
31 from sfa.planetlab.plxrn import hostname_to_hrn, slicename_to_hrn, email_to_hrn, hrn_to_pl_slicename
33 def _get_site_hrn(interface_hrn, site):
34 # Hardcode 'internet2' into the hrn for sites hosting
35 # internet2 nodes. This is a special operation for some vini
37 hrn = ".".join([interface_hrn, site['login_base']])
38 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
39 if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
40 hrn = ".".join([interface_hrn, "internet2", site['login_base']])
46 def __init__ (self, auth_hierarchy, logger):
47 self.auth_hierarchy = auth_hierarchy
50 def add_options (self, parser):
51 # we don't have any options for now
54 # hrn hash is initialized from current db
55 # remember just-created records as we go
56 # xxx might make sense to add a UNIQUE constraint in the db itself
57 def remember_record_by_hrn (self, record):
58 tuple = (record.type, record.hrn)
59 if tuple in self.records_by_type_hrn:
60 self.logger.warning ("PlImporter.remember_record_by_hrn: duplicate (%s,%s)"%tuple)
62 self.records_by_type_hrn [ tuple ] = record
64 # ditto for pointer hash
65 def remember_record_by_pointer (self, record):
66 if record.pointer == -1:
67 self.logger.warning ("PlImporter.remember_record_by_pointer: pointer is void")
69 tuple = (record.type, record.pointer)
70 if tuple in self.records_by_type_pointer:
71 self.logger.warning ("PlImporter.remember_record_by_pointer: duplicate (%s,%s)"%tuple)
73 self.records_by_type_pointer [ ( record.type, record.pointer,) ] = record
75 def remember_record (self, record):
76 self.remember_record_by_hrn (record)
77 self.remember_record_by_pointer (record)
79 def locate_by_type_hrn (self, type, hrn):
80 return self.records_by_type_hrn.get ( (type, hrn), None)
82 def locate_by_type_pointer (self, type, pointer):
83 return self.records_by_type_pointer.get ( (type, pointer), None)
85 # a convenience/helper function to see if a record is already known
86 # a former, broken, attempt (in 2.1-9) had been made
87 # to try and use 'pointer' as a first, most significant attempt
88 # the idea being to preserve stuff as much as possible, and thus
89 # to avoid creating a new gid in the case of a simple hrn rename
90 # however this of course doesn't work as the gid depends on the hrn...
91 #def locate (self, type, hrn=None, pointer=-1):
93 # attempt = self.locate_by_type_pointer (type, pointer)
94 # if attempt : return attempt
96 # attempt = self.locate_by_type_hrn (type, hrn,)
97 # if attempt : return attempt
100 # this makes the run method a bit abtruse - out of the way
101 def create_special_vini_record (self, interface_hrn):
102 # special case for vini
103 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
104 # create a fake internet2 site first
105 i2site = {'name': 'Internet2', 'login_base': 'internet2', 'site_id': -1}
106 site_hrn = _get_site_hrn(interface_hrn, i2site)
107 # import if hrn is not in list of existing hrns or if the hrn exists
108 # but its not a site record
109 if ( 'authority', site_hrn, ) not in self.records_by_type_hrn:
110 urn = hrn_to_urn(site_hrn, 'authority')
111 if not self.auth_hierarchy.auth_exists(urn):
112 self.auth_hierarchy.create_auth(urn)
113 auth_info = self.auth_hierarchy.get_auth_info(urn)
114 auth_record = RegAuthority(hrn=site_hrn, gid=auth_info.get_gid_object(),
115 pointer=site['site_id'],
116 authority=get_authority(site_hrn))
117 auth_record.just_created()
118 dbsession.add(auth_record)
120 self.logger.info("PlImporter: Imported authority (vini site) %s"%auth_record)
121 self.remember_record ( site_record )
123 def run (self, options):
125 interface_hrn = config.SFA_INTERFACE_HRN
126 root_auth = config.SFA_REGISTRY_ROOT_AUTH
127 shell = PlShell (config)
129 ######## retrieve all existing SFA objects
130 all_records = dbsession.query(RegRecord).all()
132 # create hash by (type,hrn)
133 # we essentially use this to know if a given record is already known to SFA
134 self.records_by_type_hrn = \
135 dict ( [ ( (record.type, record.hrn) , record ) for record in all_records ] )
136 # create hash by (type,pointer)
137 self.records_by_type_pointer = \
138 dict ( [ ( (record.type, record.pointer) , record ) for record in all_records
139 if record.pointer != -1] )
141 # initialize record.stale to True by default, then mark stale=False on the ones that are in use
142 for record in all_records: record.stale=True
144 ######## retrieve PLC data
146 # retrieve only required stuf
147 sites = shell.GetSites({'peer_id': None, 'enabled' : True},
148 ['site_id','login_base','node_ids','slice_ids','person_ids', 'name'])
149 # create a hash of sites by login_base
150 # sites_by_login_base = dict ( [ ( site['login_base'], site ) for site in sites ] )
152 persons = shell.GetPersons({'peer_id': None, 'enabled': True},
153 ['person_id', 'email', 'key_ids', 'site_ids', 'role_ids'])
154 # create a hash of persons by person_id
155 persons_by_id = dict ( [ ( person['person_id'], person) for person in persons ] )
156 # also gather non-enabled user accounts so as to issue relevant warnings
157 disabled_persons = shell.GetPersons({'peer_id': None, 'enabled': False}, ['person_id'])
158 disabled_person_ids = [ person['person_id'] for person in disabled_persons ]
159 # Get all plc public keys
160 # accumulate key ids for keys retrieval
162 for person in persons:
163 key_ids.extend(person['key_ids'])
164 keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids,
166 # create a hash of keys by key_id
167 keys_by_id = dict ( [ ( key['key_id'], key ) for key in keys ] )
168 # create a dict person_id -> [ (plc)keys ]
169 keys_by_person_id = {}
170 for person in persons:
172 for key_id in person['key_ids']:
173 # by construction all the keys we fetched are ssh keys
174 # so gpg keys won't be in there
176 key = keys_by_id[key_id]
179 self.logger.warning("Could not spot key %d - probably non-ssh"%key_id)
180 keys_by_person_id[person['person_id']] = pubkeys
182 nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
183 # create hash by node_id
184 nodes_by_id = dict ( [ ( node['node_id'], node, ) for node in nodes ] )
186 slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name', 'person_ids'])
187 # create hash by slice_id
188 slices_by_id = dict ( [ (slice['slice_id'], slice ) for slice in slices ] )
190 # isolate special vini case in separate method
191 self.create_special_vini_record (interface_hrn)
195 if site['name'].startswith('sfa.'):
198 site_hrn = _get_site_hrn(interface_hrn, site)
199 # import if hrn is not in list of existing hrns or if the hrn exists
200 # but its not a site record
201 site_record=self.locate_by_type_hrn ('authority', site_hrn)
204 urn = hrn_to_urn(site_hrn, 'authority')
205 if not self.auth_hierarchy.auth_exists(urn):
206 self.auth_hierarchy.create_auth(urn)
207 auth_info = self.auth_hierarchy.get_auth_info(urn)
208 site_record = RegAuthority(hrn=site_hrn, gid=auth_info.get_gid_object(),
209 pointer=site['site_id'],
210 authority=get_authority(site_hrn))
211 site_record.just_created()
212 dbsession.add(site_record)
214 self.logger.info("PlImporter: imported authority (site) : %s" % site_record)
215 self.remember_record (site_record)
217 # if the site import fails then there is no point in trying to import the
218 # site's child records (node, slices, persons), so skip them.
219 self.logger.log_exc("PlImporter: failed to import site %s. Skipping child records"%site_hrn)
222 # xxx update the record ...
224 site_record.stale=False
226 # import node records
227 for node_id in site['node_ids']:
229 node = nodes_by_id[node_id]
231 self.logger.warning ("PlImporter: cannot find node_id %s - ignored"%node_id)
233 site_auth = get_authority(site_hrn)
234 site_name = site['login_base']
235 node_hrn = hostname_to_hrn(site_auth, site_name, node['hostname'])
236 # xxx this sounds suspicious
237 if len(node_hrn) > 64: node_hrn = node_hrn[:64]
238 node_record = self.locate_by_type_hrn ( 'node', node_hrn )
241 pkey = Keypair(create=True)
242 urn = hrn_to_urn(node_hrn, 'node')
243 node_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
244 node_record = RegNode (hrn=node_hrn, gid=node_gid,
245 pointer =node['node_id'],
246 authority=get_authority(node_hrn))
247 node_record.just_created()
248 dbsession.add(node_record)
250 self.logger.info("PlImporter: imported node: %s" % node_record)
251 self.remember_record (node_record)
253 self.logger.log_exc("PlImporter: failed to import node %s"%node_hrn)
256 # xxx update the record ...
258 node_record.stale=False
262 for person_id in site['person_ids']:
264 if person_id in persons_by_id:
265 person=persons_by_id[person_id]
267 elif person_id in disabled_person_ids:
270 self.logger.warning ("PlImporter: cannot locate person_id %s in site %s - ignored"%(person_id,site_hrn))
271 # make sure to NOT run this if anything is wrong
272 if not proceed: continue
274 person_hrn = email_to_hrn(site_hrn, person['email'])
275 # xxx suspicious again
276 if len(person_hrn) > 64: person_hrn = person_hrn[:64]
277 person_urn = hrn_to_urn(person_hrn, 'user')
279 user_record = self.locate_by_type_hrn ( 'user', person_hrn)
281 # return a tuple pubkey (a plc key object) and pkey (a Keypair object)
282 def init_person_key (person, plc_keys):
284 if person['key_ids']:
285 # randomly pick first key in set
288 pkey = convert_public_key(pubkey['key'])
290 self.logger.warn('PlImporter: unable to convert public key for %s' % person_hrn)
291 pkey = Keypair(create=True)
293 # the user has no keys. Creating a random keypair for the user's gid
294 self.logger.warn("PlImporter: person %s does not have a PL public key"%person_hrn)
295 pkey = Keypair(create=True)
296 return (pubkey, pkey)
300 plc_keys = keys_by_person_id.get(person['person_id'],[])
302 (pubkey,pkey) = init_person_key (person, plc_keys )
303 person_gid = self.auth_hierarchy.create_gid(person_urn, create_uuid(), pkey, email=person['email'])
304 user_record = RegUser (hrn=person_hrn, gid=person_gid,
305 pointer=person['person_id'],
306 authority=get_authority(person_hrn),
307 email=person['email'])
309 user_record.reg_keys=[RegKey (pubkey['key'], pubkey['key_id'])]
311 self.logger.warning("No key found for user %s"%user_record)
312 user_record.just_created()
313 dbsession.add (user_record)
315 self.logger.info("PlImporter: imported person: %s" % user_record)
316 self.remember_record ( user_record )
318 # update the record ?
320 # if a user key has changed then we need to update the
321 # users gid by forcing an update here
323 # right now, SFA only has *one* key attached to a user, and this is
324 # the key that the GID was made with
325 # so the logic here is, we consider that things are OK (unchanged) if
326 # all the SFA keys are present as PLC keys
327 # otherwise we trigger the creation of a new gid from *some* plc key
328 # and record this on the SFA side
329 # it would make sense to add a feature in PLC so that one could pick a 'primary'
330 # key but this is not available on the myplc side for now
331 # = or = it would be much better to support several keys in SFA but that
332 # does not seem doable without a major overhaul in the data model as
333 # a GID is attached to a hrn, but it's also linked to a key, so...
334 # NOTE: with this logic, the first key entered in PLC remains the one
335 # current in SFA until it is removed from PLC
336 sfa_keys = user_record.reg_keys
337 def sfa_key_in_list (sfa_key,plc_keys):
338 for plc_key in plc_keys:
339 if plc_key['key']==sfa_key.key:
342 # are all the SFA keys known to PLC ?
344 if not sfa_keys and plc_keys:
347 for sfa_key in sfa_keys:
348 if not sfa_key_in_list (sfa_key,plc_keys):
351 (pubkey,pkey) = init_person_key (person, plc_keys)
352 person_gid = self.auth_hierarchy.create_gid(person_urn, create_uuid(), pkey)
353 person_gid.set_email(person['email'])
355 user_record.reg_keys=[]
357 user_record.reg_keys=[ RegKey (pubkey['key'], pubkey['key_id'])]
358 user_record.gid = person_gid
359 user_record.just_updated()
360 self.logger.info("PlImporter: updated person: %s" % user_record)
361 user_record.email = person['email']
363 user_record.stale=False
364 # accumulate PIs - PLCAPI has a limitation that when someone has PI role
365 # this is valid for all sites she is in..
366 # PI is coded with role_id==20
367 if 20 in person['role_ids']:
368 site_pis.append (user_record)
370 self.logger.log_exc("PlImporter: failed to import person %d %s"%(person['person_id'],person['email']))
372 # maintain the list of PIs for a given site
373 # for the record, Jordan had proposed the following addition as a welcome hotfix to a previous version:
374 # site_pis = list(set(site_pis))
375 # this was likely due to a bug in the above logic, that had to do with disabled persons
376 # being improperly handled, and where the whole loop on persons
377 # could be performed twice with the same person...
378 # so hopefully we do not need to eliminate duplicates explicitly here anymore
379 site_record.reg_pis = site_pis
383 for slice_id in site['slice_ids']:
385 slice = slices_by_id[slice_id]
387 self.logger.warning ("PlImporter: cannot locate slice_id %s - ignored"%slice_id)
388 slice_hrn = slicename_to_hrn(interface_hrn, slice['name'])
389 slice_record = self.locate_by_type_hrn ('slice', slice_hrn)
392 pkey = Keypair(create=True)
393 urn = hrn_to_urn(slice_hrn, 'slice')
394 slice_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
395 slice_record = RegSlice (hrn=slice_hrn, gid=slice_gid,
396 pointer=slice['slice_id'],
397 authority=get_authority(slice_hrn))
398 slice_record.just_created()
399 dbsession.add(slice_record)
401 self.logger.info("PlImporter: imported slice: %s" % slice_record)
402 self.remember_record ( slice_record )
404 self.logger.log_exc("PlImporter: failed to import slice %s (%s)"%(slice_hrn,slice['name']))
406 # xxx update the record ...
407 # given that we record the current set of users anyways, there does not seem to be much left to do here
408 # self.logger.warning ("Slice update not yet implemented on slice %s (%s)"%(slice_hrn,slice['name']))
410 # record current users affiliated with the slice
411 slice_record.reg_researchers = \
412 [ self.locate_by_type_pointer ('user',user_id) for user_id in slice['person_ids'] ]
414 slice_record.stale=False
416 ### remove stale records
417 # special records must be preserved
418 system_hrns = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
419 for record in all_records:
420 if record.hrn in system_hrns:
422 if record.peer_authority:
424 if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
425 record.hrn.endswith("internet2"):
428 for record in all_records:
429 try: stale=record.stale
432 self.logger.warning("stale not found with %s"%record)
434 self.logger.info("PlImporter: deleting stale record: %s" % record)
435 dbsession.delete(record)