1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
import time
import pytest
import stripe
DUMMY_WEBHOOK_PAYLOAD = """{
"id": "evt_test_webhook",
"object": "event",
"data": { "object": { "id": "rdr_123", "object": "terminal.reader" } }
}"""
DUMMY_WEBHOOK_SECRET = "whsec_test_secret"
def generate_header(**kwargs):
timestamp = kwargs.get("timestamp", int(time.time()))
payload = kwargs.get("payload", DUMMY_WEBHOOK_PAYLOAD)
secret = kwargs.get("secret", DUMMY_WEBHOOK_SECRET)
scheme = kwargs.get("scheme", stripe.WebhookSignature.EXPECTED_SCHEME)
signature = kwargs.get("signature", None)
if signature is None:
payload_to_sign = "%d.%s" % (timestamp, payload)
signature = stripe.WebhookSignature._compute_signature(
payload_to_sign, secret
)
header = "t=%d,%s=%s" % (timestamp, scheme, signature)
return header
class TestWebhook(object):
def test_construct_event(self):
header = generate_header()
event = stripe.Webhook.construct_event(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
def test_raise_on_json_error(self):
payload = "this is not valid JSON"
header = generate_header(payload=payload)
with pytest.raises(ValueError):
stripe.Webhook.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
def test_raise_on_invalid_header(self):
header = "bad_header"
with pytest.raises(stripe.error.SignatureVerificationError):
stripe.Webhook.construct_event(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
def test_construct_event_from_bytearray(self):
header = generate_header()
payload = bytearray(DUMMY_WEBHOOK_PAYLOAD, "utf-8")
event = stripe.Webhook.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
def test_construct_event_from_bytes(self):
header = generate_header()
payload = bytes(DUMMY_WEBHOOK_PAYLOAD, "utf-8")
event = stripe.Webhook.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
class TestWebhookSignature(object):
def test_raise_on_malformed_header(self):
header = "i'm not even a real signature header"
with pytest.raises(
stripe.error.SignatureVerificationError,
match="Unable to extract timestamp and signatures from header",
):
stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
def test_raise_on_no_signatures_with_expected_scheme(self):
header = generate_header(scheme="v0")
with pytest.raises(
stripe.error.SignatureVerificationError,
match="No signatures found with expected scheme v1",
):
stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
def test_raise_on_no_valid_signatures_for_payload(self):
header = generate_header(signature="bad_signature")
with pytest.raises(
stripe.error.SignatureVerificationError,
match="No signatures found matching the expected signature for payload",
):
stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
def test_raise_on_timestamp_outside_tolerance(self):
header = generate_header(timestamp=int(time.time()) - 15)
with pytest.raises(
stripe.error.SignatureVerificationError,
match="Timestamp outside the tolerance zone",
):
stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD,
header,
DUMMY_WEBHOOK_SECRET,
tolerance=10,
)
def test_valid_header_and_signature(self):
header = generate_header()
assert stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET, tolerance=10
)
def test_header_contains_valid_signature(self):
header = generate_header() + ",v1=bad_signature"
assert stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET, tolerance=10
)
def test_timestamp_off_but_no_tolerance(self):
header = generate_header(timestamp=12345)
assert stripe.WebhookSignature.verify_header(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
class TestStripeClientConstructEvent(object):
def test_construct_event(self, stripe_mock_stripe_client):
header = generate_header()
event = stripe_mock_stripe_client.construct_event(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
def test_raise_on_json_error(self, stripe_mock_stripe_client):
payload = "this is not valid JSON"
header = generate_header(payload=payload)
with pytest.raises(ValueError):
stripe_mock_stripe_client.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
def test_raise_on_invalid_header(self, stripe_mock_stripe_client):
header = "bad_header"
with pytest.raises(stripe.error.SignatureVerificationError):
stripe_mock_stripe_client.construct_event(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
def test_construct_event_from_bytearray(self, stripe_mock_stripe_client):
header = generate_header()
payload = bytearray(DUMMY_WEBHOOK_PAYLOAD, "utf-8")
event = stripe_mock_stripe_client.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
def test_construct_event_from_bytes(self, stripe_mock_stripe_client):
header = generate_header()
payload = bytes(DUMMY_WEBHOOK_PAYLOAD, "utf-8")
event = stripe_mock_stripe_client.construct_event(
payload, header, DUMMY_WEBHOOK_SECRET
)
assert isinstance(event, stripe.Event)
def test_construct_event_inherits_requestor(self, http_client_mock):
http_client_mock.stub_request("delete", "/v1/terminal/readers/rdr_123")
client = stripe.StripeClient(
"sk_test_777",
stripe_account="acct_777",
stripe_version="2222-22-22",
http_client=http_client_mock.get_mock_http_client(),
)
header = generate_header()
event = client.construct_event(
DUMMY_WEBHOOK_PAYLOAD, header, DUMMY_WEBHOOK_SECRET
)
assert event._requestor == client._requestor
assert isinstance(event.data.object, stripe.terminal.Reader)
event.data.object.delete()
http_client_mock.assert_requested(
"delete",
path="/v1/terminal/readers/rdr_123",
api_key="sk_test_777",
stripe_account="acct_777",
stripe_version="2222-22-22",
)
|