replace SFA_API_DEBUG (bool) with SFA_API_LOGLEVEL (int)
[sfa.git] / sfa / importer / sfa-import-plc.py
1 #!/usr/bin/python
2 #
3 ##
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
6 # planetlab database.
7 #
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).
10 #
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.
15 ##
16
17 import os
18 import getopt
19 import sys
20
21 from sfa.util.config import Config
22 from sfa.util.xrn import Xrn, get_leaf, get_authority
23 from sfa.util.plxrn import hostname_to_hrn, slicename_to_hrn, email_to_hrn, hrn_to_pl_slicename
24
25 from sfa.storage.table import SfaTable
26
27 from sfa.importer.sfaImport import sfaImport
28
29 def process_options():
30
31    (options, args) = getopt.getopt(sys.argv[1:], '', [])
32    for opt in options:
33        name = opt[0]
34        val = opt[1]
35
36
37 def load_keys(filename):
38     keys = {}
39     tmp_dict = {}
40     try:
41         execfile(filename, tmp_dict)
42         if 'keys' in tmp_dict:
43             keys = tmp_dict['keys']
44         return keys
45     except:
46         return keys
47
48 def save_keys(filename, keys):
49     f = open(filename, 'w')
50     f.write("keys = %s" % str(keys))
51     f.close()
52
53 def _get_site_hrn(interface_hrn, site):
54     # Hardcode 'internet2' into the hrn for sites hosting
55     # internet2 nodes. This is a special operation for some vini
56     # sites only
57     hrn = ".".join([interface_hrn, site['login_base']]) 
58     if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
59         if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
60             hrn = ".".join([interface_hrn, "internet2", site['login_base']])
61     return hrn
62
63 def main():
64
65     process_options()
66     config = Config()
67     if not config.SFA_REGISTRY_ENABLED:
68         sys.exit(0)
69     root_auth = config.SFA_REGISTRY_ROOT_AUTH
70     interface_hrn = config.SFA_INTERFACE_HRN
71     keys_filename = config.config_path + os.sep + 'person_keys.py' 
72     sfaImporter = sfaImport()
73     logger=sfaImporter.logger
74     logger.setLevelFromOptVerbose(config.SFA_API_LOGLEVEL)
75     shell = sfaImporter.shell
76     
77     # initialize registry db table
78     table = SfaTable()
79
80     # create root authority 
81     sfaImporter.create_top_level_auth_records(interface_hrn)
82
83     # create s user record for the slice manager
84     sfaImporter.create_sm_client_record()
85
86     # create interface records
87     logger.info("Import: creating interface records")
88     sfaImporter.create_interface_records()
89
90     # add local root authority's cert  to trusted list
91     logger.info("Import: adding " + interface_hrn + " to trusted list")
92     authority = sfaImporter.AuthHierarchy.get_auth_info(interface_hrn)
93     sfaImporter.TrustedRoots.add_gid(authority.get_gid_object())
94
95     # special case for vini
96     if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
97         # create a fake internet2 site first
98         i2site = {'name': 'Internet2', 'abbreviated_name': 'I2',
99                     'login_base': 'internet2', 'site_id': -1}
100         sfaImporter.import_site(interface_hrn, i2site)
101    
102     # create dict of all existing sfa records
103     existing_records = {}
104     existing_hrns = []
105     key_ids = []
106     person_keys = {} 
107     results = table.find()
108     for result in results:
109         existing_records[(result['hrn'], result['type'])] = result
110         existing_hrns.append(result['hrn']) 
111             
112     # Get all plc sites
113     sites = shell.GetSites({'peer_id': None})
114     sites_dict = {}
115     for site in sites:
116         sites_dict[site['login_base']] = site 
117     
118     # Get all plc users
119     persons = shell.GetPersons({'peer_id': None, 'enabled': True}, 
120                                ['person_id', 'email', 'key_ids', 'site_ids'])
121     persons_dict = {}
122     for person in persons:
123         persons_dict[person['person_id']] = person
124         key_ids.extend(person['key_ids'])
125
126     # Get all public keys
127     keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids})
128     keys_dict = {}
129     for key in keys:
130         keys_dict[key['key_id']] = key['key']
131
132     # create a dict of person keys keyed on key_id 
133     old_person_keys = load_keys(keys_filename)
134     for person in persons:
135         pubkeys = []
136         for key_id in person['key_ids']:
137             pubkeys.append(keys_dict[key_id])
138         person_keys[person['person_id']] = pubkeys
139
140     # Get all plc nodes  
141     nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
142     nodes_dict = {}
143     for node in nodes:
144         nodes_dict[node['node_id']] = node
145
146     # Get all plc slices
147     slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name'])
148     slices_dict = {}
149     for slice in slices:
150         slices_dict[slice['slice_id']] = slice
151     # start importing 
152     for site in sites:
153         site_hrn = _get_site_hrn(interface_hrn, site)
154         logger.info("Importing site: %s" % site_hrn)
155
156         # import if hrn is not in list of existing hrns or if the hrn exists
157         # but its not a site record
158         if site_hrn not in existing_hrns or \
159            (site_hrn, 'authority') not in existing_records:
160             sfaImporter.import_site(site_hrn, site)
161              
162         # import node records
163         for node_id in site['node_ids']:
164             if node_id not in nodes_dict:
165                 continue 
166             node = nodes_dict[node_id]
167             site_auth = get_authority(site_hrn)
168             site_name = get_leaf(site_hrn)
169             hrn =  hostname_to_hrn(site_auth, site_name, node['hostname'])
170             if hrn not in existing_hrns or \
171                (hrn, 'node') not in existing_records:
172                 sfaImporter.import_node(hrn, node)
173
174         # import slices
175         for slice_id in site['slice_ids']:
176             if slice_id not in slices_dict:
177                 continue 
178             slice = slices_dict[slice_id]
179             hrn = slicename_to_hrn(interface_hrn, slice['name'])
180             if hrn not in existing_hrns or \
181                (hrn, 'slice') not in existing_records:
182                 sfaImporter.import_slice(site_hrn, slice)      
183
184         # import persons
185         for person_id in site['person_ids']:
186             if person_id not in persons_dict:
187                 continue 
188             person = persons_dict[person_id]
189             hrn = email_to_hrn(site_hrn, person['email'])
190             old_keys = []
191             new_keys = []
192             if person_id in old_person_keys:
193                 old_keys = old_person_keys[person_id]
194             if person_id in person_keys:
195                 new_keys = person_keys[person_id]
196             update_record = False
197             for key in new_keys:
198                 if key not in old_keys:
199                     update_record = True 
200
201             if hrn not in existing_hrns or \
202                (hrn, 'user') not in existing_records or update_record:
203                 sfaImporter.import_person(site_hrn, person)
204
205     
206     # remove stale records    
207     system_records = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
208     for (record_hrn, type) in existing_records.keys():
209         if record_hrn in system_records:
210             continue
211         
212         record = existing_records[(record_hrn, type)]
213         if record['peer_authority']:
214             continue
215
216         # dont delete vini's internet2 placeholdder record
217         # normally this would be deleted becuase it does not have a plc record 
218         if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
219            record_hrn.endswith("internet2"):     
220             continue
221
222         found = False
223         
224         if type == 'authority':    
225             for site in sites:
226                 site_hrn = interface_hrn + "." + site['login_base']
227                 if site_hrn == record_hrn and site['site_id'] == record['pointer']:
228                     found = True
229                     break
230
231         elif type == 'user':
232             login_base = get_leaf(get_authority(record_hrn))
233             username = get_leaf(record_hrn)
234             if login_base in sites_dict:
235                 site = sites_dict[login_base]
236                 for person in persons:
237                     tmp_username = person['email'].split("@")[0]
238                     alt_username = person['email'].split("@")[0].replace(".", "_").replace("+", "_")
239                     if username in [tmp_username, alt_username] and \
240                        site['site_id'] in person['site_ids'] and \
241                        person['person_id'] == record['pointer']:
242                         found = True
243                         break
244         
245         elif type == 'slice':
246             slicename = hrn_to_pl_slicename(record_hrn)
247             for slice in slices:
248                 if slicename == slice['name'] and \
249                    slice['slice_id'] == record['pointer']:
250                     found = True
251                     break    
252  
253         elif type == 'node':
254             login_base = get_leaf(get_authority(record_hrn))
255             nodename = Xrn.unescape(get_leaf(record_hrn))
256             if login_base in sites_dict:
257                 site = sites_dict[login_base]
258                 for node in nodes:
259                     tmp_nodename = node['hostname']
260                     if tmp_nodename == nodename and \
261                        node['site_id'] == site['site_id'] and \
262                        node['node_id'] == record['pointer']:
263                         found = True
264                         break  
265         else:
266             continue 
267         
268         if not found:
269             record_object = existing_records[(record_hrn, type)]
270             sfaImporter.delete_record(record_hrn, type) 
271                                    
272     # save pub keys
273     logger.info('Import: saving current pub keys')
274     save_keys(keys_filename, person_keys)                
275         
276 if __name__ == "__main__":
277     main()