Files
threshold/internal/perms/acl_test.go
T
Timothy Messier 2b994f3005 fix(perms): Properly resolve "only self" for permissions (#2448)
When generating permissions from the grants, if a single grant was
limited to the set of "self" actions, the permission would be marked as
only self, even if additional grants were given for non-self actions.
This would result in the generated permissions being more limiting then
they should be based on the grants. This only impacts the sessions list
endpoint. It would result in users that have been granted access to list
other user's sessions to be unable to see these results in the list
results.
2022-09-13 19:46:52 -04:00

837 lines
24 KiB
Go

package perms
import (
"encoding/json"
"fmt"
"testing"
"github.com/hashicorp/boundary/internal/intglobals"
"github.com/hashicorp/boundary/internal/types/action"
"github.com/hashicorp/boundary/internal/types/resource"
"github.com/hashicorp/boundary/internal/types/scope"
"github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/scopes"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type scopeGrant struct {
scope string
grants []string
}
func Test_ACLAllowed(t *testing.T) {
t.Parallel()
type actionAuthorized struct {
action action.Type
authorized bool
outputFields []string
}
type input struct {
name string
scopeGrants []scopeGrant
resource Resource
actionsAuthorized []actionAuthorized
userId string
accountId string
}
// A set of common grants to use in the following tests
commonGrants := []scopeGrant{
{
scope: "o_a",
grants: []string{
"id=a_bar;actions=read,update",
"id=a_baz;actions=read:self,update",
"type=host-catalog;actions=create",
"type=target;actions=list",
"id=*;type=host-set;actions=list,create",
},
},
{
scope: "o_b",
grants: []string{
"id=*;type=host-set;actions=list,create",
"id=mypin;type=host;actions=*;output_fields=name,description",
"id=*;type=*;actions=authenticate",
"id=*;type=*;output_fields=id",
},
},
{
scope: "o_c",
grants: []string{
"id={{user.id }};actions=read,update",
"id={{ account.id}};actions=change-password",
},
},
{
scope: "o_d",
grants: []string{
"id=*;type=*;actions=create,update",
"id=*;type=session;actions=*",
"id=*;type=account;actions=update;output_fields=id,version",
},
},
}
// See acl.go for expected allowed formats. The goal here is to basically
// test those, but also test a whole bunch of nonconforming values.
tests := []input{
{
name: "no grants",
resource: Resource{ScopeId: "foo", Id: "bar", Type: resource.HostCatalog},
actionsAuthorized: []actionAuthorized{
{action: action.Create},
{action: action.Read},
},
},
{
name: "no overlap",
resource: Resource{ScopeId: "foo", Id: "bar", Type: resource.HostCatalog},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Create},
{action: action.Read},
},
},
{
name: "top level create with type only",
resource: Resource{ScopeId: "o_a", Type: resource.HostCatalog},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Create, authorized: true},
{action: action.Delete},
},
},
{
name: "matching scope and id no matching action",
resource: Resource{ScopeId: "o_a", Id: "a_foo", Type: resource.Role},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Update},
{action: action.Delete},
},
},
{
name: "matching scope and id and matching action",
resource: Resource{ScopeId: "o_a", Id: "a_bar"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, authorized: true},
{action: action.Update, authorized: true},
{action: action.Delete},
},
},
{
name: "matching scope and type and all action with valid pin",
resource: Resource{ScopeId: "o_b", Pin: "mypin", Type: resource.Host},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, authorized: true, outputFields: []string{"description", "id", "name"}},
{action: action.Update, authorized: true, outputFields: []string{"description", "id", "name"}},
{action: action.Delete, authorized: true, outputFields: []string{"description", "id", "name"}},
},
},
{
name: "matching scope and type and all action but bad pin",
resource: Resource{ScopeId: "o_b", Pin: "notmypin", Type: resource.Host},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, outputFields: []string{"id"}},
{action: action.Update, outputFields: []string{"id"}},
{action: action.Delete, outputFields: []string{"id"}},
},
},
{
name: "matching scope and id and some action",
resource: Resource{ScopeId: "o_b", Id: "myhost", Type: resource.HostSet},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List, authorized: true, outputFields: []string{"id"}},
{action: action.Create, authorized: true, outputFields: []string{"id"}},
{action: action.AddHosts, outputFields: []string{"id"}},
},
},
{
name: "matching scope and id and all action but bad specifier",
resource: Resource{ScopeId: "o_b", Id: "id_g"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, outputFields: []string{"id"}},
{action: action.Update, outputFields: []string{"id"}},
{action: action.Delete, outputFields: []string{"id"}},
},
},
{
name: "matching scope and not matching type",
resource: Resource{ScopeId: "o_a", Type: resource.HostCatalog},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Update},
{action: action.Delete},
},
},
{
name: "matching scope and matching type",
resource: Resource{ScopeId: "o_a", Type: resource.HostSet},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List, authorized: true},
{action: action.Create, authorized: true},
{action: action.Delete},
},
},
{
name: "matching scope, type, action, random id and bad pin",
resource: Resource{ScopeId: "o_a", Id: "anything", Type: resource.HostCatalog, Pin: "a_bar"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Update},
{action: action.Delete},
{action: action.Read},
},
},
{
name: "wrong scope and matching type",
resource: Resource{ScopeId: "o_bad", Type: resource.HostSet},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List},
{action: action.Create},
{action: action.Delete},
},
},
{
name: "any id",
resource: Resource{ScopeId: "o_b", Type: resource.AuthMethod},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List, outputFields: []string{"id"}},
{action: action.Authenticate, authorized: true, outputFields: []string{"id"}},
{action: action.Delete, outputFields: []string{"id"}},
},
},
{
name: "bad templated user id",
resource: Resource{ScopeId: "o_c"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List},
{action: action.Authenticate},
{action: action.Delete},
},
userId: "u_abcd1234",
},
{
name: "good templated user id",
resource: Resource{ScopeId: "o_c", Id: "u_abcd1234"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, authorized: true},
{action: action.Update, authorized: true},
},
userId: "u_abcd1234",
},
{
name: "bad templated old account id",
resource: Resource{ScopeId: "o_c"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List},
{action: action.Authenticate},
{action: action.Delete},
},
accountId: fmt.Sprintf("%s_1234567890", intglobals.OldPasswordAccountPrefix),
},
{
name: "good templated old account id",
resource: Resource{ScopeId: "o_c", Id: fmt.Sprintf("%s_1234567890", intglobals.OldPasswordAccountPrefix)},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.ChangePassword, authorized: true},
{action: action.Update},
},
accountId: fmt.Sprintf("%s_1234567890", intglobals.OldPasswordAccountPrefix),
},
{
name: "bad templated new account id",
resource: Resource{ScopeId: "o_c"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List},
{action: action.Authenticate},
{action: action.Delete},
},
accountId: fmt.Sprintf("%s_1234567890", intglobals.NewPasswordAccountPrefix),
},
{
name: "good templated new account id",
resource: Resource{ScopeId: "o_c", Id: fmt.Sprintf("%s_1234567890", intglobals.NewPasswordAccountPrefix)},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.ChangePassword, authorized: true},
{action: action.Update},
},
accountId: fmt.Sprintf("%s_1234567890", intglobals.NewPasswordAccountPrefix),
},
{
name: "all type",
resource: Resource{ScopeId: "o_d", Type: resource.Account},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Create, authorized: true},
{action: action.Update, authorized: true, outputFields: []string{"id", "version"}},
},
userId: "u_abcd1234",
},
{
name: "list with top level list",
resource: Resource{ScopeId: "o_a", Type: resource.Target},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List, authorized: true},
},
},
{
name: "list sessions with wildcard actions",
resource: Resource{ScopeId: "o_d", Type: resource.Session},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.List, authorized: true},
},
},
{
name: "read self with top level read",
resource: Resource{ScopeId: "o_a", Id: "a_bar"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read, authorized: true},
{action: action.ReadSelf, authorized: true},
},
},
{
name: "read self only",
resource: Resource{ScopeId: "o_a", Id: "a_baz"},
scopeGrants: commonGrants,
actionsAuthorized: []actionAuthorized{
{action: action.Read},
{action: action.ReadSelf, authorized: true},
},
},
{
name: "create worker with create",
resource: Resource{ScopeId: scope.Global.String(), Type: resource.Worker},
scopeGrants: []scopeGrant{
{
scope: scope.Global.String(),
grants: []string{
"type=worker;actions=create",
},
},
},
actionsAuthorized: []actionAuthorized{
{action: action.CreateWorkerLed, authorized: true},
},
},
{
name: "create worker with request only",
resource: Resource{ScopeId: scope.Global.String(), Type: resource.Worker},
scopeGrants: []scopeGrant{
{
scope: scope.Global.String(),
grants: []string{
"type=worker;actions=create:worker-led",
},
},
},
actionsAuthorized: []actionAuthorized{
{action: action.CreateWorkerLed, authorized: true},
},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
var grants []Grant
for _, sg := range test.scopeGrants {
for _, g := range sg.grants {
grant, err := Parse(sg.scope, g, WithAccountId(test.accountId), WithUserId(test.userId))
require.NoError(t, err)
grants = append(grants, grant)
}
}
acl := NewACL(grants...)
for _, aa := range test.actionsAuthorized {
userId := test.userId
if userId == "" {
userId = "u_1234567890"
}
result := acl.Allowed(test.resource, aa.action, userId)
assert.True(t, result.Authorized == aa.authorized, "action: %s, acl authorized: %t, test action authorized: %t", aa.action, result.Authorized, aa.authorized)
assert.ElementsMatch(t, result.OutputFields.Fields(), aa.outputFields)
}
})
}
}
func TestACL_ListPermissions(t *testing.T) {
tests := []struct {
name string
aclGrants []scopeGrant
scopes map[string]*scopes.ScopeInfo // *scopes.ScopeInfo isn't used at the moment.
resourceType resource.Type
actionSet action.ActionSet
expPermissions []Permission
}{
{
name: "Requested scope(s) not present in ACL scope map",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=list,read"},
},
},
scopes: map[string]*scopes.ScopeInfo{
"o_non_existent_scope": nil,
"o_this_one_too": nil,
},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{},
},
{
name: "Requested resource mismatch",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=target;actions=list,read"}, // List & Read for all Targets
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session, // We're requesting sessions.
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{},
},
{
name: "Requested actions not available for the requested scope id",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=delete"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{},
},
{
name: "No specific id or wildcard provided for `id` field",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"type=*;actions=list,read"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{},
},
{
name: "Allow all ids",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=list,read"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: false,
All: true,
},
},
},
{
name: "Allow all ids, :self actions",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=list,read:self"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: true,
All: true,
},
},
},
{
name: "Allow specific IDs",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{
"id=s_1;type=session;actions=list,read",
"id=s_2;type=session;actions=list,read",
"id=s_3;type=session;actions=list,read",
},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: []string{"s_1", "s_2", "s_3"},
OnlySelf: false,
All: false,
},
},
},
{
name: "No specific type 1",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=*;actions=list,read:self"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: true,
All: true,
},
},
},
{
name: "List + No-op action with id wildcard",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=list,no-op"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: false,
All: true,
},
},
},
{
name: "List + No-op action with id wildcard, read requested",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=session;actions=list,no-op"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.Read},
expPermissions: []Permission{},
},
{
name: "List + No-op action with specific ids",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{
"id=s_1;type=session;actions=list,no-op",
"id=s_2;type=session;actions=list,no-op",
"id=s_3;type=session;actions=list,no-op",
},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: []string{"s_1", "s_2", "s_3"},
OnlySelf: false,
All: false,
},
},
},
{
name: "No specific type 2",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=*;actions=list,read:self"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Host,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Host,
Action: action.List,
ResourceIds: nil,
OnlySelf: true,
All: true,
},
},
},
{
name: "Grant hierarchy is respected",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{
"id=*;type=*;actions=*",
"id=*;type=session;actions=cancel:self,list,read:self",
},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.NoOp, action.Read, action.ReadSelf, action.Cancel, action.CancelSelf},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: false,
All: true,
},
},
},
{
name: "Full access 1",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=*;actions=*"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read, action.Create, action.Delete},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: false,
All: true,
},
},
},
{
name: "Full access 2",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{"id=*;type=*;actions=*"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil},
resourceType: resource.Host,
actionSet: action.ActionSet{action.List, action.Read, action.Create, action.Delete},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Host,
Action: action.List,
ResourceIds: nil,
OnlySelf: false,
All: true,
},
},
},
{
name: "Multiple scopes",
aclGrants: []scopeGrant{
{
scope: "o_1",
grants: []string{
"id=s_1;type=session;actions=list,read",
"id=s_2;type=session;actions=list,read",
"id=s_3;type=session;actions=list,read",
},
},
{
scope: "o_2",
grants: []string{"id=*;type=session;actions=list,read:self"},
},
},
scopes: map[string]*scopes.ScopeInfo{"o_1": nil, "o_2": nil},
resourceType: resource.Session,
actionSet: action.ActionSet{action.List, action.Read},
expPermissions: []Permission{
{
ScopeId: "o_1",
Resource: resource.Session,
Action: action.List,
ResourceIds: []string{"s_1", "s_2", "s_3"},
OnlySelf: false,
All: false,
},
{
ScopeId: "o_2",
Resource: resource.Session,
Action: action.List,
ResourceIds: nil,
OnlySelf: true,
All: true,
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var grants []Grant
for _, sg := range tt.aclGrants {
for _, g := range sg.grants {
grant, err := Parse(sg.scope, g, WithSkipFinalValidation(true))
require.NoError(t, err)
grants = append(grants, grant)
}
}
acl := NewACL(grants...)
perms := acl.ListPermissions(tt.scopes, tt.resourceType, tt.actionSet)
require.ElementsMatch(t, tt.expPermissions, perms)
})
}
}
func TestJsonMarshal(t *testing.T) {
res := &Resource{
ScopeId: "scope",
Id: "id",
Type: resource.Controller,
Pin: "",
}
out, err := json.Marshal(res)
require.NoError(t, err)
assert.Equal(t, `{"scope_id":"scope","id":"id","type":"controller"}`, string(out))
}
// Test_AnonRestrictions loops through every resource and action and ensures
// that it always fails for the anonymous user, regardless of what is granted,
// except for the specific things allowed.
func Test_AnonRestrictions(t *testing.T) {
t.Parallel()
type input struct {
name string
grant string
templatedType bool
shouldHaveSuccess bool
}
tests := []input{
{
name: "id-specific",
grant: "id=foobar;actions=%s",
},
{
name: "wildcard-id",
grant: "id=*;type=%s;actions=%s",
templatedType: true,
shouldHaveSuccess: true,
},
{
name: "wildcard-id-and-type",
grant: "id=*;type=*;actions=%s",
},
{
name: "no-id",
grant: "type=%s;actions=%s",
templatedType: true,
shouldHaveSuccess: true,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
require, assert := require.New(t), assert.New(t)
for i := resource.Type(1); i <= resource.Credential; i++ {
if i == resource.Controller || i == resource.Worker {
continue
}
for j := action.Type(1); j <= action.ReadCertificateAuthority; j++ {
res := Resource{
ScopeId: scope.Global.String(),
Id: "foobar",
Type: resource.Type(i),
}
grant := test.grant
if test.templatedType {
grant = fmt.Sprintf(grant, resource.Type(i).String(), action.Type(j).String())
} else {
grant = fmt.Sprintf(grant, action.Type(j).String())
}
parsedGrant, err := Parse(scope.Global.String(), grant, WithSkipFinalValidation(true))
require.NoError(err)
acl := NewACL(parsedGrant)
results := acl.Allowed(res, action.Type(j), AnonymousUserId)
switch test.shouldHaveSuccess {
case true:
// Ensure it's one of the specific cases and fail otherwise
switch {
case i == resource.Scope && (j == action.List || j == action.NoOp):
assert.True(results.Authorized, fmt.Sprintf("i: %v, j: %v", i, j))
case i == resource.AuthMethod && (j == action.List || j == action.NoOp || j == action.Authenticate):
assert.True(results.Authorized, fmt.Sprintf("i: %v, j: %v", i, j))
default:
assert.False(results.Authorized, fmt.Sprintf("i: %v, j: %v", i, j))
}
default:
// Should always fail
assert.False(results.Authorized)
}
}
}
})
}
}