Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork6.3k
feat: Add configurable permissions for Actions automatic tokens#36173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
Excellencedev wants to merge18 commits intogo-gitea:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+1,195 −12
Open
Changes from14 commits
Commits
Show all changes
18 commits Select commitHold shift + click to select a range
3a10e8f feat: Add configurable permissions for Actions automatic tokens
Excellencedev249794c Merge branch 'main' into fix-24635
Excellencedeve20d12e Merge branch 'main' into fix-24635
Excellencedev9a69f65 Adress all review comments
Excellencedev43e96d5 WIP
Excellencedev2a204e3 WIP
Excellencedev297ecef Final core implementation changes
Excellencedevbd4420e Merge branch 'main' into fix-24635
Excellencedev5317bb0 Fix lints
Excellencedev0682fd8 Fix test
Excellencedevfd1afc5 Fixing Test Failures for Token Permissions
Excellencedeva4aae82 Fix test
Excellencedev65051b1 Fix checks
Excellencedeva6b6e70 update tesr
Excellencedevb900c5c Merge branch 'main' into fix-24635
Excellencedev5eb2f12 wip
Excellencedev92506da Merge branch 'fix-24635' of https://github.com/Excellencedev/gitea in…
Excellencedev8daef63 Adress all reviewer feedback
ExcellencedevFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
43 changes: 43 additions & 0 deletionsmodels/actions/config.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
Excellencedev marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // SPDX-License-Identifier: MIT | ||
| package actions | ||
| import ( | ||
| "context" | ||
| repo_model"code.gitea.io/gitea/models/repo" | ||
| user_model"code.gitea.io/gitea/models/user" | ||
| "code.gitea.io/gitea/modules/json" | ||
| ) | ||
| // GetOrgActionsConfig loads the ActionsConfig for an organization from user settings | ||
| // It returns a default config if no setting is found | ||
| funcGetOrgActionsConfig(ctx context.Context,orgIDint64) (*repo_model.ActionsConfig,error) { | ||
| val,err:=user_model.GetUserSetting(ctx,orgID,"actions.config") | ||
| iferr!=nil { | ||
| returnnil,err | ||
| } | ||
| cfg:=&repo_model.ActionsConfig{} | ||
| ifval=="" { | ||
| // Return defaults if no config exists | ||
| returncfg,nil | ||
| } | ||
| iferr:=json.Unmarshal([]byte(val),cfg);err!=nil { | ||
| returnnil,err | ||
| } | ||
| returncfg,nil | ||
| } | ||
| // SetOrgActionsConfig saves the ActionsConfig for an organization to user settings | ||
| funcSetOrgActionsConfig(ctx context.Context,orgIDint64,cfg*repo_model.ActionsConfig)error { | ||
| bs,err:=json.Marshal(cfg) | ||
| iferr!=nil { | ||
| returnerr | ||
| } | ||
| returnuser_model.SetUserSetting(ctx,orgID,"actions.config",string(bs)) | ||
| } | ||
55 changes: 45 additions & 10 deletionsmodels/perm/access/repo_permission.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletionsmodels/repo/repo_unit.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -168,11 +168,122 @@ func (cfg *PullRequestsConfig) GetDefaultMergeStyle() MergeStyle { | ||
| return MergeStyleMerge | ||
| } | ||
| // ActionsTokenPermissionMode defines the default permission mode for Actions tokens | ||
| type ActionsTokenPermissionMode string | ||
| const ( | ||
| // ActionsTokenPermissionModePermissive - write access by default (current behavior, backwards compatible) | ||
| ActionsTokenPermissionModePermissive ActionsTokenPermissionMode = "permissive" | ||
| // ActionsTokenPermissionModeRestricted - read access by default | ||
| ActionsTokenPermissionModeRestricted ActionsTokenPermissionMode = "restricted" | ||
| // ActionsTokenPermissionModeCustom - user-defined permissions | ||
| ActionsTokenPermissionModeCustom ActionsTokenPermissionMode = "custom" | ||
| ) | ||
| // ActionsTokenPermissions defines the permissions for different repository units | ||
| type ActionsTokenPermissions struct { | ||
| // Contents (repository code) - read/write/none | ||
| Contents perm.AccessMode `json:"contents"` | ||
| // Issues - read/write/none | ||
| Issues perm.AccessMode `json:"issues"` | ||
| // PullRequests - read/write/none | ||
| PullRequests perm.AccessMode `json:"pull_requests"` | ||
| // Packages - read/write/none | ||
| Packages perm.AccessMode `json:"packages"` | ||
| // Actions - read/write/none | ||
| Actions perm.AccessMode `json:"actions"` | ||
| // Wiki - read/write/none | ||
| Wiki perm.AccessMode `json:"wiki"` | ||
| } | ||
| // HasRead checks if the permission has read access for the given scope | ||
| func (p ActionsTokenPermissions) HasRead(scope string) bool { | ||
Excellencedev marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| var mode perm.AccessMode | ||
| switch scope { | ||
| case "actions": | ||
| mode = p.Actions | ||
| case "contents": | ||
| mode = p.Contents | ||
| case "issues": | ||
| mode = p.Issues | ||
| case "packages": | ||
| mode = p.Packages | ||
| case "pull_requests": | ||
| mode = p.PullRequests | ||
| case "wiki": | ||
| mode = p.Wiki | ||
| } | ||
| return mode >= perm.AccessModeRead | ||
| } | ||
| // HasWrite checks if the permission has write access for the given scope | ||
| func (p ActionsTokenPermissions) HasWrite(scope string) bool { | ||
| var mode perm.AccessMode | ||
| switch scope { | ||
| case "actions": | ||
| mode = p.Actions | ||
| case "contents": | ||
| mode = p.Contents | ||
| case "issues": | ||
| mode = p.Issues | ||
| case "packages": | ||
| mode = p.Packages | ||
| case "pull_requests": | ||
| mode = p.PullRequests | ||
| case "wiki": | ||
| mode = p.Wiki | ||
| } | ||
| return mode >= perm.AccessModeWrite | ||
| } | ||
| // DefaultActionsTokenPermissions returns the default permissions for permissive mode | ||
| func DefaultActionsTokenPermissions(mode ActionsTokenPermissionMode) ActionsTokenPermissions { | ||
| if mode == ActionsTokenPermissionModeRestricted { | ||
| return ActionsTokenPermissions{ | ||
| Contents: perm.AccessModeRead, | ||
| Issues: perm.AccessModeRead, | ||
| PullRequests: perm.AccessModeRead, | ||
| Packages: perm.AccessModeRead, | ||
| Actions: perm.AccessModeRead, | ||
| Wiki: perm.AccessModeRead, | ||
| } | ||
| } | ||
| // Permissive mode (default) | ||
| return ActionsTokenPermissions{ | ||
| Contents: perm.AccessModeWrite, | ||
| Issues: perm.AccessModeWrite, | ||
| PullRequests: perm.AccessModeWrite, | ||
| Packages: perm.AccessModeRead, // Packages read by default for security | ||
| Actions: perm.AccessModeWrite, | ||
| Wiki: perm.AccessModeWrite, | ||
| } | ||
| } | ||
| // ForkPullRequestPermissions returns the restricted permissions for fork pull requests | ||
| func ForkPullRequestPermissions() ActionsTokenPermissions { | ||
| return ActionsTokenPermissions{ | ||
| Contents: perm.AccessModeRead, | ||
| Issues: perm.AccessModeRead, | ||
| PullRequests: perm.AccessModeRead, | ||
| Packages: perm.AccessModeRead, | ||
| Actions: perm.AccessModeRead, | ||
| Wiki: perm.AccessModeRead, | ||
| } | ||
| } | ||
| type ActionsConfig struct { | ||
| DisabledWorkflows []string | ||
| // CollaborativeOwnerIDs is a list of owner IDs used to share actions from private repos. | ||
| // Only workflows from the private repos whose owners are in CollaborativeOwnerIDs can access the current repo's actions. | ||
| CollaborativeOwnerIDs []int64 | ||
| // TokenPermissionMode defines the default permission mode (permissive or restricted) | ||
| TokenPermissionMode ActionsTokenPermissionMode `json:"token_permission_mode,omitempty"` | ||
| // DefaultTokenPermissions defines the default permissions for workflow tokens | ||
| DefaultTokenPermissions *ActionsTokenPermissions `json:"default_token_permissions,omitempty"` | ||
| // MaxTokenPermissions defines the maximum permissions (cannot be exceeded by workflow permissions keyword) | ||
| MaxTokenPermissions *ActionsTokenPermissions `json:"max_token_permissions,omitempty"` | ||
Excellencedev marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // AllowCrossRepoAccess indicates if actions in this repo/org can access other repos in the same org | ||
| AllowCrossRepoAccess bool `json:"allow_cross_repo_access,omitempty"` | ||
| } | ||
| func (cfg *ActionsConfig) EnableWorkflow(file string) { | ||
| @@ -209,6 +320,59 @@ func (cfg *ActionsConfig) IsCollaborativeOwner(ownerID int64) bool { | ||
| return slices.Contains(cfg.CollaborativeOwnerIDs, ownerID) | ||
| } | ||
| // GetTokenPermissionMode returns the token permission mode (defaults to permissive for backwards compatibility) | ||
| func (cfg *ActionsConfig) GetTokenPermissionMode() ActionsTokenPermissionMode { | ||
| if cfg.TokenPermissionMode == "" { | ||
| return ActionsTokenPermissionModePermissive | ||
| } | ||
| return cfg.TokenPermissionMode | ||
| } | ||
| // GetEffectiveTokenPermissions returns the effective token permissions based on settings and context | ||
| func (cfg *ActionsConfig) GetEffectiveTokenPermissions(isForkPullRequest bool) ActionsTokenPermissions { | ||
| // Fork pull requests always get restricted read-only access for security | ||
| if isForkPullRequest { | ||
| return ForkPullRequestPermissions() | ||
| } | ||
| // Use custom default permissions if set | ||
| if cfg.DefaultTokenPermissions != nil { | ||
| return *cfg.DefaultTokenPermissions | ||
| } | ||
| // Otherwise use mode-based defaults | ||
| return DefaultActionsTokenPermissions(cfg.GetTokenPermissionMode()) | ||
| } | ||
| // GetMaxTokenPermissions returns the maximum allowed permissions | ||
| func (cfg *ActionsConfig) GetMaxTokenPermissions() ActionsTokenPermissions { | ||
| if cfg.MaxTokenPermissions != nil { | ||
| return *cfg.MaxTokenPermissions | ||
| } | ||
| // Default max is write for everything except packages | ||
| return ActionsTokenPermissions{ | ||
| Contents: perm.AccessModeWrite, | ||
| Issues: perm.AccessModeWrite, | ||
| PullRequests: perm.AccessModeWrite, | ||
| Packages: perm.AccessModeWrite, | ||
| Actions: perm.AccessModeWrite, | ||
| Wiki: perm.AccessModeWrite, | ||
| } | ||
| } | ||
| // ClampPermissions ensures that the given permissions don't exceed the maximum | ||
| func (cfg *ActionsConfig) ClampPermissions(perms ActionsTokenPermissions) ActionsTokenPermissions { | ||
| maxPerms := cfg.GetMaxTokenPermissions() | ||
| return ActionsTokenPermissions{ | ||
| Contents: min(perms.Contents, maxPerms.Contents), | ||
| Issues: min(perms.Issues, maxPerms.Issues), | ||
| PullRequests: min(perms.PullRequests, maxPerms.PullRequests), | ||
| Packages: min(perms.Packages, maxPerms.Packages), | ||
| Actions: min(perms.Actions, maxPerms.Actions), | ||
| Wiki: min(perms.Wiki, maxPerms.Wiki), | ||
| } | ||
| } | ||
| // FromDB fills up a ActionsConfig from serialized format. | ||
| func (cfg *ActionsConfig) FromDB(bs []byte) error { | ||
| return json.UnmarshalHandleDoubleEncode(bs, &cfg) | ||
75 changes: 75 additions & 0 deletionsmodels/repo/repo_unit_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.