Files
argo-cd/util/rbac/rbac_test.go
Michael Crenshaw 0ec46f6857 chore(ci): upgrade golangci-lint to v2 (#22484)
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-03-27 12:37:52 -04:00

525 lines
20 KiB
Go

package rbac
import (
"context"
"strings"
"testing"
"time"
"github.com/argoproj/argo-cd/v3/util/test"
"github.com/golang-jwt/jwt/v5"
log "github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/fake"
"github.com/argoproj/argo-cd/v3/util/assets"
)
const (
fakeConfigMapName = "fake-cm"
fakeNamespace = "fake-ns"
)
var noOpUpdate = func(_ *corev1.ConfigMap) error {
return nil
}
func fakeConfigMap() *corev1.ConfigMap {
cm := corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{
Kind: "ConfigMap",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: fakeConfigMapName,
Namespace: fakeNamespace,
},
Data: make(map[string]string),
}
return &cm
}
func TestPolicyCSV(t *testing.T) {
t.Run("will return empty string if data has no csv entries", func(t *testing.T) {
// given
data := make(map[string]string)
// when
policy := PolicyCSV(data)
// then
assert.Empty(t, policy)
})
t.Run("will return just policy defined with default key", func(t *testing.T) {
// given
data := make(map[string]string)
expectedPolicy := "policy1\npolicy2"
data[ConfigMapPolicyCSVKey] = expectedPolicy
data["UnrelatedKey"] = "unrelated value"
// when
policy := PolicyCSV(data)
// then
assert.Equal(t, expectedPolicy, policy)
})
t.Run("will return composed policy provided by multiple policy keys", func(t *testing.T) {
// given
data := make(map[string]string)
data[ConfigMapPolicyCSVKey] = "policy1"
data["UnrelatedKey"] = "unrelated value"
data["policy.overlay1.csv"] = "policy2"
data["policy.overlay2.csv"] = "policy3"
// when
policy := PolicyCSV(data)
// then
assert.Regexp(t, "^policy1", policy)
assert.Contains(t, policy, "policy2")
assert.Contains(t, policy, "policy3")
})
t.Run("will return composed policy in a deterministic order", func(t *testing.T) {
// given
data := make(map[string]string)
data["UnrelatedKey"] = "unrelated value"
data["policy.B.csv"] = "policyb"
data["policy.A.csv"] = "policya"
data["policy.C.csv"] = "policyc"
data[ConfigMapPolicyCSVKey] = "policy1"
// when
policy := PolicyCSV(data)
// then
result := strings.Split(policy, "\n")
assert.Len(t, result, 4)
assert.Equal(t, "policy1", result[0])
assert.Equal(t, "policya", result[1])
assert.Equal(t, "policyb", result[2])
assert.Equal(t, "policyc", result[3])
})
}
// TestBuiltinPolicyEnforcer tests the builtin policy rules
func TestBuiltinPolicyEnforcer(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
// Without setting builtin policy, this should fail
assert.False(t, enf.Enforce("admin", "applications", "get", "foo/bar"))
// now set builtin policy
_ = enf.SetBuiltinPolicy(assets.BuiltinPolicyCSV)
allowed := [][]any{
{"admin", "applications", "get", "foo/bar"},
{"admin", "applications", "delete", "foo/bar"},
{"role:readonly", "applications", "get", "foo/bar"},
{"role:admin", "applications", "get", "foo/bar"},
{"role:admin", "applications", "delete", "foo/bar"},
}
for _, a := range allowed {
if !assert.True(t, enf.Enforce(a...)) {
log.Errorf("%s: expected true, got false", a)
}
}
disallowed := [][]any{
{"role:readonly", "applications", "create", "foo/bar"},
{"role:readonly", "applications", "delete", "foo/bar"},
}
for _, a := range disallowed {
if !assert.False(t, enf.Enforce(a...)) {
log.Errorf("%s: expected false, got true", a)
}
}
}
// TestProjectIsolationEnforcement verifies the ability to create Project specific policies
func TestProjectIsolationEnforcement(t *testing.T) {
kubeclientset := fake.NewClientset(fakeConfigMap())
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
policy := `
p, role:foo-admin, *, *, foo/*, allow
p, role:bar-admin, *, *, bar/*, allow
g, alice, role:foo-admin
g, bob, role:bar-admin
`
_ = enf.SetBuiltinPolicy(policy)
// verify alice can only affect objects in foo and not bar,
// and that bob can only affect objects in bar and not foo
assert.True(t, enf.Enforce("bob", "applications", "delete", "bar/obj"))
assert.False(t, enf.Enforce("bob", "applications", "delete", "foo/obj"))
assert.True(t, enf.Enforce("alice", "applications", "delete", "foo/obj"))
assert.False(t, enf.Enforce("alice", "applications", "delete", "bar/obj"))
}
// TestProjectReadOnly verifies the ability to have a read only role in a Project
func TestProjectReadOnly(t *testing.T) {
kubeclientset := fake.NewClientset(fakeConfigMap())
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
policy := `
p, role:foo-readonly, *, get, foo/*, allow
g, alice, role:foo-readonly
`
_ = enf.SetBuiltinPolicy(policy)
assert.True(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("alice", "applications", "delete", "bar/obj"))
assert.False(t, enf.Enforce("alice", "applications", "get", "bar/obj"))
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
}
// TestDefaultRole tests the ability to set a default role
func TestDefaultRole(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
_ = enf.SetBuiltinPolicy(assets.BuiltinPolicyCSV)
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/bar"))
// after setting the default role to be the read-only role, this should now pass
enf.SetDefaultRole("role:readonly")
assert.True(t, enf.Enforce("bob", "applications", "get", "foo/bar"))
}
// TestURLAsObjectName tests the ability to have a URL as an object name
func TestURLAsObjectName(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
policy := `
p, alice, repositories, *, foo/*, allow
p, bob, repositories, *, foo/https://github.com/argoproj/argo-cd.git, allow
p, cathy, repositories, *, foo/*, allow
`
_ = enf.SetUserPolicy(policy)
assert.True(t, enf.Enforce("alice", "repositories", "delete", "foo/https://github.com/argoproj/argo-cd.git"))
assert.True(t, enf.Enforce("alice", "repositories", "delete", "foo/https://github.com/golang/go.git"))
assert.True(t, enf.Enforce("bob", "repositories", "delete", "foo/https://github.com/argoproj/argo-cd.git"))
assert.False(t, enf.Enforce("bob", "repositories", "delete", "foo/https://github.com/golang/go.git"))
}
func TestEnableDisableEnforce(t *testing.T) {
kubeclientset := fake.NewClientset(fakeConfigMap())
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
policy := `
p, alice, *, get, foo/obj, allow
p, mike, *, get, foo/obj, deny
`
_ = enf.SetUserPolicy(policy)
enf.SetClaimsEnforcerFunc(func(_ jwt.Claims, _ ...any) bool {
return false
})
assert.True(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("alice", "applications/resources", "delete", "foo/obj"))
assert.False(t, enf.Enforce("mike", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("mike", "applications/resources", "delete", "foo/obj"))
assert.False(t, enf.Enforce(nil, "applications/resources", "delete", "foo/obj"))
assert.False(t, enf.Enforce(&jwt.RegisteredClaims{}, "applications/resources", "delete", "foo/obj"))
enf.EnableEnforce(false)
assert.True(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.True(t, enf.Enforce("alice", "applications/resources", "delete", "foo/obj"))
assert.True(t, enf.Enforce("mike", "applications", "get", "foo/obj"))
assert.True(t, enf.Enforce("mike", "applications/resources", "delete", "foo/obj"))
assert.True(t, enf.Enforce(nil, "applications/resources", "delete", "foo/obj"))
assert.True(t, enf.Enforce(&jwt.RegisteredClaims{}, "applications/resources", "delete", "foo/obj"))
}
func TestUpdatePolicy(t *testing.T) {
kubeclientset := fake.NewClientset(fakeConfigMap())
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
_ = enf.SetUserPolicy("p, alice, *, get, foo/obj, allow")
assert.True(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
_ = enf.SetUserPolicy("p, bob, *, get, foo/obj, allow")
assert.False(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.True(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
_ = enf.SetUserPolicy("")
assert.False(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
_ = enf.SetBuiltinPolicy("p, alice, *, get, foo/obj, allow")
assert.True(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
_ = enf.SetBuiltinPolicy("p, bob, *, get, foo/obj, allow")
assert.False(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.True(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
_ = enf.SetBuiltinPolicy("")
assert.False(t, enf.Enforce("alice", "applications", "get", "foo/obj"))
assert.False(t, enf.Enforce("bob", "applications", "get", "foo/obj"))
}
func TestNoPolicy(t *testing.T) {
cm := fakeConfigMap()
kubeclientset := fake.NewClientset(cm)
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
assert.False(t, enf.Enforce("admin", "applications", "delete", "foo/bar"))
}
// TestValidatePolicyCheckUserDefinedPolicyReferentialIntegrity adds a hook into logrus.StandardLogger and validates
// policies with and without referential integrity issues. Log entries are searched to verify expected outcomes.
func TestValidatePolicyCheckUserDefinedPolicyReferentialIntegrity(t *testing.T) {
// Policy with referential integrity
policy := `
p, role:depA, *, get, foo/obj, allow
p, role:depB, *, get, foo/obj, deny
g, depA, role:depA
g, depB, role:depB
`
hook := test.LogHook{}
log.AddHook(&hook)
t.Cleanup(func() {
log.StandardLogger().ReplaceHooks(log.LevelHooks{})
})
require.NoError(t, ValidatePolicy(policy))
assert.Empty(t, hook.GetRegexMatchesInEntries("user defined roles not found in policies"))
// Policy with a role reference which transitively associates to policies
policy = `
p, role:depA, *, get, foo/obj, allow
p, role:depB, *, get, foo/obj, deny
g, depC, role:depC
g, role:depC, role:depA
`
require.NoError(t, ValidatePolicy(policy))
assert.Empty(t, hook.GetRegexMatchesInEntries("user defined roles not found in policies"))
// Policy with a role reference which has no associated policies
policy = `
p, role:depA, *, get, foo/obj, allow
p, role:depB, *, get, foo/obj, deny
g, depC, role:depC
`
require.NoError(t, ValidatePolicy(policy))
assert.Len(t, hook.GetRegexMatchesInEntries("user defined roles not found in policies: role:depC"), 1)
}
// TestClaimsEnforcerFunc tests
func TestClaimsEnforcerFunc(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
claims := jwt.RegisteredClaims{
Subject: "foo",
}
assert.False(t, enf.Enforce(&claims, "applications", "get", "foo/bar"))
enf.SetClaimsEnforcerFunc(func(_ jwt.Claims, _ ...any) bool {
return true
})
assert.True(t, enf.Enforce(&claims, "applications", "get", "foo/bar"))
}
// TestDefaultRoleWithRuntimePolicy tests the ability for a default role to still take affect when
// enforcing a runtime policy
func TestDefaultRoleWithRuntimePolicy(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
runtimePolicy := assets.BuiltinPolicyCSV
assert.False(t, enf.EnforceRuntimePolicy("", runtimePolicy, "bob", "applications", "get", "foo/bar"))
enf.SetDefaultRole("role:readonly")
assert.True(t, enf.EnforceRuntimePolicy("", runtimePolicy, "bob", "applications", "get", "foo/bar"))
}
// TestClaimsEnforcerFuncWithRuntimePolicy tests the ability for claims enforcer function to still
// take effect when enforcing a runtime policy
func TestClaimsEnforcerFuncWithRuntimePolicy(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
runtimePolicy := assets.BuiltinPolicyCSV
claims := jwt.RegisteredClaims{
Subject: "foo",
}
assert.False(t, enf.EnforceRuntimePolicy("", runtimePolicy, claims, "applications", "get", "foo/bar"))
enf.SetClaimsEnforcerFunc(func(_ jwt.Claims, _ ...any) bool {
return true
})
assert.True(t, enf.EnforceRuntimePolicy("", runtimePolicy, claims, "applications", "get", "foo/bar"))
}
// TestInvalidRuntimePolicy tests when an invalid policy is supplied, it falls back to normal enforcement
func TestInvalidRuntimePolicy(t *testing.T) {
cm := fakeConfigMap()
kubeclientset := fake.NewClientset(cm)
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
_ = enf.SetBuiltinPolicy(assets.BuiltinPolicyCSV)
assert.True(t, enf.EnforceRuntimePolicy("", "", "admin", "applications", "update", "foo/bar"))
assert.False(t, enf.EnforceRuntimePolicy("", "", "role:readonly", "applications", "update", "foo/bar"))
badPolicy := "this, is, not, a, good, policy"
assert.True(t, enf.EnforceRuntimePolicy("", badPolicy, "admin", "applications", "update", "foo/bar"))
assert.False(t, enf.EnforceRuntimePolicy("", badPolicy, "role:readonly", "applications", "update", "foo/bar"))
}
func TestValidatePolicy(t *testing.T) {
goodPolicies := []string{
"p, role:admin, projects, delete, *, allow",
"",
"#",
`p, "role,admin", projects, delete, *, allow`,
` p, role:admin, projects, delete, *, allow `,
}
for _, good := range goodPolicies {
require.NoError(t, ValidatePolicy(good))
}
badPolicies := []string{
"this, is, not, a, good, policy",
"this\ttoo",
}
for _, bad := range badPolicies {
require.Error(t, ValidatePolicy(bad))
}
}
// TestEnforceErrorMessage ensures we give descriptive error message
func TestEnforceErrorMessage(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
err := enf.syncUpdate(fakeConfigMap(), noOpUpdate)
require.NoError(t, err)
require.EqualError(t, enf.EnforceErr("admin", "applications", "get", "foo/bar"), "rpc error: code = PermissionDenied desc = permission denied: applications, get, foo/bar")
require.EqualError(t, enf.EnforceErr(), "rpc error: code = PermissionDenied desc = permission denied")
//nolint:staticcheck
ctx := context.WithValue(t.Context(), "claims", &jwt.RegisteredClaims{Subject: "proj:default:admin"})
require.EqualError(t, enf.EnforceErr(ctx.Value("claims"), "project"), "rpc error: code = PermissionDenied desc = permission denied: project, sub: proj:default:admin")
iat := time.Unix(int64(1593035962), 0).Format(time.RFC3339)
exp := "rpc error: code = PermissionDenied desc = permission denied: project, sub: proj:default:admin, iat: " + iat
//nolint:staticcheck
ctx = context.WithValue(t.Context(), "claims", &jwt.RegisteredClaims{Subject: "proj:default:admin", IssuedAt: jwt.NewNumericDate(time.Unix(int64(1593035962), 0))})
require.EqualError(t, enf.EnforceErr(ctx.Value("claims"), "project"), exp)
//nolint:staticcheck
ctx = context.WithValue(t.Context(), "claims", &jwt.RegisteredClaims{ExpiresAt: jwt.NewNumericDate(time.Now())})
require.EqualError(t, enf.EnforceErr(ctx.Value("claims"), "project"), "rpc error: code = PermissionDenied desc = permission denied: project")
//nolint:staticcheck
ctx = context.WithValue(t.Context(), "claims", &jwt.RegisteredClaims{Subject: "proj:default:admin", IssuedAt: nil})
assert.EqualError(t, enf.EnforceErr(ctx.Value("claims"), "project"), "rpc error: code = PermissionDenied desc = permission denied: project, sub: proj:default:admin")
}
func TestDefaultGlobMatchMode(t *testing.T) {
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(fakeConfigMap(), noOpUpdate))
policy := `
p, alice, clusters, get, "https://github.com/*/*.git", allow
`
_ = enf.SetUserPolicy(policy)
assert.True(t, enf.Enforce("alice", "clusters", "get", "https://github.com/argoproj/argo-cd.git"))
assert.False(t, enf.Enforce("alice", "repositories", "get", "https://github.com/argoproj/argo-cd.git"))
}
func TestGlobMatchMode(t *testing.T) {
cm := fakeConfigMap()
cm.Data[ConfigMapMatchModeKey] = GlobMatchMode
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(cm, noOpUpdate))
policy := `
p, alice, clusters, get, "https://github.com/*/*.git", allow
`
_ = enf.SetUserPolicy(policy)
assert.True(t, enf.Enforce("alice", "clusters", "get", "https://github.com/argoproj/argo-cd.git"))
assert.False(t, enf.Enforce("alice", "clusters", "get", "https://github.com/argo-cd.git"))
}
func TestRegexMatchMode(t *testing.T) {
cm := fakeConfigMap()
cm.Data[ConfigMapMatchModeKey] = RegexMatchMode
kubeclientset := fake.NewClientset()
enf := NewEnforcer(kubeclientset, fakeNamespace, fakeConfigMapName, nil)
require.NoError(t, enf.syncUpdate(cm, noOpUpdate))
policy := `
p, alice, clusters, get, "https://github.com/argo[a-z]{4}/argo-[a-z]+.git", allow
`
_ = enf.SetUserPolicy(policy)
assert.True(t, enf.Enforce("alice", "clusters", "get", "https://github.com/argoproj/argo-cd.git"))
assert.False(t, enf.Enforce("alice", "clusters", "get", "https://github.com/argoproj/1argo-cd.git"))
}
func TestGlobMatchFunc(t *testing.T) {
ok, _ := globMatchFunc("arg1")
assert.False(t, ok.(bool))
ok, _ = globMatchFunc(time.Now(), "arg2")
assert.False(t, ok.(bool))
ok, _ = globMatchFunc("arg1", time.Now())
assert.False(t, ok.(bool))
ok, _ = globMatchFunc("arg/123", "arg/*")
assert.True(t, ok.(bool))
}
func TestLoadPolicyLine(t *testing.T) {
t.Run("Valid permission line", func(t *testing.T) {
policy := `p, role:Myrole, applications, *, myproj/*, allow`
model := newBuiltInModel()
require.NoError(t, loadPolicyLine(policy, model))
})
t.Run("Valid grant line", func(t *testing.T) {
policy := `g, your-github-org:your-team, role:org-admin`
model := newBuiltInModel()
require.NoError(t, loadPolicyLine(policy, model))
})
t.Run("Empty policy line", func(t *testing.T) {
policy := ""
model := newBuiltInModel()
require.NoError(t, loadPolicyLine(policy, model))
})
t.Run("Comment policy line", func(t *testing.T) {
policy := "# Some comment"
model := newBuiltInModel()
require.NoError(t, loadPolicyLine(policy, model))
})
t.Run("Invalid policy line: single token", func(t *testing.T) {
policy := "p"
model := newBuiltInModel()
require.Error(t, loadPolicyLine(policy, model))
})
t.Run("Invalid policy line: plain text", func(t *testing.T) {
policy := "Some comment"
model := newBuiltInModel()
require.Error(t, loadPolicyLine(policy, model))
})
t.Run("Invalid policy line", func(t *testing.T) {
policy := "agh, foo, bar"
model := newBuiltInModel()
require.Error(t, loadPolicyLine(policy, model))
})
t.Run("Invalid policy line missing comma", func(t *testing.T) {
policy := "p, role:Myrole, applications, *, myproj/* allow"
model := newBuiltInModel()
require.Error(t, loadPolicyLine(policy, model))
})
t.Run("Invalid policy line missing policy type", func(t *testing.T) {
policy := ", role:Myrole, applications, *, myproj/*, allow"
model := newBuiltInModel()
require.Error(t, loadPolicyLine(policy, model))
})
}