mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-03-26 10:53:05 -04:00
This PR is part of a series (#11311). Adds support for reading and creating repo-secific access tokens through the API via the `GET /users/{username}/tokens`, `POST /users/{username}/tokens`, and `DELETE /users/{username}/tokens/{id}` APIs. Validation rules are included to [restrict repo-specific access tokens to specific scopes](https://codeberg.org/forgejo/design/issues/50#issuecomment-11093951). ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes (can be removed for JavaScript changes) - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/11504): <!--number 11504 --><!--line 0 --><!--description cmVhZCwgY3JlYXRlLCAmIGRlbGV0ZSByZXBvLXNwZWNpZmljIGFjY2VzcyB0b2tlbnMgdmlhIEFQSQ==-->read, create, & delete repo-specific access tokens via API<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11504 Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
68 lines
2.1 KiB
Go
68 lines
2.1 KiB
Go
// Copyright 2026 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
package auth
|
|
|
|
import (
|
|
"context"
|
|
|
|
"forgejo.org/models/db"
|
|
"forgejo.org/modules/timeutil"
|
|
)
|
|
|
|
// Represents a many-to-many join table which indicates specific repositories (RepoID) that can be accessed by an access
|
|
// token (TokenID). An access token's ResourceAllRepos field must be false for records in this table to become active.
|
|
type AccessTokenResourceRepo struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
TokenID int64 `xorm:"NOT NULL REFERENCES(access_token, id)"` // needs to be shortened from "AccessTokenID" for the index to fit MySQL table identifier length restrictions
|
|
RepoID int64 `xorm:"NOT NULL REFERENCES(repository, id)"`
|
|
|
|
CreatedUnix timeutil.TimeStamp `xorm:"created NOT NULL"`
|
|
}
|
|
|
|
func init() {
|
|
db.RegisterModel(new(AccessTokenResourceRepo))
|
|
}
|
|
|
|
func GetRepositoriesAccessibleWithToken(ctx context.Context, accessTokenID int64) ([]*AccessTokenResourceRepo, error) {
|
|
var resources []*AccessTokenResourceRepo
|
|
err := db.GetEngine(ctx).
|
|
Where("token_id = ?", accessTokenID).
|
|
Find(&resources)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return resources, nil
|
|
}
|
|
|
|
func GetRepositoriesAccessibleWithTokens(ctx context.Context, accessTokens []*AccessToken) (map[int64][]*AccessTokenResourceRepo, error) {
|
|
accessTokenIDs := make([]int64, len(accessTokens))
|
|
for i, at := range accessTokens {
|
|
accessTokenIDs[i] = at.ID
|
|
}
|
|
|
|
var resources []*AccessTokenResourceRepo
|
|
err := db.GetEngine(ctx).
|
|
In("token_id", accessTokenIDs).
|
|
Find(&resources)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
retval := make(map[int64][]*AccessTokenResourceRepo)
|
|
for _, resource := range resources {
|
|
retval[resource.TokenID] = append(retval[resource.TokenID], resource)
|
|
}
|
|
return retval, nil
|
|
}
|
|
|
|
func InsertAccessTokenResourceRepos(ctx context.Context, accessTokenID int64, resources []*AccessTokenResourceRepo) error {
|
|
return db.WithTx(ctx, func(ctx context.Context) error {
|
|
for _, resourceRepo := range resources {
|
|
resourceRepo.TokenID = accessTokenID
|
|
if err := db.Insert(ctx, resourceRepo); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
}
|