Split get_accessory_data to avoid mixing secrets, headers, etc. #74
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
michelemin
force-pushed
the
refactor_get_accessory_data
branch
from
5849e2f to
a8dd2eb
Compare
obelisk
requested changes
Jan 21, 2025
| @@ -1,6 +1,6 @@ | |||
| [package] | |||
| name = "plaid_stl" | |||
| version = "0.14.2" | |||
| version = "0.16.0" | |||
There was a problem hiding this comment.
Yes, let's see if we merge this one of the DB size limit first.
| @@ -260,7 +260,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { | |||
| let message = Message { | |||
| type_: name.to_string(), | |||
| data: String::new().into_bytes(), | |||
| accessory_data: query.into_iter().map(|(k, v)| (k, v.into_bytes())).collect(), | |||
| accessory_data: HashMap::new(), | |||
There was a problem hiding this comment.
Does this break deserialization of previous messages?
There was a problem hiding this comment.
I don't think so. In the sense that whatever is given as query params ends up in the query_params field of the Message, while the accessory_data remains empty (for now). Then it's up to the rule to know that data has to be read differently. So yes, in that sense this is a breaking change. And same for secrets and headers.
michelemin
force-pushed
the
refactor_get_accessory_data
branch
from
3da2435 to
5109e91
Compare
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.
The current situation is that secrets, headers (for POST requests) and query params (for GET requests) end up in "accessory data".
The code avoids security issues by making sure that secrets are added last, thus overwriting headers/params with the same name. However, this remains error prone and prevents us from having things with the same name.
This PR splits this additional data into
Each has their getter method, generated through macros (since it's the same exact thing for all of them).
Also adding tests that show that
Existing tests have been updated.
Breaking changes
! Existing rules need to be changed !
Usually rules are getting either secrets or headers from accessory data. One has to go through all the rules and replace that call with
get_headersorget_secrets, as appropriate.