mirror of
				https://gitcode.com/gitea/gitea.git
				synced 2025-10-25 12:26:40 +08:00 
			
		
		
		
	 18de83b2a3
			
		
	
	18de83b2a3
	
	
	
		
			
			## 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>
		
	
		
			
				
	
	
		
			183 lines
		
	
	
		
			6.3 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			183 lines
		
	
	
		
			6.3 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| // bootstrap module must be the first one to be imported, it handles webpack lazy-loading and global errors
 | |
| import './bootstrap.js';
 | |
| 
 | |
| import {initRepoActivityTopAuthorsChart} from './components/RepoActivityTopAuthors.vue';
 | |
| import {initScopedAccessTokenCategories} from './components/ScopedAccessTokenSelector.vue';
 | |
| import {initDashboardRepoList} from './components/DashboardRepoList.vue';
 | |
| 
 | |
| import {initGlobalCopyToClipboardListener} from './features/clipboard.js';
 | |
| import {initContextPopups} from './features/contextpopup.js';
 | |
| import {initRepoGraphGit} from './features/repo-graph.js';
 | |
| import {initHeatmap} from './features/heatmap.js';
 | |
| import {initImageDiff} from './features/imagediff.js';
 | |
| import {initRepoMigration} from './features/repo-migration.js';
 | |
| import {initRepoProject} from './features/repo-projects.js';
 | |
| import {initTableSort} from './features/tablesort.js';
 | |
| import {initAdminUserListSearchForm} from './features/admin/users.js';
 | |
| import {initAdminConfigs} from './features/admin/config.js';
 | |
| import {initMarkupAnchors} from './markup/anchors.js';
 | |
| import {initNotificationCount, initNotificationsTable} from './features/notification.js';
 | |
| import {initRepoIssueContentHistory} from './features/repo-issue-content.js';
 | |
| import {initStopwatch} from './features/stopwatch.js';
 | |
| import {initFindFileInRepo} from './features/repo-findfile.js';
 | |
| import {initCommentContent, initMarkupContent} from './markup/content.js';
 | |
| import {initPdfViewer} from './render/pdf.js';
 | |
| 
 | |
| import {initUserAuthLinkAccountView, initUserAuthOauth2} from './features/user-auth.js';
 | |
| import {
 | |
|   initRepoIssueDue,
 | |
|   initRepoIssueReferenceRepositorySearch,
 | |
|   initRepoIssueTimeTracking,
 | |
|   initRepoIssueWipTitle,
 | |
|   initRepoPullRequestMergeInstruction,
 | |
|   initRepoPullRequestAllowMaintainerEdit,
 | |
|   initRepoPullRequestReview, initRepoIssueSidebarList
 | |
| } from './features/repo-issue.js';
 | |
| import {
 | |
|   initRepoEllipsisButton,
 | |
|   initRepoCommitLastCommitLoader,
 | |
|   initCommitStatuses,
 | |
| } from './features/repo-commit.js';
 | |
| import {
 | |
|   initFootLanguageMenu,
 | |
|   initGlobalButtonClickOnEnter,
 | |
|   initGlobalButtons,
 | |
|   initGlobalCommon,
 | |
|   initGlobalDropzone,
 | |
|   initGlobalEnterQuickSubmit,
 | |
|   initGlobalFormDirtyLeaveConfirm,
 | |
|   initGlobalLinkActions,
 | |
|   initHeadNavbarContentToggle,
 | |
| } from './features/common-global.js';
 | |
| import {initRepoTopicBar} from './features/repo-home.js';
 | |
| import {initAdminEmails} from './features/admin/emails.js';
 | |
| import {initAdminCommon} from './features/admin/common.js';
 | |
| import {initRepoTemplateSearch} from './features/repo-template.js';
 | |
| import {initRepoCodeView} from './features/repo-code.js';
 | |
| import {initSshKeyFormParser} from './features/sshkey-helper.js';
 | |
| import {initUserSettings} from './features/user-settings.js';
 | |
| import {initRepoArchiveLinks} from './features/repo-common.js';
 | |
| import {initRepoMigrationStatusChecker} from './features/repo-migrate.js';
 | |
| import {
 | |
|   initRepoSettingGitHook,
 | |
|   initRepoSettingsCollaboration,
 | |
|   initRepoSettingSearchTeamBox,
 | |
| } from './features/repo-settings.js';
 | |
| import {initRepoDiffView} from './features/repo-diff.js';
 | |
| import {initOrgTeamSearchRepoBox, initOrgTeamSettings} from './features/org-team.js';
 | |
| import {initUserAuthWebAuthn, initUserAuthWebAuthnRegister} from './features/user-auth-webauthn.js';
 | |
| import {initRepoRelease, initRepoReleaseNew} from './features/repo-release.js';
 | |
| import {initRepoEditor} from './features/repo-editor.js';
 | |
| import {initCompSearchUserBox} from './features/comp/SearchUserBox.js';
 | |
| import {initInstall} from './features/install.js';
 | |
