First draft of the Nitos federation with SFA
[sfa.git] / sfa / importer / nitosimporter.py
1
2 import os
3
4 from sfa.util.config import Config
5 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn
6
7 from sfa.trust.gid import create_uuid    
8 from sfa.trust.certificate import convert_public_key, Keypair
9
10 from sfa.storage.alchemy import dbsession
11 from sfa.storage.model import RegRecord, RegAuthority, RegSlice, RegNode, RegUser, RegKey
12
13 from sfa.nitos.nitosshell import NitosShell    
14 from sfa.nitos.nitosxrn import hostname_to_hrn, slicename_to_hrn, email_to_hrn, hrn_to_nitos_slicename, username_to_hrn
15
16 def _get_site_hrn(interface_hrn, site):
17     hrn = ".".join([interface_hrn, site['name']]) 
18     return hrn
19
20
21 class NitosImporter:
22
23     def __init__ (self, auth_hierarchy, logger):
24         self.auth_hierarchy = auth_hierarchy
25         self.logger=logger
26
27     def add_options (self, parser):
28         # we don't have any options for now
29         pass
30
31     # hrn hash is initialized from current db
32     # remember just-created records as we go
33     # xxx might make sense to add a UNIQUE constraint in the db itself
34     def remember_record_by_hrn (self, record):
35         tuple = (record.type, record.hrn)
36         if tuple in self.records_by_type_hrn:
37             self.logger.warning ("NitosImporter.remember_record_by_hrn: duplicate (%s,%s)"%tuple)
38             return
39         self.records_by_type_hrn [ tuple ] = record
40
41     # ditto for pointer hash
42     def remember_record_by_pointer (self, record):
43         if record.pointer == -1:
44             self.logger.warning ("NitosImporter.remember_record_by_pointer: pointer is void")
45             return
46         tuple = (record.type, record.pointer)
47         if tuple in self.records_by_type_pointer:
48             self.logger.warning ("NitosImporter.remember_record_by_pointer: duplicate (%s,%s)"%tuple)
49             return
50         self.records_by_type_pointer [ ( record.type, record.pointer,) ] = record
51
52     def remember_record (self, record):
53         self.remember_record_by_hrn (record)
54         self.remember_record_by_pointer (record)
55
56     def locate_by_type_hrn (self, type, hrn):
57         return self.records_by_type_hrn.get ( (type, hrn), None)
58
59     def locate_by_type_pointer (self, type, pointer):
60         return self.records_by_type_pointer.get ( (type, pointer), None)
61
62     # a convenience/helper function to see if a record is already known
63     # a former, broken, attempt (in 2.1-9) had been made 
64     # to try and use 'pointer' as a first, most significant attempt
65     # the idea being to preserve stuff as much as possible, and thus 
66     # to avoid creating a new gid in the case of a simple hrn rename
67     # however this of course doesn't work as the gid depends on the hrn...
68     #def locate (self, type, hrn=None, pointer=-1):
69     #    if pointer!=-1:
70     #        attempt = self.locate_by_type_pointer (type, pointer)
71     #        if attempt : return attempt
72     #    if hrn is not None:
73     #        attempt = self.locate_by_type_hrn (type, hrn,)
74     #        if attempt : return attempt
75     #    return None
76
77     # this makes the run method a bit abtruse - out of the way
78
79     def run (self, options):
80         config = Config ()
81         interface_hrn = config.SFA_INTERFACE_HRN
82         root_auth = config.SFA_REGISTRY_ROOT_AUTH
83         shell = NitosShell (config)
84
85         ######## retrieve all existing SFA objects
86         all_records = dbsession.query(RegRecord).all()
87
88         # create hash by (type,hrn) 
89         # we essentially use this to know if a given record is already known to SFA 
90         self.records_by_type_hrn = \
91             dict ( [ ( (record.type, record.hrn) , record ) for record in all_records ] )
92         # create hash by (type,pointer) 
93         self.records_by_type_pointer = \
94             dict ( [ ( (record.type, record.pointer) , record ) for record in all_records 
95                      if record.pointer != -1] )
96
97         # initialize record.stale to True by default, then mark stale=False on the ones that are in use
98         for record in all_records: record.stale=True
99
100         ######## retrieve NITOS data
101         # Get site info
102         # retrieve only required stuf
103         site = shell.getTestbedInfo()
104         sites = [site]
105         # create a hash of sites by login_base
106 #       # sites_by_login_base = dict ( [ ( site['login_base'], site ) for site in sites ] )
107         # Get all NITOS users
108         users = shell.getUsers() 
109         # create a hash of users by user_id
110         users_by_id = dict ( [ ( user['user_id'], user) for user in users ] )
111         # Get all NITOS public keys
112         # accumulate key ids for keys retrieval
113 #        key_ids = []
114 #        for person in persons:
115 #            key_ids.extend(person['key_ids'])
116 #        keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids,
117 #                               'key_type': 'ssh'} )
118 #        # create a hash of keys by key_id
119 #        keys_by_id = dict ( [ ( key['key_id'], key ) for key in keys ] ) 
120         # create a dict user_id -> [ (nitos)keys ]
121         keys_by_user_id = dict ( [ ( user['user_id'], user['keys']) for user in users ] ) 
122         # Get all nitos nodes  
123         nodes = shell.getNodes()
124         # create hash by node_id
125         nodes_by_id = dict ( [ (node['node_id'], node) for node in nodes ] )
126         # Get all nitos slices
127         slices = shell.getSlices()
128         # create hash by slice_id
129         slices_by_id = dict ( [ (slice['slice_id'], slice) for slice in slices ] )
130
131
132         # start importing 
133         for site in sites:
134         #for i in [0]:
135             site_hrn = _get_site_hrn(interface_hrn, site)
136             # import if hrn is not in list of existing hrns or if the hrn exists
137             # but its not a site record
138             site_record=self.locate_by_type_hrn ('authority', site_hrn)
139             if not site_record:
140                 try:
141                     urn = hrn_to_urn(site_hrn, 'authority')
142                     if not self.auth_hierarchy.auth_exists(urn):
143                         self.auth_hierarchy.create_auth(urn)
144                     auth_info = self.auth_hierarchy.get_auth_info(urn)
145                     site_record = RegAuthority(hrn=site_hrn, gid=auth_info.get_gid_object(),
146                                                pointer=0,
147                                                authority=get_authority(site_hrn))
148                     site_record.just_created()
149                     dbsession.add(site_record)
150                     dbsession.commit()
151                     self.logger.info("NitosImporter: imported authority (site) : %s" % site_record) 
152                     self.remember_record (site_record)
153                 except:
154                     # if the site import fails then there is no point in trying to import the
155                     # site's child records (node, slices, persons), so skip them.
156                     self.logger.log_exc("NitosImporter: failed to import site. Skipping child records") 
157                     continue 
158             else:
159                 # xxx update the record ...
160                 pass
161             site_record.stale=False
162              
163             # import node records
164             for node in nodes:
165                 site_auth = get_authority(site_hrn)
166                 site_name = site['name']
167                 node_hrn =  hostname_to_hrn(site_auth, site_name, node['name'])
168                 # xxx this sounds suspicious
169                 if len(node_hrn) > 64: node_hrn = node_hrn[:64]
170                 node_record = self.locate_by_type_hrn ( 'node', node_hrn )
171                 if not node_record:
172                     try:
173                         pkey = Keypair(create=True)
174                         urn = hrn_to_urn(node_hrn, 'node')
175                         node_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
176                         node_record = RegNode (hrn=node_hrn, gid=node_gid, 
177                                                pointer =node['node_id'],
178                                                authority=get_authority(node_hrn))
179                         node_record.just_created()
180                         dbsession.add(node_record)
181                         dbsession.commit()
182                         self.logger.info("NitosImporter: imported node: %s" % node_record)  
183                         self.remember_record (node_record)
184                     except:
185                            self.logger.log_exc("NitosImporter: failed to import node")
186                 else:
187                     # xxx update the record ...
188                     pass
189                 node_record.stale=False
190
191
192             # import users
193             for user in users:
194                 user_hrn = username_to_hrn(interface_hrn, site['name'], user['username'])
195                 # xxx suspicious again
196                 if len(user_hrn) > 64: user_hrn = user_hrn[:64]
197                 user_urn = hrn_to_urn(user_hrn, 'user')
198
199                 user_record = self.locate_by_type_hrn ( 'user', user_hrn)
200
201                 # return a tuple pubkey (a nitos key object) and pkey (a Keypair object)
202                 def init_user_key (user):
203                     pubkey = None
204                     pkey = None
205                     if  user['keys']:
206                         # randomly pick first key in set
207                         for key in user['keys']:
208                              pubkey = key
209                              try:
210                                 pkey = convert_public_key(pubkey)
211                                 break
212                              except:
213                                 continue
214                         if not pkey:
215                             self.logger.warn('NitosImporter: unable to convert public key for %s' % user_hrn)
216                             pkey = Keypair(create=True)
217                     else:
218                         # the user has no keys. Creating a random keypair for the user's gid
219                         self.logger.warn("NitosImporter: user %s does not have a NITOS public key"%user_hrn)
220                         pkey = Keypair(create=True)
221                     return (pubkey, pkey)
222
223                 # new user
224                 try:
225                     if not user_record:
226                         (pubkey,pkey) = init_user_key (user)
227                         user_gid = self.auth_hierarchy.create_gid(user_urn, create_uuid(), pkey)
228                         user_gid.set_email(user['email'])
229                         user_record = RegUser (hrn=user_hrn, gid=user_gid, 
230                                                  pointer=user['user_id'], 
231                                                  authority=get_authority(user_hrn),
232                                                  email=user['email'])
233                         if pubkey: 
234                             user_record.reg_keys=[RegKey (pubkey)]
235                         else:
236                             self.logger.warning("No key found for user %s"%user_record)
237                         user_record.just_created()
238                         dbsession.add (user_record)
239                         dbsession.commit()
240                         self.logger.info("NitosImporter: imported user: %s" % user_record)
241                         self.remember_record ( user_record )
242                     else:
243                         # update the record ?
244                         # if user's primary key has changed then we need to update the 
245                         # users gid by forcing an update here
246                         sfa_keys = user_record.reg_keys
247                         def key_in_list (key,sfa_keys):
248                             for reg_key in sfa_keys:
249                                 if reg_key.key==key: return True
250                             return False
251                         # is there a new key in NITOS ?
252                         new_keys=False
253                         for key in user['keys']:
254                             if not key_in_list (key,sfa_keys):
255                                 new_keys = True
256                         if new_keys:
257                             (pubkey,pkey) = init_user_key (user)
258                             user_gid = self.auth_hierarchy.create_gid(user_urn, create_uuid(), pkey)
259                             if not pubkey:
260                                 user_record.reg_keys=[]
261                             else:
262                                 user_record.reg_keys=[ RegKey (pubkey)]
263                             self.logger.info("NitosImporter: updated user: %s" % user_record)
264                     user_record.email = user['email']
265                     dbsession.commit()
266                     user_record.stale=False
267                 except:
268                     self.logger.log_exc("NitosImporter: failed to import user %s %s"%(user['user_id'],user['email']))
269     
270
271             # import slices
272             for slice in slices:
273                 slice_hrn = slicename_to_hrn(interface_hrn, site['name'], slice['slice_name'])
274                 slice_record = self.locate_by_type_hrn ('slice', slice_hrn)
275                 if not slice_record:
276                     try:
277                         pkey = Keypair(create=True)
278                         urn = hrn_to_urn(slice_hrn, 'slice')
279                         slice_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
280                         slice_record = RegSlice (hrn=slice_hrn, gid=slice_gid, 
281                                                  pointer=slice['slice_id'],
282                                                  authority=get_authority(slice_hrn))
283                         slice_record.just_created()
284                         dbsession.add(slice_record)
285                         dbsession.commit()
286                         self.logger.info("NitosImporter: imported slice: %s" % slice_record)  
287                         self.remember_record ( slice_record )
288                     except:
289                         self.logger.log_exc("NitosImporter: failed to import slice")
290                 else:
291                     # xxx update the record ...
292                     self.logger.warning ("Slice update not yet implemented")
293                     pass
294                 # record current users affiliated with the slice
295                 slice_record.reg_researchers = \
296                       [ self.locate_by_type_pointer ('user',int(user_id)) for user_id in slice['user_id'] ]
297                 dbsession.commit()
298                 slice_record.stale=False
299
300
301         ### remove stale records
302         # special records must be preserved
303         system_hrns = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
304         for record in all_records: 
305             if record.hrn in system_hrns: 
306                 record.stale=False
307             if record.peer_authority:
308                 record.stale=False
309
310         for record in all_records:
311             try:        stale=record.stale
312             except:     
313                 stale=True
314                 self.logger.warning("stale not found with %s"%record)
315             if stale:
316                 self.logger.info("NitosImporter: deleting stale record: %s" % record)
317                 dbsession.delete(record)
318                 dbsession.commit()
319
320
321
322 if __name__ == "__main__":
323        from sfa.util.sfalogging import logger
324        nitosimporter = NitosImporter("pla.nitos", logger)
325        nitosimporter.run(None)