Files
coder/coderd/authorize_test.go
T
Jeremy RuppelandSteven Masley 51a9aa1bfc perf(coderd): batch authcheck permissions via rbac.Filter (#27309)
`POST /api/v2/authcheck` evaluated every check with a full policy
evaluation in a serial loop. A subject in many organizations (100+)
produced hundreds of full evaluations, taking seconds on a cold cache
(DEVEX-608).

Group the checks by `(action, resource type)` and authorize each group
with the existing `rbac.Filter`, which amortizes a single partial
evaluation across the group once it is large enough. Each check is
wrapped in a small value struct that carries its response key, so
`Filter`'s returned subset maps back to keys by reading a field rather
than relying on element identity.

`Filter` now takes an explicit `prepareThreshold`; existing callers pass
the new `rbac.DefaultFilterThreshold` (10), and `checkAuthorization`
passes 50, above the ~35-group crossover measured for this workload, so
subjects with few objects of a given type keep the per-object path and
cannot regress.

## Stacking

This is stacked on top of #27244. `Filter` runs `Prepare` (partial
evaluation), and those residuals are only compact once #27244's
set-membership residuals land. On plain `main` the existing O(N)
residual fanout means batching can regress at high org counts, so this
change should land with or after #27244.

<details>
<summary>Decision log</summary>

### Bottleneck

- `site/src/modules/permissions/organizations.ts` defines ~14 permission
checks per org; `organizationsPermissions()` flattens them across all
orgs into one `POST /api/v2/authcheck`. A 100-org request is ~1400
checks.
- `checkAuthorization` looped serially, calling `Authorizer.Authorize`
(full eval) once per check.
- The endpoint's `maxFetch = 10` only caps checks that carry a
`resource_id`, not total checks, so it does not bound this workload.

### Approach

- Group checks by `(action, resource type)` and run each group through
`rbac.Filter`, which does one partial evaluation (`Prepare`) and reuses
it across the group.
- Carry the response key as data in a small value struct implementing
`RBACObject()`, so allowed results map back to keys without pointer
identity:

  ```go
  type authorizeCheck struct {
      key    string
      object rbac.Object
  }
  func (c authorizeCheck) RBACObject() rbac.Object { return c.object }
  ```

- `Filter` takes a required `prepareThreshold int` (no functional
options). Generic callers pass `rbac.DefaultFilterThreshold = 10`;
`/authcheck` passes 50 because the measured crossover for this workload
is ~35 groups.

### Alternatives rejected

- **Bounded `errgroup` parallelism**: reduced wall time at high org
counts but not aggregate work (allocations flat). Discarded in favor of
reducing work via partial evaluation.
- **Symmetric-deny Rego simplification** (on the #27244 branch):
replacing the known-org deny-fold with symmetric `org := -1` /
`scope_org := -1` rules failed existing SQL-compile tests. A `-1`
known-org vote gated by `not org = -1` produces a negated membership
test over the unknown org id, which OPA emits as an unconvertible
support rule. #27244's fold (`member_allow - org_deny`, a positive
set-difference membership test) is therefore load-bearing, not
incidental.

</details>

---

Authored with Coder Agents.

---------

Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com>
2026-08-06 09:18:46 -04:00

277 lines
9.0 KiB
Go

