Skip to content

refactor(api): require permission key in create and update requests #1885

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AmanGIT07 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(api): require permission key in create and update requests #1885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b786f6
refactor(api): require permission key in create and update requests
AmanGIT07 Aug 14, 2026
c28de61
refactor(api): validate permission key parts and name the rejection
AmanGIT07 Aug 14, 2026
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
7 changes: 4 additions & 3 deletions cmd/seed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"connectrpc.com/connect"
"github.com/MakeNowJust/heredoc"
"github.com/raystack/frontier/config"
"github.com/raystack/frontier/internal/bootstrap/schema"
frontierv1beta1 "github.com/raystack/frontier/proto/v1beta1"
frontierv1beta1connect "github.com/raystack/frontier/proto/v1beta1/frontierv1beta1connect"
"github.com/raystack/salt/cli/printer"
Expand Down Expand Up @@ -112,10 +113,10 @@ func createCustomRolesAndPermissions(ctx context.Context, client frontierv1beta1
}

str := "created custom permissions : "
//nolint:staticcheck
for _, v := range permissionBodies {
str = fmt.Sprintf("%s %s:%s", str, v.GetNamespace(), v.GetName())
resourceNamespaces = append(resourceNamespaces, v.GetNamespace())
permNamespace, permName := schema.PermissionNamespaceAndNameFromKey(v.GetKey())
str = fmt.Sprintf("%s %s:%s", str, permNamespace, permName)
resourceNamespaces = append(resourceNamespaces, permNamespace)
}
fmt.Println(str)

Expand Down
30 changes: 11 additions & 19 deletions cmd/seed/permissions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,42 @@
[
{
"name": "create",
"key": "compute.order.create",
"title": "Create Order",
"namespace": "compute/order",
"metadata": {}
},
{
"name": "get",
"key": "compute.order.get",
"title": "Read Order",
"namespace": "compute/order",
"metadata": {}
},
{
"name": "update",
"key": "compute.order.update",
"title": "Update Order",
"namespace": "compute/order",
"metadata": {}
},
{
"name": "delete",
"key": "compute.order.delete",
"title": "Delete Order",
"namespace": "compute/order",
"metadata": {}
},
{
"name": "list",
"key": "compute.order.list",
"title": "List Orders",
"namespace": "compute/order",
"metadata": {}
},
{
"name": "get",
"key": "database.order.get",
"title": "List Database Order",
"namespace": "database/order",
"metadata":{}
"metadata": {}
},
{
"name": "update",
"key": "database.order.update",
"title": "Update Database Order",
"namespace": "database/order",
"metadata":{}
"metadata": {}
},
{
"name": "delete",
"key": "database.order.delete",
"title": "Delete Database Order",
"namespace": "database/order",
"metadata":{}
"metadata": {}
}
]
1 change: 1 addition & 0 deletions internal/api/v1beta1connect/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ var (
ErrAlreadyApplied = errors.New("credits already applied")
ErrInvalidRoleID = errors.New("role id is invalid")
ErrNamespaceSplitNotation = errors.New("subject/object should be provided as 'namespace:uuid'")
ErrPermissionKeyNotation = errors.New("permission key should be provided as 'service.resource.verb'")
ErrPolicyNotFound = errors.New("policy doesn't exist")
ErrProjectNotFound = errors.New("project doesn't exist")
ErrGroupNotFound = errors.New("group doesn't exist")
Expand Down
18 changes: 10 additions & 8 deletions internal/api/v1beta1connect/permission.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,14 @@ func (h *ConnectHandler) CreatePermission(ctx context.Context, request *connect.
var permissionSlugs []string
for _, permBody := range request.Msg.GetBodies() {
permNamespace, permName := schema.PermissionNamespaceAndNameFromKey(permBody.GetKey())
if permNamespace == "" || permName == "" {
permNamespace, permName = permBody.GetNamespace(), permBody.GetName() //nolint:staticcheck
}
if permName == "" || permNamespace == "" {
return nil, connect.NewError(connect.CodeInvalidArgument, ErrBadRequest)
return nil, connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation)
}
if !schema.IsValidPermissionName(permName) {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("permission name cannot contain special characters"))
}

if permNamespace == schema.DefaultNamespace {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("permission namespace cannot be "+schema.DefaultNamespace))
if !schema.IsValidPermissionNamespace(permNamespace) {
return nil, connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation)
}
permissionSlugs = append(permissionSlugs, schema.FQPermissionNameFromNamespace(permNamespace, permName))

