Repository navigation
feat(auth): accept instance authenticators on Cargo endpoints #61
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.
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
Open
BaptisteCentreon
wants to merge
1
commit into
pulp:main
Choose a base branch
from
BaptisteCentreon:oidc-cargo-auth
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+87
−7
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -306,28 +306,41 @@ def retrieve(self, request, repo): | |
| data = { | ||
| "dl": self.base_download_url, | ||
| "api": self.base_api_url, | ||
| "auth-required": False, | ||
| "auth-required": bool(self.distribution.content_guard_id), | ||
| } | ||
| return HttpResponse(json.dumps(data), content_type="application/json") | ||
|
|
||
|
|
||
| class CargoMeApiView(APIView): | ||
| class CargoAuthMixin: | ||
| """Authenticate the Cargo token first, then the deployment's configured authenticators. | ||
|
|
||
| Cargo endpoints must not shadow ``DEFAULT_AUTHENTICATION_CLASSES``: hardcoding only | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid double-backticks please. And please disclose AI use in accordance with our AI policy https://github.com/pulp/pulp-docs/blob/main/pulpproject.org/help/more/governance/ai_policy.md |
||
| ``CargoTokenAuthentication`` locks them to ``crg_`` tokens and rejects every other | ||
| credential the instance accepts (Basic, session, SSO, OIDC/workload identity). | ||
| Prepending the Cargo token keeps ``cargo login`` working while letting any configured | ||
| authenticator (e.g. a CI bearer token) reach the view. | ||
| """ | ||
|
|
||
| def get_authenticators(self): | ||
| return [CargoTokenAuthentication(), *super().get_authenticators()] | ||
|
|
||
|
|
||
| class CargoMeApiView(CargoAuthMixin, APIView): | ||
| """ | ||
| Auth verification endpoint for ``cargo login``. | ||
|
|
||
| Cargo calls GET /me after login to verify the token is valid. | ||
| See: https://doc.rust-lang.org/cargo/reference/registry-web-api.html | ||
| """ | ||
|
|
||
| authentication_classes = [CargoTokenAuthentication] | ||
| permission_classes = [IsAuthenticated] | ||
| renderer_classes = [JSONRenderer] | ||
|
|
||
| def get(self, request, **kwargs): | ||
| return HttpResponse(json.dumps({"ok": True}), content_type="application/json") | ||
|
|
||
|
|
||
| class CargoPublishApiView(APIView): | ||
| class CargoPublishApiView(CargoAuthMixin, APIView): | ||
| """ | ||
| View for Cargo's crate publish endpoint (PUT /api/v1/crates/new). | ||
|
|
||
|
|
@@ -337,7 +350,6 @@ class CargoPublishApiView(APIView): | |
| See: https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish | ||
| """ | ||
|
|
||
| authentication_classes = [CargoTokenAuthentication] | ||
| permission_classes = [IsAuthenticated] | ||
| renderer_classes = [JSONRenderer] | ||
|
|
||
|
|
@@ -430,12 +442,11 @@ def put(self, request, **kwargs): | |
| ) | ||
|
|
||
|
|
||
| class CargoDownloadApiView(APIView): | ||
| class CargoDownloadApiView(CargoAuthMixin, APIView): | ||
| """ | ||
| View for Cargo's crate download, readme, yank, and unyank endpoints. | ||
| """ | ||
|
|
||
| authentication_classes = [CargoTokenAuthentication] | ||
| renderer_classes = [PlainTextRenderer, JSONRenderer] | ||
|
|
||
| def get_permissions(self): | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a general change, or do you specifically have in mind a use case for mixing content guards with cargo download?