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

docs: Update webhook auth docstring #990

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update webhook auth docstring #990

wants to merge 1 commit into from

Conversation

jpclark6
Copy link

@jpclark6 jpclark6 commented May 11, 2021 •
edited
Loading

Fixes

The verify_signature method returns False if the event payload is decoded using utf-8 and special characters exist, such as "é". The payload must be decoded using latin-1 to successfully pass authorization in these situations.

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

@jpclark6
Update webhook auth docstring
0bb6434 
The verify_signature method returns False if the event payload is decoded
using utf-8 if special characters exist. The payload must be decoded
using latin-1 to have it not fail on what should be successful
authorizations. It is not clear from the current docstring what encoding
to use when decoding the bytes payload
@thinkingserious thinkingserious added status: code review request requesting a community code review or review from Twilio status: ready for deploy code ready to be released in next deploy type: community enhancement feature request not on Twilio's roadmap type: docs update documentation change not affecting the code and removed status: code review request requesting a community code review or review from Twilio labels May 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thinkingserious thinkingserious thinkingserious approved these changes

Assignees
No one assigned
Labels
status: ready for deploy code ready to be released in next deploy type: community enhancement feature request not on Twilio's roadmap type: docs update documentation change not affecting the code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jpclark6 @thinkingserious