| import {initCompWebHookEditor} from './features/comp/WebHookEditor.js';
 | |
| import {initRepoBranchButton} from './features/repo-branch.js';
 | |
| import {initCommonOrganization} from './features/common-organization.js';
 | |
| import {initRepoWikiForm} from './features/repo-wiki.js';
 | |
| import {initRepoCommentForm, initRepository} from './features/repo-legacy.js';
 | |
| import {initCopyContent} from './features/copycontent.js';
 | |
| import {initCaptcha} from './features/captcha.js';
 | |
| import {initRepositoryActionView} from './components/RepoActionView.vue';
 | |
| import {initGlobalTooltips} from './modules/tippy.js';
 | |
| import {initGiteaFomantic} from './modules/fomantic.js';
 | |
| import {onDomReady} from './utils/dom.js';
 | |
| import {initRepoIssueList} from './features/repo-issue-list.js';
 | |
| import {initCommonIssueListQuickGoto} from './features/common-issue-list.js';
 | |
| 
 | |
| // Init Gitea's Fomantic settings
 | |
| initGiteaFomantic();
 | |
| 
 | |
| onDomReady(() => {
 | |
|   initGlobalCommon();
 | |
| 
 | |
|   initGlobalTooltips();
 | |
|   initGlobalButtonClickOnEnter();
 | |
|   initGlobalButtons();
 | |
|   initGlobalCopyToClipboardListener();
 | |
|   initGlobalDropzone();
 | |
|   initGlobalEnterQuickSubmit();
 | |
|   initGlobalFormDirtyLeaveConfirm();
 | |
|   initGlobalLinkActions();
 | |
| 
 | |
|   initCommonOrganization();
 | |
|   initCommonIssueListQuickGoto();
 | |
| 
 | |
|   initCompSearchUserBox();
 | |
|   initCompWebHookEditor();
 | |
| 
 | |
|   initInstall();
 | |
| 
 | |
|   initHeadNavbarContentToggle();
 | |
|   initFootLanguageMenu();
 | |
| 
 | |
|   initCommentContent();
 | |
|   initContextPopups();
 | |
|   initHeatmap();
 | |
|   initImageDiff();
 | |
|   initMarkupAnchors();
 | |
|   initMarkupContent();
 | |
|   initSshKeyFormParser();
 | |
|   initStopwatch();
 | |
|   initTableSort();
 | |
|   initFindFileInRepo();
 | |
|   initCopyContent();
 | |
| 
 | |
|   initAdminCommon();
 | |
|   initAdminEmails();
 | |
|   initAdminUserListSearchForm();
 | |
|   initAdminConfigs();
 | |
| 
 | |
|   initDashboardRepoList();
 | |
| 
 | |
|   initNotificationCount();
 | |
|   initNotificationsTable();
 | |
| 
 | |
|   initOrgTeamSearchRepoBox();
 | |
|   initOrgTeamSettings();
 | |
| 
 | |
|   initRepoActivityTopAuthorsChart();
 | |
|   initRepoArchiveLinks();
 | |
|   initRepoBranchButton();
 | |
|   initRepoCodeView();
 | |
|   initRepoCommentForm();
 | |
|   initRepoEllipsisButton();
 | |
|   initRepoCommitLastCommitLoader();
 | |
|   initRepoEditor();
 | |
|   initRepoGraphGit();
 | |
|   initRepoIssueContentHistory();
 | |
|   initRepoIssueDue();
 | |
|   initRepoIssueList();
 | |
|   initRepoIssueSidebarList();
 | |
|   initRepoIssueReferenceRepositorySearch();
 | |
|   initRepoIssueTimeTracking();
 | |
|   initRepoIssueWipTitle();
 | |
|   initRepoMigration();
 | |
|   initRepoMigrationStatusChecker();
 | |
|   initRepoProject();
 | |
|   initRepoPullRequestMergeInstruction();
 | |
|   initRepoPullRequestAllowMaintainerEdit();
 | |
|   initRepoPullRequestReview();
 | |
|   initRepoRelease();
 | |
|   initRepoReleaseNew();
 | |
|   initRepoSettingGitHook();
 | |
|   initRepoSettingSearchTeamBox();
 | |
|   initRepoSettingsCollaboration();
 | |
|   initRepoTemplateSearch();
 | |
|   initRepoTopicBar();
 | |
|   initRepoWikiForm();
 | |
|   initRepository();
 | |
|   initRepositoryActionView();
 | |
| 
 | |
|   initCommitStatuses();
 | |
|   initCaptcha();
 | |
| 
 | |
|   initUserAuthLinkAccountView();
 | |
|   initUserAuthOauth2();
 | |
|   initUserAuthWebAuthn();
 | |
|   initUserAuthWebAuthnRegister();
 | |
|   initUserSettings();
 | |
|   initRepoDiffView();
 | |
|   initPdfViewer();
 | |
|   initScopedAccessTokenCategories();
 | |
| });
 |