forgejo/services
oliverpool b6e81357bd
Add Webhook authorization header ()
_This is a different approach to , 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 )
- TeamCity 
- Gitea instances 
- 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 ), so that it gets available for all
present and future hook types (especially the custom ones ).

This would also solve the buggy matrix retry .

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
..
agit Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
asymkey Refactor AssertExistsAndLoadBean to use generics () 2022-08-16 10:22:25 +08:00
attachment Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
auth Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
automerge feat: notify doers of a merge when automerging () 2022-11-03 23:49:00 +08:00
comments Move issues related files into models/issues () 2022-06-13 17:37:59 +08:00
context Move almost all functions' parameter db.Engine to context.Context () 2022-05-20 22:08:52 +08:00
cron Refactor git command arguments and make all arguments to be safe to be used () 2022-10-23 22:44:45 +08:00
externalaccount Refactor auth package () 2022-01-02 21:12:35 +08:00
forms Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
gitdiff Refactor git command arguments and make all arguments to be safe to be used () 2022-10-23 22:44:45 +08:00
issue Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
lfs Prevent Authorization header for presigned LFS urls () 2022-10-22 21:36:44 +08:00
mailer feat: notify doers of a merge when automerging () 2022-11-03 23:49:00 +08:00
markup Link mentioned user in markdown only if they are visible to viewer () 2022-10-23 17:13:52 +08:00
migrations Handle branch name with prefix in GitHub migration () 2022-11-03 10:32:52 +08:00
mirror Refactor git command arguments and make all arguments to be safe to be used () 2022-10-23 22:44:45 +08:00
org Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
packages Replace ServeStream with ServeContent () 2022-08-25 12:05:21 -04:00
pull feat: notify doers of a merge when automerging () 2022-11-03 23:49:00 +08:00
release Revert "Do not send notifications for draft releases ()" () 2022-10-26 00:00:00 +02:00
repository Fix repository adoption on Windows () 2022-10-31 23:16:48 +00:00
task Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
user Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
webhook Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
wiki Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00