-
Notifications
You must be signed in to change notification settings - Fork 1k
Add option to skip signature verification #821
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.
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
Open
habara-k
wants to merge
6
commits into
line:master
Choose a base branch
from
habara-k:allow-to-skip-signature-verification
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ddbbd44
Add option to skip signature verification
habara-k e6b69b2
Merge branch 'master' into allow-to-skip-signature-verification
habara-k b4b5d14
Update WebhookHandler, update document, and add tests
habara-k 1a31c09
Revert examples
habara-k 9763f5e
Fix style
habara-k 9f0b4f0
Fix style
habara-k File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,166 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
# Licensed under the Apache License, Version 2.0 (the "License"); you may | ||
# not use this file except in compliance with the License. You may obtain | ||
# a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
# License for the specific language governing permissions and limitations | ||
# under the License. | ||
|
||
from __future__ import unicode_literals, absolute_import | ||
|
||
import unittest | ||
|
||
from linebot.v3 import ( | ||
WebhookParser, WebhookHandler | ||
) | ||
from linebot.v3.exceptions import InvalidSignatureError | ||
|
||
|
||
class TestWebhookParserWithSkipSignatureVerification(unittest.TestCase): | ||
def setUp(self): | ||
self.parser = WebhookParser('channel_secret') | ||
self.parser_with_skip = WebhookParser('channel_secret', skip_signature_verification=lambda: True) | ||
|
||
def test_parse_with_invalid_signature(self): | ||
body = '{"events": []}' | ||
signature = 'invalid_signature' | ||
|
||
# Should raise InvalidSignatureError when skip_signature_verification is False (default) | ||
with self.assertRaises(InvalidSignatureError): | ||
self.parser.parse(body, signature) | ||
|
||
# Should not raise InvalidSignatureError when skip_signature_verification is True | ||
try: | ||
self.parser_with_skip.parse(body, signature) | ||
except InvalidSignatureError: | ||
self.fail("parse() raised InvalidSignatureError unexpectedly!") | ||
|
||
|
||
class TestWebhookHandlerWithSkipSignatureVerification(unittest.TestCase): | ||
def setUp(self): | ||
self.handler = WebhookHandler('channel_secret') | ||
self.handler_with_skip = WebhookHandler('channel_secret', skip_signature_verification=lambda: True) | ||
self.handler_called = False | ||
self.handler_with_skip_called = False | ||
|
||
@self.handler.default() | ||
def default(event): | ||
self.handler_called = True | ||
|
||
@self.handler_with_skip.default() | ||
def default_with_skip(event): | ||
self.handler_with_skip_called = True | ||
|
||
def test_handle_with_invalid_signature(self): | ||
body = """ | ||
{ | ||
"events": [ | ||
{ | ||
"type": "message", | ||
"message": { | ||
"type": "text", | ||
"id": "123", | ||
"text": "test" | ||
}, | ||
"timestamp": 1462629479859, | ||
"source": { | ||
"type": "user", | ||
"userId": "U123" | ||
}, | ||
"replyToken": "reply_token", | ||
"mode": "active", | ||
"webhookEventId": "test_id", | ||
"deliveryContext": { | ||
"isRedelivery": false | ||
} | ||
} | ||
] | ||
} | ||
""" | ||
signature = 'invalid_signature' | ||
|
||
# Should raise InvalidSignatureError when skip_signature_verification is False (default) | ||
with self.assertRaises(InvalidSignatureError): | ||
self.handler.handle(body, signature) | ||
|
||
# Handler should not be called when signature verification fails | ||
self.assertFalse(self.handler_called) | ||
|
||
# Should not raise InvalidSignatureError when skip_signature_verification is True | ||
try: | ||
self.handler_with_skip.handle(body, signature) | ||
except InvalidSignatureError: | ||
self.fail("handle() raised InvalidSignatureError unexpectedly!") | ||
|
||
# Handler should be called when signature verification is skipped | ||
self.assertTrue(self.handler_with_skip_called) | ||
|
||
def test_dynamic_skip_signature_verification(self): | ||
body = """ | ||
{ | ||
"events": [ | ||
{ | ||
"type": "message", | ||
"message": { | ||
"type": "text", | ||
"id": "123", | ||
"text": "test" | ||
}, | ||
"timestamp": 1462629479859, | ||
"source": { | ||
"type": "user", | ||
"userId": "U123" | ||
}, | ||
"replyToken": "reply_token", | ||
"mode": "active", | ||
"webhookEventId": "test_id", | ||
"deliveryContext": { | ||
"isRedelivery": false | ||
} | ||
} | ||
] | ||
} | ||
""" | ||
signature = 'invalid_signature' | ||
skip_flag = [False] | ||
|
||
# Create a handler with dynamic skip flag | ||
handler_with_dynamic_skip = WebhookHandler( | ||
'channel_secret', | ||
skip_signature_verification=lambda: skip_flag[0] | ||
) | ||
|
||
dynamic_handler_called = [False] | ||
|
||
@handler_with_dynamic_skip.default() | ||
def default_dynamic(event): | ||
dynamic_handler_called[0] = True | ||
|
||
# Should raise InvalidSignatureError when skip_signature_verification returns False | ||
with self.assertRaises(InvalidSignatureError): | ||
handler_with_dynamic_skip.handle(body, signature) | ||
|
||
# Handler should not be called | ||
self.assertFalse(dynamic_handler_called[0]) | ||
|
||
# Change the skip flag | ||
skip_flag[0] = True | ||
|
||
# Should not raise InvalidSignatureError now | ||
try: | ||
handler_with_dynamic_skip.handle(body, signature) | ||
except InvalidSignatureError: | ||
self.fail("handle() raised InvalidSignatureError unexpectedly!") | ||
|
||
# Handler should be called now | ||
self.assertTrue(dynamic_handler_called[0]) | ||
|
||
|
||
if __name__ == '__main__': | ||
unittest.main() |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
line/line-bot-sdk-go#595 (comment)
Therefor I think
False
should be used in example.