Skip to content

migrating branch operation endpoints to use PermissionDescriptor #9452

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2025
Merged

migrating branch operation endpoints to use PermissionDescriptor #9452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 12 additions & 67 deletions pkg/api/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2866,12 +2866,7 @@ func (c *Controller) ListBranches(w http.ResponseWriter, r *http.Request, reposi
}

func (c *Controller) CreateBranch(w http.ResponseWriter, r *http.Request, body apigen.CreateBranchJSONRequestBody, repository string) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.CreateBranchAction,
Resource: permissions.BranchArn(repository, body.Name),
},
}) {
if !c.authorizeReq(w, r, "CreateBranch", permissions.PermissionParams{Repository: &repository, Branch: &body.Name}, nil) {
return
}
ctx := r.Context()
Expand All @@ -2893,12 +2888,7 @@ func (c *Controller) CreateBranch(w http.ResponseWriter, r *http.Request, body a
}

func (c *Controller) DeleteBranch(w http.ResponseWriter, r *http.Request, repository, branch string, body apigen.DeleteBranchParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.DeleteBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "DeleteBranch", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand All @@ -2912,12 +2902,7 @@ func (c *Controller) DeleteBranch(w http.ResponseWriter, r *http.Request, reposi
}

func (c *Controller) GetBranch(w http.ResponseWriter, r *http.Request, repository, branch string) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.ReadBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "GetBranch", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -3047,12 +3032,7 @@ func (c *Controller) handleAPIError(ctx context.Context, w http.ResponseWriter,
}

func (c *Controller) ResetBranch(w http.ResponseWriter, r *http.Request, body apigen.ResetBranchJSONRequestBody, repository, branch string) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.RevertBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "ResetBranch", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -3080,13 +3060,8 @@ func (c *Controller) ResetBranch(w http.ResponseWriter, r *http.Request, body ap
}

func (c *Controller) HardResetBranch(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.HardResetBranchParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
// TODO(ozkatz): Can we have another action here?
Action: permissions.RevertBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
// TODO(ozkatz): Can we have another action here?
if !c.authorizeReq(w, r, "HardResetBranch", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -3211,12 +3186,7 @@ func importStatusToResponse(status *graveler.ImportStatus) apigen.ImportStatus {
}

func (c *Controller) ImportStatus(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.ImportStatusParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.ReadBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "ImportStatus", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand All @@ -3230,12 +3200,7 @@ func (c *Controller) ImportStatus(w http.ResponseWriter, r *http.Request, reposi
}

func (c *Controller) ImportCancel(w http.ResponseWriter, r *http.Request, repository, branch string, params apigen.ImportCancelParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.ImportCancelAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "ImportCancel", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand All @@ -3249,12 +3214,7 @@ func (c *Controller) ImportCancel(w http.ResponseWriter, r *http.Request, reposi
}

func (c *Controller) Commit(w http.ResponseWriter, r *http.Request, body apigen.CommitJSONRequestBody, repository, branch string, params apigen.CommitParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.CreateCommitAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "Commit", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -3708,12 +3668,7 @@ func (c *Controller) CopyObject(w http.ResponseWriter, r *http.Request, body api
}

func (c *Controller) RevertBranch(w http.ResponseWriter, r *http.Request, body apigen.RevertBranchJSONRequestBody, repository, branch string) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.RevertBranchAction,
Resource: permissions.BranchArn(repository, branch),
},
}) {
if !c.authorizeReq(w, r, "RevertBranch", permissions.PermissionParams{Repository: &repository, Branch: &branch}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -4516,12 +4471,7 @@ func (c *Controller) DiffRefs(w http.ResponseWriter, r *http.Request, repository
}

func (c *Controller) LogCommits(w http.ResponseWriter, r *http.Request, repository, ref string, params apigen.LogCommitsParams) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.ReadBranchAction,
Resource: permissions.BranchArn(repository, ref),
},
}) {
if !c.authorizeReq(w, r, "LogCommits", permissions.PermissionParams{Repository: &repository, Branch: &ref}, nil) {
return
}
ctx := r.Context()
Expand Down Expand Up @@ -5038,12 +4988,7 @@ func (c *Controller) GetUnderlyingProperties(w http.ResponseWriter, r *http.Requ
}

func (c *Controller) MergeIntoBranch(w http.ResponseWriter, r *http.Request, body apigen.MergeIntoBranchJSONRequestBody, repository, sourceRef, destinationBranch string) {
if !c.authorize(w, r, permissions.Node{
Permission: permissions.Permission{
Action: permissions.CreateCommitAction,
Resource: permissions.BranchArn(repository, destinationBranch),
},
}) {
if !c.authorizeReq(w, r, "MergeIntoBranch", permissions.PermissionParams{Repository: &repository, Branch: &destinationBranch}, nil) {
return
}
ctx := r.Context()
Expand Down
31 changes: 31 additions & 0 deletions pkg/permissions/permission.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ func ExternalPrincipalArn(principalID string) string {
type PermissionParams struct {
Repository *string
Path *string
Branch *string
}

type PermissionDescriptor interface {
Expand All @@ -84,8 +85,27 @@ func (o *ObjectPermission) Permission(params PermissionParams) Node {
}
}

type BranchPermission struct {
Action string
}

func (o *BranchPermission) Permission(params PermissionParams) Node {
return Node{
Permission: Permission{
Action: o.Action,
Resource: ObjectArn(*params.Repository, *params.Branch),
},
}
}

var readObjectPermission = ObjectPermission{Action: ReadObjectAction}
var writeObjectPermission = ObjectPermission{Action: WriteObjectAction}
var createBranchPermission = BranchPermission{Action: CreateBranchAction}
var deleteBranchPermission = BranchPermission{Action: DeleteBranchAction}
var readBranchPermission = BranchPermission{Action: ReadBranchAction}
var revertBranchPermission = BranchPermission{Action: RevertBranchAction}
var createCommitPermission = BranchPermission{Action: CreateCommitAction}
var importCancelPermission = BranchPermission{Action: ImportCancelAction}

var permissionByOp = map[string]PermissionDescriptor{
"HeadObject": &readObjectPermission,
Expand All @@ -97,6 +117,17 @@ var permissionByOp = map[string]PermissionDescriptor{
"UpdateObjectUserMetadata": &writeObjectPermission,
"UploadObject": &writeObjectPermission,
"UploadObjectPreflight": &writeObjectPermission,
"CreateBranch": &createBranchPermission,
"DeleteBranch": &deleteBranchPermission,
"GetBranch": &readBranchPermission,
"RevertBranch": &revertBranchPermission,
"LogCommits": &readBranchPermission,
"ResetBranch": &revertBranchPermission,
"MergeIntoBranch": &createCommitPermission,
"HardResetBranch": &revertBranchPermission,
"ImportStatus": &readBranchPermission,
"Commit": &createCommitPermission,
"ImportCancel": &importCancelPermission,
}

func GetPermissionDescriptor(operationId string) PermissionDescriptor {
Expand Down
Loading