0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-01-17 20:03:59 -05:00
forgejo/models/migrations/fixtures
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
..
Test_addConfidentialClientColumnToOAuth2ApplicationTable Record OAuth client type at registration () 2022-10-24 15:59:24 +08:00
Test_addHeaderAuthorizationEncryptedColWebhook Add Webhook authorization header () 2022-11-03 20:23:20 +02:00
Test_deleteOrphanedIssueLabels Create Proper Migration Tests () 2021-03-24 19:27:22 +01:00
Test_remigrateU2FCredentials Attempt to fix the webauthn migration again - part 3 () 2022-02-16 21:03:58 +00:00
Test_removeInvalidLabels Create Proper Migration Tests () 2021-03-24 19:27:22 +01:00
Test_storeWebauthnCredentialIDAsBytes WebAuthn CredentialID field needs to be increased in size () 2022-07-30 15:25:26 +02:00
Test_unwrapLDAPSourceCfg Refactor: Move login out of models () 2021-07-24 11:16:34 +01:00
Test_updateOpenMilestoneCounts Update milestone counters when issue is deleted () 2022-10-22 23:08:10 +08:00