forgejo/templates
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
..
admin Allow package version sorting (#21453) 2022-10-23 09:18:15 +08:00
api/packages/pypi Add Package Registry (#16510) 2022-03-30 16:42:47 +08:00
base Remove useless appVer from JS window.config (#21445) 2022-10-14 01:16:27 +08:00
code Run make fmt (#21437) 2022-10-13 21:33:54 -04:00
custom Add footer extra links template (#9576) 2020-01-03 20:41:56 +02:00
explore Localize all timestamps (#21440) 2022-10-17 12:08:21 +08:00
mail Add team member invite by email (#20307) 2022-10-19 14:40:28 +02:00
org Add team member invite by email (#20307) 2022-10-19 14:40:28 +02:00
package Allow package version sorting (#21453) 2022-10-23 09:18:15 +08:00
repo Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
shared Localize all timestamps (#21440) 2022-10-17 12:08:21 +08:00
status Remove fomantic image module (#21145) 2022-09-12 17:08:46 +08:00
swagger Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
user Added missing headers on user packages page (#21172) 2022-10-24 20:01:05 +08:00
home.tmpl Refactor i18n to locale (#20153) 2022-06-27 15:58:46 -05:00
install.tmpl Configure update checker on installation page (#21655) 2022-11-01 19:23:56 +00:00
post-install.tmpl Rename StaticUrlPrefix to AssetUrlPrefix (#15779) 2021-05-08 16:27:25 +02:00