2 # SFA XML-RPC and SOAP interfaces
14 import sfa.util.sfalogging
15 import sfa.util.xmlrpcprotocol as xmlrpcprotocol
16 from sfa.trust.auth import Auth
17 from sfa.util.config import *
18 from sfa.util.faults import *
19 from sfa.util.debug import *
20 from sfa.trust.rights import *
21 from sfa.trust.credential import *
22 from sfa.trust.certificate import *
23 from sfa.util.namespace import *
24 from sfa.util.api import *
25 from sfa.util.nodemanager import NodeManager
27 from collections import defaultdict
29 class defaultdict(dict):
30 def __init__(self, default_factory=None, *a, **kw):
31 if (default_factory is not None and
32 not hasattr(default_factory, '__call__')):
33 raise TypeError('first argument must be callable')
34 dict.__init__(self, *a, **kw)
35 self.default_factory = default_factory
36 def __getitem__(self, key):
38 return dict.__getitem__(self, key)
40 return self.__missing__(key)
41 def __missing__(self, key):
42 if self.default_factory is None:
44 self[key] = value = self.default_factory()
47 if self.default_factory is None:
50 args = self.default_factory,
51 return type(self), args, None, None, self.items()
53 return self.__copy__()
55 return type(self)(self.default_factory, self)
56 def __deepcopy__(self, memo):
58 return type(self)(self.default_factory,
59 copy.deepcopy(self.items()))
61 return 'defaultdict(%s, %s)' % (self.default_factory,
63 ## end of http://code.activestate.com/recipes/523034/ }}}
65 def list_to_dict(recs, key):
67 convert a list of dictionaries into a dictionary keyed on the
68 specified dictionary key
70 keys = [rec[key] for rec in recs]
71 return dict(zip(keys, recs))
73 class SfaAPI(BaseAPI):
75 # flat list of method names
77 methods = sfa.methods.all
79 def __init__(self, config = "/etc/sfa/sfa_config.py", encoding = "utf-8",
80 methods='sfa.methods', peer_cert = None, interface = None,
81 key_file = None, cert_file = None, cache = None):
82 BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, \
83 peer_cert=peer_cert, interface=interface, key_file=key_file, \
84 cert_file=cert_file, cache=cache)
86 self.encoding = encoding
87 from sfa.util.table import SfaTable
88 self.SfaTable = SfaTable
89 # Better just be documenting the API
94 self.config = Config(config)
95 self.auth = Auth(peer_cert)
96 self.interface = interface
97 self.key_file = key_file
98 self.key = Keypair(filename=self.key_file)
99 self.cert_file = cert_file
100 self.cert = Certificate(filename=self.cert_file)
101 self.credential = None
102 # Initialize the PLC shell only if SFA wraps a myPLC
103 rspec_type = self.config.get_aggregate_type()
104 if (rspec_type == 'pl' or rspec_type == 'vini' or rspec_type == 'eucalyptus'):
105 self.plshell = self.getPLCShell()
106 self.plshell_version = "4.3"
108 self.hrn = self.config.SFA_INTERFACE_HRN
109 self.time_format = "%Y-%m-%d %H:%M:%S"
110 self.logger=sfa.util.sfalogging.logger
112 def getPLCShell(self):
113 self.plauth = {'Username': self.config.SFA_PLC_USER,
114 'AuthMethod': 'password',
115 'AuthString': self.config.SFA_PLC_PASSWORD}
117 sys.path.append(os.path.dirname(os.path.realpath("/usr/bin/plcsh")))
118 self.plshell_type = 'direct'
120 shell = PLC.Shell.Shell(globals = globals())
122 self.plshell_type = 'xmlrpc'
123 url = self.config.SFA_PLC_URL
124 shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
128 def getCredential(self):
130 Retrun a valid credential for this interface.
132 if self.interface in ['registry']:
133 return self.getCredentialFromLocalRegistry()
135 return self.getCredentialFromRegistry()
137 def getDelegatedCredential(self, creds):
139 Attempt to find a credential delegated to us in
140 the specified list of creds.
142 if creds and not isinstance(creds, list):
144 delegated_creds = filter_creds_by_caller(creds,self.hrn)
145 if not delegated_creds:
147 return delegated_creds[0]
149 def getCredentialFromRegistry(self):
151 Get our credential from a remote registry
154 path = self.config.SFA_DATA_DIR
155 filename = ".".join([self.interface, self.hrn, type, "cred"])
156 cred_filename = path + os.sep + filename
158 credential = Credential(filename = cred_filename)
159 return credential.save_to_string(save_parents=True)
161 from sfa.server.registry import Registries
162 registries = Registries(self)
163 registry = registries[self.hrn]
164 cert_string=self.cert.save_to_string(save_parents=True)
165 # get self credential
166 self_cred = registry.get_self_credential(cert_string, type, self.hrn)
168 cred = registry.get_credential(self_cred, type, self.hrn)
171 Credential(string=cred).save_to_file(cred_filename, save_parents=True)
174 def getCredentialFromLocalRegistry(self):
176 Get our current credential directly from the local registry.
180 auth_hrn = self.auth.get_authority(hrn)
182 # is this a root or sub authority
183 if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
185 auth_info = self.auth.get_auth_info(auth_hrn)
186 table = self.SfaTable()
187 records = table.findObjects(hrn)
191 type = record['type']
192 object_gid = record.get_gid_object()
193 new_cred = Credential(subject = object_gid.get_subject())
194 new_cred.set_gid_caller(object_gid)
195 new_cred.set_gid_object(object_gid)
196 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
198 r1 = determine_rights(type, hrn)
199 new_cred.set_privileges(r1)
201 auth_kind = "authority,ma,sa"
203 new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
208 return new_cred.save_to_string(save_parents=True)
211 def loadCredential (self):
213 Attempt to load credential from file if it exists. If it doesnt get
214 credential from registry.
217 # see if this file exists
218 # XX This is really the aggregate's credential. Using this is easier than getting
219 # the registry's credential from iteslf (ssl errors).
220 ma_cred_filename = self.config.SFA_DATA_DIR + os.sep + self.interface + self.hrn + ".ma.cred"
222 self.credential = Credential(filename = ma_cred_filename)
224 self.credential = self.getCredentialFromRegistry()
227 # Convert SFA fields to PLC fields for use when registering up updating
228 # registry record in the PLC database
230 # @param type type of record (user, slice, ...)
231 # @param hrn human readable name
232 # @param sfa_fields dictionary of SFA fields
233 # @param pl_fields dictionary of PLC fields (output)
235 def sfa_fields_to_pl_fields(self, type, hrn, record):
237 def convert_ints(tmpdict, int_fields):
238 for field in int_fields:
240 tmpdict[field] = int(tmpdict[field])
243 #for field in record:
244 # pl_record[field] = record[field]
247 if not "instantiation" in pl_record:
248 pl_record["instantiation"] = "plc-instantiated"
249 pl_record["name"] = hrn_to_pl_slicename(hrn)
251 pl_record["url"] = record["url"]
252 if "description" in record:
253 pl_record["description"] = record["description"]
254 if "expires" in record:
255 pl_record["expires"] = int(record["expires"])
258 if not "hostname" in pl_record:
259 if not "hostname" in record:
260 raise MissingSfaInfo("hostname")
261 pl_record["hostname"] = record["hostname"]
262 if not "model" in pl_record:
263 pl_record["model"] = "geni"
265 elif type == "authority":
266 pl_record["login_base"] = hrn_to_pl_login_base(hrn)
268 if not "name" in pl_record:
269 pl_record["name"] = hrn
271 if not "abbreviated_name" in pl_record:
272 pl_record["abbreviated_name"] = hrn
274 if not "enabled" in pl_record:
275 pl_record["enabled"] = True
277 if not "is_public" in pl_record:
278 pl_record["is_public"] = True
282 def fill_record_pl_info(self, records):
284 Fill in the planetlab specific fields of a SFA record. This
285 involves calling the appropriate PLC method to retrieve the
286 database record for the object.
288 PLC data is filled into the pl_info field of the record.
290 @param record: record to fill in field (in/out param)
293 node_ids, site_ids, slice_ids = [], [], []
294 person_ids, key_ids = [], []
295 type_map = {'node': node_ids, 'authority': site_ids,
296 'slice': slice_ids, 'user': person_ids}
298 for record in records:
299 for type in type_map:
300 if type == record['type']:
301 type_map[type].append(record['pointer'])
304 nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
306 node_list = self.plshell.GetNodes(self.plauth, node_ids)
307 nodes = list_to_dict(node_list, 'node_id')
309 site_list = self.plshell.GetSites(self.plauth, site_ids)
310 sites = list_to_dict(site_list, 'site_id')
312 slice_list = self.plshell.GetSlices(self.plauth, slice_ids)
313 slices = list_to_dict(slice_list, 'slice_id')
315 person_list = self.plshell.GetPersons(self.plauth, person_ids)
316 persons = list_to_dict(person_list, 'person_id')
317 for person in persons:
318 key_ids.extend(persons[person]['key_ids'])
320 pl_records = {'node': nodes, 'authority': sites,
321 'slice': slices, 'user': persons}
324 key_list = self.plshell.GetKeys(self.plauth, key_ids)
325 keys = list_to_dict(key_list, 'key_id')
328 for record in records:
329 # records with pointer==-1 do not have plc info.
330 # for example, the top level authority records which are
331 # authorities, but not PL "sites"
332 if record['pointer'] == -1:
335 for type in pl_records:
336 if record['type'] == type:
337 if record['pointer'] in pl_records[type]:
338 record.update(pl_records[type][record['pointer']])
341 if record['type'] == 'user':
342 pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys]
343 record['keys'] = pubkeys
345 # fill in record hrns
346 records = self.fill_record_hrns(records)
350 def fill_record_hrns(self, records):
352 convert pl ids to hrns
356 slice_ids, person_ids, site_ids, node_ids = [], [], [], []
357 for record in records:
358 if 'site_id' in record:
359 site_ids.append(record['site_id'])
360 if 'site_ids' in records:
361 site_ids.extend(record['site_ids'])
362 if 'person_ids' in record:
363 person_ids.extend(record['person_ids'])
364 if 'slice_ids' in record:
365 slice_ids.extend(record['slice_ids'])
366 if 'node_ids' in record:
367 node_ids.extend(record['node_ids'])
370 slices, persons, sites, nodes = {}, {}, {}, {}
372 site_list = self.plshell.GetSites(self.plauth, site_ids, ['site_id', 'login_base'])
373 sites = list_to_dict(site_list, 'site_id')
375 person_list = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'email'])
376 persons = list_to_dict(person_list, 'person_id')
378 slice_list = self.plshell.GetSlices(self.plauth, slice_ids, ['slice_id', 'name'])
379 slices = list_to_dict(slice_list, 'slice_id')
381 node_list = self.plshell.GetNodes(self.plauth, node_ids, ['node_id', 'hostname'])
382 nodes = list_to_dict(node_list, 'node_id')
384 # convert ids to hrns
385 for record in records:
387 # get all relevant data
388 type = record['type']
389 pointer = record['pointer']
395 if 'site_id' in record:
396 site = sites[record['site_id']]
397 login_base = site['login_base']
398 record['site'] = ".".join([auth_hrn, login_base])
399 if 'person_ids' in record:
400 emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
401 if person_id in persons]
402 usernames = [email.split('@')[0] for email in emails]
403 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
404 record['persons'] = person_hrns
405 if 'slice_ids' in record:
406 slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
407 if slice_id in slices]
408 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
409 record['slices'] = slice_hrns
410 if 'node_ids' in record:
411 hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
413 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
414 record['nodes'] = node_hrns
415 if 'site_ids' in record:
416 login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
418 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
419 record['sites'] = site_hrns
423 def fill_record_sfa_info(self, records):
425 def startswith(prefix, values):
426 return [value for value in values if value.startswith(prefix)]
431 for record in records:
432 person_ids.extend(record.get("person_ids", []))
433 site_ids.extend(record.get("site_ids", []))
434 if 'site_id' in record:
435 site_ids.append(record['site_id'])
437 # get all pis from the sites we've encountered
438 # and store them in a dictionary keyed on site_id
441 pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
442 pi_list = self.plshell.GetPersons(self.plauth, pi_filter, ['person_id', 'site_ids'])
444 # we will need the pi's hrns also
445 person_ids.append(pi['person_id'])
447 # we also need to keep track of the sites these pis
449 for site_id in pi['site_ids']:
450 if site_id in site_pis:
451 site_pis[site_id].append(pi)
453 site_pis[site_id] = [pi]
455 # get sfa records for all records associated with these records.
456 # we'll replace pl ids (person_ids) with hrns from the sfa records
459 # get the sfa records
460 table = self.SfaTable()
461 person_list, persons = [], {}
462 person_list = table.find({'type': 'user', 'pointer': person_ids})
463 # create a hrns keyed on the sfa record's pointer.
464 # Its possible for multiple records to have the same pointer so
465 # the dict's value will be a list of hrns.
466 persons = defaultdict(list)
467 for person in person_list:
468 persons[person['pointer']].append(person)
471 pl_person_list, pl_persons = [], {}
472 pl_person_list = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'roles'])
473 pl_persons = list_to_dict(pl_person_list, 'person_id')
476 for record in records:
477 # skip records with no pl info (top level authorities)
478 if record['pointer'] == -1:
481 type = record['type']
482 if (type == "slice"):
483 # all slice users are researchers
485 record['researcher'] = []
486 for person_id in record['person_ids']:
487 hrns = [person['hrn'] for person in persons[person_id]]
488 record['researcher'].extend(hrns)
490 # pis at the slice's site
491 pl_pis = site_pis[record['site_id']]
492 pi_ids = [pi['person_id'] for pi in pl_pis]
493 for person_id in pi_ids:
494 hrns = [person['hrn'] for person in persons[person_id]]
495 record['PI'].extend(hrns)
496 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
497 record['geni_creator'] = record['PI']
499 elif (type == "authority"):
501 record['operator'] = []
503 for pointer in record['person_ids']:
504 if pointer not in persons or pointer not in pl_persons:
505 # this means there is not sfa or pl record for this user
507 hrns = [person['hrn'] for person in persons[pointer]]
508 roles = pl_persons[pointer]['roles']
510 record['PI'].extend(hrns)
512 record['operator'].extend(hrns)
514 record['owner'].extend(hrns)
515 # xxx TODO: OrganizationName
516 elif (type == "node"):
517 sfa_info['dns'] = record.get("hostname", "")
518 # xxx TODO: URI, LatLong, IP, DNS
520 elif (type == "user"):
521 sfa_info['email'] = record.get("email", "")
522 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
523 sfa_info['geni_certificate'] = record['gid']
524 # xxx TODO: PostalAddress, Phone
525 record.update(sfa_info)
527 def fill_record_info(self, records):
529 Given a SFA record, fill in the PLC specific and SFA specific
530 fields in the record.
532 if not isinstance(records, list):
535 self.fill_record_pl_info(records)
536 self.fill_record_sfa_info(records)
538 def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
539 # get a list of the HRNs tht are members of the old and new records
541 oldList = oldRecord.get(listName, [])
544 newList = record.get(listName, [])
546 # if the lists are the same, then we don't have to update anything
547 if (oldList == newList):
550 # build a list of the new person ids, by looking up each person to get
553 table = self.SfaTable()
554 records = table.find({'type': 'user', 'hrn': newList})
556 newIdList.append(rec['pointer'])
558 # build a list of the old person ids from the person_ids field
560 oldIdList = oldRecord.get("person_ids", [])
561 containerId = oldRecord.get_pointer()
563 # if oldRecord==None, then we are doing a Register, instead of an
566 containerId = record.get_pointer()
568 # add people who are in the new list, but not the oldList
569 for personId in newIdList:
570 if not (personId in oldIdList):
571 addFunc(self.plauth, personId, containerId)
573 # remove people who are in the old list, but not the new list
574 for personId in oldIdList:
575 if not (personId in newIdList):
576 delFunc(self.plauth, personId, containerId)
578 def update_membership(self, oldRecord, record):
579 if record.type == "slice":
580 self.update_membership_list(oldRecord, record, 'researcher',
581 self.plshell.AddPersonToSlice,
582 self.plshell.DeletePersonFromSlice)
583 elif record.type == "authority":
589 class ComponentAPI(BaseAPI):
591 def __init__(self, config = "/etc/sfa/sfa_config.py", encoding = "utf-8", methods='sfa.methods',
592 peer_cert = None, interface = None, key_file = None, cert_file = None):
594 BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, peer_cert=peer_cert,
595 interface=interface, key_file=key_file, cert_file=cert_file)
596 self.encoding = encoding
598 # Better just be documenting the API
602 self.nodemanager = NodeManager(self.config)
604 def sliver_exists(self):
605 sliver_dict = self.nodemanager.GetXIDs()
606 if slicename in sliver_dict.keys():
611 def get_registry(self):
612 addr, port = self.config.SFA_REGISTRY_HOST, self.config.SFA_REGISTRY_PORT
613 url = "http://%(addr)s:%(port)s" % locals()
614 server = xmlrpcprotocol.get_server(url, self.key_file, self.cert_file)
617 def get_node_key(self):
618 # this call requires no authentication,
619 # so we can generate a random keypair here
621 (kfd, keyfile) = tempfile.mkstemp()
622 (cfd, certfile) = tempfile.mkstemp()
623 key = Keypair(create=True)
624 key.save_to_file(keyfile)
625 cert = Certificate(subject=subject)
626 cert.set_issuer(key=key, subject=subject)
629 cert.save_to_file(certfile)
630 registry = self.get_registry()
631 # the registry will scp the key onto the node
634 def getCredential(self):
636 Get our credential from a remote registry
638 path = self.config.SFA_DATA_DIR
639 config_dir = self.config.config_path
640 cred_filename = path + os.sep + 'node.cred'
642 credential = Credential(filename = cred_filename)
643 return credential.save_to_string(save_parents=True)
645 node_pkey_file = config_dir + os.sep + "node.key"
646 node_gid_file = config_dir + os.sep + "node.gid"
647 cert_filename = path + os.sep + 'server.cert'
648 if not os.path.exists(node_pkey_file) or \
649 not os.path.exists(node_gid_file):
653 gid = GID(filename=node_gid_file)
655 # get credential from registry
656 cert_str = Certificate(filename=cert_filename).save_to_string(save_parents=True)
657 registry = self.get_registry()
658 cred = registry.get_self_credential(cert_str, 'node', hrn)
659 Credential(string=cred).save_to_file(credfile, save_parents=True)
663 def clean_key_cred(self):
665 remove the existing keypair and cred and generate new ones
667 files = ["server.key", "server.cert", "node.cred"]
669 filepath = KEYDIR + os.sep + f
670 if os.path.isfile(filepath):
673 # install the new key pair
674 # get_credential will take care of generating the new keypair