Add SPNEGOExchangeError (and retain KerberosExchangeError as a shim)

Signed-off-by: Robbie Harwood <[email protected]>
Resolves: #1

Author: frozencemetery

requests_gssapi/exceptions.py

@@ -12,5 +12,8 @@ class MutualAuthenticationError(RequestException):
     """Mutual Authentication Error"""
 
 
-class KerberosExchangeError(RequestException):
-    """Kerberos Exchange Failed Error"""
+class SPNEGOExchangeError(RequestException):
+    """SPNEGO Exchange Failed Error"""
+
+# drop-in shim!
+KerberosExchangeError = SPNEGOExchangeError

requests_gssapi/gssapi_.py

@@ -9,7 +9,7 @@
 from requests.structures import CaseInsensitiveDict
 from requests.cookies import cookiejar_from_dict
 
-from .exceptions import MutualAuthenticationError, KerberosExchangeError
+from .exceptions import MutualAuthenticationError, SPNEGOExchangeError
 
 log = logging.getLogger(__name__)
 
@@ -95,9 +95,9 @@ def __init__(self, mutual_authentication=REQUIRED, service="HTTP",
 
     def generate_request_header(self, response, host, is_preemptive=False):
         """
-        Generates the GSSAPI authentication token with kerberos.
+        Generates the GSSAPI authentication token
 
-        If any GSSAPI step fails, raise KerberosExchangeError
+        If any GSSAPI step fails, raise SPNEGOExchangeError
         with failure detail.
 
         """
@@ -143,7 +143,7 @@ def generate_request_header(self, response, host, is_preemptive=False):
             log.exception(
                 "generate_request_header(): {0} failed:".format(gss_stage))
             log.exception(msg)
-            raise KerberosExchangeError("%s failed: %s" % (gss_stage, msg))
+            raise SPNEGOExchangeError("%s failed: %s" % (gss_stage, msg))
 
     def authenticate_user(self, response, **kwargs):
         """Handles user authentication with GSSAPI"""
@@ -152,7 +152,7 @@ def authenticate_user(self, response, **kwargs):
 
         try:
             auth_header = self.generate_request_header(response, host)
-        except KerberosExchangeError:
+        except SPNEGOExchangeError:
             # GSS Failure, return existing response
             return response
 

test_requests_gssapi.py

@@ -104,7 +104,7 @@ def test_generate_request_header_init_error(self):
             response.headers = {'www-authenticate': 'negotiate token'}
             host = urlparse(response.url).hostname
             auth = requests_gssapi.HTTPSPNEGOAuth()
-            self.assertRaises(requests_gssapi.exceptions.KerberosExchangeError,
+            self.assertRaises(requests_gssapi.exceptions.SPNEGOExchangeError,
                               auth.generate_request_header, response, host)
             fake_init.assert_called_with(
                 name=gssapi.Name("[email protected]"),
@@ -118,7 +118,7 @@ def test_generate_request_header_step_error(self):
             response.headers = {'www-authenticate': 'negotiate token'}
             host = urlparse(response.url).hostname
             auth = requests_gssapi.HTTPSPNEGOAuth()
-            self.assertRaises(requests_gssapi.exceptions.KerberosExchangeError,
+            self.assertRaises(requests_gssapi.exceptions.SPNEGOExchangeError,
                               auth.generate_request_header, response, host)
             fake_init.assert_called_with(
                 name=gssapi.Name("[email protected]"),