1
1
mirror of https://github.com/go-gitea/gitea synced 2024-12-25 01:54:26 +00:00
gitea/modules/convert
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
..
convert.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
git_commit_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
git_commit.go Add stat to ToCommit function for speed (#21337) 2022-10-06 11:21:04 +08:00
issue_comment.go Fix 500 on time tracking in timeline API (#21052) 2022-09-04 15:01:23 +01:00
issue_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
issue.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
main_test.go Use a struct as test options (#19393) 2022-04-14 21:58:21 +08:00
mirror.go Add new API endpoints for push mirrors management (#19841) 2022-07-30 18:45:59 +02:00
notification.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
package.go Move access and repo permission to models/perm/access (#19350) 2022-05-11 12:09:36 +02:00
pull_review.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
pull_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
pull.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
release.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
repository.go Make external issue tracker regexp configurable via API (#21338) 2022-10-07 20:49:30 +08:00
status.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
user_test.go Refactor AssertExistsAndLoadBean to use generics (#20797) 2022-08-16 10:22:25 +08:00
user.go Include login_name in adminCreateUser response (#20283) 2022-07-15 16:52:11 +08:00
utils_test.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
utils.go Add migration from GitBucket (#16767) 2021-11-14 20:11:10 +01:00
wiki.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00