You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
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>
2 years ago
..
blob.go RepoAssignment ensure to close before overwrite (#19449) 2 years ago
branch.go Move some code into models/git (#19879) 2 years ago
collaborators.go Move some files into models' sub packages (#20262) 2 years ago
commits.go Add `stat` to `ToCommit` function for speed (#21337) 2 years ago
file.go fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2 years ago
fork.go Move access and repo permission to models/perm/access (#19350) 2 years ago
git_hook.go Move macaron to chi (#14293) 3 years ago
git_ref.go Go 1.19 format (#20758) 2 years ago
hook.go Add Webhook authorization header (#20926) 2 years ago
hook_test.go Decouple HookTask from Repository (#17940) 2 years ago
issue.go Use correct page size for link header pagination (#20546) 2 years ago
issue_comment.go Move issues related files into models/issues (#19931) 2 years ago
issue_label.go Add more linters to improve code readability (#19989) 2 years ago
issue_reaction.go Move issues related files into models/issues (#19931) 2 years ago
issue_stopwatch.go Move issues related files into models/issues (#19931) 2 years ago
issue_subscription.go Move issues related files into models/issues (#19931) 2 years ago
issue_tracked_time.go Go 1.19 format (#20758) 2 years ago
key.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2 years ago
label.go Move issues related files into models/issues (#19931) 2 years ago
language.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2 years ago
main_test.go Use queue instead of memory queue in webhook send service (#19390) 2 years ago
migrate.go Move some files into models' sub packages (#20262) 2 years ago
milestone.go fix: some typos (#19956) 2 years ago
mirror.go Add new API endpoints for push mirrors management (#19841) 2 years ago
notes.go Add `stat` to `ToCommit` function for speed (#21337) 2 years ago
patch.go Move issues related files into models/issues (#19931) 2 years ago
pull.go feat: notify doers of a merge when automerging (#21553) 2 years ago
pull_review.go Dismiss prior pull reviews if done via web in review dismiss (#20197) 2 years ago
release.go Move some files into models' sub packages (#20262) 2 years ago
release_attachment.go Move some files into models' sub packages (#20262) 2 years ago
release_tags.go Move some files into models' sub packages (#20262) 2 years ago
repo.go Make external issue tracker regexp configurable via API (#21338) 2 years ago
repo_test.go Renamed ctx.User to ctx.Doer. (#19161) 2 years ago
star.go Renamed ctx.User to ctx.Doer. (#19161) 2 years ago
status.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2 years ago
subscriber.go Renamed ctx.User to ctx.Doer. (#19161) 2 years ago
tag.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2 years ago
teams.go Move some files into models' sub packages (#20262) 2 years ago
topic.go Add missing return for when topic isn't found (#20351) 2 years ago
transfer.go Move almost all functions' parameter db.Engine to context.Context (#19748) 2 years ago
tree.go Propagate context and ensure git commands run in request context (#17868) 2 years ago
wiki.go Webhook for Wiki changes (#20219) 2 years ago