Skip to content

Add more informative 401 error. #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjacovich merged 5 commits into from
Jun 12, 2025
Merged

Add more informative 401 error. #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0fcbeb3
Add more informative 401 error.
tjacovich Jun 11, 2025
b6bef78
Merge branch 'adsabs:main' into more-informative-401
tjacovich Jun 12, 2025
90f5e23
Commit first stab at testing 401.
tjacovich Jun 12, 2025
d6bcba4
Relocated 401 update into GatewayProtectorView where error is actuall…
tjacovich Jun 12, 2025
a99cdc7
Remove test invalid authorization.
tjacovich Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apigateway/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def unauthorized():
This overrides the default behavior or re-directing to a login view
"""
abort(401)

@app.teardown_request
def teardown_request(exception=None):
"""This function will close active transaction, if there is one
Expand Down
1 change: 1 addition & 0 deletions apigateway/tests/test_services.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ def test_route():

assert "X-api-uid" in request.headers


def test_headers_not_set(self, app):

@app.route("/test_auth_headers_not_set")
Expand Down
5 changes: 5 additions & 0 deletions apigateway/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import jsondiff as jd
import requests
from authlib.oauth2.rfc6749.errors import UnsupportedTokenTypeError
from authlib.integrations.flask_oauth2 import ResourceProtector
from flask import Request, current_app, request
from flask.views import View
Expand Down Expand Up @@ -259,6 +260,10 @@ def _construct_remote_url(self) -> str:
class GatewayResourceProtector(ResourceProtector):
def raise_error_response(self, error):
body = json.dumps(dict({"message": error.description}))
Copy link
Copy Markdown
Contributor Author

@tjacovich tjacovich Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason for the special handling is because the Bearer:TOKEN doesn't register as a Bearer token so authlib throws an UnsupportedTokenTypeError and that does not have a description so the body of the error is empty without additional handling.

if type(error)==UnsupportedTokenTypeError:
current_app.logger.info("Token not recognized as a Bearer Token.")
body="Unauthorized. If you are using the API, please confirm your Authorization header is of the form Bearer TOKEN and not Bearer:TOKEN"
raise Oauth2HttpError(error.status_code, error.description, body, error.get_headers())
raise Oauth2HttpError(error.status_code, error.description, body, error.get_headers())


Expand Down