package coderd_test
import (
"context"
"fmt"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
func TestCheckPermissions(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
adminClient := coderdtest.New(t, &coderdtest.Options{
IncludeProvisionerDaemon: true,
})
// Create adminClient, member, and org adminClient
adminUser := coderdtest.CreateFirstUser(t, adminClient)
memberClient, _ := coderdtest.CreateAnotherUser(t, adminClient, adminUser.OrganizationID)
memberUser, err := memberClient.User(ctx, codersdk.Me)
require.NoError(t, err)
orgAdminClient, _ := coderdtest.CreateAnotherUser(t, adminClient, adminUser.OrganizationID, rbac.ScopedRoleOrgAdmin(adminUser.OrganizationID))
orgAdminUser, err := orgAdminClient.User(ctx, codersdk.Me)
require.NoError(t, err)
version := coderdtest.CreateTemplateVersion(t, adminClient, adminUser.OrganizationID, nil)
coderdtest.AwaitTemplateVersionJobCompleted(t, adminClient, version.ID)
template := coderdtest.CreateTemplate(t, adminClient, adminUser.OrganizationID, version.ID)
// With admin, member, and org admin
const (
readAllUsers = "read-all-users"
readOrgWorkspaces = "read-org-workspaces"
readMyself = "read-myself"
readOwnWorkspaces = "read-own-workspaces"
updateSpecificTemplate = "update-specific-template"
)
params := map[string]codersdk.AuthorizationCheck{
readAllUsers: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceUser,
},
Action: "read",
},
readOrgWorkspaces: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceWorkspace,
OrganizationID: adminUser.OrganizationID.String(),
},
Action: "read",
},
readMyself: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceUser,
OwnerID: "me",
},
Action: "read",
},
readOwnWorkspaces: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceWorkspace,
OrganizationID: adminUser.OrganizationID.String(),
OwnerID: "me",
},
Action: "read",
},
updateSpecificTemplate: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceTemplate,
ResourceID: template.ID.String(),
},
Action: "update",
},
}
testCases := []struct {
Name string
Client *codersdk.Client
UserID uuid.UUID
Check codersdk.AuthorizationResponse
}{
{
Name: "Admin",
Client: adminClient,
UserID: adminUser.UserID,
Check: map[string]bool{
readAllUsers: true,
readOrgWorkspaces: true,
readMyself: true,
readOwnWorkspaces: true,
updateSpecificTemplate: true,
},
},
{
Name: "OrgAdmin",
Client: orgAdminClient,
UserID: orgAdminUser.ID,
Check: map[string]bool{
readAllUsers: true,
readOrgWorkspaces: true,
readMyself: true,
readOwnWorkspaces: true,
updateSpecificTemplate: true,
},
},
{
Name: "Member",
Client: memberClient,
UserID: memberUser.ID,
Check: map[string]bool{
readAllUsers: false,
readOrgWorkspaces: false,
readMyself: true,
readOwnWorkspaces: true,
updateSpecificTemplate: false,
},
},
}
for _, c := range testCases {
t.Run("CheckAuthorization/"+c.Name, func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
resp, err := c.Client.AuthCheck(ctx, codersdk.AuthorizationRequest{Checks: params})
require.NoError(t, err, "check perms")
require.Equal(t, c.Check, resp)
})
}
// Enough same-typed checks in one request to push a group past the batching
// threshold, exercising the grouped partial-evaluation path and the key
// mapping. Reading org members is allowed for any member; updating them is
// admin-only, so the two actions must map back to their keys distinctly.
t.Run("CheckAuthorization/Grouped", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
grouped := make(map[string]codersdk.AuthorizationCheck)
adminExpected := make(map[string]bool)
memberExpected := make(map[string]bool)
for i := 0; i < 55; i++ {
readKey := fmt.Sprintf("read-members-%d", i)
grouped[readKey] = codersdk.AuthorizationCheck{
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceOrganizationMember,
OrganizationID: adminUser.OrganizationID.String(),
},
Action: "read",
}
adminExpected[readKey] = true
memberExpected[readKey] = true
updateKey := fmt.Sprintf("update-members-%d", i)
grouped[updateKey] = codersdk.AuthorizationCheck{
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceOrganizationMember,
OrganizationID: adminUser.OrganizationID.String(),
},
Action: "update",
}
adminExpected[updateKey] = true
memberExpected[updateKey] = false
}
adminResp, err := adminClient.AuthCheck(ctx, codersdk.AuthorizationRequest{Checks: grouped})
require.NoError(t, err)
require.Equal(t, adminExpected, map[string]bool(adminResp))
memberResp, err := memberClient.AuthCheck(ctx, codersdk.AuthorizationRequest{Checks: grouped})
require.NoError(t, err)
require.Equal(t, memberExpected, map[string]bool(memberResp))
})
// A member may create a workspace in an org it belongs to, so an
// any_org=true check is allowed. Repeating it past the batching threshold
// must not change the answer: AnyOrgOwner objects have no verified partial-
// evaluation semantics, so they must stay on the per-object path rather than
// being grouped into rbac.Filter's prepared query, which denies them.
t.Run("CheckAuthorization/AnyOrg", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
check := codersdk.AuthorizationCheck{
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceWorkspace,
OwnerID: "me",
AnyOrgOwner: true,
},
Action: "create",
}
// Below the threshold: a single check is evaluated in full and allowed.
single, err := memberClient.AuthCheck(ctx, codersdk.AuthorizationRequest{
Checks: map[string]codersdk.AuthorizationCheck{"create-any-org": check},
})
require.NoError(t, err)
require.True(t, single["create-any-org"], "single any_org check should be allowed")
// The same check repeated past the threshold must stay allowed.
grouped := make(map[string]codersdk.AuthorizationCheck)
expected := make(map[string]bool)
for i := 0; i < 55; i++ {
key := fmt.Sprintf("create-any-org-%d", i)
grouped[key] = check
expected[key] = true
}
resp, err := memberClient.AuthCheck(ctx, codersdk.AuthorizationRequest{Checks: grouped})
require.NoError(t, err)
require.Equal(t, expected, map[string]bool(resp))
})
// A single (read, workspace) group past the batching threshold mixing
// resource_id checks (concrete workspaces fetched via the maxFetch path)
// with org-scoped checks (synthetic org-level objects). The member owns the
// fetched workspace so those keys are allowed, but cannot read all org
// workspaces so the org-scoped keys are denied. Both object shapes must map
// back to the correct per-key verdict through the one prepared query.
t.Run("CheckAuthorization/MixedGroup", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
workspace := coderdtest.CreateWorkspace(t, memberClient, template.ID)
coderdtest.AwaitWorkspaceBuildJobCompleted(t, memberClient, workspace.LatestBuild.ID)
grouped := make(map[string]codersdk.AuthorizationCheck)
expected := make(map[string]bool)
// resource_id checks are capped at maxFetch (10); the member owns the
// workspace, so reading it is allowed.
for i := 0; i < 10; i++ {
key := fmt.Sprintf("read-own-workspace-%d", i)
grouped[key] = codersdk.AuthorizationCheck{
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceWorkspace,
ResourceID: workspace.ID.String(),
},
Action: "read",
}
expected[key] = true
}
// Org-scoped checks push the (read, workspace) group past the threshold.
// A member cannot read every workspace in the org, so these are denied.
for i := 0; i < 45; i++ {
key := fmt.Sprintf("read-org-workspace-%d", i)
grouped[key] = codersdk.AuthorizationCheck{
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceWorkspace,
OrganizationID: adminUser.OrganizationID.String(),
},
Action: "read",
}
expected[key] = false
}
resp, err := memberClient.AuthCheck(ctx, codersdk.AuthorizationRequest{Checks: grouped})
require.NoError(t, err)
require.Equal(t, expected, map[string]bool(resp))
})
}