forgejo/services/webhook
oliverpool b6e81357bd
Add Webhook authorization header (#20926)
_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):


![2022-08-23-142911](https://user-images.githubusercontent.com/3864879/186162483-5b721504-eef5-4932-812e-eb96a68494cc.png)

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>
2022-11-03 20:23:20 +02:00
..
deliver.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
deliver_test.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
dingtalk.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
dingtalk_test.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
discord.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
discord_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
feishu.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
feishu_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
general.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
general_test.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
main_test.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
matrix.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
matrix_test.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
msteams.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
msteams_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
packagist.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
packagist_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
payloader.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
slack.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
slack_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
telegram.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00
telegram_test.go Webhook for Wiki changes (#20219) 2022-09-04 20:54:23 +01:00
webhook.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2022-10-24 20:29:17 +01:00
webhook_test.go Decouple HookTask from Repository (#17940) 2022-10-21 18:21:56 +02:00
wechatwork.go Display total commit count in hook message (#21400) 2022-10-17 00:22:34 +08:00