4 from sfa.util.faults import SfaFault, SfaAPIError
5 from sfa.util.genicode import GENICODE
6 from sfa.util.config import Config
7 from sfa.util.cache import Cache
8 from sfa.trust.auth import Auth
10 from sfa.trust.certificate import Keypair, Certificate
11 from sfa.trust.credential import Credential
12 from sfa.trust.rights import determine_rights
14 from sfa.server.xmlrpcapi import XmlrpcApi
16 from sfa.client.return_value import ReturnValue
18 # thgen xxx fixme this is wrong all right, but temporary, will use generic
19 from sfa.storage.table import SfaTable
22 class SfaApi (XmlrpcApi):
25 An SfaApi instance is a basic xmlrcp service
26 augmented with the local cryptographic material and hrn
28 It also has the notion of its own interface (a string describing
29 whether we run a registry, aggregate or slicemgr) and has
30 the notion of neighbour sfa services as defined
31 in /etc/sfa/{aggregates,registries}.xml
33 Finally it contains a cache instance
35 It gets augmented by the generic layer with
36 (*) an instance of manager (actually a manager module for now)
37 (*) which in turn holds an instance of a testbed driver
38 For convenience api.manager.driver == api.driver
41 def __init__ (self, encoding="utf-8", methods='sfa.methods',
42 config = "/etc/sfa/sfa_config.py",
43 peer_cert = None, interface = None,
44 key_file = None, cert_file = None, cache = None):
46 XmlrpcApi.__init__ (self, encoding)
48 # we may be just be documenting the API
52 self.config = Config(config)
53 self.credential = None
54 self.auth = Auth(peer_cert)
55 self.interface = interface
56 self.hrn = self.config.SFA_INTERFACE_HRN
57 self.key_file = key_file
58 self.key = Keypair(filename=self.key_file)
59 self.cert_file = cert_file
60 self.cert = Certificate(filename=self.cert_file)
62 if self.cache is None:
66 from sfa.server.registry import Registries
67 self.registries = Registries()
70 from sfa.server.aggregate import Aggregates
71 self.aggregates = Aggregates()
73 # filled later on by generic/Generic
76 def server_proxy(self, interface, cred, timeout=30):
78 Returns a connection to the specified interface. Use the specified
79 credential to determine the caller and look for the caller's key/cert
80 in the registry hierarchy cache.
82 from sfa.trust.hierarchy import Hierarchy
83 if not isinstance(cred, Credential):
84 cred_obj = Credential(string=cred)
87 caller_gid = cred_obj.get_gid_caller()
88 hierarchy = Hierarchy()
89 auth_info = hierarchy.get_auth_info(caller_gid.get_hrn())
90 key_file = auth_info.get_privkey_filename()
91 cert_file = auth_info.get_gid_filename()
92 server = interface.server_proxy(key_file, cert_file, timeout)
96 def getCredential(self):
98 Return a valid credential for this interface.
101 path = self.config.SFA_DATA_DIR
102 filename = ".".join([self.interface, self.hrn, type, "cred"])
103 cred_filename = os.path.join(path,filename)
105 if os.path.isfile(cred_filename):
106 cred = Credential(filename = cred_filename)
107 # make sure cred isnt expired
108 if not cred.get_expiration or \
109 datetime.datetime.utcnow() < cred.get_expiration():
110 return cred.save_to_string(save_parents=True)
112 # get a new credential
113 if self.interface in ['registry']:
114 cred = self.__getCredentialRaw()
116 cred = self.__getCredential()
117 cred.save_to_file(cred_filename, save_parents=True)
119 return cred.save_to_string(save_parents=True)
122 def getDelegatedCredential(self, creds):
124 Attempt to find a credential delegated to us in
125 the specified list of creds.
127 from sfa.trust.hierarchy import Hierarchy
128 if creds and not isinstance(creds, list):
130 hierarchy = Hierarchy()
132 delegated_cred = None
134 if hierarchy.auth_exists(Credential(string=cred).get_gid_caller().get_hrn()):
135 delegated_cred = cred
137 return delegated_cred
139 def __getCredential(self):
141 Get our credential from a remote registry
143 from sfa.server.registry import Registries
144 registries = Registries()
145 registry = registries.server_proxy(self.hrn, self.key_file, self.cert_file)
146 cert_string=self.cert.save_to_string(save_parents=True)
147 # get self credential
148 self_cred = registry.GetSelfCredential(cert_string, self.hrn, 'authority')
150 cred = registry.GetCredential(self_cred, self.hrn, 'authority')
151 return Credential(string=cred)
153 def __getCredentialRaw(self):
155 Get our current credential directly from the local registry.
159 auth_hrn = self.auth.get_authority(hrn)
161 # is this a root or sub authority
162 if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
164 auth_info = self.auth.get_auth_info(auth_hrn)
165 # xxx thgen fixme - use SfaTable hardwired for now
166 #table = self.SfaTable()
168 records = table.findObjects({'hrn': hrn, 'type': 'authority+sa'})
172 type = record['type']
173 object_gid = record.get_gid_object()
174 new_cred = Credential(subject = object_gid.get_subject())
175 new_cred.set_gid_caller(object_gid)
176 new_cred.set_gid_object(object_gid)
177 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
179 r1 = determine_rights(type, hrn)
180 new_cred.set_privileges(r1)
186 def loadCredential (self):
188 Attempt to load credential from file if it exists. If it doesnt get
189 credential from registry.
192 # see if this file exists
193 # XX This is really the aggregate's credential. Using this is easier than getting
194 # the registry's credential from iteslf (ssl errors).
195 filename = self.interface + self.hrn + ".ma.cred"
196 ma_cred_path = os.path.join(self.config.SFA_DATA_DIR,filename)
198 self.credential = Credential(filename = ma_cred_path)
200 self.credential = self.getCredentialFromRegistry()
202 def get_cached_server_version(self, server):
203 cache_key = server.url + "-version"
204 server_version = None
206 server_version = self.cache.get(cache_key)
207 if not server_version:
208 result = server.GetVersion()
209 server_version = ReturnValue.get_value(result)
210 # cache version for 24 hours
211 self.cache.add(cache_key, server_version, ttl= 60*60*24)
212 return server_version
215 def get_geni_code(self, result):
217 'geni_code': GENICODE.SUCCESS,
221 if isinstance(result, SfaFault):
222 code['geni_code'] = result.faultCode
223 code['am_code'] = result.faultCode
227 def get_geni_value(self, result):
229 if isinstance(result, SfaFault):
233 def get_geni_output(self, result):
235 if isinstance(result, SfaFault):
236 output = result.faultString
239 def prepare_response_v2_am(self, result):
241 'code': self.get_geni_code(result),
242 'value': self.get_geni_value(result),
243 'output': self.get_geni_output(result),
247 def prepare_response(self, result, method=""):
249 Converts the specified result into a standard GENI compliant
252 # as of dec 13 2011 we only support API v2
253 if self.interface.lower() in ['aggregate', 'slicemgr']:
254 result = self.prepare_response_v2_am(result)
255 return XmlrpcApi.prepare_response(self, result, method)