-
Notifications
You must be signed in to change notification settings - Fork 4
/
permission_attribute_arguments.go
223 lines (202 loc) · 6.3 KB
/
permission_attribute_arguments.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
216
217
218
219
220
221
222
223
package validation
import (
"fmt"
"strings"
"github.com/samber/lo"
"github.com/teamkeel/keel/casing"
"github.com/teamkeel/keel/schema/expressions"
"github.com/teamkeel/keel/schema/parser"
"github.com/teamkeel/keel/schema/query"
"github.com/teamkeel/keel/schema/validation/errorhandling"
"github.com/teamkeel/keel/schema/validation/rules/expression"
)
func PermissionsAttributeArguments(asts []*parser.AST, errs *errorhandling.ValidationErrors) Visitor {
var model *parser.ModelNode
var action *parser.ActionNode
var job *parser.JobNode
return Visitor{
EnterModel: func(m *parser.ModelNode) {
model = m
},
LeaveModel: func(_ *parser.ModelNode) {
model = nil
},
EnterAction: func(a *parser.ActionNode) {
action = a
},
LeaveAction: func(_ *parser.ActionNode) {
action = nil
},
EnterJob: func(j *parser.JobNode) {
job = j
},
LeaveJob: func(_ *parser.JobNode) {
job = nil
},
EnterAttribute: func(attr *parser.AttributeNode) {
if attr.Name.Value != parser.AttributePermission {
return
}
hasActions := false
hasExpression := false
hasRoles := false
for _, arg := range attr.Arguments {
if arg.Label == nil || arg.Label.Value == "" {
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: "@permission requires all arguments to be named, for example @permission(roles: [MyRole])",
},
arg,
))
continue
}
switch arg.Label.Value {
case "actions":
hasActions = true
if action != nil || job != nil {
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: fmt.Sprintf(
"cannot provide 'actions' arguments when using @permission in %s",
lo.Ternary(action != nil, "an action", "a job"),
),
},
arg.Label,
))
continue
}
errs.Concat(validateIdentArray(arg.Expression, []string{
parser.ActionTypeGet,
parser.ActionTypeCreate,
parser.ActionTypeUpdate,
parser.ActionTypeList,
parser.ActionTypeDelete,
}, "valid action type"))
case "expression":
hasExpression = true
context := expressions.ExpressionContext{
Model: model,
Attribute: attr,
Action: action,
}
rules := []expression.Rule{
expression.OperatorLogicalRule,
}
expressionErrors := expression.ValidateExpression(
asts,
arg.Expression,
rules,
context,
)
for _, err := range expressionErrors {
// TODO: remove cast when expression.ValidateExpression returns correct type
errs.AppendError(err.(*errorhandling.ValidationError))
}
// Extra check for using row-based expression in a read/write function
// Ideally this would be done as part of the expression validation, but
// if we don't provide the model as context the error is not very helpful.
if action != nil && (action.Type.Value == "read" || action.Type.Value == "write") {
for _, cond := range arg.Expression.Conditions() {
for _, op := range []*parser.Operand{cond.LHS, cond.RHS} {
if op == nil || op.Ident == nil {
continue
}
// An ident must have at least one fragment - we only care about the first one
fragment := op.Ident.Fragments[0]
if fragment.Fragment == casing.ToLowerCamel(model.Name.Value) {
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: fmt.Sprintf(
"cannot use row-based permissions in a %s action",
action.Type.Value,
),
Hint: "implement your permissions logic in your function code using the permissions API - https://docs.keel.so/functions#permissions",
},
fragment,
))
}
}
}
}
case "roles":
hasRoles = true
roles := []string{}
for _, role := range query.Roles(asts) {
roles = append(roles, role.Name.Value)
}
errs.Concat(validateIdentArray(arg.Expression, roles, "role defined in your schema"))
default:
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: fmt.Sprintf(
"'%s' is not a valid argument for @permission",
arg.Label.Value,
),
Hint: "Did you mean one of 'actions', 'expression', or 'roles'?",
},
arg.Label,
))
}
}
// Missing actions argument which is required
if job == nil && action == nil && !hasActions {
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: "required argument 'actions' missing",
},
attr.Name,
))
}
// One of expression or roles must be provided
if !hasExpression && !hasRoles {
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: "@permission requires either the 'expressions' or 'roles' argument to be provided",
},
attr.Name,
))
}
},
}
}
func validateIdentArray(expr *parser.Expression, allowed []string, identType string) (errs errorhandling.ValidationErrors) {
value, err := expr.ToValue()
if err != nil || value.Array == nil {
example := ""
if len(allowed) > 0 {
example = allowed[0]
}
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: fmt.Sprintf("value should be a list e.g. [%s]", example),
},
expr,
))
return
}
for _, item := range value.Array.Values {
valid := item.Ident != nil && lo.Contains(allowed, item.ToString())
if !valid {
hint := ""
if len(allowed) > 0 {
hint = fmt.Sprintf("valid values are: %s", strings.Join(allowed, ", "))
}
errs.AppendError(errorhandling.NewValidationErrorWithDetails(
errorhandling.AttributeArgumentError,
errorhandling.ErrorDetails{
Message: fmt.Sprintf("%s is not a %s", item.ToString(), identType),
Hint: hint,
},
item,
))
}
}
return
}