TrueCloudLab/frostfs-node
20
1
Fork 27
Code Issues 101 Pull requests 6 Projects Releases 1 Activity Actions 2

[#1124] cli: Improve APE rule parsing
All checks were successful
Vulncheck / Vulncheck (pull_request) Successful in 1m25s
Details
DCO action / DCO (pull_request) Successful in 1m59s
Details
Build / Build Components (1.21) (pull_request) Successful in 2m27s
Details
Build / Build Components (1.22) (pull_request) Successful in 4m25s
Details
Pre-commit hooks / Pre-commit (pull_request) Successful in 4m57s
Details
Tests and linters / Staticcheck (pull_request) Successful in 5m38s
Details
Tests and linters / gopls check (pull_request) Successful in 5m57s
Details
Tests and linters / Lint (pull_request) Successful in 6m26s
Details
Tests and linters / Tests (1.22) (pull_request) Successful in 9m5s
Details
Tests and linters / Tests (1.21) (pull_request) Successful in 9m11s
Details
Tests and linters / Tests with -race (pull_request) Successful in 9m4s
Details

Browse source 
* Make APE rule parser to read condition's kind in unambiguous using lexemes
`ResourceCondition`, `RequestCondition` instead confusing `Object.Request`, `Object.Resource`.
* Fix unit-tests.

Signed-off-by: Airat Arifullin <a.arifullin@yadro.com>
This commit is contained in:
Airat Arifullin 2024-05-14 12:23:26 +03:00
parent 20baf6e112
commit 952d13cd2b
8 changed files with 149 additions and 145 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cmd/frostfs-cli/modules/control/add_rule.go
View file

@ -24,7 +24,7 @@ var addRuleCmd = &cobra.Command{
Long: "Add local APE rule to a node with following format:\n<action>[:action_detail] <operation> [<condition1> ...] <resource>",
Example: `control add-rule --endpoint ... -w ... --address ... --chain-id ChainID --cid ... --rule "allow Object.Get *"
--rule "deny Object.Get EbxzAdz5LB4uqxuz6crWKAumBNtZyK2rKsqQP7TdZvwr/*"
--rule "deny:QuotaLimitReached Object.Put Object.Resource:Department=HR *"
--rule "deny:QuotaLimitReached Object.Put ResourceCondition:Department=HR *"
control add-rule --endpoint ... -w ... --address ... --chain-id ChainID --cid ... --path some_chain.json
`,

56
cmd/frostfs-cli/modules/util/ape.go
View file

@ -21,7 +21,7 @@ var (
errUnknownAction = errors.New("action is not recognized")
errUnknownBinaryOperator = errors.New("binary operator is not recognized")
errUnknownCondObjectType = errors.New("condition object type is not recognized")
errMixedTypesInRule = errors.New("found mixed type of actions and conditions in rule")
errMixedTypesInRule = errors.New("found mixed type of actions in rule")
errNoActionsInRule = errors.New("there are no actions in rule")
errUnsupportedResourceFormat = errors.New("unsupported resource format")
errFailedToParseAllAny = errors.New("any/all is not parsed")
@ -38,10 +38,10 @@ func PrintHumanReadableAPEChain(cmd *cobra.Command, chain *apechain.Chain) {
cmd.Println("\tConditions:")
for _, c := range rule.Condition {
var ot string
switch c.Object {
case apechain.ObjectResource:
switch c.Kind {
case apechain.KindResource:
ot = "Resource"
case apechain.ObjectRequest:
case apechain.KindRequest:
ot = "Request"
default:
panic("unknown object type")
@ -100,9 +100,9 @@ func ParseAPEChain(chain *apechain.Chain, rules []string) error {
// deny Object.Put *
// deny:QuotaLimitReached Object.Put *
// allow Object.Put *
// allow Object.Get Object.Resource:Department=HR Object.Request:Actor=ownerA *
// allow Object.Get any Object.Resource:Department=HR Object.Request:Actor=ownerA *
// allow Object.Get all Object.Resource:Department=HR Object.Request:Actor=ownerA *
// allow Object.Get ResourceCondition:Department=HR RequestCondition:Actor=ownerA *
// allow Object.Get any ResourceCondition:Department=HR RequestCondition:Actor=ownerA *
// allow Object.Get all ResourceCondition:Department=HR RequestCondition:Actor=ownerA *
// allow Object.* *
// allow Container.* *
//
@ -138,7 +138,9 @@ func parseRuleLexemes(r *apechain.Rule, lexemes []string) error {
return err
}
var isObject *bool
var objectTargeted bool
var containerTargeted bool
for i, lexeme := range lexemes[1:] {
anyExpr, anyErr := parseAnyAll(lexeme)
if anyErr == nil {
@ -156,23 +158,30 @@ func parseRuleLexemes(r *apechain.Rule, lexemes []string) error {
lexemes = lexemes[i+1:]
break
}
actionType = condition.Object == apechain.ObjectResource || condition.Object == apechain.ObjectRequest
r.Condition = append(r.Condition, *condition)
} else {
r.Actions.Names = append(r.Actions.Names, names...)
if actionType {
objectTargeted = true
} else {
containerTargeted = true
}
if isObject == nil {
isObject = &actionType
} else if actionType != *isObject {
if objectTargeted && containerTargeted {
// Actually, APE chain allows to define rules for several resources, for example, if
// chain target is namespace, but the parser primitevly compiles verbs,
// conditions and resources in one rule. So, for the parser, one rule relates only to
// one resource type - object or container.
return errMixedTypesInRule
}
r.Actions.Names = append(r.Actions.Names, names...)
}
}
r.Actions.Names = unique(r.Actions.Names)
if len(r.Actions.Names) == 0 {
return fmt.Errorf("%w:%w", err, errNoActionsInRule)
}
for _, lexeme := range lexemes {
resource, errRes := parseResource(lexeme, *isObject)
resource, errRes := parseResource(lexeme, objectTargeted)
if errRes != nil {
return fmt.Errorf("%w:%w", err, errRes)
}
@ -308,32 +317,27 @@ func parseResource(lexeme string, isObj bool) (string, error) {
}
const (
ObjectResource = "object.resource"
ObjectRequest = "object.request"
ContainerResource = "container.resource"
ContainerRequest = "container.request"
ResourceCondition = "resourcecondition"
RequestCondition = "requestcondition"
)
var typeToCondObject = map[string]apechain.ObjectType{
ObjectResource: apechain.ObjectResource,
ObjectRequest: apechain.ObjectRequest,
ContainerResource: apechain.ContainerResource,
ContainerRequest: apechain.ContainerRequest,
var typeToCondKindType = map[string]apechain.ConditionKindType{
ResourceCondition: apechain.KindResource,
RequestCondition: apechain.KindRequest,
}
func parseCondition(lexeme string) (*apechain.Condition, error) {
typ, expression, found := strings.Cut(lexeme, ":")
typ = strings.ToLower(typ)
objType, ok := typeToCondObject[typ]
condKindType, ok := typeToCondKindType[typ]
if ok {
if !found {
return nil, fmt.Errorf("%w: %s", errInvalidConditionFormat, lexeme)
}
var cond apechain.Condition
cond.Object = objType
cond.Kind = condKindType
lhs, rhs, binExpFound := strings.Cut(expression, "!=")
if !binExpFound {

24
cmd/frostfs-cli/modules/util/ape_test.go
View file

@ -109,7 +109,7 @@ func TestParseAPERule(t *testing.T) {
},
{
name: "Valid allow rule with conditions",
rule: "allow Object.Get Object.Resource:Department=HR Object.Request:Actor!=ownerA *",
rule: "allow Object.Get ResourceCondition:Department=HR RequestCondition:Actor!=ownerA *",
expectRule: policyengine.Rule{
Status: policyengine.Allow,
Actions: policyengine.Actions{Names: []string{nativeschema.MethodGetObject}},
@ -117,13 +117,13 @@ func TestParseAPERule(t *testing.T) {
Condition: []policyengine.Condition{
{
Op: policyengine.CondStringEquals,
Object: policyengine.ObjectResource,
Kind: policyengine.KindResource,
Key: "Department",
Value: "HR",
},
{
Op: policyengine.CondStringNotEquals,
Object: policyengine.ObjectRequest,
Kind: policyengine.KindRequest,
Key: "Actor",
Value: "ownerA",
},
@ -132,7 +132,7 @@ func TestParseAPERule(t *testing.T) {
},
{
name: "Valid rule for object with conditions with action detail",
rule: "deny:QuotaLimitReached Object.Get Object.Resource:Department=HR Object.Request:Actor!=ownerA *",
rule: "deny:QuotaLimitReached Object.Get ResourceCondition:Department=HR RequestCondition:Actor!=ownerA *",
expectRule: policyengine.Rule{
Status: policyengine.QuotaLimitReached,
Actions: policyengine.Actions{Names: []string{nativeschema.MethodGetObject}},
@ -140,13 +140,13 @@ func TestParseAPERule(t *testing.T) {
Condition: []policyengine.Condition{
{
Op: policyengine.CondStringEquals,
Object: policyengine.ObjectResource,
Kind: policyengine.KindResource,
Key: "Department",
Value: "HR",
},
{
Op: policyengine.CondStringNotEquals,
Object: policyengine.ObjectRequest,
Kind: policyengine.KindRequest,
Key: "Actor",
Value: "ownerA",
},
@ -170,12 +170,12 @@ func TestParseAPERule(t *testing.T) {
},
{
name: "Invalid rule with unknown condition binary operator",
rule: "deny Object.Put Object.Resource:Department<HR *",
rule: "deny Object.Put ResourceCondition:Department<HR *",
expectErr: errUnknownBinaryOperator,
},
{
name: "Invalid rule with unknown condition object type",
rule: "deny Object.Put Object.ResourZe:Department=HR *",
rule: "deny Object.Put ResourSeCondiDion:Department=HR *",
expectErr: errUnknownCondObjectType,
},
{
@ -185,7 +185,7 @@ func TestParseAPERule(t *testing.T) {
},
{
name: "Invalid rule with no actions",
rule: "allow Container.Resource:A=B *",
rule: "allow ResourceCondition:A=B *",
expectErr: errNoActionsInRule,
},
{
@ -271,7 +271,7 @@ func TestParseAPERule(t *testing.T) {
},
{
name: "Valid rule for container with conditions with action detail",
rule: "allow Container.Get Container.Resource:A=B Container.Put Container.Request:C!=D " +
rule: "allow Container.Get ResourceCondition:A=B Container.Put RequestCondition:C!=D " +
"* /cnt_id",
expectRule: policyengine.Rule{
Status: policyengine.Allow,
@ -283,13 +283,13 @@ func TestParseAPERule(t *testing.T) {
Condition: []policyengine.Condition{
{
Op: policyengine.CondStringEquals,
Object: policyengine.ContainerResource,
Kind: policyengine.KindResource,
Key: "A",
Value: "B",
},
{
Op: policyengine.CondStringNotEquals,
Object: policyengine.ContainerRequest,
Kind: policyengine.KindRequest,
Key: "C",
Value: "D",
},

2
go.mod
View file

@ -9,7 +9,7 @@ require (
git.frostfs.info/TrueCloudLab/frostfs-observability v0.0.0-20231101111734-b3ad3335ff65
git.frostfs.info/TrueCloudLab/frostfs-sdk-go v0.0.0-20240507063414-99e02858af12
git.frostfs.info/TrueCloudLab/hrw v1.2.1
git.frostfs.info/TrueCloudLab/policy-engine v0.0.0-20240426062043-c5397286410f
git.frostfs.info/TrueCloudLab/policy-engine v0.0.0-20240513163744-1f6f4163d40d
git.frostfs.info/TrueCloudLab/tzhash v1.8.0
git.frostfs.info/TrueCloudLab/zapjournald v0.0.0-20240124114243-cb2e66427d02
github.com/cheggaaa/pb v1.0.29

BIN
go.sum
View file

Binary file not shown.

12
internal/ape/converter.go
View file

@ -80,7 +80,7 @@ func appendTargetsOnly(source []apechain.Rule, st apechain.Status, act apechain.
}
for _, target := range targets {
var roleCondition apechain.Condition
roleCondition.Object = apechain.ObjectRequest
roleCondition.Kind = apechain.KindRequest
roleCondition.Key = nativeschema.PropertyKeyActorRole
roleCondition.Value = target.Role().String()
roleCondition.Op = apechain.CondStringEquals
@ -88,7 +88,7 @@ func appendTargetsOnly(source []apechain.Rule, st apechain.Status, act apechain.
for _, binKey := range target.BinaryKeys() {
var pubKeyCondition apechain.Condition
pubKeyCondition.Object = apechain.ObjectRequest
pubKeyCondition.Kind = apechain.KindRequest
pubKeyCondition.Key = nativeschema.PropertyKeyActorPublicKey
pubKeyCondition.Value = hex.EncodeToString(binKey)
pubKeyCondition.Op = apechain.CondStringEquals
@ -112,7 +112,7 @@ func appendTargetsAndFilters(source []apechain.Rule, st apechain.Status, act ape
Resources: res,
}
var roleCondition apechain.Condition
roleCondition.Object = apechain.ObjectRequest
roleCondition.Kind = apechain.KindRequest
roleCondition.Key = nativeschema.PropertyKeyActorRole
roleCondition.Value = target.Role().String()
roleCondition.Op = apechain.CondStringEquals
@ -132,7 +132,7 @@ func appendTargetsAndFilters(source []apechain.Rule, st apechain.Status, act ape
Resources: res,
}
var pubKeyCondition apechain.Condition
pubKeyCondition.Object = apechain.ObjectRequest
pubKeyCondition.Kind = apechain.KindRequest
pubKeyCondition.Key = nativeschema.PropertyKeyActorPublicKey
pubKeyCondition.Value = hex.EncodeToString(binKey)
pubKeyCondition.Op = apechain.CondStringEquals
@ -155,10 +155,10 @@ func appendFilters(source []apechain.Condition, filters []eacl.Filter) ([]apecha
var cond apechain.Condition
var isObject bool
if filter.From() == eacl.HeaderFromObject {
cond.Object = apechain.ObjectResource
cond.Kind = apechain.KindResource
isObject = true
} else if filter.From() == eacl.HeaderFromRequest {
cond.Object = apechain.ObjectRequest
cond.Kind = apechain.KindRequest
} else {
return nil, &ConvertEACLError{nested: fmt.Errorf("unknown filter from: %d", filter.From())}
}

32
pkg/services/container/ape_test.go
View file

@ -228,7 +228,7 @@ func testDenyGetContainerForOthers(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -328,7 +328,7 @@ func testDenyGetContainerByUserClaimTag(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: fmt.Sprintf(commonschema.PropertyKeyFormatFrostFSIDUserClaim, "tag-attr1"),
Value: "value100",
Op: chain.CondStringNotEquals,
@ -426,7 +426,7 @@ func testDenyGetContainerByGroupID(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: commonschema.PropertyKeyFrostFSIDGroupID,
Value: "19888",
Op: chain.CondStringEquals,
@ -500,7 +500,7 @@ func testDenySetContainerEACLForIR(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleIR,
Op: chain.CondStringEquals,
@ -578,7 +578,7 @@ func testDenyGetContainerEACLForIRSessionToken(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleIR,
Op: chain.CondStringEquals,
@ -657,7 +657,7 @@ func testDenyPutContainerForOthersSessionToken(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -712,7 +712,7 @@ func testDenyPutContainerReadNamespaceFromFrostfsID(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -796,7 +796,7 @@ func testDenyPutContainerInvalidNamespace(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -879,7 +879,7 @@ func testDenyListContainersForPK(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorPublicKey,
Value: hex.EncodeToString(pk.PublicKey().Bytes()),
Op: chain.CondStringEquals,
@ -993,7 +993,7 @@ func testDenyListContainersValidationNamespaceError(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorPublicKey,
Value: actorPK.PublicKey().String(),
Op: chain.CondStringEquals,
@ -1195,7 +1195,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -1237,7 +1237,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -1280,7 +1280,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -1323,7 +1323,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -1366,7 +1366,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,
@ -1410,7 +1410,7 @@ func TestValidateContainerBoundedOperation(t *testing.T) {
},
Condition: []chain.Condition{
{
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorRole,
Value: nativeschema.PropertyValueContainerRoleOthers,
Op: chain.CondStringEquals,

8
pkg/services/object/ape/checker_test.go
View file

@ -313,7 +313,7 @@ func TestAPECheck(t *testing.T) {
Condition: []chain.Condition{
{
Op: chain.CondStringLike,
Object: chain.ObjectResource,
Kind: chain.KindResource,
Key: "attr1",
Value: "attribute*",
},
@ -352,7 +352,7 @@ func TestAPECheck(t *testing.T) {
Condition: []chain.Condition{
{
Op: chain.CondStringLike,
Object: chain.ObjectRequest,
Kind: chain.KindRequest,
Key: nativeschema.PropertyKeyActorPublicKey,
Value: senderKey,
},
@ -382,7 +382,7 @@ func TestAPECheck(t *testing.T) {
Condition: []chain.Condition{
{
Op: chain.CondStringEquals,
Object: chain.ObjectResource,
Kind: chain.KindResource,
Key: nativeschema.PropertyKeyObjectPayloadLength,
Value: "1000",
},
@ -504,7 +504,7 @@ func TestPutECChunk(t *testing.T) {
Condition: []chain.Condition{
{
Op: chain.CondStringEquals,
Object: chain.ObjectResource,
Kind: chain.KindResource,
Key: "attr1",
Value: "value",
},