Skip to content
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

Make expanded grants immutable. #278

Merged
merged 2 commits into from
Dec 31, 2024
Merged

Make expanded grants immutable. #278

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
3aad9bf
Make expanded grants immutable.
ggreer Dec 31, 2024
f7bd344
Add test for immutable grants in cycles. This behavior doesn't curren…
ggreer Dec 31, 2024
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
5 changes: 5 additions & 0 deletions pkg/sync/syncer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1536,10 +1536,15 @@ func (s *syncer) newExpandedGrant(_ context.Context, descEntitlement *v2.Entitle
return nil, fmt.Errorf("newExpandedGrant: principal is nil")
}

// Add immutable annotation since this function is only called if no direct grant exists
var annos annotations.Annotations
annos.Update(&v2.GrantImmutable{})

grant := &v2.Grant{
Id: fmt.Sprintf("%s:%s:%s", descEntitlement.Id, principal.Id.ResourceType, principal.Id.Resource),
Entitlement: descEntitlement,
Principal: principal,
Annotations: annos,
}

return grant, nil
Expand Down
217 changes: 215 additions & 2 deletions pkg/sync/syncer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ import (
"testing"

v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
reader_v2 "github.com/conductorone/baton-sdk/pb/c1/reader/v2"
"github.com/conductorone/baton-sdk/pkg/annotations"
"github.com/conductorone/baton-sdk/pkg/dotc1z/manager"
et "github.com/conductorone/baton-sdk/pkg/types/entitlement"
gt "github.com/conductorone/baton-sdk/pkg/types/grant"
rs "github.com/conductorone/baton-sdk/pkg/types/resource"
Expand Down Expand Up @@ -62,8 +64,6 @@ func TestExpandGrants(t *testing.T) {
principal, err := mc.AddUser(ctx, pid)
require.NoError(t, err)

// This isn't needed because grant expansion will create this grant
// _ = mc.AddGroupMember(ctx, group, principal)
_ = mc.AddGroupMember(ctx, group, principal)
}
}
Expand All @@ -81,6 +81,219 @@ func TestExpandGrants(t *testing.T) {
_ = os.Remove(c1zpath)
}

func TestExpandGrantImmutable(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to add a test for a circular group expansion? i think this current test is a fine validation, but i was wondering about the behavoir of full circles, eg group A has member B which has member group C which has member A -> and a user could be attached at any point, but only have direct in a single group?

Copy link
Contributor Author

@ggreer ggreer Dec 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a test but it looks like we'll need more changes to correctly support immutable in circular group membership. We currently fail to mark them immutable. I think that's OK for now.

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

mc := newMockConnector()

mc.rtDB = append(mc.rtDB, groupResourceType, userResourceType)

group1, group1Ent, err := mc.AddGroup(ctx, "test_group_1")
require.NoError(t, err)
group2, group2Ent, err := mc.AddGroup(ctx, "test_group_2")
require.NoError(t, err)

user1, err := mc.AddUser(ctx, "user_1")
require.NoError(t, err)
user2, err := mc.AddUser(ctx, "user_2")
require.NoError(t, err)

// Add all users to group 2
_ = mc.AddGroupMember(ctx, group2, user1)
_ = mc.AddGroupMember(ctx, group2, user2)

// Add group 2 to group 1
_ = mc.AddGroupMember(ctx, group1, group2, group2Ent)

// Directly add user 1 to group 1 (this grant should not be immutable after expansion)
_ = mc.AddGroupMember(ctx, group1, user1)

tempDir, err := os.MkdirTemp("", "baton-expand-grant-immutable")
require.NoError(t, err)
defer os.RemoveAll(tempDir)
c1zpath := filepath.Join(tempDir, "expand-grants.c1z")
syncer, err := NewSyncer(ctx, mc, WithC1ZPath(c1zpath), WithTmpDir(tempDir))
require.NoError(t, err)
err = syncer.Sync(ctx)
require.NoError(t, err)
err = syncer.Close(ctx)
require.NoError(t, err)

c1zManager, err := manager.New(ctx, c1zpath)
require.NoError(t, err)

store, err := c1zManager.LoadC1Z(ctx)
require.NoError(t, err)

allGrantsReq := &v2.GrantsServiceListGrantsRequest{}
allGrants, err := store.ListGrants(ctx, allGrantsReq)
require.NoError(t, err)
require.Len(t, allGrants.List, 5)

req := &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
Entitlement: group1Ent,
PageToken: "",
Annotations: nil,
}
resp, err := store.ListGrantsForEntitlement(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 3) // both users and group2 should have group1 membership

req = &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
Entitlement: group1Ent,
PrincipalId: user1.Id,
PageToken: "",
Annotations: nil,
}
resp, err = store.ListGrantsForEntitlement(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 1)

