2 # SFA XML-RPC and SOAP interfaces
13 from sfa.trust.auth import Auth
14 from sfa.util.config import *
15 from sfa.util.faults import *
16 from sfa.util.debug import *
17 from sfa.trust.rights import *
18 from sfa.trust.credential import *
19 from sfa.trust.certificate import *
20 from sfa.util.namespace import *
21 from sfa.util.api import *
22 from sfa.util.nodemanager import NodeManager
23 from sfa.util.sfalogging import *
24 from sfa.util.table import SfaTable
26 class SfaAPI(BaseAPI):
28 # flat list of method names
30 methods = sfa.methods.all
32 def __init__(self, config = "/etc/sfa/sfa_config", encoding = "utf-8", methods='sfa.methods',
33 peer_cert = None, interface = None, key_file = None, cert_file = None):
34 BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, peer_cert=peer_cert,
35 interface=interface, key_file=key_file, cert_file=cert_file)
37 self.encoding = encoding
39 # Better just be documenting the API
44 self.config = Config(config)
45 self.auth = Auth(peer_cert)
46 self.interface = interface
47 self.key_file = key_file
48 self.key = Keypair(filename=self.key_file)
49 self.cert_file = cert_file
50 self.cert = Certificate(filename=self.cert_file)
51 self.credential = None
53 # Initialize the PLC shell only if SFA wraps a myPLC
54 rspec_type = self.config.get_aggregate_rspec_type()
55 if (rspec_type == 'pl' or rspec_type == 'vini'):
56 self.plshell = self.getPLCShell()
57 self.plshell_version = self.getPLCShellVersion()
59 self.hrn = self.config.SFA_INTERFACE_HRN
60 self.time_format = "%Y-%m-%d %H:%M:%S"
61 self.logger=get_sfa_logger()
63 def getPLCShell(self):
64 self.plauth = {'Username': self.config.SFA_PLC_USER,
65 'AuthMethod': 'password',
66 'AuthString': self.config.SFA_PLC_PASSWORD}
68 self.plshell_type = 'direct'
70 shell = PLC.Shell.Shell(globals = globals())
71 shell.AuthCheck(self.plauth)
74 self.plshell_type = 'xmlrpc'
76 url = self.config.SFA_PLC_URL
77 shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
78 shell.AuthCheck(self.plauth)
81 def getPLCShellVersion(self):
82 # We need to figure out what version of PLCAPI we are talking to.
83 # Some calls we need to make later will be different depending on
86 # This is probably a bad way to determine api versions
87 # but its easy and will work for now. Lets try to make
88 # a call that only exists is PLCAPI.4.3. If it fails, we
89 # can assume the api version is 4.2
90 self.plshell.GetTagTypes(self.plauth)
96 def getCredential(self):
97 if self.interface in ['registry']:
98 return self.getCredentialFromLocalRegistry()
100 return self.getCredentialFromRegistry()
102 def getCredentialFromRegistry(self):
104 Get our credential from a remote registry
107 path = self.config.SFA_DATA_DIR
108 filename = ".".join([self.interface, self.hrn, type, "cred"])
109 cred_filename = path + os.sep + filename
111 credential = Credential(filename = cred_filename)
112 return credential.save_to_string(save_parents=True)
114 from sfa.server.registry import Registries
115 registries = Registries(self)
116 registry = registries[self.hrn]
117 cert_string=self.cert.save_to_string(save_parents=True)
118 # get self credential
119 self_cred = registry.get_self_credential(cert_string, type, self.hrn)
121 cred = registry.get_credential(self_cred, type, self.hrn)
124 Credential(string=cred).save_to_file(cred_filename, save_parents=True)
127 def getCredentialFromLocalRegistry(self):
129 Get our current credential directly from the local registry.
133 auth_hrn = self.auth.get_authority(hrn)
135 # is this a root or sub authority
136 if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
138 auth_info = self.auth.get_auth_info(auth_hrn)
140 records = table.findObjects(hrn)
144 type = record['type']
145 object_gid = record.get_gid_object()
146 new_cred = Credential(subject = object_gid.get_subject())
147 new_cred.set_gid_caller(object_gid)
148 new_cred.set_gid_object(object_gid)
149 new_cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
150 new_cred.set_pubkey(object_gid.get_pubkey())
151 r1 = determine_rights(type, hrn)
152 new_cred.set_privileges(r1)
154 auth_kind = "authority,ma,sa"
156 new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
161 return new_cred.save_to_string(save_parents=True)
164 def loadCredential (self):
166 Attempt to load credential from file if it exists. If it doesnt get
167 credential from registry.
170 # see if this file exists
171 # XX This is really the aggregate's credential. Using this is easier than getting
172 # the registry's credential from iteslf (ssl errors).
173 ma_cred_filename = self.config.SFA_DATA_DIR + os.sep + self.interface + self.hrn + ".ma.cred"
175 self.credential = Credential(filename = ma_cred_filename)
177 self.credential = self.getCredentialFromRegistry()
180 # Convert SFA fields to PLC fields for use when registering up updating
181 # registry record in the PLC database
183 # @param type type of record (user, slice, ...)
184 # @param hrn human readable name
185 # @param sfa_fields dictionary of SFA fields
186 # @param pl_fields dictionary of PLC fields (output)
188 def sfa_fields_to_pl_fields(self, type, hrn, record):
190 def convert_ints(tmpdict, int_fields):
191 for field in int_fields:
193 tmpdict[field] = int(tmpdict[field])
196 #for field in record:
197 # pl_record[field] = record[field]
200 if not "instantiation" in pl_record:
201 pl_record["instantiation"] = "plc-instantiated"
202 pl_record["name"] = hrn_to_pl_slicename(hrn)
204 pl_record["url"] = record["url"]
205 if "description" in record:
206 pl_record["description"] = record["description"]
207 if "expires" in record:
208 pl_record["expires"] = int(record["expires"])
211 if not "hostname" in pl_record:
212 if not "hostname" in record:
213 raise MissingSfaInfo("hostname")
214 pl_record["hostname"] = record["hostname"]
215 if not "model" in pl_record:
216 pl_record["model"] = "geni"
218 elif type == "authority":
219 pl_record["login_base"] = hrn_to_pl_login_base(hrn)
221 if not "name" in pl_record:
222 pl_record["name"] = hrn
224 if not "abbreviated_name" in pl_record:
225 pl_record["abbreviated_name"] = hrn
227 if not "enabled" in pl_record:
228 pl_record["enabled"] = True
230 if not "is_public" in pl_record:
231 pl_record["is_public"] = True
235 def fill_record_pl_info(self, record):
237 Fill in the planetlab specific fields of a SFA record. This
238 involves calling the appropriate PLC method to retrieve the
239 database record for the object.
241 PLC data is filled into the pl_info field of the record.
243 @param record: record to fill in field (in/out param)
245 type = record['type']
246 pointer = record['pointer']
249 # records with pointer==-1 do not have plc info associated with them.
250 # for example, the top level authority records which are
251 # authorities, but not PL "sites"
256 if (type in ["authority"]):
257 pl_res = self.plshell.GetSites(self.plauth, [pointer])
258 elif (type == "slice"):
259 pl_res = self.plshell.GetSlices(self.plauth, [pointer])
260 elif (type == "user"):
261 pl_res = self.plshell.GetPersons(self.plauth, [pointer])
262 elif (type == "node"):
263 pl_res = self.plshell.GetNodes(self.plauth, [pointer])
265 raise UnknownSfaType(type)
268 raise PlanetLabRecordDoesNotExist(record['hrn'])
270 # convert ids to hrns
271 pl_record = pl_res[0]
272 if 'site_id' in pl_record:
273 sites = self.plshell.GetSites(self.plauth, pl_record['site_id'], ['login_base'])
275 login_base = site['login_base']
276 pl_record['site'] = ".".join([auth_hrn, login_base])
277 if 'person_ids' in pl_record:
278 persons = self.plshell.GetPersons(self.plauth, pl_record['person_ids'], ['email'])
279 emails = [person['email'] for person in persons]
280 usernames = [email.split('@')[0] for email in emails]
281 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
282 pl_record['persons'] = person_hrns
283 if 'slice_ids' in pl_record:
284 slices = self.plshell.GetSlices(self.plauth, pl_record['slice_ids'], ['name'])
285 slicenames = [slice['name'] for slice in slices]
286 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
287 pl_record['slices'] = slice_hrns
288 if 'node_ids' in pl_record:
289 nodes = self.plshell.GetNodes(self.plauth, pl_record['node_ids'], ['hostname'])
290 hostnames = [node['hostname'] for node in nodes]
291 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
292 pl_record['nodes'] = node_hrns
293 if 'site_ids' in pl_record:
294 sites = self.plshell.GetSites(self.plauth, pl_record['site_ids'], ['login_base'])
295 login_bases = [site['login_base'] for site in sites]
296 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
297 pl_record['sites'] = site_hrns
298 if 'key_ids' in pl_record:
299 keys = self.plshell.GetKeys(self.plauth, pl_record['key_ids'])
302 pubkeys = [key['key'] for key in keys]
303 pl_record['keys'] = pubkeys
305 record.update(pl_record)
309 def fill_record_sfa_info(self, record):
311 type = record['type']
313 if (type == "slice"):
314 person_ids = record.get("person_ids", [])
315 persons = table.find({'type': 'user', 'pointer': person_ids})
316 researchers = [person['hrn'] for person in persons]
317 sfa_info['researcher'] = researchers
319 elif (type == "authority"):
320 person_ids = record.get("person_ids", [])
321 persons = table.find({'type': 'user', 'pointer': person_ids})
323 for person in persons:
324 persons_dict[person['pointer']] = person
325 pl_persons = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'roles'])
326 pis, techs, admins = [], [], []
327 for person in pl_persons:
328 pointer = person['person_id']
330 if pointer not in persons_dict:
331 # this means there is not sfa record for this user
333 hrn = persons_dict[pointer]['hrn']
334 if 'pi' in person['roles']:
336 if 'tech' in person['roles']:
338 if 'admin' in person['roles']:
342 sfa_info['operator'] = techs
343 sfa_info['owner'] = admins
344 # xxx TODO: OrganizationName
346 elif (type == "node"):
347 sfa_info['dns'] = record.get("hostname", "")
348 # xxx TODO: URI, LatLong, IP, DNS
350 elif (type == "user"):
351 sfa_info['email'] = record.get("email", "")
352 # xxx TODO: PostalAddress, Phone
354 record.update(sfa_info)
356 def fill_record_info(self, record):
358 Given a SFA record, fill in the PLC specific and SFA specific
359 fields in the record.
361 self.fill_record_pl_info(record)
362 self.fill_record_sfa_info(record)
364 def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
365 # get a list of the HRNs tht are members of the old and new records
367 oldList = oldRecord.get(listName, [])
370 newList = record.get(listName, [])
372 # if the lists are the same, then we don't have to update anything
373 if (oldList == newList):
376 # build a list of the new person ids, by looking up each person to get
380 records = table.find({'type': 'user', 'hrn': newList})
382 newIdList.append(rec['pointer'])
384 # build a list of the old person ids from the person_ids field
386 oldIdList = oldRecord.get("person_ids", [])
387 containerId = oldRecord.get_pointer()
389 # if oldRecord==None, then we are doing a Register, instead of an
392 containerId = record.get_pointer()
394 # add people who are in the new list, but not the oldList
395 for personId in newIdList:
396 if not (personId in oldIdList):
397 addFunc(self.plauth, personId, containerId)
399 # remove people who are in the old list, but not the new list
400 for personId in oldIdList:
401 if not (personId in newIdList):
402 delFunc(self.plauth, personId, containerId)
404 def update_membership(self, oldRecord, record):
405 if record.type == "slice":
406 self.update_membership_list(oldRecord, record, 'researcher',
407 self.plshell.AddPersonToSlice,
408 self.plshell.DeletePersonFromSlice)
409 elif record.type == "authority":
415 class ComponentAPI(BaseAPI):
417 def __init__(self, config = "/etc/sfa/sfa_config", encoding = "utf-8", methods='sfa.methods',
418 peer_cert = None, interface = None, key_file = None, cert_file = None):
420 BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, peer_cert=peer_cert,
421 interface=interface, key_file=key_file, cert_file=cert_file)
422 self.encoding = encoding
424 # Better just be documenting the API
428 self.nodemanager = NodeManager(config)
430 def sliver_exists(self):
431 sliver_dict = self.nodemanager.GetXIDs()
432 if slicename in sliver_dict.keys():