sfa/server/sfaapi.py

   1 import os, os.path
   2 import datetime
   3
   4 from sfa.util.faults import SfaAPIError
   5 from sfa.util.config import Config
   6 from sfa.util.cache import Cache
   7 from sfa.trust.auth import Auth
   8 from sfa.trust.certificate import Keypair, Certificate
   9 from sfa.trust.credential import Credential
  10 from sfa.trust.rights import determine_rights
  11 from sfa.server.xmlrpcapi import XmlrpcApi
  12 from sfa.util.genicode import GENICODE
  13
  14 # thgen xxx fixme this is wrong all right, but temporary, will use generic
  15 from sfa.util.table import SfaTable
  16
  17 ####################
  18 class SfaApi (XmlrpcApi):
  19
  20     """
  21     An SfaApi instance is a basic xmlrcp service
  22     augmented with the local cryptographic material and hrn
  23
  24     It also has the notion of its own interface (a string describing
  25     whether we run a registry, aggregate or slicemgr) and has
  26     the notion of neighbour sfa services as defined
  27     in /etc/sfa/{aggregates,registries}.xml
  28
  29     Finally it contains a cache instance
  30
  31     It gets augmented by the generic layer with
  32     (*) an instance of manager (actually a manager module for now)
  33     (*) which in turn holds an instance of a testbed driver
  34     For convenience api.manager.driver == api.driver
  35     """
  36
  37     def __init__ (self, encoding="utf-8", methods='sfa.methods',
  38                   config = "/etc/sfa/sfa_config.py",
  39                   peer_cert = None, interface = None,
  40                   key_file = None, cert_file = None, cache = None):
  41
  42         XmlrpcApi.__init__ (self, encoding)
  43
  44         # we may be just be documenting the API
  45         if config is None:
  46             return
  47         # Load configuration
  48         self.config = Config(config)
  49         self.credential = None
  50         self.auth = Auth(peer_cert)
  51         self.interface = interface
  52         self.hrn = self.config.SFA_INTERFACE_HRN
  53         self.key_file = key_file
  54         self.key = Keypair(filename=self.key_file)
  55         self.cert_file = cert_file
  56         self.cert = Certificate(filename=self.cert_file)
  57         self.cache = cache
  58         if self.cache is None:
  59             self.cache = Cache()
  60
  61         # load registries
  62         from sfa.server.registry import Registries
  63         self.registries = Registries()
  64
  65         # load aggregates
  66         from sfa.server.aggregate import Aggregates
  67         self.aggregates = Aggregates()
  68
  69         # filled later on by generic/Generic
  70         self.manager=None
  71
  72     def server_proxy(self, interface, cred, timeout=30):
  73         """
  74         Returns a connection to the specified interface. Use the specified
  75         credential to determine the caller and look for the caller's key/cert
  76         in the registry hierarchy cache.
  77         """
  78         from sfa.trust.hierarchy import Hierarchy
  79         if not isinstance(cred, Credential):
  80             cred_obj = Credential(string=cred)
  81         else:
  82             cred_obj = cred
  83         caller_gid = cred_obj.get_gid_caller()
  84         hierarchy = Hierarchy()
  85         auth_info = hierarchy.get_auth_info(caller_gid.get_hrn())
  86         key_file = auth_info.get_privkey_filename()
  87         cert_file = auth_info.get_gid_filename()
  88         server = interface.server_proxy(key_file, cert_file, timeout)
  89         return server
  90
  91
  92     def getCredential(self):
  93         """
  94         Return a valid credential for this interface.
  95         """
  96         type = 'authority'
  97         path = self.config.SFA_DATA_DIR
  98         filename = ".".join([self.interface, self.hrn, type, "cred"])
  99         cred_filename = os.path.join(path,filename)
 100         cred = None
 101         if os.path.isfile(cred_filename):
 102             cred = Credential(filename = cred_filename)
 103             # make sure cred isnt expired
 104             if not cred.get_expiration or \
 105                datetime.datetime.utcnow() < cred.get_expiration():
 106                 return cred.save_to_string(save_parents=True)
 107
 108         # get a new credential
 109         if self.interface in ['registry']:
 110             cred =  self.__getCredentialRaw()
 111         else:
 112             cred =  self.__getCredential()
 113         cred.save_to_file(cred_filename, save_parents=True)
 114
 115         return cred.save_to_string(save_parents=True)
 116
 117
 118     def getDelegatedCredential(self, creds):
 119         """
 120         Attempt to find a credential delegated to us in
 121         the specified list of creds.
 122         """
 123         from sfa.trust.hierarchy import Hierarchy
 124         if creds and not isinstance(creds, list):
 125             creds = [creds]
 126         hierarchy = Hierarchy()
 127
 128         delegated_cred = None
 129         for cred in creds:
 130             if hierarchy.auth_exists(Credential(string=cred).get_gid_caller().get_hrn()):
 131                 delegated_cred = cred
 132                 break
 133         return delegated_cred
 134
 135     def __getCredential(self):
 136         """
 137         Get our credential from a remote registry
 138         """
 139         from sfa.server.registry import Registries
 140         registries = Registries()
 141         registry = registries.server_proxy(self.hrn, self.key_file, self.cert_file)
 142         cert_string=self.cert.save_to_string(save_parents=True)
 143         # get self credential
 144         self_cred = registry.GetSelfCredential(cert_string, self.hrn, 'authority')
 145         # get credential
 146         cred = registry.GetCredential(self_cred, self.hrn, 'authority')
 147         return Credential(string=cred)
 148
 149     def __getCredentialRaw(self):
 150         """
 151         Get our current credential directly from the local registry.
 152         """
 153
 154         hrn = self.hrn
 155         auth_hrn = self.auth.get_authority(hrn)
 156
 157         # is this a root or sub authority
 158         if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
 159             auth_hrn = hrn
 160         auth_info = self.auth.get_auth_info(auth_hrn)
 161         # xxx thgen fixme - use SfaTable hardwired for now
 162         #table = self.SfaTable()
 163         table = SfaTable()
 164         records = table.findObjects({'hrn': hrn, 'type': 'authority+sa'})
 165         if not records:
 166             raise RecordNotFound
 167         record = records[0]
 168         type = record['type']
 169         object_gid = record.get_gid_object()
 170         new_cred = Credential(subject = object_gid.get_subject())
 171         new_cred.set_gid_caller(object_gid)
 172         new_cred.set_gid_object(object_gid)
 173         new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
 174
 175         r1 = determine_rights(type, hrn)
 176         new_cred.set_privileges(r1)
 177         new_cred.encode()
 178         new_cred.sign()
 179
 180         return new_cred
 181
 182     def loadCredential (self):
 183         """
 184         Attempt to load credential from file if it exists. If it doesnt get
 185         credential from registry.
 186         """
 187
 188         # see if this file exists
 189         # XX This is really the aggregate's credential. Using this is easier than getting
 190         # the registry's credential from iteslf (ssl errors).
 191         filename = self.interface + self.hrn + ".ma.cred"
 192         ma_cred_path = os.path.join(self.config.SFA_DATA_DIR,filename)
 193         try:
 194             self.credential = Credential(filename = ma_cred_path)
 195         except IOError:
 196             self.credential = self.getCredentialFromRegistry()
 197
 198     def get_cached_server_version(self, server):
 199         cache_key = server.url + "-version"
 200         server_version = None
 201         if self.cache:
 202             server_version = self.cache.get(cache_key)
 203         if not server_version:
 204             server_version = server.GetVersion()
 205             # cache version for 24 hours
 206             self.cache.add(cache_key, server_version, ttl= 60*60*24)
 207         return server_version
 208
 209
 210     def get_geni_code(self, result):
 211         code = {
 212             'geni_code': GENICODE.SUCCESS,
 213             'am_type': 'sfa',
 214             'am_code': None,
 215         }
 216         if isinstnace(result, SfaFault):
 217             code['geni_code'] = result.faultCode
 218             code['am_code'] = result.faultCode
 219
 220         return code
 221
 222     def get_geni_value(self, result):
 223         value = result
 224         if isinstance(result, SfaFault):
 225             value = ""
 226         return value
 227
 228     def get_geni_output(self, result):
 229         output = ""
 230         if isinstance(result, SFaFault):
 231             output = result.faultString
 232         return output
 233
 234     def prepare_response_v2_am(self, result):
 235         response = {
 236             'code': self.get_geni_code(result),
 237             'value': self.get_geni_value(result),
 238             'output': self.get_geni_output(result),
 239         }
 240         return response
 241
 242     def prepare_response(self, result, method=""):
 243         """
 244         Converts the specified result into a standard GENI compliant
 245         response
 246         """
 247         if self.interface.lower() == 'aggregate':
 248             if hasattr(self.config, 'SFA_AM_API_VERSION') and \
 249               self.config.SFA_AM_API_VERSION == "2":
 250                 result = self.prepare_response_v2_am(result)
 251         return XmlrpcApi.prepare_response(result, method)
 252