sfa/trust/credential_factory.py

   1 #----------------------------------------------------------------------
   2 # Copyright (c) 2014 Raytheon BBN Technologies
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and/or hardware specification (the "Work") to
   6 # deal in the Work without restriction, including without limitation the
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Work, and to permit persons to whom the Work
   9 # is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Work.
  13 #
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
  21 # IN THE WORK.
  22 #----------------------------------------------------------------------
  23
  24 from __future__ import print_function
  25
  26 from sfa.util.sfalogging import logger
  27 from sfa.trust.credential import Credential
  28 from sfa.trust.abac_credential import ABACCredential
  29
  30 import json
  31 import re
  32
  33 # Factory for creating credentials of different sorts by type.
  34 # Specifically, this factory can create standard SFA credentials
  35 # and ABAC credentials from XML strings based on their identifying content
  36
  37 class CredentialFactory:
  38
  39     UNKNOWN_CREDENTIAL_TYPE = 'geni_unknown'
  40
  41     # Static Credential class method to determine the type of a credential
  42     # string depending on its contents
  43     @staticmethod
  44     def getType(credString):
  45         credString_nowhitespace = re.sub('\s', '', credString)
  46         if credString_nowhitespace.find('<type>abac</type>') > -1:
  47             return ABACCredential.ABAC_CREDENTIAL_TYPE
  48         elif credString_nowhitespace.find('<type>privilege</type>') > -1:
  49             return Credential.SFA_CREDENTIAL_TYPE
  50         else:
  51             st = credString_nowhitespace.find('<type>')
  52             end = credString_nowhitespace.find('</type>', st)
  53             return credString_nowhitespace[st + len('<type>'):end]
  54 #            return CredentialFactory.UNKNOWN_CREDENTIAL_TYPE
  55
  56     # Static Credential class method to create the appropriate credential
  57     # (SFA or ABAC) depending on its type
  58     @staticmethod
  59     def createCred(credString=None, credFile=None):
  60         if not credString and not credFile:
  61             raise Exception("CredentialFactory.createCred called with no argument")
  62         if credFile:
  63             try:
  64                 credString = open(credFile).read()
  65             except Exception as e:
  66                 logger.info("Error opening credential file %s: %s" % credFile, e)
  67                 return None
  68
  69         # Try to treat the file as JSON, getting the cred_type from the struct
  70         try:
  71             credO = json.loads(credString, encoding='ascii')
  72             if credO.has_key('geni_value') and credO.has_key('geni_type'):
  73                 cred_type = credO['geni_type']
  74                 credString = credO['geni_value']
  75         except Exception as e:
  76             # It wasn't a struct. So the credString is XML. Pull the type directly from the string
  77             logger.debug("Credential string not JSON: %s" % e)
  78             cred_type = CredentialFactory.getType(credString)
  79
  80         if cred_type == Credential.SFA_CREDENTIAL_TYPE:
  81             try:
  82                 cred = Credential(string=credString)
  83                 return cred
  84             except Exception as e:
  85                 if credFile:
  86                     msg = "credString started: %s" % credString[:50]
  87                     raise Exception("%s not a parsable SFA credential: %s. " % (credFile, e) + msg)
  88                 else:
  89                     raise Exception("SFA Credential not parsable: %s. Cred start: %s..." % (e, credString[:50]))
  90
  91         elif cred_type == ABACCredential.ABAC_CREDENTIAL_TYPE:
  92             try:
  93                 cred = ABACCredential(string=credString)
  94                 return cred
  95             except Exception as e:
  96                 if credFile:
  97                     raise Exception("%s not a parsable ABAC credential: %s" % (credFile, e))
  98                 else:
  99                     raise Exception("ABAC Credential not parsable: %s. Cred start: %s..." % (e, credString[:50]))
 100         else:
 101             raise Exception("Unknown credential type '%s'" % cred_type)
 102
 103 if __name__ == "__main__":
 104     c2 = open('/tmp/sfa.xml').read()
 105     cred1 = CredentialFactory.createCred(credFile='/tmp/cred.xml')
 106     cred2 = CredentialFactory.createCred(credString=c2)
 107
 108     print("C1 = %s" % cred1)
 109     print("C2 = %s" % cred2)
 110     c1s = cred1.dump_string()
 111     print("C1 = %s" % c1s)
 112 #    print "C2 = %s" % cred2.dump_string()