/
webhook_test.go
233 lines (210 loc) · 5.96 KB
/
webhook_test.go
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
package svix_test
import (
"fmt"
"net/http"
"strings"
"testing"
"time"
svix "github.com/svix/svix-webhooks/go"
)
var defaultMsgID = "msg_p5jXN8AQM9LWM0D4loKWxJek"
var defaultPayload = []byte(`{"test": 2432232314}`)
var defaultSecret = "MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
var tolerance time.Duration = 5 * time.Minute
type testPayload struct {
id string
timestamp time.Time
header http.Header
secret string
payload []byte
signature string
}
func newTestPayload(timestamp time.Time) *testPayload {
tp := &testPayload{}
tp.id = defaultMsgID
tp.timestamp = timestamp
tp.payload = defaultPayload
tp.secret = defaultSecret
wh, _ := svix.NewWebhook(tp.secret)
tp.signature, _ = wh.Sign(tp.id, tp.timestamp, tp.payload)
tp.header = http.Header{}
tp.header.Set("svix-id", tp.id)
tp.header.Set("svix-signature", tp.signature)
tp.header.Set("svix-timestamp", fmt.Sprint(tp.timestamp.Unix()))
return tp
}
func TestWebhook(t *testing.T) {
testCases := []struct {
name string
testPayload *testPayload
modifyPayload func(*testPayload)
noEnforceTimestamp bool
expectedErr bool
}{
{
name: "valid signature is valid",
testPayload: newTestPayload(time.Now()),
expectedErr: false,
},
{
name: "valid unbranded signature is valid",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
unbrandedHeaders := http.Header{}
unbrandedHeaders.Set("webhook-id", tp.header.Get("svix-id"))
unbrandedHeaders.Set("webhook-timestamp", tp.header.Get("svix-timestamp"))
unbrandedHeaders.Set("webhook-signature", tp.header.Get("svix-signature"))
tp.header = unbrandedHeaders
},
expectedErr: false,
},
{
name: "missing id returns error",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Del("svix-id")
},
expectedErr: true,
},
{
name: "missing timestamp returns error",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Del("svix-timestamp")
},
expectedErr: true,
},
{
name: "missing signature returns error",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Del("svix-signature")
},
expectedErr: true,
},
{
name: "invalid signature is invalid",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Set("svix-signature", "v1,Ceo5qEr07ixe2NLpvHk3FH9bwy/WavXrAFQ/9tdO6mc=")
},
expectedErr: true,
},
{
name: "partial signature is invalid",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Set("svix-signature", "v1,")
},
expectedErr: true,
},
{
name: "old timestamp fails",
testPayload: newTestPayload(time.Now().Add(tolerance * -1)),
expectedErr: true,
},
{
name: "new timestamp fails",
testPayload: newTestPayload(time.Now().Add(tolerance + time.Second)),
expectedErr: true,
},
{
name: "valid multi sig is valid",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
sigs := []string{
"v1,Ceo5qEr07ixe2NLpvHk3FH9bwy/WavXrAFQ/9tdO6mc=",
"v2,Ceo5qEr07ixe2NLpvHk3FH9bwy/WavXrAFQ/9tdO6mc=",
tp.header.Get("svix-signature"), // valid signature
"v1,Ceo5qEr07ixe2NLpvHk3FH9bwy/WavXrAFQ/9tdO6mc=",
}
tp.header.Set("svix-signature", strings.Join(sigs, " "))
},
expectedErr: false,
},
{
name: "old timestamp passes when ignoring tolerance",
testPayload: newTestPayload(time.Now().Add(tolerance * -1)),
noEnforceTimestamp: true,
expectedErr: false,
},
{
name: "new timestamp passes when ignoring tolerance",
testPayload: newTestPayload(time.Now().Add(tolerance * 1)),
noEnforceTimestamp: true,
expectedErr: false,
},
{
name: "valid timestamp passes when ignoring tolerance",
testPayload: newTestPayload(time.Now()),
noEnforceTimestamp: true,
expectedErr: false,
},
{
name: "invalid timestamp fails when ignoring tolerance",
testPayload: newTestPayload(time.Now()),
modifyPayload: func(tp *testPayload) {
tp.header.Set("svix-timestamp", fmt.Sprint(time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC).Unix()))
},
noEnforceTimestamp: true,
expectedErr: true,
},
}
for _, tc := range testCases {
if tc.modifyPayload != nil {
tc.modifyPayload(tc.testPayload)
}
wh, err := svix.NewWebhook(tc.testPayload.secret)
if err != nil {
t.Error(err)
continue
}
if tc.noEnforceTimestamp {
err = wh.VerifyIgnoringTimestamp(tc.testPayload.payload, tc.testPayload.header)
} else {
err = wh.Verify(tc.testPayload.payload, tc.testPayload.header)
}
if err != nil && !tc.expectedErr {
t.Errorf("%s: failed with err %s but shouldn't have", tc.name, err.Error())
} else if err == nil && tc.expectedErr {
t.Errorf("%s: didn't error but should have", tc.name)
}
}
}
func TestWebhookPrefix(t *testing.T) {
tp := newTestPayload(time.Now())
wh, err := svix.NewWebhook(tp.secret)
if err != nil {
t.Fatal(err)
}
err = wh.Verify(tp.payload, tp.header)
if err != nil {
t.Fatal(err)
}
wh, err = svix.NewWebhook(fmt.Sprintf("whsec_%s", tp.secret))
if err != nil {
t.Fatal(err)
}
err = wh.Verify(tp.payload, tp.header)
if err != nil {
t.Fatal(err)
}
}
func TestWebhookSign(t *testing.T) {
key := "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
msgID := "msg_p5jXN8AQM9LWM0D4loKWxJek"
timestamp := time.Unix(1614265330, 0)
payload := []byte(`{"test": 2432232314}`)
expected := "v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE="
wh, err := svix.NewWebhook(key)
if err != nil {
t.Fatal(err)
}
signature, err := wh.Sign(msgID, timestamp, payload)
if err != nil {
t.Fatal(err)
}
if signature != expected {
t.Fatalf("signature %s != expected signature %s", signature, expected)
}
}