Merge ~ggouzi/maas:raise-base-request-missing-oauth-timestamp into maas:master

[Gaetan Gouzi]

Raise a HTTP 400 if `oauth_timestamp` is not set

https://bugs.launchpad.net/maas/+bug/2002525

In addition with fix in piston3 lib https://code.launchpad.net/~ggouzi/django-piston3/+git/django-piston3/+merge/457993

[MAAS Lander (maas-lander)]

UNIT TESTS
-b raise-base-request-missing-oauth-timestamp lp:~ggouzi/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/4318/console
COMMIT: 6f02b3ea54983414a4a7b819f2127edf9bca332e

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

Imports are incorrectly sorted, run the formatter to fix that.

review: Needs Fixing

da2c594... by ggouzi <email address hidden> on 2024-01-05

Pep8: Rearrange import order

[MAAS Lander (maas-lander)]

UNIT TESTS
-b raise-base-request-missing-oauth-timestamp lp:~ggouzi/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/4330/console
COMMIT: da2c594527e97482d3d9201e8ac98e72928a2010

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

ImportError: cannot import name 'OAuthBadRequest' from 'piston3.oauth' (/usr/lib/python3/dist-packages/piston3/oauth.py)

[Gaetan Gouzi (ggouzi)]

> ImportError: cannot import name 'OAuthBadRequest' from 'piston3.oauth'
> (/usr/lib/python3/dist-packages/piston3/oauth.py)
My mistake, should have waited for https://code.launchpad.net/~ggouzi/django-piston3/+git/django-piston3/+merge/457993, where OAuthBadRequest is defined, to be merged

d9420f2... by ggouzi <email address hidden> on 2024-01-06

Create OAuthBadRequest class return HTTP 400 if OAuthMissingParam error is raised from django-piston3 auth

[MAAS Lander (maas-lander)]

UNIT TESTS
-b raise-base-request-missing-oauth-timestamp lp:~ggouzi/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/4344/console
COMMIT: 35e9b2a63f1371beef7576a401d6dab2d23ad9e9

review: Needs Fixing

[Jack Lloyd-Walters (lloydwaltersj)]

jenkins: !test

[Jack Lloyd-Walters (lloydwaltersj)]

I believe the piston changes have since landed, so let's request a re-test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b raise-base-request-missing-oauth-timestamp lp:~ggouzi/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas-tester/4460/console
COMMIT: 35e9b2a63f1371beef7576a401d6dab2d23ad9e9

review: Needs Fixing

Unmerged commits

d9420f2... by ggouzi <email address hidden> on 2024-01-06

Create OAuthBadRequest class return HTTP 400 if OAuthMissingParam error is raised from django-piston3 auth

da2c594... by ggouzi <email address hidden> on 2024-01-05

Pep8: Rearrange import order

6f02b3e... by ggouzi <email address hidden> on 2024-01-04

Add check to return HTTP 400 if oauth_timestamp is not set

diff --git a/src/maasserver/api/auth.py b/src/maasserver/api/auth.py
index 7d4b93e..e17527e 100644
--- a/src/maasserver/api/auth.py
+++ b/src/maasserver/api/auth.py
@@ -7,10 +7,10 @@
 from operator import xor
 
 from piston3.authentication import OAuthAuthentication, send_oauth_error
-from piston3.oauth import OAuthError
+from piston3.oauth import OAuthError, OAuthMissingParam
 from piston3.utils import rc
 
-from maasserver.exceptions import Unauthorized
+from maasserver.exceptions import MAASAPIBadRequest, Unauthorized
 from maasserver.macaroon_auth import (
     MacaroonAPIAuthentication,
     validate_user_external_auth,
@@ -18,6 +18,18 @@ from maasserver.macaroon_auth import (
 from maasserver.models.user import SYSTEM_USERS
 
 
+class OAuthBadRequest(MAASAPIBadRequest):
+    """BadRequest error for OAuth signed requests with invalid parameters."""
+
+    def __init__(self, error):
+        super().__init__()
+        self.error = error
+        self.error.message = f"Bad Request: {error.message}"
+
+    def __str__(self):
+        return repr(self.error.message)
+
+
 class OAuthUnauthorized(Unauthorized):
     """Unauthorized error for OAuth signed requests with invalid tokens."""
 
@@ -62,6 +74,8 @@ class MAASAPIAuthentication(OAuthAuthentication):
                 consumer, token, parameters = self.validate_token(request)
             except OAuthError as error:
                 raise OAuthUnauthorized(error)
+            except OAuthMissingParam as error:
+                raise OAuthBadRequest(error)
 
             if consumer and token:
                 user = token.user
diff --git a/src/maasserver/api/tests/test_auth.py b/src/maasserver/api/tests/test_auth.py
index b34a67f..0bfac82 100644
--- a/src/maasserver/api/tests/test_auth.py
+++ b/src/maasserver/api/tests/test_auth.py
@@ -11,7 +11,11 @@ from django.contrib.auth.models import AnonymousUser
 from piston3 import oauth
 
 from maasserver.api import auth as api_auth
-from maasserver.api.auth import MAASAPIAuthentication, OAuthUnauthorized
+from maasserver.api.auth import (
+    MAASAPIAuthentication,
+    OAuthBadRequest,
+    OAuthUnauthorized,
+)
 from maasserver.middleware import ExternalAuthInfo
 from maasserver.secrets import SecretManager
 from maasserver.testing.factory import factory
@@ -164,3 +168,14 @@ class TestOAuthUnauthorized(MAASTestCase):
             "Authorization Error: Invalid API key.",
             str(maas_exception),
         )
+
+
+class TestOAuthBadRequest(MAASTestCase):
+    def test_exception_unicode_includes_original_failure_message(self):
+        error_msg = factory.make_name("error-message")
+        original_exception = oauth.OAuthMissingParam(error_msg)
+        maas_exception = OAuthBadRequest(original_exception)
+        self.assertIn(
+            f"Bad Request: {error_msg}",
+            str(maas_exception),
+        )