b6e81357bd
_This is a different approach to #20267, I took the liberty of adapting some parts, see below_ ## Context In some cases, a weebhook endpoint requires some kind of authentication. The usual way is by sending a static `Authorization` header, with a given token. For instance: - Matrix expects a `Bearer <token>` (already implemented, by storing the header cleartext in the metadata - which is buggy on retry #19872) - TeamCity #18667 - Gitea instances #20267 - SourceHut https://man.sr.ht/graphql.md#authentication-strategies (this is my actual personal need :) ## Proposed solution Add a dedicated encrypt column to the webhook table (instead of storing it as meta as proposed in #20267), so that it gets available for all present and future hook types (especially the custom ones #19307). This would also solve the buggy matrix retry #19872. As a first step, I would recommend focusing on the backend logic and improve the frontend at a later stage. For now the UI is a simple `Authorization` field (which could be later customized with `Bearer` and `Basic` switches):  The header name is hard-coded, since I couldn't fine any usecase justifying otherwise. ## Questions - What do you think of this approach? @justusbunsi @Gusted @silverwind - ~~How are the migrations generated? Do I have to manually create a new file, or is there a command for that?~~ - ~~I started adding it to the API: should I complete it or should I drop it? (I don't know how much the API is actually used)~~ ## Done as well: - add a migration for the existing matrix webhooks and remove the `Authorization` logic there _Closes #19872_ Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Gusted <williamzijl7@hotmail.com> Co-authored-by: delvh <dev.lh@web.de>
89 lines
2.5 KiB
Go
89 lines
2.5 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package v1_19 //nolint
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/models/migrations/base"
|
|
"code.gitea.io/gitea/models/webhook"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/secret"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func Test_addHeaderAuthorizationEncryptedColWebhook(t *testing.T) {
|
|
// Create Webhook table
|
|
type Webhook struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
Type webhook.HookType `xorm:"VARCHAR(16) 'type'"`
|
|
Meta string `xorm:"TEXT"` // store hook-specific attributes
|
|
|
|
// HeaderAuthorizationEncrypted should be accessed using HeaderAuthorization() and SetHeaderAuthorization()
|
|
HeaderAuthorizationEncrypted string `xorm:"TEXT"`
|
|
}
|
|
|
|
type ExpectedWebhook struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
Meta string
|
|
HeaderAuthorization string
|
|
}
|
|
|
|
type HookTask struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
HookID int64
|
|
PayloadContent string `xorm:"LONGTEXT"`
|
|
}
|
|
|
|
// Prepare and load the testing database
|
|
x, deferable := base.PrepareTestEnv(t, 0, new(Webhook), new(ExpectedWebhook), new(HookTask))
|
|
defer deferable()
|
|
if x == nil || t.Failed() {
|
|
return
|
|
}
|
|
|
|
if err := AddHeaderAuthorizationEncryptedColWebhook(x); err != nil {
|
|
assert.NoError(t, err)
|
|
return
|
|
}
|
|
|
|
expected := []ExpectedWebhook{}
|
|
if err := x.Table("expected_webhook").Asc("id").Find(&expected); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
|
|
got := []Webhook{}
|
|
if err := x.Table("webhook").Select("id, meta, header_authorization_encrypted").Asc("id").Find(&got); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
|
|
for i, e := range expected {
|
|
assert.Equal(t, e.Meta, got[i].Meta)
|
|
|
|
if e.HeaderAuthorization == "" {
|
|
assert.Equal(t, "", got[i].HeaderAuthorizationEncrypted)
|
|
} else {
|
|
cipherhex := got[i].HeaderAuthorizationEncrypted
|
|
cleartext, err := secret.DecryptSecret(setting.SecretKey, cipherhex)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, e.HeaderAuthorization, cleartext)
|
|
}
|
|
}
|
|
|
|
// ensure that no hook_task has some remaining "access_token"
|
|
hookTasks := []HookTask{}
|
|
if err := x.Table("hook_task").Select("id, payload_content").Asc("id").Find(&hookTasks); !assert.NoError(t, err) {
|
|
return
|
|
}
|
|
for _, h := range hookTasks {
|
|
var m map[string]interface{}
|
|
err := json.Unmarshal([]byte(h.PayloadContent), &m)
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, m["access_token"])
|
|
}
|
|
}
|