Small rewording of exception messages

Author: Qup42

oauth2_provider/exceptions.py

@@ -19,8 +19,11 @@ class FatalClientError(OAuthToolkitError):
     pass
 
 
-# TODO: Cleanup
 class OIDCError(Exception):
+    """
+    General class to derive from for all OIDC related errors.
+    """
+
     status_code = 400
     error = None
 
@@ -34,30 +37,29 @@ def __init__(self, description=None):
 
 class InvalidRequestFatalError(OIDCError):
     """
-    For fatal errors, the request is missing a required parameter, includes
-    an invalid parameter value, includes a parameter more than once, or is
-    otherwise malformed.
+    For fatal errors. These are requests with invalid parameter values, missing parameters or otherwise
+    incorrect requests.
     """
 
     error = "invalid_request"
 
 
 class ClientIdMissmatch(InvalidRequestFatalError):
-    description = "Missmatch between Client ID of the ID Token and provided the Client ID."
+    description = "Mismatch between the Client ID of the ID Token and the Client ID that was provided."
 
 
 class InvalidOIDCClientError(InvalidRequestFatalError):
-    description = "The Client is unknown or no client was included."
+    description = "The client is unknown or no client has been included."
 
 
-class MismatchingOIDCRedirectURIError(InvalidRequestFatalError):
-    description = "Mismatching post logout redirect URI."
+class InvalidOIDCRedirectURIError(InvalidRequestFatalError):
+    description = "Invalid post logout redirect URI."
 
 
 class InvalidIDTokenError(InvalidRequestFatalError):
-    description = "The ID Token is expired, revoked, malformed, or invalid for other reasons."
+    description = "The ID Token is expired, revoked, malformed, or otherwise invalid."
 
 
 class LogoutDenied(OIDCError):
     error = "logout_denied"
-    description = "Logout was denied by the user."
+    description = "Logout has been refused by the user."

oauth2_provider/views/oidc.py

@@ -14,8 +14,8 @@
     ClientIdMissmatch,
     InvalidIDTokenError,
     InvalidOIDCClientError,
+    InvalidOIDCRedirectURIError,
     LogoutDenied,
-    MismatchingOIDCRedirectURIError,
     OIDCError,
 )
 from ..forms import ConfirmLogoutForm
@@ -195,13 +195,13 @@ def validate_logout_request(user, id_token_hint, client_id, post_logout_redirect
             raise InvalidOIDCClientError()
         scheme = urlparse(post_logout_redirect_uri)[0]
         if not scheme:
-            raise MismatchingOIDCRedirectURIError("A Scheme is required for the redirect URI.")
+            raise InvalidOIDCRedirectURIError("A Scheme is required for the redirect URI.")
         if scheme == "http" and application.client_type != "confidential":
-            raise MismatchingOIDCRedirectURIError("http is only allowed with confidential clients.")
+            raise InvalidOIDCRedirectURIError("http is only allowed with confidential clients.")
         if scheme not in application.get_allowed_schemes():
-            raise MismatchingOIDCRedirectURIError(f'Redirect to scheme "{scheme}" is not permitted.')
+            raise InvalidOIDCRedirectURIError(f'Redirect to scheme "{scheme}" is not permitted.')
         if not application.post_logout_redirect_uri_allowed(post_logout_redirect_uri):
-            raise MismatchingOIDCRedirectURIError("This client does not have this redirect uri registered.")
+            raise InvalidOIDCRedirectURIError("This client does not have this redirect uri registered.")
 
     return prompt_logout, (post_logout_redirect_uri, application)
 

tests/test_oidc_views.py

@@ -3,11 +3,7 @@
 from django.test import TestCase
 from django.urls import reverse
 
-from oauth2_provider.exceptions import (
-    ClientIdMissmatch,
-    InvalidOIDCClientError,
-    MismatchingOIDCRedirectURIError,
-)
+from oauth2_provider.exceptions import ClientIdMissmatch, InvalidOIDCClientError, InvalidOIDCRedirectURIError
 from oauth2_provider.oauth2_validators import OAuth2Validator
 from oauth2_provider.settings import oauth2_settings
 from oauth2_provider.views.oidc import validate_logout_request
@@ -221,21 +217,21 @@ def test_validate_logout_request(oidc_tokens, public_application, other_user, rp
             client_id=None,
             post_logout_redirect_uri="http://example.org",
         )
-    with pytest.raises(MismatchingOIDCRedirectURIError):
+    with pytest.raises(InvalidOIDCRedirectURIError):
         validate_logout_request(
             user=oidc_tokens.user,
             id_token_hint=None,
             client_id=client_id,
             post_logout_redirect_uri="example.org",
         )
-    with pytest.raises(MismatchingOIDCRedirectURIError):
+    with pytest.raises(InvalidOIDCRedirectURIError):
         validate_logout_request(
             user=oidc_tokens.user,
             id_token_hint=None,
             client_id=client_id,
             post_logout_redirect_uri="imap://example.org",
         )
-    with pytest.raises(MismatchingOIDCRedirectURIError):
+    with pytest.raises(InvalidOIDCRedirectURIError):
         validate_logout_request(
             user=oidc_tokens.user,
             id_token_hint=None,