feat!: drop reading other 'user' permission #8650

Emyrk · 2023-07-21T15:24:21Z

Blocked by: #8625
Closes: #5002, https://github.com/coder/v2-customers/issues/232

Members of the platform can no longer read or list other users. Resources that have "created_by" or "initiated_by" still retain user context, but only include username and avatar url.

Attempting to read a user found via those means will result in a 404.

Groups are also now a privileged endpoint.

Admins via template ACL

If a user is given admin to any template, that user can still see the users + groups listed in the template permissions. This is done via a new /template/<template_id>/acl/available endpoint.

UI

No more Users tab for regular users

Members of the platform can no longer read or list other users. Resources that have "created_by" or "initiated_by" still retain user context, but only include username and avatar url. Attempting to read a user found via those means will result in a 404.

…d_users_perm

BrunoQuaresma

LGTM

johnstcn · 2023-07-25T19:14:44Z

coderd/users_test.go

We should add unit tests in this file to assert this new behaviour.

Which new behavior exactly? The rbac stuff is all tested.

~~I will add a test for the acl available~~ EDIT: Added for acl available endpoint

While the RBAC stuff may be unit tested, we also need to ensure that the behaviour is as desired at the API endpoint level.

My understanding of this PR is that it removes the ability of org members to read other org members. Is this understanding correct?

If so, I suggest adding test cases to cover the following:

As an org member, I can read my own user by ID.

As an org member, I can read my own user by name.

As an org member, I cannot read another org member by ID.

As an org member, I cannot read another org member by name.

As an org member, I cannot list all users in the org.

As an auditor, I can read another org member by ID.

As an auditor, I can read another org member by name.

My understanding of this PR is that it removes the ability of org members to read other org members. Is this understanding correct?

Yes. You cannot read other org members or other users. This matrix of who can read who is tedious to test at the api level. So I have matrix tests that answer those questions.

Org Member matrix

coder/coderd/rbac/roles_test.go

Lines 290 to 298 in 39912a2

{

Name: "ReadOrgMember",

Actions: []rbac.Action{rbac.ActionRead},

Resource: rbac.ResourceOrganizationMember.WithID(currentUser).InOrg(orgID).WithOwner(currentUser.String()),

AuthorizeMap: map[bool][]authSubject{

true: {owner, orgAdmin, userAdmin, orgMemberMe, templateAdmin},

false: {memberMe, otherOrgAdmin, otherOrgMember},

},

},

Read user matrix:

coder/coderd/rbac/roles_test.go

Lines 106 to 123 in 39912a2

{

Name: "MyUser",

Actions: []rbac.Action{rbac.ActionRead},

Resource: rbac.ResourceUserObject(currentUser),

AuthorizeMap: map[bool][]authSubject{

true: {orgMemberMe, owner, memberMe, templateAdmin, userAdmin},

false: {otherOrgMember, otherOrgAdmin, orgAdmin},

},

},

{

Name: "AUser",

Actions: []rbac.Action{rbac.ActionCreate, rbac.ActionUpdate, rbac.ActionDelete},

Resource: rbac.ResourceUser,

AuthorizeMap: map[bool][]authSubject{

true: {owner, userAdmin},

false: {memberMe, orgMemberMe, orgAdmin, otherOrgMember, otherOrgAdmin, templateAdmin},

},

},

These cover all the cases you just asked.

The OrgMember RBAC object is defined here:

coder/coderd/database/modelmethods.go

Lines 194 to 200 in 39912a2

func (m OrganizationMember) RBACObject() rbac.Object {

return rbac.ResourceOrganizationMember.

WithID(m.UserID).

InOrg(m.OrganizationID).

WithOwner(m.UserID.String())

}

And then it is asserted the db makes the right checks in the dbauth_test.go:

coder/coderd/database/dbauthz/dbauthz_test.go

Lines 533 to 538 in 39912a2

s.Run("GetOrganizationMembershipsByUserID", s.Subtest(func(db database.Store, check *expects) {

u := dbgen.User(s.T(), db, database.User{})

a := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{UserID: u.ID})

b := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{UserID: u.ID})

check.Args(u.ID).Asserts(a, rbac.ActionRead, b, rbac.ActionRead).Returns(slice.New(a, b))

}))

So these tests cover that any db calls for a given resource as a given actor are correct according to that list you mentioned.

The test I added was the ACL listing available users/groups because it uses dbauth.AsSystemContext to get around the permissions and keep the UX if you are an admin for a given template. I imagine we might need to revisit that in future based on certain feedback, but it was required to keep the UX the same.

I would also really like to see tests at the coderd package level for this change.
That can be done as a follow-up if required, but it would increase confidence and solidify the behaviour.

It would increase confidence for sure.

We don't do these style RBAC tests at the coderd package layer atm except in very few cases. Most of our coderd tests run as Owner ☹️.

I'd prefer not to have to write all these, because ideally I wouldn't write new tests, but run the existing tests as various actors and assert various outcomes. But that requires refactoring the tests for fetching users, groups, etc 😢.

Essentially, I think if we are going to test these kinds of things at the coderd level, we should do it in a way that doesn't just add a lot of test code bloat.

There might be an issue we should make at some point to audit the rbac assertions in our unit test for correctness.

