gitea/routers/api/v1
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
..
activitypub Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
admin Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
misc Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) () 2022-10-24 20:29:17 +01:00
notify Move some files into models' sub packages () 2022-08-25 10:31:57 +08:00
org Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
packages Add support for Vagrant packages () 2022-08-29 15:04:45 +08:00
repo Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
settings Make mirror feature more configurable () 2021-09-07 17:49:36 +02:00
swagger Add API endpoint to get changed files of a PR () 2022-09-29 04:27:20 +02:00
user Record OAuth client type at registration () 2022-10-24 15:59:24 +08:00
utils Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
api.go Add API endpoint to get changed files of a PR () 2022-09-29 04:27:20 +02:00
auth.go Remove legacy `+build:` constraint () 2022-05-02 23:22:45 +08:00
auth_windows.go Let web and API routes have different auth methods group () 2022-03-28 12:46:28 +08:00