2019-04-18 01:06:35 +09:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
2022-11-28 03:20:29 +09:00
|
|
|
// SPDX-License-Identifier: MIT
|
2019-04-18 01:06:35 +09:00
|
|
|
|
2022-09-03 04:18:23 +09:00
|
|
|
package integration
|
2019-04-18 01:06:35 +09:00
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
2019-05-12 00:29:17 +09:00
|
|
|
"net/url"
|
2019-04-18 01:06:35 +09:00
|
|
|
"testing"
|
|
|
|
|
2023-01-18 06:46:03 +09:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2021-12-10 10:27:50 +09:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-16 17:53:21 +09:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 18:49:20 +09:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2019-05-11 19:21:34 +09:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2019-04-18 01:06:35 +09:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
|
|
|
func getDeleteFileOptions() *api.DeleteFileOptions {
|
|
|
|
return &api.DeleteFileOptions{
|
|
|
|
FileOptions: api.FileOptions{
|
|
|
|
BranchName: "master",
|
|
|
|
NewBranchName: "master",
|
2019-06-30 00:19:24 +09:00
|
|
|
Message: "Removing the file new/file.txt",
|
2019-04-18 01:06:35 +09:00
|
|
|
Author: api.Identity{
|
|
|
|
Name: "John Doe",
|
|
|
|
Email: "johndoe@example.com",
|
|
|
|
},
|
|
|
|
Committer: api.Identity{
|
|
|
|
Name: "Jane Doe",
|
|
|
|
Email: "janedoe@example.com",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
SHA: "103ff9234cefeee5ec5361d22b49fbb04d385885",
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPIDeleteFile(t *testing.T) {
|
2019-05-12 00:29:17 +09:00
|
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
2022-08-16 11:22:25 +09:00
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) // owner of the repo1 & repo16
|
2023-09-14 11:59:53 +09:00
|
|
|
org3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3}) // owner of the repo3, is an org
|
2022-08-16 11:22:25 +09:00
|
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4}) // owner of neither repos
|
|
|
|
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) // public repo
|
|
|
|
repo3 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 3}) // public repo
|
|
|
|
repo16 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 16}) // private repo
|
2019-05-12 00:29:17 +09:00
|
|
|
fileID := 0
|
|
|
|
|
|
|
|
// Get user2's token
|
|
|
|
session := loginUser(t, user2.Name)
|
Redesign Scoped Access Tokens (#24767)
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
- `activitypub`
- `admin` (hidden if user is not a site admin)
- `misc`
- `notification`
- `organization`
- `package`
- `issue`
- `repository`
- `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
- `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
- `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
- _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
- _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
- _This should be addressed in this PR_
- For example:
```go
m.Group("/users/{username}/orgs", func() {
m.Get("", reqToken(), org.ListUserOrgs)
m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
2023-06-05 03:57:16 +09:00
|
|
|
token2 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2019-05-12 00:29:17 +09:00
|
|
|
// Get user4's token
|
|
|
|
session = loginUser(t, user4.Name)
|
Redesign Scoped Access Tokens (#24767)
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
- `activitypub`
- `admin` (hidden if user is not a site admin)
- `misc`
- `notification`
- `organization`
- `package`
- `issue`
- `repository`
- `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
- `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
- `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
- _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
- _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
- _This should be addressed in this PR_
- For example:
```go
m.Group("/users/{username}/orgs", func() {
m.Get("", reqToken(), org.ListUserOrgs)
m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
2023-06-05 03:57:16 +09:00
|
|
|
token4 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
|
|
|
// Test deleting a file in repo1 which user2 owns, try both with branch and empty branch
|
|
|
|
for _, branch := range [...]string{
|
|
|
|
"master", // Branch
|
|
|
|
"", // Empty branch
|
|
|
|
} {
|
|
|
|
fileID++
|
|
|
|
treePath := fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo1, treePath)
|
|
|
|
deleteFileOptions := getDeleteFileOptions()
|
|
|
|
deleteFileOptions.BranchName = branch
|
2023-12-22 08:59:59 +09:00
|
|
|
req := NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2019-05-12 00:29:17 +09:00
|
|
|
var fileResponse api.FileResponse
|
|
|
|
DecodeJSON(t, resp, &fileResponse)
|
|
|
|
assert.NotNil(t, fileResponse)
|
|
|
|
assert.Nil(t, fileResponse.Content)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Test deleting file and making the delete in a new branch
|
2019-04-18 01:06:35 +09:00
|
|
|
fileID++
|
|
|
|
treePath := fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo1, treePath)
|
|
|
|
deleteFileOptions := getDeleteFileOptions()
|
2019-05-12 00:29:17 +09:00
|
|
|
deleteFileOptions.BranchName = repo1.DefaultBranch
|
|
|
|
deleteFileOptions.NewBranchName = "new_branch"
|
2023-12-22 08:59:59 +09:00
|
|
|
req := NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2019-04-18 01:06:35 +09:00
|
|
|
var fileResponse api.FileResponse
|
|
|
|
DecodeJSON(t, resp, &fileResponse)
|
|
|
|
assert.NotNil(t, fileResponse)
|
|
|
|
assert.Nil(t, fileResponse.Content)
|
2019-06-30 00:19:24 +09:00
|
|
|
assert.EqualValues(t, deleteFileOptions.Message+"\n", fileResponse.Commit.Message)
|
|
|
|
|
|
|
|
// Test deleting file without a message
|
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo1, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
|
|
|
deleteFileOptions.Message = ""
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2019-06-30 00:19:24 +09:00
|
|
|
DecodeJSON(t, resp, &fileResponse)
|
2023-04-18 07:04:26 +09:00
|
|
|
expectedMessage := "Delete " + treePath + "\n"
|
2019-06-30 00:19:24 +09:00
|
|
|
assert.EqualValues(t, expectedMessage, fileResponse.Commit.Message)
|
2019-04-18 01:06:35 +09:00
|
|
|
|
2019-05-12 00:29:17 +09:00
|
|
|
// Test deleting a file with the wrong SHA
|
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo1, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
|
|
|
deleteFileOptions.SHA = "badsha"
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusBadRequest)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
2019-05-31 00:09:05 +09:00
|
|
|
// Test creating a file in repo16 by user4 who does not have write access
|
2019-05-12 00:29:17 +09:00
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo16, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo16.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token4)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
|
|
|
// Tests a repo with no token given so will fail
|
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo16, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo16.Name, treePath), &deleteFileOptions)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
|
|
|
// Test using access token for a private repo that the user of the token owns
|
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo16, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo16.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusOK)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
2023-09-14 11:59:53 +09:00
|
|
|
// Test using org repo "org3/repo3" where user2 is a collaborator
|
2019-05-12 00:29:17 +09:00
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
2023-09-14 11:59:53 +09:00
|
|
|
createFile(org3, repo3, treePath)
|
2019-05-12 00:29:17 +09:00
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", org3.Name, repo3.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token2)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusOK)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
2023-09-14 11:59:53 +09:00
|
|
|
// Test using org repo "org3/repo3" with no user token
|
2019-05-12 00:29:17 +09:00
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
2023-09-14 11:59:53 +09:00
|
|
|
createFile(org3, repo3, treePath)
|
2019-05-12 00:29:17 +09:00
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", org3.Name, repo3.Name, treePath), &deleteFileOptions)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2019-05-12 00:29:17 +09:00
|
|
|
|
|
|
|
// Test using repo "user2/repo1" where user4 is a NOT collaborator
|
|
|
|
fileID++
|
|
|
|
treePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
|
|
createFile(user2, repo1, treePath)
|
|
|
|
deleteFileOptions = getDeleteFileOptions()
|
2023-12-22 08:59:59 +09:00
|
|
|
req = NewRequestWithJSON(t, "DELETE", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath), &deleteFileOptions).
|
|
|
|
AddTokenAuth(token4)
|
2022-12-02 12:39:42 +09:00
|
|
|
MakeRequest(t, req, http.StatusForbidden)
|
2019-05-12 00:29:17 +09:00
|
|
|
})
|
2019-04-18 01:06:35 +09:00
|
|
|
}
|