feat: rewrite hmac-auth plugin for usability #11581
Merged
Conversation
This file contains 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
dosubot
bot
added
size:XXL
|
bad title, we can not use pls add more description about why we need this PR? |
Revolyssup
changed the title
Revolyssup
changed the title
done |
moonming
previously approved these changes
Sep 18, 2024
nic-6443
previously approved these changes
Sep 18, 2024
membphis
previously approved these changes
Sep 18, 2024
apisix/plugins/hmac-auth.lua
Outdated
| date = auth_data[5] | ||
| signed_headers = auth_data[6] | ||
| end | ||
| if not auth_string:match("^Signature") then |
There was a problem hiding this comment.
a high performance way: core.string.has_prefix
There was a problem hiding this comment.
apisix/plugins/hmac-auth.lua
Outdated
| if not validated_consumer then | ||
| core.log.warn("client request can't be validated: ", err or "Invalid signature") | ||
| return 401, {message = "client request can't be validated"} | ||
| end | ||
|
|
||
| local consumer_conf = consumer.plugin(plugin_name) | ||
| consumer.attach_consumer(ctx, validated_consumer, consumer_conf) | ||
| core.log.info("hit hmac-auth rewrite") |
Revolyssup
dismissed stale reviews from membphis, nic-6443, and moonming
via
5793e98
moonming
approved these changes
Sep 18, 2024
nic-6443
approved these changes
Sep 19, 2024
5 tasks
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.
Currently the hmac-auth plugin has a lot of headers that need to be configured, which makes it confusing to use the plugin. This PR also makes it so that it follows the RFC.
This PR refactors the plugin as following:
Authorizationheader instead of multiple headers for ease of use. Now you can provide 4 parameters(key_id,signature, headers,algorithm) in Authorization header separated by comma in any order, this makes it easy to use@Request-target definition comes from: https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures-03#name-request-target
Signing string generation logic: https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-00#section-2.1.2