Merge branch 'master' of ssh://git.onelab.eu/git/sfa
[sfa.git] / sfa / importer / sfaImport.py
1 #
2 # The import tool assumes that the existing PLC hierarchy should all be part
3 # of "planetlab.us" (see the root_auth and level1_auth variables below).
4 #
5 # Public keys are extracted from the users' SSH keys automatically and used to
6 # create GIDs. This is relatively experimental as a custom tool had to be
7 # written to perform conversion from SSH to OpenSSL format. It only supports
8 # RSA keys at this time, not DSA keys.
9 ##
10
11 from sfa.util.sfalogging import _SfaLogger
12
13 from sfa.util.record import SfaRecord
14 from sfa.util.table import SfaTable
15 from sfa.util.xrn import get_authority, hrn_to_urn
16 from sfa.util.plxrn import email_to_hrn
17 from sfa.util.config import Config
18 from sfa.trust.certificate import convert_public_key, Keypair
19 from sfa.trust.trustedroots import TrustedRoots
20 from sfa.trust.hierarchy import Hierarchy
21 from sfa.trust.gid import create_uuid
22
23
24 def _un_unicode(str):
25    if isinstance(str, unicode):
26        return str.encode("ascii", "ignore")
27    else:
28        return str
29
30 def _cleanup_string(str):
31     # pgsql has a fit with strings that have high ascii in them, so filter it
32     # out when generating the hrns.
33     tmp = ""
34     for c in str:
35         if ord(c) < 128:
36             tmp = tmp + c
37     str = tmp
38
39     str = _un_unicode(str)
40     str = str.replace(" ", "_")
41     str = str.replace(".", "_")
42     str = str.replace("(", "_")
43     str = str.replace("'", "_")
44     str = str.replace(")", "_")
45     str = str.replace('"', "_")
46     return str
47
48 class sfaImport:
49
50     def __init__(self):
51        self.logger = _SfaLogger(logfile='/var/log/sfa_import.log', loggername='importlog')
52        self.AuthHierarchy = Hierarchy()
53        self.config = Config()
54        self.TrustedRoots = TrustedRoots(Config.get_trustedroots_dir(self.config))
55        self.plc_auth = self.config.get_plc_auth()
56        self.root_auth = self.config.SFA_REGISTRY_ROOT_AUTH
57         
58        # connect to planetlab
59        self.shell = None
60        if "Url" in self.plc_auth:
61           from sfa.plc.remoteshell import RemoteShell
62           self.shell = RemoteShell(self.logger)
63        else:
64           import PLC.Shell
65           self.shell = PLC.Shell.Shell(globals = globals())        
66
67     def create_top_level_auth_records(self, hrn):
68         """
69         Create top level db records (includes root and sub authorities (local/remote)
70         """
71         # make sure parent exists
72         parent_hrn = get_authority(hrn)
73         if not parent_hrn:
74             parent_hrn = hrn
75         if not parent_hrn == hrn:
76             self.create_top_level_auth_records(parent_hrn)
77
78         # create the db record if it doesnt already exist    
79         auth_info = self.AuthHierarchy.get_auth_info(hrn)
80         table = SfaTable()
81         auth_record = table.find({'type': 'authority', 'hrn': hrn})
82
83         if not auth_record:
84             auth_record = SfaRecord(hrn=hrn, gid=auth_info.get_gid_object(), type="authority", pointer=-1)
85             auth_record['authority'] = get_authority(auth_record['hrn'])
86             self.logger.info("Import: inserting authority record for %s"%hrn)
87             table.insert(auth_record)
88
89     def create_sm_client_record(self):
90         """
91         Create a user record for the Slicemanager service.
92         """
93         hrn = self.config.SFA_INTERFACE_HRN + '.slicemanager'
94         urn = hrn_to_urn(hrn, 'user')
95         if not self.AuthHierarchy.auth_exists(urn):
96             self.logger.info("Import: creating Slice Manager user")
97             self.AuthHierarchy.create_auth(urn)
98
99         auth_info = self.AuthHierarchy.get_auth_info(hrn)
100         table = SfaTable()
101         sm_user_record = table.find({'type': 'user', 'hrn': hrn})
102         if not sm_user_record:
103             record = SfaRecord(hrn=hrn, gid=auth_info.get_gid_object(), type="user", pointer=-1)
104             record['authority'] = get_authority(record['hrn'])
105             table.insert(record)    
106
107     def create_interface_records(self):
108         """
109         Create a record for each SFA interface
110         """
111         # just create certs for all sfa interfaces even if they
112         # arent enabled
113         interface_hrn = self.config.SFA_INTERFACE_HRN
114         interfaces = ['authority+sa', 'authority+am', 'authority+sm']
115         table = SfaTable()
116         auth_info = self.AuthHierarchy.get_auth_info(interface_hrn)
117         pkey = auth_info.get_pkey_object()
118         for interface in interfaces:
119             interface_record = table.find({'type': interface, 'hrn': interface_hrn})
120             if not interface_record:
121                 self.logger.info("Import: interface %s %s " % (interface_hrn, interface))
122                 urn = hrn_to_urn(interface_hrn, interface)
123                 gid = self.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
124                 record = SfaRecord(hrn=interface_hrn, gid=gid, type=interface, pointer=-1)  
125                 record['authority'] = get_authority(interface_hrn)
126                 table.insert(record) 
127                                 
128
129     
130     def import_person(self, parent_hrn, person):
131         """
132         Register a user record 
133         """
134         hrn = email_to_hrn(parent_hrn, person['email'])
135
136         # ASN.1 will have problems with hrn's longer than 64 characters
137         if len(hrn) > 64:
138             hrn = hrn[:64]
139
140         self.logger.info("Import: person %s"%hrn)
141         key_ids = []
142         if 'key_ids' in person and person['key_ids']:
143             key_ids = person["key_ids"]
144             # get the user's private key from the SSH keys they have uploaded
145             # to planetlab
146             keys = self.shell.GetKeys(self.plc_auth, key_ids)
147             key = keys[0]['key']
148             pkey = None
149             try:
150                 pkey = convert_public_key(key)
151             except:
152                 self.logger.warn('unable to convert public key for %s' % hrn) 
153             if not pkey:
154                 pkey = Keypair(create=True)
155         else:
156             # the user has no keys
157             self.logger.warn("Import: person %s does not have a PL public key"%hrn)
158             # if a key is unavailable, then we still need to put something in the
159             # user's GID. So make one up.
160             pkey = Keypair(create=True)
161
162         # create the gid
163         urn = hrn_to_urn(hrn, 'user')
164         person_gid = self.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
165         table = SfaTable()
166         person_record = SfaRecord(hrn=hrn, gid=person_gid, type="user", pointer=person['person_id'])
167         person_record['authority'] = get_authority(person_record['hrn'])
168         existing_records = table.find({'hrn': hrn, 'type': 'user', 'pointer': person['person_id']})
169         if not existing_records:
170             table.insert(person_record)
171         else:
172             self.logger.info("Import: %s exists, updating " % hrn)
173             existing_record = existing_records[0]
174             person_record['record_id'] = existing_record['record_id']
175             table.update(person_record)
176
177     def import_slice(self, parent_hrn, slice):
178         slicename = slice['name'].split("_",1)[-1]
179         slicename = _cleanup_string(slicename)
180
181         if not slicename:
182             self.logger.error("Import: failed to parse slice name %s" %slice['name'])
183             return
184
185         hrn = parent_hrn + "." + slicename
186         self.logger.info("Import: slice %s"%hrn)
187
188         pkey = Keypair(create=True)
189         urn = hrn_to_urn(hrn, 'slice')
190         slice_gid = self.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
191         slice_record = SfaRecord(hrn=hrn, gid=slice_gid, type="slice", pointer=slice['slice_id'])
192         slice_record['authority'] = get_authority(slice_record['hrn'])
193         table = SfaTable()
194         existing_records = table.find({'hrn': hrn, 'type': 'slice', 'pointer': slice['slice_id']})
195         if not existing_records:
196             table.insert(slice_record)
197         else:
198             self.logger.info("Import: %s exists, updating " % hrn)
199             existing_record = existing_records[0]
200             slice_record['record_id'] = existing_record['record_id']
201             table.update(slice_record)
202
203     def import_node(self, hrn, node):
204         self.logger.info("Import: node %s" % hrn)
205         # ASN.1 will have problems with hrn's longer than 64 characters
206         if len(hrn) > 64:
207             hrn = hrn[:64]
208
209         table = SfaTable()
210         node_record = table.find({'type': 'node', 'hrn': hrn})
211         pkey = Keypair(create=True)
212         urn = hrn_to_urn(hrn, 'node')
213         node_gid = self.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
214         node_record = SfaRecord(hrn=hrn, gid=node_gid, type="node", pointer=node['node_id'])
215         node_record['authority'] = get_authority(node_record['hrn'])
216         existing_records = table.find({'hrn': hrn, 'type': 'node', 'pointer': node['node_id']})
217         if not existing_records:
218             table.insert(node_record)
219         else:
220             self.logger.info("Import: %s exists, updating " % hrn)
221             existing_record = existing_records[0]
222             node_record['record_id'] = existing_record['record_id']
223             table.update(node_record)
224
225     
226     def import_site(self, hrn, site):
227         urn = hrn_to_urn(hrn, 'authority')
228         self.logger.info("Import: site %s"%hrn)
229
230         # create the authority
231         if not self.AuthHierarchy.auth_exists(urn):
232             self.AuthHierarchy.create_auth(urn)
233
234         auth_info = self.AuthHierarchy.get_auth_info(urn)
235
236         table = SfaTable()
237         auth_record = SfaRecord(hrn=hrn, gid=auth_info.get_gid_object(), type="authority", pointer=site['site_id'])
238         auth_record['authority'] = get_authority(auth_record['hrn'])
239         existing_records = table.find({'hrn': hrn, 'type': 'authority', 'pointer': site['site_id']})
240         if not existing_records:
241             table.insert(auth_record)
242         else:
243             self.logger.info("Import: %s exists, updating " % hrn)
244             existing_record = existing_records[0]
245             auth_record['record_id'] = existing_record['record_id']
246             table.update(auth_record)
247
248         return hrn
249
250
251     def delete_record(self, hrn, type):
252         # delete the record
253         table = SfaTable()
254         record_list = table.find({'type': type, 'hrn': hrn})
255         for record in record_list:
256             self.logger.info("Import: removing record %s %s" % (type, hrn))
257             table.remove(record)