fix(admin): require admin key for schema validate endpoint#13328
Open
shreemaan-abhishek wants to merge 1 commit intoapache:masterfrom
Open
fix(admin): require admin key for schema validate endpoint#13328shreemaan-abhishek wants to merge 1 commit intoapache:masterfrom
shreemaan-abhishek wants to merge 1 commit intoapache:masterfrom
Conversation
The /apisix/admin/schema/validate/* handler did not call set_ctx_and_check_token() like every other Admin API handler, so the endpoint accepted unauthenticated requests even when admin_key_required was enabled. Add the auth check at the top of schema_validate() and cover the three auth states (no key, wrong key, correct key) in t/admin/token.t. Reported by Kacper.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The
/apisix/admin/schema/validate/*handler inapisix/admin/init.luadoes not callset_ctx_and_check_token(), unlike every other Admin API handler. As a result, the endpoint accepts unauthenticated requests even whenadmin_key_requiredis enabled (the default in production), returning the body validation result (e.g.400) instead of the expected401 Unauthorized.Reproduction (against a default-config 3.x APISIX instance):
The behaviour also contradicts the Admin API documentation, which shows the request being sent with
X-API-KEY: $admin_key.Impact
Fix
Add
set_ctx_and_check_token()as the first call inschema_validate(), matching every other handler in the file (run,get_plugins_list,post_reload_plugins,standalone_run,validate_configs).Tests
Added three cases in
t/admin/token.tcovering the schema-validate endpoint:Reported privately by Kacper.
Which issue(s) this PR fixes:
Fixes #
Checklist