Skip to content
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.

Sign up for GitHub

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

Jump to bottom

verifyAndReceive should accept raw string payload #420

Closed
oscard0m opened this issue Feb 1, 2021 · 3 comments · Fixed by #586
Closed

verifyAndReceive should accept raw string payload #420

oscard0m opened this issue Feb 1, 2021 · 3 comments · Fixed by #586
Assignees
@gr2m
Labels
Type: Bug Something isn't working as documented, or is being fixed
Projects
JS

Comments

@oscard0m
Copy link
Member

oscard0m commented Feb 1, 2021 •
edited by gr2m

What happened?
Using verifyAndReceive method with a payload in string format does not work

Details here: probot/probot#1467 (comment)

What did you expect to happen?
verifyAndReceive should accept the raw payload payload string besides the parsed object

What the problem might be
To improve signature of verifyAndReceive to support both types
@oscard0m oscard0m added the Type: Bug Something isn't working as documented, or is being fixed label Feb 1, 2021
@ghost ghost added this to Bugs in JS Feb 1, 2021
@oscard0m oscard0m mentioned this issue Feb 1, 2021
Merged
8 tasks
@gr2m gr2m changed the title verifyAndReceive should support _stringified_ payload verifyAndReceive should accept raw string payload Feb 2, 2021
@gr2m
Copy link
Contributor

gr2m commented Feb 2, 2021

@oscard0m I slightly rephrased the issue and your description for clarity. The intend is not for users to stringify the parsed JSON string again, but instead pass the raw string from the server. The benefit is that it might include white space that is significant for the signature verification, but will get lost when parsed and stringified again

@gr2m gr2m self-assigned this Apr 22, 2021
@ghost ghost moved this from Bugs to In progress in JS Apr 22, 2021
@gr2m
Copy link
Contributor

gr2m commented Apr 22, 2021 •
edited

This should also resolve #76

@gr2m gr2m mentioned this issue Jun 17, 2021
Merged
@gr2m gr2m closed this as completed in #586 Jun 17, 2021
JS automation moved this from In progress to Done Jun 17, 2021
@gr2m gr2m mentioned this issue Jun 17, 2021
Closed
@github-actions
Copy link
Contributor

🎉 This issue has been resolved in version 9.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gr2m gr2m mentioned this issue Jun 17, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gr2m gr2m

Labels
Type: Bug Something isn't working as documented, or is being fixed
Projects
No open projects
JS
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat:octokit.verifyAndReceive() accepts raw string payload octokit/webhooks.js
2 participants
@gr2m @oscard0m