The current various series of tests are loosely coupled for sure and probably are missing things or have bugs.

github-actions bot assigned Emyrk Jul 21, 2023

Emyrk mentioned this pull request Jul 18, 2023

feat: remove "view all users" from members #8447

Closed

4 tasks

Emyrk added 12 commits July 25, 2023 09:27

Merge remote-tracking branch 'origin/main' into stevenmasley/drop_rea…

89ec2ed

…d_users_perm

Hide /users page for regular users

4545d1a

make groups a privledged endpoint

7ce87a7

Permissions page for template perms

8e86149

remove console log

82ceab8

Fix perms unit tests

ddd147d

Fixing unit tests

658e2e2

make gen

9007b8e

Fix pagination users test

72b0862

Make fmt

f1ed8b3

Update unit test with perm changes

04d9166

remove unused function

e0af28e

Emyrk marked this pull request as ready for review July 25, 2023 18:24

count 0 vs -1

515edf1

Emyrk requested a review from BrunoQuaresma July 25, 2023 18:46

Emyrk assigned johnstcn Jul 25, 2023

BrunoQuaresma approved these changes Jul 25, 2023

View reviewed changes

johnstcn reviewed Jul 25, 2023

View reviewed changes

Unit test to test acl available

39912a2

Emyrk added the release/breaking This label is applied to PRs to detect breaking changes as part of the release process label Jul 26, 2023

Emyrk changed the title ~~feat: drop reading other 'user' permission~~ feat!: drop reading other 'user' permission Jul 26, 2023

Use correct sdk method

4463012

johnstcn approved these changes Jul 26, 2023

View reviewed changes

Emyrk merged commit 2089006 into main Jul 26, 2023

Emyrk deleted the stevenmasley/drop_read_users_perm branch July 26, 2023 14:33

github-actions bot locked and limited conversation to collaborators Jul 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: drop reading other 'user' permission #8650

feat!: drop reading other 'user' permission #8650

Emyrk commented Jul 21, 2023 •

edited

Loading

BrunoQuaresma left a comment

johnstcn Jul 25, 2023

Emyrk Jul 25, 2023 •

edited

Loading

johnstcn Jul 26, 2023 •

edited

Loading

Emyrk Jul 26, 2023

johnstcn Jul 26, 2023

Emyrk Jul 26, 2023

Emyrk Jul 26, 2023

	{
	Name: "ReadOrgMember",
	Actions: []rbac.Action{rbac.ActionRead},
	Resource: rbac.ResourceOrganizationMember.WithID(currentUser).InOrg(orgID).WithOwner(currentUser.String()),
	AuthorizeMap: map[bool][]authSubject{
	true: {owner, orgAdmin, userAdmin, orgMemberMe, templateAdmin},
	false: {memberMe, otherOrgAdmin, otherOrgMember},
	},
	},

	{
	Name: "MyUser",
	Actions: []rbac.Action{rbac.ActionRead},
	Resource: rbac.ResourceUserObject(currentUser),
	AuthorizeMap: map[bool][]authSubject{
	true: {orgMemberMe, owner, memberMe, templateAdmin, userAdmin},
	false: {otherOrgMember, otherOrgAdmin, orgAdmin},
	},
	},
	{
	Name: "AUser",
	Actions: []rbac.Action{rbac.ActionCreate, rbac.ActionUpdate, rbac.ActionDelete},
	Resource: rbac.ResourceUser,
	AuthorizeMap: map[bool][]authSubject{
	true: {owner, userAdmin},
	false: {memberMe, orgMemberMe, orgAdmin, otherOrgMember, otherOrgAdmin, templateAdmin},
	},
	},

	func (m OrganizationMember) RBACObject() rbac.Object {
	return rbac.ResourceOrganizationMember.
	WithID(m.UserID).
	InOrg(m.OrganizationID).
	WithOwner(m.UserID.String())
	}

	s.Run("GetOrganizationMembershipsByUserID", s.Subtest(func(db database.Store, check *expects) {
	u := dbgen.User(s.T(), db, database.User{})
	a := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{UserID: u.ID})
	b := dbgen.OrganizationMember(s.T(), db, database.OrganizationMember{UserID: u.ID})
	check.Args(u.ID).Asserts(a, rbac.ActionRead, b, rbac.ActionRead).Returns(slice.New(a, b))
	}))

feat!: drop reading other 'user' permission #8650

feat!: drop reading other 'user' permission #8650

Conversation

Emyrk commented Jul 21, 2023 • edited Loading

Admins via template ACL

UI

BrunoQuaresma left a comment

Choose a reason for hiding this comment

johnstcn Jul 25, 2023

Choose a reason for hiding this comment

Emyrk Jul 25, 2023 • edited Loading

Choose a reason for hiding this comment

johnstcn Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Emyrk Jul 26, 2023

Choose a reason for hiding this comment

johnstcn Jul 26, 2023

Choose a reason for hiding this comment

Emyrk Jul 26, 2023

Choose a reason for hiding this comment

Emyrk Jul 26, 2023

Choose a reason for hiding this comment

Emyrk commented Jul 21, 2023 •

edited

Loading

Emyrk Jul 25, 2023 •

edited

Loading

johnstcn Jul 26, 2023 •

edited

Loading