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
24 from sfa.storage.table import SfaTable
25 from sfa.storage.record import SfaRecord
26 from sfa.trust.gid import create_uuid
27 from sfa.trust.certificate import convert_public_key, Keypair
28 from sfa.importer.sfaImport import sfaImport, _cleanup_string
29 from sfa.plc.plshell import PlShell
31 def process_options():
33 (options, args) = getopt.getopt(sys.argv[1:], '', [])
39 def load_keys(filename):
43 execfile(filename, tmp_dict)
44 if 'keys' in tmp_dict:
45 keys = tmp_dict['keys']
50 def save_keys(filename, keys):
51 f = open(filename, 'w')
52 f.write("keys = %s" % str(keys))
55 def _get_site_hrn(interface_hrn, site):
56 # Hardcode 'internet2' into the hrn for sites hosting
57 # internet2 nodes. This is a special operation for some vini
59 hrn = ".".join([interface_hrn, site['login_base']])
60 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
61 if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
62 hrn = ".".join([interface_hrn, "internet2", site['login_base']])
69 if not config.SFA_REGISTRY_ENABLED:
71 root_auth = config.SFA_REGISTRY_ROOT_AUTH
72 interface_hrn = config.SFA_INTERFACE_HRN
73 keys_filename = config.config_path + os.sep + 'person_keys.py'
74 sfaImporter = sfaImport()
75 sfaImporter.create_top_level_records()
76 logger=sfaImporter.logger
77 logger.setLevelFromOptVerbose(config.SFA_API_LOGLEVEL)
78 shell = PlShell (config)
80 # create dict of all existing sfa records
86 results = table.find()
87 for result in results:
88 existing_records[(result['hrn'], result['type'])] = result
89 existing_hrns.append(result['hrn'])
92 sites = shell.GetSites({'peer_id': None})
95 sites_dict[site['login_base']] = site
98 persons = shell.GetPersons({'peer_id': None, 'enabled': True},
99 ['person_id', 'email', 'key_ids', 'site_ids'])
101 for person in persons:
102 persons_dict[person['person_id']] = person
103 key_ids.extend(person['key_ids'])
105 # Get all public keys
106 keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids})
109 keys_dict[key['key_id']] = key['key']
111 # create a dict of person keys keyed on key_id
112 old_person_keys = load_keys(keys_filename)
113 for person in persons:
115 for key_id in person['key_ids']:
116 pubkeys.append(keys_dict[key_id])
117 person_keys[person['person_id']] = pubkeys
120 nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
123 nodes_dict[node['node_id']] = node
126 slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name'])
129 slices_dict[slice['slice_id']] = slice
131 # special case for vini
132 if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
133 # create a fake internet2 site first
134 i2site = {'name': 'Internet2', 'abbreviated_name': 'I2',
135 'login_base': 'internet2', 'site_id': -1}
136 site_hrn = _get_site_hrn(interface_hrn, i2site)
137 logger.info("Importing site: %s" % site_hrn)
138 # import if hrn is not in list of existing hrns or if the hrn exists
139 # but its not a site record
140 if site_hrn not in existing_hrns or \
141 (site_hrn, 'authority') not in existing_records:
142 logger.info("Import: site %s " % site_hrn)
143 urn = hrn_to_urn(site_hrn, 'authority')
144 if not sfaImporter.AuthHierarchy.auth_exists(urn):
145 sfaImporter.AuthHierarchy.create_auth(urn)
146 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
147 auth_record = SfaRecord(hrn=site_hrn, gid=auth_info.get_gid_object(), type="authority", pointer=site['site_id'])
148 auth_record.sync(verbose=True)
152 site_hrn = _get_site_hrn(interface_hrn, site)
153 logger.info("Importing site: %s" % site_hrn)
155 # import if hrn is not in list of existing hrns or if the hrn exists
156 # but its not a site record
157 if site_hrn not in existing_hrns or \
158 (site_hrn, 'authority') not in existing_records:
160 logger.info("Import: site %s " % site_hrn)
161 urn = hrn_to_urn(site_hrn, 'authority')
162 if not sfaImporter.AuthHierarchy.auth_exists(urn):
163 sfaImporter.AuthHierarchy.create_auth(urn)
164 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
165 auth_record = SfaRecord(hrn=site_hrn, gid=auth_info.get_gid_object(), \
166 type="authority", pointer=site['site_id'])
167 logger.info("Import: importing site: %s" % auth_record.summary_string())
170 # if the site import fails then there is no point in trying to import the
171 # site's child records (node, slices, persons), so skip them.
172 logger.log_exc("Import: failed to import site. Skipping child records")
175 # import node records
176 for node_id in site['node_ids']:
177 if node_id not in nodes_dict:
179 node = nodes_dict[node_id]
180 site_auth = get_authority(site_hrn)
181 site_name = get_leaf(site_hrn)
182 hrn = hostname_to_hrn(site_auth, site_name, node['hostname'])
185 if hrn not in existing_hrns or \
186 (hrn, 'node') not in existing_records:
188 pkey = Keypair(create=True)
189 urn = hrn_to_urn(hrn, 'node')
190 node_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
191 node_record = SfaRecord(hrn=hrn, gid=node_gid, type="node", pointer=node['node_id'], authority=get_authority(hrn))
192 logger.info("Import: importing node: %s" % node_record.summary_string())
195 logger.log_exc("Import: failed to import node")
199 for slice_id in site['slice_ids']:
200 if slice_id not in slices_dict:
202 slice = slices_dict[slice_id]
203 hrn = slicename_to_hrn(interface_hrn, slice['name'])
204 #slicename = slice['name'].split("_",1)[-1]
205 #slicename = _cleanup_string(slicename)
206 if hrn not in existing_hrns or \
207 (hrn, 'slice') not in existing_records:
209 pkey = Keypair(create=True)
210 urn = hrn_to_urn(hrn, 'slice')
211 slice_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
212 slice_record = SfaRecord(hrn=hrn, gid=slice_gid, type="slice", pointer=slice['slice_id'],
213 authority=get_authority(hrn))
214 logger.info("Import: importing slice: %s" % slice_record.summary_string())
217 logger.log_exc("Import: failed to import slice")
220 for person_id in site['person_ids']:
221 if person_id not in persons_dict:
223 person = persons_dict[person_id]
224 hrn = email_to_hrn(site_hrn, person['email'])
228 # if user's primary key has chnaged then we need to update the
229 # users gid by forcing a update here
232 if person_id in old_person_keys:
233 old_keys = old_person_keys[person_id]
234 if person_id in person_keys:
235 new_keys = person_keys[person_id]
236 update_record = False
238 if key not in old_keys:
241 if hrn not in existing_hrns or \
242 (hrn, 'user') not in existing_records or update_record:
244 if 'key_ids' in person and person['key_ids']:
247 pkey = convert_public_key(key)
249 logger.warn('unable to convert public key for %s' % hrn)
250 pkey = Keypair(create=True)
252 # the user has no keys. Creating a random keypair for the user's gid
253 logger.warn("Import: person %s does not have a PL public key"%hrn)
254 pkey = Keypair(create=True)
255 urn = hrn_to_urn(hrn, 'user')
256 person_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
257 person_record = SfaRecord(hrn=hrn, gid=person_gid, type="user", \
258 pointer=person['person_id'], authority=get_authority(hrn))
259 logger.info("Import: importing person: %s" % person_record.summary_string())
262 logger.log_exc("Import: failed to import person.")
264 # remove stale records
265 system_records = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
266 for (record_hrn, type) in existing_records.keys():
267 if record_hrn in system_records:
270 record = existing_records[(record_hrn, type)]
271 if record['peer_authority']:
274 # dont delete vini's internet2 placeholdder record
275 # normally this would be deleted becuase it does not have a plc record
276 if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
277 record_hrn.endswith("internet2"):
282 if type == 'authority':
284 site_hrn = interface_hrn + "." + site['login_base']
285 if site_hrn == record_hrn and site['site_id'] == record['pointer']:
290 login_base = get_leaf(get_authority(record_hrn))
291 username = get_leaf(record_hrn)
292 if login_base in sites_dict:
293 site = sites_dict[login_base]
294 for person in persons:
295 tmp_username = person['email'].split("@")[0]
296 alt_username = person['email'].split("@")[0].replace(".", "_").replace("+", "_")
297 if username in [tmp_username, alt_username] and \
298 site['site_id'] in person['site_ids'] and \
299 person['person_id'] == record['pointer']:
303 elif type == 'slice':
304 slicename = hrn_to_pl_slicename(record_hrn)
306 if slicename == slice['name'] and \
307 slice['slice_id'] == record['pointer']:
312 login_base = get_leaf(get_authority(record_hrn))
313 nodename = Xrn.unescape(get_leaf(record_hrn))
314 if login_base in sites_dict:
315 site = sites_dict[login_base]
317 tmp_nodename = node['hostname']
318 if tmp_nodename == nodename and \
319 node['site_id'] == site['site_id'] and \
320 node['node_id'] == record['pointer']:
328 record_object = existing_records[(record_hrn, type)]
329 record = SfaRecord(dict=record_object)
330 logger.info("Import: deleting record: %s" % record.summary_string())
333 logger.log_exc("Import: failded to delete record")
335 logger.info('Import: saving current pub keys')
336 save_keys(keys_filename, person_keys)
338 if __name__ == "__main__":