forgejo/routers/api/v1
Giteabot 0e3a5abb69
Deprecate query string auth tokens (#28390) (#28430)
Backport #28390 by @jackHay22

## Changes
- Add deprecation warning to `Token` and `AccessToken` authentication
methods in swagger.
- Add deprecation warning header to API response. Example:
  ```
  HTTP/1.1 200 OK
  ...
  Warning: token and access_token API authentication is deprecated
  ...
  ```
- Add setting `DISABLE_QUERY_AUTH_TOKEN` to reject query string auth
tokens entirely. Default is `false`

## Next steps
- `DISABLE_QUERY_AUTH_TOKEN` should be true in a subsequent release and
the methods should be removed in swagger
- `DISABLE_QUERY_AUTH_TOKEN` should be removed and the implementation of
the auth methods in question should be removed

## Open questions
- Should there be further changes to the swagger documentation?
Deprecation is not yet supported for security definitions (coming in
[OpenAPI Spec version
3.2.0](https://github.com/OAI/OpenAPI-Specification/issues/2506))
- Should the API router logger sanitize urls that use `token` or
`access_token`? (This is obviously an insufficient solution on its own)

Co-authored-by: Jack Hay <jack@allspice.io>
Co-authored-by: delvh <dev.lh@web.de>
(cherry picked from commit f144521aea)
2023-12-12 15:21:33 +01:00
..
activitypub More refactoring of db.DefaultContext (#27083) 2023-09-15 06:13:19 +00:00
admin Another round of db.DefaultContext refactor (#27103) (#27262) 2023-09-25 19:24:35 +02:00
misc [BRANDING] Update nodeinfo branding 2023-11-13 13:58:18 +01:00
notify More db.DefaultContext refactor (#27265) (#27347) 2023-09-29 13:35:01 +00:00
org [MODERATION] User blocking 2023-11-13 13:58:02 +01:00
packages Another round of db.DefaultContext refactor (#27103) (#27262) 2023-09-25 19:24:35 +02:00
repo Also sync DB branches on push if necessary (#28361) (#28403) 2023-12-12 15:21:33 +01:00
settings Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
swagger [MODERATION] User blocking 2023-11-13 13:58:02 +01:00
user Fix comment permissions (#28213) (#28216) 2023-11-26 13:56:50 +01:00
utils Fix comment permissions (#28213) (#28216) 2023-11-26 13:56:50 +01:00
api.go Deprecate query string auth tokens (#28390) (#28430) 2023-12-12 15:21:33 +01:00