Expand Down Expand Up @@ -116,7 +112,13 @@ func (h *ConnectHandler) UpdatePermission(ctx context.Context, request *connect.

permNamespace, permName := schema.PermissionNamespaceAndNameFromKey(request.Msg.GetBody().GetKey())
if permNamespace == "" || permName == "" {
permNamespace, permName = request.Msg.GetBody().GetNamespace(), request.Msg.GetBody().GetName() //nolint:staticcheck
return nil, connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation)
}
if !schema.IsValidPermissionName(permName) {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("permission name cannot contain special characters"))
}
if !schema.IsValidPermissionNamespace(permNamespace) {
return nil, connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation)
}
updatedPermission, err := h.permissionService.Update(ctx, permission.Permission{
ID: request.Msg.GetId(),
Expand Down
129 changes: 55 additions & 74 deletions internal/api/v1beta1connect/permission_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ func TestHandler_CreatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
},
}),
Expand All @@ -82,30 +81,43 @@ func TestHandler_CreatePermission(t *testing.T) {
errors.New("test error"))),
},
{
name: "should return bad request error if namespace id is empty",
name: "should return bad request error if key is missing",
setup: func(as *mocks.PermissionService, bs *mocks.BootstrapService) {},
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Name: testPermissions[testPermissionIdx].Name,
Title: "no key sent",
},
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrBadRequest),
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation),
},
{
name: "should return bad request error if name is empty",
name: "should return bad request error if key is malformed",
setup: func(as *mocks.PermissionService, bs *mocks.BootstrapService) {},
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: "app.resource",
},
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrBadRequest),
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation),
},
{
name: "should return bad request error if key namespace is invalid",
setup: func(as *mocks.PermissionService, bs *mocks.BootstrapService) {},
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Key: "app..get",
},
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation),
},
{
name: "should return success if permission service return nil error",
Expand Down Expand Up @@ -143,12 +155,10 @@ func TestHandler_CreatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Name: testPermissions[testPermissionIdx].Name + "0",
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name+"0"),
},
{
Name: testPermissions[testPermissionIdx].Name + "1",
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name+"1"),
},
},
}),
Expand All @@ -174,50 +184,6 @@ func TestHandler_CreatePermission(t *testing.T) {
}),
wantErr: nil,
},
{
name: "should return success if permission service return nil error with permission key",
setup: func(as *mocks.PermissionService, bs *mocks.BootstrapService) {
bs.EXPECT().AppendSchema(mock.AnythingOfType("context.backgroundCtx"), schema.ServiceDefinition{
Permissions: []schema.ResourcePermission{
{
Name: testPermissions[testPermissionIdx].Name + "0",
Namespace: testPermissions[testPermissionIdx].NamespaceID,
},
},
}).Return(nil)
as.EXPECT().List(mock.Anything, permission.Filter{
Slugs: []string{
schema.FQPermissionNameFromNamespace(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name+"0"),
},
}).Return([]permission.Permission{
{
ID: testPermissions[testPermissionIdx].ID,
Name: testPermissions[testPermissionIdx].Name + "0",
NamespaceID: testPermissions[testPermissionIdx].NamespaceID,
},
}, nil)
},
request: connect.NewRequest(&frontierv1beta1.CreatePermissionRequest{
Bodies: []*frontierv1beta1.PermissionRequestBody{
{
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name+"0"),
},
},
}),
want: connect.NewResponse(&frontierv1beta1.CreatePermissionResponse{
Permissions: []*frontierv1beta1.Permission{
{
Id: testPermissions[testPermissionIdx].ID,
Name: testPermissions[testPermissionIdx].Name + "0",
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name+"0"),
CreatedAt: timestamppb.New(testPermissions[testPermissionIdx].CreatedAt),
UpdatedAt: timestamppb.New(testPermissions[testPermissionIdx].UpdatedAt),
},
},
}),
wantErr: nil,
},
}

for _, tt := range tests {
Expand Down Expand Up @@ -255,8 +221,7 @@ func TestHandler_UpdatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
}),
want: nil,
Expand All @@ -275,8 +240,7 @@ func TestHandler_UpdatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
}),
want: nil,
Expand All @@ -291,8 +255,7 @@ func TestHandler_UpdatePermission(t *testing.T) {
},
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Body: &frontierv1beta1.PermissionRequestBody{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
}),
want: nil,
Expand All @@ -309,28 +272,47 @@ func TestHandler_UpdatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrBadRequest),
},
{
name: "should return bad request error if name is empty",
setup: func(as *mocks.PermissionService) {
as.EXPECT().Update(mock.AnythingOfType("context.backgroundCtx"), permission.Permission{
ID: testPermissions[testPermissionIdx].ID,
NamespaceID: testPermissions[testPermissionIdx].NamespaceID}).Return(permission.Permission{}, permission.ErrInvalidDetail)
},
name: "should return bad request error if key is missing",
setup: func(as *mocks.PermissionService) {},
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Title: "no key sent",
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrBadRequest),
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation),
},
{
name: "should return bad request error if key is malformed",
setup: func(as *mocks.PermissionService) {},
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Key: "app.resource",
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, ErrPermissionKeyNotation),
},
{
name: "should return bad request error if key name has special characters",
setup: func(as *mocks.PermissionService) {},
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Key: "app.resource.we$rd",
},
}),
want: nil,
wantErr: connect.NewError(connect.CodeInvalidArgument, errors.New("permission name cannot contain special characters")),
},
{
name: "should return success if permission service return nil error",
Expand All @@ -344,8 +326,7 @@ func TestHandler_UpdatePermission(t *testing.T) {
request: connect.NewRequest(&frontierv1beta1.UpdatePermissionRequest{
Id: testPermissions[testPermissionIdx].ID,
Body: &frontierv1beta1.PermissionRequestBody{
Name: testPermissions[testPermissionIdx].Name,
Namespace: testPermissions[testPermissionIdx].NamespaceID,
Key: schema.PermissionKeyFromNamespaceAndName(testPermissions[testPermissionIdx].NamespaceID, testPermissions[testPermissionIdx].Name),
},
}),
want: connect.NewResponse(&frontierv1beta1.UpdatePermissionResponse{
Expand Down
Loading
Loading