-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwebhook_test.go
More file actions
390 lines (322 loc) · 12.4 KB
/
webhook_test.go
File metadata and controls
390 lines (322 loc) · 12.4 KB
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
package lettermint
import (
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
)
// generateTestSignature creates a valid signature for testing
func generateTestSignature(payload string, secret string, timestamp int64) string {
signedPayload := fmt.Sprintf("%d.%s", timestamp, payload)
h := hmac.New(sha256.New, []byte(secret))
h.Write([]byte(signedPayload))
hash := hex.EncodeToString(h.Sum(nil))
return fmt.Sprintf("t=%d,v1=%s", timestamp, hash)
}
func TestVerifyWebhook_Success(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered","timestamp":"2026-03-23T08:56:21.046734Z","data":{"message_id":"msg_123","recipient":"user@example.com"}}`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
event, err := VerifyWebhook(signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err != nil {
t.Fatalf("VerifyWebhook() error = %v", err)
}
if event == nil {
t.Fatal("VerifyWebhook() returned nil event")
}
if event.ID != "wh_123" {
t.Errorf("event.ID = %v, want wh_123", event.ID)
}
if event.Event != "message.delivered" {
t.Errorf("event.Event = %v, want message.delivered", event.Event)
}
if event.Data.MessageID != "msg_123" {
t.Errorf("event.Data.MessageID = %v, want msg_123", event.Data.MessageID)
}
if event.Data.Recipient != "user@example.com" {
t.Errorf("event.Data.Recipient = %v, want user@example.com", event.Data.Recipient)
}
if event.RawPayload == nil {
t.Error("event.RawPayload should not be nil")
}
}
func TestVerifyWebhook_WithDeliveryTimestamp(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
// Matching delivery timestamp should work
event, err := VerifyWebhook(signature, []byte(payload), timestamp, secret, DefaultWebhookTolerance)
if err != nil {
t.Fatalf("VerifyWebhook() error = %v", err)
}
if event == nil {
t.Fatal("VerifyWebhook() returned nil event")
}
// Mismatched delivery timestamp should fail
_, err = VerifyWebhook(signature, []byte(payload), timestamp+100, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for mismatched timestamp")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhook() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhook_InvalidSignature(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
secret := "test-secret"
timestamp := time.Now().Unix()
// Wrong signature
signature := fmt.Sprintf("t=%d,v1=invalid_hash", timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for invalid signature")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhook() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhook_WrongSecret(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, "correct-secret", timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, "wrong-secret", DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for wrong secret")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhook() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhook_ExpiredTimestamp(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
secret := "test-secret"
// Timestamp from 10 minutes ago
timestamp := time.Now().Add(-10 * time.Minute).Unix()
signature := generateTestSignature(payload, secret, timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for expired timestamp")
}
if !errors.Is(err, ErrWebhookTimestampExpired) {
t.Errorf("VerifyWebhook() error should wrap ErrWebhookTimestampExpired, got %v", err)
}
}
func TestVerifyWebhook_FutureTimestamp(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
secret := "test-secret"
// Timestamp from 10 minutes in the future
timestamp := time.Now().Add(10 * time.Minute).Unix()
signature := generateTestSignature(payload, secret, timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for future timestamp")
}
if !errors.Is(err, ErrWebhookTimestampExpired) {
t.Errorf("VerifyWebhook() error should wrap ErrWebhookTimestampExpired, got %v", err)
}
}
func TestVerifyWebhook_CustomTolerance(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered"}`
secret := "test-secret"
// Timestamp from 2 minutes ago
timestamp := time.Now().Add(-2 * time.Minute).Unix()
signature := generateTestSignature(payload, secret, timestamp)
// Should fail with 1 minute tolerance
_, err := VerifyWebhook(signature, []byte(payload), 0, secret, 1*time.Minute)
if err == nil {
t.Fatal("VerifyWebhook() expected error with 1 minute tolerance")
}
// Should succeed with 5 minute tolerance
event, err := VerifyWebhook(signature, []byte(payload), 0, secret, 5*time.Minute)
if err != nil {
t.Fatalf("VerifyWebhook() error = %v with 5 minute tolerance", err)
}
if event == nil {
t.Fatal("VerifyWebhook() returned nil event")
}
}
func TestVerifyWebhook_MalformedSignature(t *testing.T) {
tests := []struct {
name string
signature string
}{
{"empty", ""},
{"no parts", "invalid"},
{"missing hash", "t=1234567890"},
{"missing timestamp", "v1=abc123"},
{"invalid timestamp", "t=invalid,v1=abc123"},
{"wrong format", "timestamp=1234567890,hash=abc123"},
}
payload := `{"id":"wh_123"}`
secret := "test-secret"
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := VerifyWebhook(tt.signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for malformed signature")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhook() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
})
}
}
func TestVerifyWebhook_EmptySecret(t *testing.T) {
payload := `{"id":"wh_123"}`
timestamp := time.Now().Unix()
signature := fmt.Sprintf("t=%d,v1=abc123", timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, "", DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for empty secret")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhook() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhook_InvalidJSON(t *testing.T) {
payload := `invalid json`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
_, err := VerifyWebhook(signature, []byte(payload), 0, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhook() expected error for invalid JSON")
}
// Should not be a signature error, but a parsing error
if errors.Is(err, ErrInvalidWebhookSignature) {
t.Error("VerifyWebhook() error should not be ErrInvalidWebhookSignature for JSON error")
}
}
func TestVerifyWebhookFromRequest_Success(t *testing.T) {
payload := `{"id":"wh_123","event":"message.delivered","data":{"message_id":"msg_123"}}`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
req := httptest.NewRequest(http.MethodPost, "/webhook", strings.NewReader(payload))
req.Header.Set(HeaderSignature, signature)
req.Header.Set(HeaderDelivery, fmt.Sprintf("%d", timestamp))
event, err := VerifyWebhookFromRequest(req, secret, DefaultWebhookTolerance)
if err != nil {
t.Fatalf("VerifyWebhookFromRequest() error = %v", err)
}
if event == nil {
t.Fatal("VerifyWebhookFromRequest() returned nil event")
}
if event.ID != "wh_123" {
t.Errorf("event.ID = %v, want wh_123", event.ID)
}
}
func TestVerifyWebhookFromRequest_AcceptsBodyLargerThanOneMiB(t *testing.T) {
payload := fmt.Sprintf(
`{"id":"wh_123","event":"message.delivered","data":{"message_id":"%s"}}`,
strings.Repeat("a", 1<<20),
)
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
req := httptest.NewRequest(http.MethodPost, "/webhook", strings.NewReader(payload))
req.Header.Set(HeaderSignature, signature)
req.Header.Set(HeaderDelivery, fmt.Sprintf("%d", timestamp))
event, err := VerifyWebhookFromRequest(req, secret, DefaultWebhookTolerance)
if err != nil {
t.Fatalf("VerifyWebhookFromRequest() error = %v", err)
}
if event.Data.MessageID != strings.Repeat("a", 1<<20) {
t.Fatal("VerifyWebhookFromRequest() did not preserve oversized message_id")
}
}
func TestVerifyWebhookFromRequestWithMaxBodyBytes_RejectsBodyLargerThanLimit(t *testing.T) {
const maxBodyBytes int64 = 32
payload := `{"id":"wh_123","event":"message.delivered","data":{"message_id":"msg_123"}}`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
req := httptest.NewRequest(http.MethodPost, "/webhook", strings.NewReader(payload))
req.Header.Set(HeaderSignature, signature)
req.Header.Set(HeaderDelivery, fmt.Sprintf("%d", timestamp))
_, err := VerifyWebhookFromRequestWithMaxBodyBytes(req, secret, DefaultWebhookTolerance, maxBodyBytes)
if err == nil {
t.Fatal("VerifyWebhookFromRequest() expected error for oversized body")
}
var maxBytesErr *http.MaxBytesError
if !errors.As(err, &maxBytesErr) {
t.Fatalf("VerifyWebhookFromRequest() error should wrap *http.MaxBytesError, got %v", err)
}
if maxBytesErr.Limit != maxBodyBytes {
t.Errorf("MaxBytesError.Limit = %v, want %v", maxBytesErr.Limit, maxBodyBytes)
}
}
func TestVerifyWebhookFromRequest_MissingSignatureHeader(t *testing.T) {
req := httptest.NewRequest(http.MethodPost, "/webhook", strings.NewReader(`{"id":"wh_123"}`))
// No signature header
_, err := VerifyWebhookFromRequest(req, "test-secret", DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhookFromRequest() expected error for missing signature header")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhookFromRequest() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhookFromRequest_InvalidDeliveryHeader(t *testing.T) {
payload := `{"id":"wh_123"}`
secret := "test-secret"
timestamp := time.Now().Unix()
signature := generateTestSignature(payload, secret, timestamp)
req := httptest.NewRequest(http.MethodPost, "/webhook", strings.NewReader(payload))
req.Header.Set(HeaderSignature, signature)
req.Header.Set(HeaderDelivery, "not-a-number")
_, err := VerifyWebhookFromRequest(req, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhookFromRequest() expected error for invalid delivery header")
}
if !errors.Is(err, ErrInvalidWebhookSignature) {
t.Errorf("VerifyWebhookFromRequest() error should wrap ErrInvalidWebhookSignature, got %v", err)
}
}
func TestVerifyWebhookFromRequest_BodyReadError(t *testing.T) {
secret := "test-secret"
timestamp := time.Now().Unix()
signature := fmt.Sprintf("t=%d,v1=abc123", timestamp)
// Create a request with a body that will error on read
req := httptest.NewRequest(http.MethodPost, "/webhook", &errorReader{})
req.Header.Set(HeaderSignature, signature)
_, err := VerifyWebhookFromRequest(req, secret, DefaultWebhookTolerance)
if err == nil {
t.Fatal("VerifyWebhookFromRequest() expected error for body read error")
}
}
// errorReader is a reader that always returns an error
type errorReader struct{}
func (e *errorReader) Read(p []byte) (n int, err error) {
return 0, io.ErrUnexpectedEOF
}
func TestSecureCompare(t *testing.T) {
tests := []struct {
name string
a string
b string
want bool
}{
{"equal strings", "abc123", "abc123", true},
{"different strings", "abc123", "abc456", false},
{"different lengths", "abc", "abcdef", false},
{"empty strings", "", "", true},
{"one empty", "abc", "", false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := secureCompare(tt.a, tt.b); got != tt.want {
t.Errorf("secureCompare() = %v, want %v", got, tt.want)
}
})
}
}