fix: URL encoding for pubsubTopic and contentTopics parameters #3200
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
Related to waku-org#3128 Update the API to enforce mandatory URL encoding for `pubsubTopic` and `content_topic`. * Update `docs/api/rest-api.md` to include examples of URL-encoded `pubsubTopic` and `contentTopics` parameters. * Modify `waku/waku_api/rest/store/handlers.nim` to validate and enforce URL encoding for `pubsubTopic` and `contentTopics` parameters. * Add error handling for invalid or non-encoded `pubsubTopic` and `contentTopics` parameters in `waku/waku_api/rest/store/handlers.nim`. * Update `decodeRequestBody` function in `waku/waku_api/rest/rest_serdes.nim` to validate and enforce URL encoding for `pubsubTopic` and `contentTopics` parameters. * Add error handling for invalid or non-encoded `pubsubTopic` and `contentTopics` parameters in `waku/waku_api/rest/rest_serdes.nim`.
Ivansete-status
changed the title
| if T.hasKey("pubsubTopic"): | ||
| let pubsubTopic = T["pubsubTopic"] | ||
| if pubsubTopic != encodeUrl(pubsubTopic): | ||
| return err(RestApiResponse.badRequest("Invalid or non-encoded pubsubTopic parameter")) |
There was a problem hiding this comment.
Suggested change
| return err(RestApiResponse.badRequest("Invalid or non-encoded pubsubTopic parameter")) | |
| return err(RestApiResponse.badRequest("Invalid or non-URL-encoded pubsubTopic parameter")) |
| let contentTopics = T["contentTopics"] | ||
| for topic in contentTopics: | ||
| if topic != encodeUrl(topic): | ||
| return err(RestApiResponse.badRequest("Invalid or non-encoded content_topic parameter")) |
There was a problem hiding this comment.
Suggested change
| return err(RestApiResponse.badRequest("Invalid or non-encoded content_topic parameter")) | |
| return err(RestApiResponse.badRequest("Invalid or non-URL-encoded content_topic parameter")) |
| #### [`get_waku_v2_store_v3_messages`](https://rfc.vac.dev/spec/16/#get_waku_v2_store_v3_messages) | ||
|
|
||
| ```bash | ||
| curl -v -X GET "http://127.0.0.1:49153/store/v3/messages?includeData=true&pubsubTopic=/waku/2/rs/3/0&pageSize=20&ascending=true" |
There was a problem hiding this comment.
Are you sure that it still works with that format :) ?
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.
Related to #3128
Update the API to enforce mandatory URL encoding for
pubsubTopicandcontent_topic.docs/api/rest-api.mdto include examples of URL-encodedpubsubTopicandcontentTopicsparameters.waku/waku_api/rest/store/handlers.nimto validate and enforce URL encoding forpubsubTopicandcontentTopicsparameters.pubsubTopicandcontentTopicsparameters inwaku/waku_api/rest/store/handlers.nim.decodeRequestBodyfunction inwaku/waku_api/rest/rest_serdes.nimto validate and enforce URL encoding forpubsubTopicandcontentTopicsparameters.pubsubTopicandcontentTopicsparameters inwaku/waku_api/rest/rest_serdes.nim.