1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-22 08:42:32 -05:00
forgejo/services/forms
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.go Add Visible modes function from Organisation to Users too (#16069) 2021-06-26 20:53:14 +01:00
auth_form.go Rework mailer settings (#18982) 2022-08-02 13:24:18 +08:00
org.go Team permission allow different unit has different permission (#17811) 2022-01-05 11:37:00 +08:00
repo_branch_form.go Keep path when creating a new branch (#21153) 2022-09-15 21:25:16 +08:00
repo_form.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
repo_form_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
repo_tag_form.go Add tag protection (#15629) 2021-06-25 16:28:55 +02:00
user_form.go Configure update checker on installation page (#21655) 2022-11-01 19:23:56 +00:00
user_form_auth_openid.go Add support mCaptcha as captcha provider (#20458) 2022-08-10 15:20:10 +02:00
user_form_hidden_comments.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
user_form_test.go Move modules/forms to services/forms (#15305) 2021-04-06 20:44:05 +01:00