diff options
author | Chongyi Zheng <harryzheng25@gmail.com> | 2023-01-17 16:46:03 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-17 15:46:03 -0600 |
commit | de484e86bc495a67d2f122ed438178d587a92526 (patch) | |
tree | 82ebe623a517a31006699a21613c0307020417b0 /models/migrations/v1_19 | |
parent | db2286bbb69f5453f5b184a16a9dca999f3f3eb8 (diff) | |
download | gitea-de484e86bc495a67d2f122ed438178d587a92526.tar.gz gitea-de484e86bc495a67d2f122ed438178d587a92526.zip |
Support scoped access tokens (#20908)
This PR adds the support for scopes of access tokens, mimicking the
design of GitHub OAuth scopes.
The changes of the core logic are in `models/auth` that `AccessToken`
struct will have a `Scope` field. The normalized (no duplication of
scope), comma-separated scope string will be stored in `access_token`
table in the database.
In `services/auth`, the scope will be stored in context, which will be
used by `reqToken` middleware in API calls. Only OAuth2 tokens will have
granular token scopes, while others like BasicAuth will default to scope
`all`.
A large amount of work happens in `routers/api/v1/api.go` and the
corresponding `tests/integration` tests, that is adding necessary scopes
to each of the API calls as they fit.
- [x] Add `Scope` field to `AccessToken`
- [x] Add access control to all API endpoints
- [x] Update frontend & backend for when creating tokens
- [x] Add a database migration for `scope` column (enable 'all' access
to past tokens)
I'm aiming to complete it before Gitea 1.19 release.
Fixes #4300
Diffstat (limited to 'models/migrations/v1_19')
-rw-r--r-- | models/migrations/v1_19/v239.go | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/models/migrations/v1_19/v239.go b/models/migrations/v1_19/v239.go new file mode 100644 index 0000000000..10076f2401 --- /dev/null +++ b/models/migrations/v1_19/v239.go @@ -0,0 +1,22 @@ +// Copyright 2022 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package v1_19 //nolint + +import ( + "xorm.io/xorm" +) + +func AddScopeForAccessTokens(x *xorm.Engine) error { + type AccessToken struct { + Scope string + } + + if err := x.Sync(new(AccessToken)); err != nil { + return err + } + + // all previous tokens have `all` and `sudo` scopes + _, err := x.Exec("UPDATE access_token SET scope = ? WHERE scope IS NULL OR scope = ''", "all,sudo") + return err +} |