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

Update GitHub signature header to use sha256 #123

Merged
merged 2 commits into from
Jan 25, 2022
Merged

Update GitHub signature header to use sha256 #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed9176b
Update GitHub signature header to use sha256
nlecoy Oct 5, 2021
05ca388
fix: Add fallback for GitHub webhook signature check
nlecoy Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion scm/driver/github/webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ func (s *webhookService) Parse(req *http.Request, fn scm.SecretFunc) (scm.Webhoo
return hook, nil
}

sig := req.Header.Get("X-Hub-Signature")
sig := req.Header.Get("X-Hub-Signature-256")
bradrydzewski marked this conversation as resolved.
Show resolved Hide resolved
if sig == "" {
sig = req.Header.Get("X-Hub-Signature")
}
if !hmac.ValidatePrefix(data, []byte(key), sig) {
return hook, scm.ErrSignatureInvalid
}
Expand Down
21 changes: 19 additions & 2 deletions scm/driver/github/webhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ func TestWebhooks(t *testing.T) {
buf := bytes.NewBuffer(before)
r, _ := http.NewRequest("GET", "/", buf)
r.Header.Set("X-GitHub-Event", test.event)
r.Header.Set("X-Hub-Signature", "sha1=380f462cd2e160b84765144beabdad2e930a7ec5")
r.Header.Set("X-Hub-Signature-256", "sha256=3bfbbc3bfc44498db2254f577b2e4bed201ece6163518ba91cb2c21f0f59d512")
r.Header.Set("X-GitHub-Delivery", "f2467dea-70d6-11e8-8955-3c83993e0aef")

s := new(webhookService)
Expand Down Expand Up @@ -259,7 +259,7 @@ func TestWebhookInvalid(t *testing.T) {
r, _ := http.NewRequest("GET", "/", bytes.NewBuffer(f))
r.Header.Set("X-GitHub-Event", "push")
r.Header.Set("X-GitHub-Delivery", "ee8d97b4-1479-43f1-9cac-fbbd1b80da55")
r.Header.Set("X-Hub-Signature", "sha1=380f462cd2e160b84765144beabdad2e930a7ec5")
r.Header.Set("X-Hub-Signature-256", "sha256=3bfbbc3bfc44498db2254f577b2e4bed201ece6163518ba91cb2c21f0f59d512")

s := new(webhookService)
_, err := s.Parse(r, secretFunc)
Expand All @@ -269,6 +269,23 @@ func TestWebhookInvalid(t *testing.T) {
}

func TestWebhookValid(t *testing.T) {
// the sha can be recalculated with the below command
// openssl dgst -sha256 -hmac <secret> <file>

f, _ := ioutil.ReadFile("testdata/webhooks/push.json")
r, _ := http.NewRequest("GET", "/", bytes.NewBuffer(f))
r.Header.Set("X-GitHub-Event", "push")
r.Header.Set("X-GitHub-Delivery", "ee8d97b4-1479-43f1-9cac-fbbd1b80da55")
r.Header.Set("X-Hub-Signature-256", "sha256=e3bfe744d4e2e29ed990bde8acfb8255ca51ef65f99657767989fb6349f32957")

s := new(webhookService)
_, err := s.Parse(r, secretFunc)
if err != nil {
t.Errorf("Expect valid signature, got %v", err)
}
}

func TestWebhookSignatureFallback(t *testing.T) {
// the sha can be recalculated with the below command
// openssl dgst -sha1 -hmac <secret> <file>

Expand Down