-
Notifications
You must be signed in to change notification settings - Fork 10
/
multi.go
215 lines (195 loc) · 6.53 KB
/
multi.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
// © 2022-2023 Snyk Limited All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package policy
import (
"context"
"fmt"
"sort"
"github.com/open-policy-agent/opa/ast"
"github.com/open-policy-agent/opa/topdown"
"github.com/snyk/policy-engine/pkg/logging"
"github.com/snyk/policy-engine/pkg/models"
"github.com/snyk/policy-engine/pkg/policy/inferattributes"
"github.com/snyk/policy-engine/pkg/rego"
)
// ProcessSingleResultSet functions extract RuleResult models from the ResultSet of
// multi-resource type rules.
type ProcessMultiResultSet func(
metadata Metadata,
defaultRemediation string,
resources map[string]*ruleResultBuilder,
) ([]models.RuleResult, error)
// MultiResourcePolicy represents a policy that takes multiple resources as input.
type MultiResourcePolicy struct {
*BasePolicy
processorFactory func(metadata Metadata, defaultRemediation string) MultiResourceProcessor
}
// SingleResourceProcessor can turn rego results into the results model we want.
type MultiResourceProcessor interface {
ProcessValue(ast.Value) error
ProcessResource(ast.Value) error
Results() []models.RuleResult
}
// Eval will evaluate the policy on the given input.
func (p *MultiResourcePolicy) Eval(
ctx context.Context,
options EvalOptions,
) ([]models.RuleResults, error) {
logger := options.Logger
if logger == nil {
logger = logging.NopLogger
}
logger = logger.WithField(logging.PACKAGE, p.Package()).
WithField(logging.POLICY_TYPE, "multi_resource").
WithField(logging.JUDGEMENT_NAME, p.judgementRule.name).
WithField(logging.JUDGEMENT_KEY, p.judgementRule.key)
output := models.RuleResults{}
output.Package_ = p.pkg
metadata, err := p.Metadata(ctx, options.RegoState)
if err != nil {
logger.Error(ctx, "Failed to query metadata")
err = fmt.Errorf("%w: %v", FailedToQueryMetadata, err)
output.Errors = append(output.Errors, err.Error())
return []models.RuleResults{output}, err
}
defaultRemediation := metadata.RemediationFor(options.Input.InputType)
metadata.copyToRuleResults(options.Input.InputType, &output)
builtins := NewBuiltins(options.Input, options.ResourcesResolver)
tracer := inferattributes.NewTracer()
query := rego.Query{
Query: p.judgementRule.query(),
Builtins: builtins.Implementations(),
Tracers: []topdown.QueryTracer{tracer},
Input: ast.NewObject(
[2]*ast.Term{ast.StringTerm("resources"), ast.ObjectTerm()},
),
}
processor := p.processorFactory(metadata, defaultRemediation)
err = options.RegoState.Query(
ctx,
query,
processor.ProcessValue,
)
if err != nil {
logger.Error(ctx, "Failed to evaluate rule")
err = fmt.Errorf("%w: %v", FailedToEvaluateRule, err)
output.Errors = append(output.Errors, err.Error())
return []models.RuleResults{output}, err
}
err = options.RegoState.Query(
ctx,
query.Add(rego.Query{Query: p.resourcesRule.query()}),
processor.ProcessResource,
)
if err != nil {
logger.Error(ctx, "Failed to query resources")
err = fmt.Errorf("%w: %v", FailedToQueryResources, err)
output.Errors = append(output.Errors, err.Error())
return []models.RuleResults{output}, err
}
ruleResults := processor.Results()
tracer.InferAttributes(ruleResults)
output.ResourceTypes = builtins.ResourceTypes()
output.Results = ruleResults
return []models.RuleResults{output}, nil
}
type multiDenyProcessor struct {
metadata Metadata
defaultRemediation string
builders map[string]*ruleResultBuilder
}
func NewMultiDenyProcessor(metadata Metadata, defaultRemediation string) MultiResourceProcessor {
return &multiDenyProcessor{
metadata: metadata,
defaultRemediation: defaultRemediation,
builders: map[string]*ruleResultBuilder{},
}
}
func (p *multiDenyProcessor) ProcessValue(val ast.Value) error {
var result policyResult
if err := rego.Bind(val, &result); err != nil {
return err
}
correlation := result.GetCorrelation()
var builder *ruleResultBuilder
if b, ok := p.builders[correlation]; ok {
builder = b
} else {
builder = newRuleResultBuilder()
p.builders[correlation] = builder
builder.severity = p.metadata.Severity
builder.remediation = p.defaultRemediation
}
builder.passed = false
builder.messages = append(builder.messages, result.Message)
if result.ResourceType != "" {
builder.resourceType = result.ResourceType
}
if result.PrimaryResource != nil {
builder.setPrimaryResource(result.PrimaryResource.Key())
}
if resource := result.GetResource(); resource != nil {
resourceKey := resource.Key()
builder.addResource(resourceKey)
for _, attr := range result.Attributes {
builder.addResourceAttribute(resourceKey, attr)
}
}
if result.Remediation != "" {
builder.remediation = result.Remediation
}
if result.Severity != "" {
builder.severity = result.Severity
}
return nil
}
func (p *multiDenyProcessor) ProcessResource(val ast.Value) error {
var result resourcesResult
if err := rego.Bind(val, &result); err != nil {
return err
}
correlation := result.GetCorrelation()
if _, ok := p.builders[correlation]; !ok {
p.builders[correlation] = newRuleResultBuilder()
p.builders[correlation].passed = true
p.builders[correlation].severity = p.metadata.Severity
p.builders[correlation].remediation = p.defaultRemediation
}
if result.ResourceType != "" {
p.builders[correlation].setMissingResourceType(result.ResourceType)
}
if result.Resource != nil {
p.builders[correlation].addResource(result.Resource.Key())
}
if result.PrimaryResource != nil {
p.builders[correlation].setPrimaryResource(result.PrimaryResource.Key())
}
for _, attr := range result.Attributes {
p.builders[correlation].addResourceAttribute(result.GetResource().Key(), attr)
}
return nil
}
func (p *multiDenyProcessor) Results() []models.RuleResult {
// Ensure deterministic ordering of results.
results := make([]models.RuleResult, len(p.builders))
correlations := []string{}
for correlation := range p.builders {
correlations = append(correlations, correlation)
}
sort.Strings(correlations)
for i, correlation := range correlations {
results[i] = p.builders[correlation].toRuleResult()
}
return results
}