4 # Import PLC records into the SFA database. It is indended that this tool be
5 # run once to create SFA records that reflect the current state of the
8 # The import tool assumes that the existing PLC hierarchy should all be part
9 # of "planetlab.us" (see the root_auth and level1_auth variables below).
11 # Public keys are extracted from the users' SSH keys automatically and used to
12 # create GIDs. This is relatively experimental as a custom tool had to be
13 # written to perform conversion from SSH to OpenSSL format. It only supports
14 # RSA keys at this time, not DSA keys.
21 from sfa.util.config import Config
22 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn
23 from sfa.util.plxrn import hostname_to_hrn, slicename_to_hrn, email_to_hrn, hrn_to_pl_slicename
25 from sfa.trust.gid import create_uuid
26 from sfa.trust.certificate import convert_public_key, Keypair
28 from sfa.plc.plshell import PlShell
30 from sfa.storage.alchemy import dbsession
31 from sfa.storage.persistentobjs import RegRecord
33 from sfa.importer.sfaImport import sfaImport, _cleanup_string
35 def process_options():
37 (options, args) = getopt.getopt(sys.argv[1:], '', [])
43 def load_keys(filename):
47 execfile(filename, tmp_dict)
48 if 'keys' in tmp_dict:
49 keys = tmp_dict['keys']
54 def save_keys(filename, keys):
55 f = open(filename, 'w')
56 f.write("keys = %s" % str(keys))
59 def _get_site_hrn(interface_hrn, site):
60 # Hardcode 'internet2' into the hrn for sites hosting
61 # internet2 nodes. This is a special operation for some vini
63 hrn = ".".join([interface_hrn, site['login_base']])
64 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
65 if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
66 hrn = ".".join([interface_hrn, "internet2", site['login_base']])
69 # maybe could use a call to persistentobjs.init_tables somewhere
70 # however now import s expected to be done after service creation..
75 if not config.SFA_REGISTRY_ENABLED:
77 root_auth = config.SFA_REGISTRY_ROOT_AUTH
78 interface_hrn = config.SFA_INTERFACE_HRN
79 keys_filename = config.config_path + os.sep + 'person_keys.py'
80 sfaImporter = sfaImport()
81 sfaImporter.create_top_level_records()
82 logger=sfaImporter.logger
83 logger.setLevelFromOptVerbose(config.SFA_API_LOGLEVEL)
84 shell = PlShell (config)
86 # create dict of all existing sfa records
91 for record in dbsession.query(RegRecord):
92 existing_records[ (record.hrn, record.type,) ] = record
93 existing_hrns.append(record.hrn)
96 sites = shell.GetSites({'peer_id': None})
99 sites_dict[site['login_base']] = site
102 persons = shell.GetPersons({'peer_id': None, 'enabled': True},
103 ['person_id', 'email', 'key_ids', 'site_ids'])
105 for person in persons:
106 persons_dict[person['person_id']] = person
107 key_ids.extend(person['key_ids'])
109 # Get all public keys
110 keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids})
113 keys_dict[key['key_id']] = key['key']
115 # create a dict of person keys keyed on key_id
116 old_person_keys = load_keys(keys_filename)
117 for person in persons:
119 for key_id in person['key_ids']:
120 pubkeys.append(keys_dict[key_id])
121 person_keys[person['person_id']] = pubkeys
124 nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
127 nodes_dict[node['node_id']] = node
130 slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name'])
133 slices_dict[slice['slice_id']] = slice
135 # special case for vini
136 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
137 # create a fake internet2 site first
138 i2site = {'name': 'Internet2', 'abbreviated_name': 'I2',
139 'login_base': 'internet2', 'site_id': -1}
140 site_hrn = _get_site_hrn(interface_hrn, i2site)
141 logger.info("Importing site: %s" % site_hrn)
142 # import if hrn is not in list of existing hrns or if the hrn exists
143 # but its not a site record
144 if site_hrn not in existing_hrns or \
145 (site_hrn, 'authority') not in existing_records:
146 logger.info("Import: site %s " % site_hrn)
147 urn = hrn_to_urn(site_hrn, 'authority')
148 if not sfaImporter.AuthHierarchy.auth_exists(urn):
149 sfaImporter.AuthHierarchy.create_auth(urn)
150 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
151 auth_record = RegRecord("authority", hrn=site_hrn, gid=auth_info.get_gid_object(),
152 pointer=site['site_id'],
153 authority=get_authority(site_hrn))
154 logger.info("Import: Importing auth %s"%auth_record)
155 dbsession.add(auth_record)
160 site_hrn = _get_site_hrn(interface_hrn, site)
161 logger.info("Importing site: %s" % site_hrn)
163 # import if hrn is not in list of existing hrns or if the hrn exists
164 # but its not a site record
165 if site_hrn not in existing_hrns or \
166 (site_hrn, 'authority') not in existing_records:
168 urn = hrn_to_urn(site_hrn, 'authority')
169 if not sfaImporter.AuthHierarchy.auth_exists(urn):
170 sfaImporter.AuthHierarchy.create_auth(urn)
171 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
172 auth_record = RegRecord("authority", hrn=site_hrn, gid=auth_info.get_gid_object(),
173 pointer=site['site_id'],
174 authority=get_authority(site_hrn))
175 logger.info("Import: importing site: %s" % auth_record)
176 dbsession.add(auth_record)
179 # if the site import fails then there is no point in trying to import the
180 # site's child records (node, slices, persons), so skip them.
181 logger.log_exc("Import: failed to import site. Skipping child records")
184 # import node records
185 for node_id in site['node_ids']:
186 if node_id not in nodes_dict:
188 node = nodes_dict[node_id]
189 site_auth = get_authority(site_hrn)
190 site_name = get_leaf(site_hrn)
191 hrn = hostname_to_hrn(site_auth, site_name, node['hostname'])
194 if hrn not in existing_hrns or \
195 (hrn, 'node') not in existing_records:
197 pkey = Keypair(create=True)
198 urn = hrn_to_urn(hrn, 'node')
199 node_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
200 node_record = RegRecord("node", hrn=hrn, gid=node_gid,
201 pointer=node['node_id'],
202 authority=get_authority(hrn))
203 logger.info("Import: importing node: %s" % node_record)
204 dbsession.add(node_record)
207 logger.log_exc("Import: failed to import node")
211 for slice_id in site['slice_ids']:
212 if slice_id not in slices_dict:
214 slice = slices_dict[slice_id]
215 hrn = slicename_to_hrn(interface_hrn, slice['name'])
216 #slicename = slice['name'].split("_",1)[-1]
217 #slicename = _cleanup_string(slicename)
218 if hrn not in existing_hrns or \
219 (hrn, 'slice') not in existing_records:
221 pkey = Keypair(create=True)
222 urn = hrn_to_urn(hrn, 'slice')
223 slice_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
224 slice_record = RegRecord("slice", hrn=hrn, gid=slice_gid,
225 pointer=slice['slice_id'],
226 authority=get_authority(hrn))
227 logger.info("Import: importing slice: %s" % slice_record)
228 dbsession.add(slice_record)
231 logger.log_exc("Import: failed to import slice")
234 for person_id in site['person_ids']:
235 if person_id not in persons_dict:
237 person = persons_dict[person_id]
238 hrn = email_to_hrn(site_hrn, person['email'])
242 # if user's primary key has changed then we need to update the
243 # users gid by forcing an update here
246 if person_id in old_person_keys:
247 old_keys = old_person_keys[person_id]
248 if person_id in person_keys:
249 new_keys = person_keys[person_id]
250 update_record = False
252 if key not in old_keys:
255 if hrn not in existing_hrns or \
256 (hrn, 'user') not in existing_records or update_record:
258 if 'key_ids' in person and person['key_ids']:
261 pkey = convert_public_key(key)
263 logger.warn('unable to convert public key for %s' % hrn)
264 pkey = Keypair(create=True)
266 # the user has no keys. Creating a random keypair for the user's gid
267 logger.warn("Import: person %s does not have a PL public key"%hrn)
268 pkey = Keypair(create=True)
269 urn = hrn_to_urn(hrn, 'user')
270 person_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
271 person_record = RegRecord("user", hrn=hrn, gid=person_gid,
272 pointer=person['person_id'],
273 authority=get_authority(hrn))
274 logger.info("Import: importing person: %s" % person_record)
275 dbsession.add (person_record)
278 logger.log_exc("Import: failed to import person.")
280 # remove stale records
281 system_records = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
282 for (record_hrn, type) in existing_records.keys():
283 if record_hrn in system_records:
286 record = existing_records[(record_hrn, type)]
287 if record.peer_authority:
290 # dont delete vini's internet2 placeholdder record
291 # normally this would be deleted becuase it does not have a plc record
292 if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
293 record_hrn.endswith("internet2"):
298 if type == 'authority':
300 site_hrn = interface_hrn + "." + site['login_base']
301 if site_hrn == record_hrn and site['site_id'] == record.pointer:
306 login_base = get_leaf(get_authority(record_hrn))
307 username = get_leaf(record_hrn)
308 if login_base in sites_dict:
309 site = sites_dict[login_base]
310 for person in persons:
311 tmp_username = person['email'].split("@")[0]
312 alt_username = person['email'].split("@")[0].replace(".", "_").replace("+", "_")
313 if username in [tmp_username, alt_username] and \
314 site['site_id'] in person['site_ids'] and \
315 person['person_id'] == record.pointer:
319 elif type == 'slice':
320 slicename = hrn_to_pl_slicename(record_hrn)
322 if slicename == slice['name'] and \
323 slice['slice_id'] == record.pointer:
328 login_base = get_leaf(get_authority(record_hrn))
329 nodename = Xrn.unescape(get_leaf(record_hrn))
330 if login_base in sites_dict:
331 site = sites_dict[login_base]
333 tmp_nodename = node['hostname']
334 if tmp_nodename == nodename and \
335 node['site_id'] == site['site_id'] and \
336 node['node_id'] == record.pointer:
344 record_object = existing_records[(record_hrn, type)]
345 logger.info("Import: deleting record: %s" % record)
349 logger.log_exc("Import: failded to delete record")
351 logger.info('Import: saving current pub keys')
352 save_keys(keys_filename, person_keys)
354 if __name__ == "__main__":