You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

migrate_test.go 3.5KB

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>
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. // Copyright 2021 The Gitea Authors. All rights reserved.
  2. // SPDX-License-Identifier: MIT
  3. package integration
  4. import (
  5. "fmt"
  6. "net/http"
  7. "net/url"
  8. "os"
  9. "path/filepath"
  10. "testing"
  11. auth_model "code.gitea.io/gitea/models/auth"
  12. repo_model "code.gitea.io/gitea/models/repo"
  13. "code.gitea.io/gitea/models/unittest"
  14. user_model "code.gitea.io/gitea/models/user"
  15. "code.gitea.io/gitea/modules/setting"
  16. "code.gitea.io/gitea/modules/structs"
  17. "code.gitea.io/gitea/services/migrations"
  18. "github.com/stretchr/testify/assert"
  19. )
  20. func TestMigrateLocalPath(t *testing.T) {
  21. assert.NoError(t, unittest.PrepareTestDatabase())
  22. adminUser := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user1"})
  23. old := setting.ImportLocalPaths
  24. setting.ImportLocalPaths = true
  25. basePath := t.TempDir()
  26. lowercasePath := filepath.Join(basePath, "lowercase")
  27. err := os.Mkdir(lowercasePath, 0o700)
  28. assert.NoError(t, err)
  29. err = migrations.IsMigrateURLAllowed(lowercasePath, adminUser)
  30. assert.NoError(t, err, "case lowercase path")
  31. mixedcasePath := filepath.Join(basePath, "mIxeDCaSe")
  32. err = os.Mkdir(mixedcasePath, 0o700)
  33. assert.NoError(t, err)
  34. err = migrations.IsMigrateURLAllowed(mixedcasePath, adminUser)
  35. assert.NoError(t, err, "case mixedcase path")
  36. setting.ImportLocalPaths = old
  37. }
  38. func TestMigrateGiteaForm(t *testing.T) {
  39. onGiteaRun(t, func(t *testing.T, u *url.URL) {
  40. AllowLocalNetworks := setting.Migrations.AllowLocalNetworks
  41. setting.Migrations.AllowLocalNetworks = true
  42. AppVer := setting.AppVer
  43. // Gitea SDK (go-sdk) need to parse the AppVer from server response, so we must set it to a valid version string.
  44. setting.AppVer = "1.16.0"
  45. defer func() {
  46. setting.Migrations.AllowLocalNetworks = AllowLocalNetworks
  47. setting.AppVer = AppVer
  48. migrations.Init()
  49. }()
  50. assert.NoError(t, migrations.Init())
  51. ownerName := "user2"
  52. repoName := "repo1"
  53. repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: ownerName})
  54. session := loginUser(t, ownerName)
  55. token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeReadMisc)
  56. // Step 0: verify the repo is available
  57. req := NewRequestf(t, "GET", fmt.Sprintf("/%s/%s", ownerName, repoName))
  58. _ = session.MakeRequest(t, req, http.StatusOK)
  59. // Step 1: get the Gitea migration form
  60. req = NewRequestf(t, "GET", "/repo/migrate/?service_type=%d", structs.GiteaService)
  61. resp := session.MakeRequest(t, req, http.StatusOK)
  62. // Step 2: load the form
  63. htmlDoc := NewHTMLParser(t, resp.Body)
  64. link, exists := htmlDoc.doc.Find(`form.ui.form[action^="/repo/migrate"]`).Attr("action")
  65. assert.True(t, exists, "The template has changed")
  66. // Step 4: submit the migration to only migrate issues
  67. migratedRepoName := "otherrepo"
  68. req = NewRequestWithValues(t, "POST", link, map[string]string{
  69. "_csrf": htmlDoc.GetCSRF(),
  70. "service": fmt.Sprintf("%d", structs.GiteaService),
  71. "clone_addr": fmt.Sprintf("%s%s/%s", u, ownerName, repoName),
  72. "auth_token": token,
  73. "issues": "on",
  74. "repo_name": migratedRepoName,
  75. "description": "",
  76. "uid": fmt.Sprintf("%d", repoOwner.ID),
  77. })
  78. resp = session.MakeRequest(t, req, http.StatusSeeOther)
  79. // Step 5: a redirection displays the migrated repository
  80. loc := resp.Header().Get("Location")
  81. assert.EqualValues(t, fmt.Sprintf("/%s/%s", ownerName, migratedRepoName), loc)
  82. // Step 6: check the repo was created
  83. unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{Name: migratedRepoName})
  84. })
  85. }