grant := resp.List[0]

annos := annotations.Annotations(grant.Annotations)
immutable := &v2.GrantImmutable{}
hasImmutable, err := annos.Pick(immutable)
require.NoError(t, err)

require.False(t, hasImmutable) // Direct grant should not be immutable

req = &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
Entitlement: group1Ent,
PrincipalId: user2.Id,
PageToken: "",
Annotations: nil,
}
resp, err = store.ListGrantsForEntitlement(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 1)

grant = resp.List[0]

annos = annotations.Annotations(grant.Annotations)
immutable = &v2.GrantImmutable{}
hasImmutable, err = annos.Pick(immutable)
require.NoError(t, err)

require.True(t, hasImmutable) // Expanded indirect grant should be immutable

_ = os.Remove(c1zpath)
}

func TestExpandGrantImmutableCycle(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

mc := newMockConnector()

mc.rtDB = append(mc.rtDB, groupResourceType, userResourceType)

group1, group1Ent, err := mc.AddGroup(ctx, "test_group_1")
require.NoError(t, err)
group2, group2Ent, err := mc.AddGroup(ctx, "test_group_2")
require.NoError(t, err)
group3, group3Ent, err := mc.AddGroup(ctx, "test_group_3")
require.NoError(t, err)

user1, err := mc.AddUser(ctx, "user_1")
require.NoError(t, err)
user2, err := mc.AddUser(ctx, "user_2")
require.NoError(t, err)

// Add all users to group 2
_ = mc.AddGroupMember(ctx, group2, user1)
_ = mc.AddGroupMember(ctx, group2, user2)

// Add group 2 to group 1
_ = mc.AddGroupMember(ctx, group1, group2, group2Ent)
// Add group 3 to group 2
_ = mc.AddGroupMember(ctx, group2, group3, group3Ent)
// Add group 1 to group 3
_ = mc.AddGroupMember(ctx, group3, group1, group1Ent)

// Directly add user 1 to group 1 (this grant should not be immutable after expansion)
_ = mc.AddGroupMember(ctx, group1, user1)

tempDir, err := os.MkdirTemp("", "baton-expand-grant-immutable-cycle")
require.NoError(t, err)
defer os.RemoveAll(tempDir)
c1zpath := filepath.Join(tempDir, "expand-grants.c1z")
syncer, err := NewSyncer(ctx, mc, WithC1ZPath(c1zpath), WithTmpDir(tempDir))
require.NoError(t, err)
err = syncer.Sync(ctx)
require.NoError(t, err)
err = syncer.Close(ctx)
require.NoError(t, err)

c1zManager, err := manager.New(ctx, c1zpath)
require.NoError(t, err)

store, err := c1zManager.LoadC1Z(ctx)
require.NoError(t, err)

allGrantsReq := &v2.GrantsServiceListGrantsRequest{}
allGrants, err := store.ListGrants(ctx, allGrantsReq)
require.NoError(t, err)
require.Len(t, allGrants.List, 6)

req := &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
Entitlement: group1Ent,
PageToken: "",
Annotations: nil,
}
resp, err := store.ListGrantsForEntitlement(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 2) // both users and group2 should have group1 membership

req = &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
// Entitlement: group1Ent,
PrincipalId: user1.Id,
PageToken: "",
Annotations: nil,
}
resp, err = store.ListGrantsForPrincipal(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 2)

grant := resp.List[0]
for _, g := range resp.List {
if g.Entitlement.Id == group1Ent.Id {
grant = g
break
}
}
require.Equal(t, grant.Entitlement.Id, group1Ent.Id)

annos := annotations.Annotations(grant.Annotations)
immutable := &v2.GrantImmutable{}
hasImmutable, err := annos.Pick(immutable)
require.NoError(t, err)

require.False(t, hasImmutable) // Direct grant should not be immutable

req = &reader_v2.GrantsReaderServiceListGrantsForEntitlementRequest{
PrincipalId: user2.Id,
PageToken: "",
Annotations: nil,
}
resp, err = store.ListGrantsForPrincipal(ctx, req)
require.NoError(t, err)
require.Len(t, resp.List, 1)

grant = resp.List[0]

annos = annotations.Annotations(grant.Annotations)
immutable = &v2.GrantImmutable{}
hasImmutable, err = annos.Pick(immutable)
require.NoError(t, err)

// TODO: Make this pass. It would require modifying an existing grant after fixing the cycle
// require.True(t, hasImmutable) // Expanded indirect grant should be immutable
require.False(t, hasImmutable) // TODO: delete this and fix the code so the above line passes

_ = os.Remove(c1zpath)
}
func BenchmarkExpandCircle(b *testing.B) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
Expand Down
Loading