-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
parse.go
511 lines (463 loc) · 15.6 KB
/
parse.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/*
Copyright 2017-2020 Gravitational, Inc.
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.
*/
// TODO(awly): combine Expression and Matcher. It should be possible to write:
// `{{regexp.match(email.local(external.trait_name))}}`
package parse
import (
"go/ast"
"go/parser"
"go/token"
"net/mail"
"regexp"
"strconv"
"strings"
"unicode"
"github.com/gravitational/teleport/lib/utils"
"github.com/gravitational/trace"
)
// Expression is an expression template
// that can interpolate to some variables
type Expression struct {
// namespace is expression namespace,
// e.g. internal.traits has a variable traits
// in internal namespace
namespace string
// variable is a variable name, e.g. trait name,
// e.g. internal.traits has variable name traits
variable string
// prefix is a prefix of the string
prefix string
// suffix is a suffix
suffix string
// transform is an optional transformer for the variable.
transform transformer
}
// emailLocalTransformer extracts local part of the email.
type emailLocalTransformer struct{}
// EmailLocal returns local part of the email
func (emailLocalTransformer) transform(in string) (string, error) {
if in == "" {
return "", trace.BadParameter("address is empty")
}
addr, err := mail.ParseAddress(in)
if err != nil {
return "", trace.BadParameter("failed to parse address %q: %q", in, err)
}
parts := strings.SplitN(addr.Address, "@", 2)
if len(parts) != 2 {
return "", trace.BadParameter("could not find local part in %q", addr.Address)
}
return parts[0], nil
}
// regexpReplaceTransformer replaces all matches of re with replacement
type regexpReplaceTransformer struct {
re *regexp.Regexp
replacement string
}
// newRegexpReplaceTransformer attempts to create a regexpReplaceTransformer or
// fails with error if the expression does not compile
func newRegexpReplaceTransformer(expression, replacement string) (*regexpReplaceTransformer, error) {
re, err := regexp.Compile(expression)
if err != nil {
return nil, trace.BadParameter("failed parsing regexp %q: %v", expression, err)
}
return ®expReplaceTransformer{
re: re,
replacement: replacement,
}, nil
}
// transform applies the regexp replacement (with expansion)
func (r regexpReplaceTransformer) transform(in string) (string, error) {
// filter out inputs which do not match the regexp at all
if !r.re.MatchString(in) {
return "", nil
}
return r.re.ReplaceAllString(in, r.replacement), nil
}
// Namespace returns a variable namespace, e.g. external or internal
func (p *Expression) Namespace() string {
return p.namespace
}
// Name returns variable name
func (p *Expression) Name() string {
return p.variable
}
// Interpolate interpolates the variable adding prefix and suffix if present,
// returns trace.NotFound in case if the trait is not found, nil in case of
// success and BadParameter error otherwise
func (p *Expression) Interpolate(traits map[string][]string) ([]string, error) {
if p.namespace == LiteralNamespace {
return []string{p.variable}, nil
}
values, ok := traits[p.variable]
if !ok {
return nil, trace.NotFound("variable is not found")
}
var out []string
for i := range values {
val := values[i]
var err error
if p.transform != nil {
val, err = p.transform.transform(val)
if err != nil {
return nil, trace.Wrap(err)
}
}
if len(val) > 0 {
out = append(out, p.prefix+val+p.suffix)
}
}
return out, nil
}
var reVariable = regexp.MustCompile(
// prefix is anyting that is not { or }
`^(?P<prefix>[^}{]*)` +
// variable is antything in brackets {{}} that is not { or }
`{{(?P<expression>\s*[^}{]*\s*)}}` +
// prefix is anyting that is not { or }
`(?P<suffix>[^}{]*)$`,
)
// NewExpression parses expressions like {{external.foo}} or {{internal.bar}},
// or a literal value like "prod". Call Interpolate on the returned Expression
// to get the final value based on traits or other dynamic values.
func NewExpression(variable string) (*Expression, error) {
match := reVariable.FindStringSubmatch(variable)
if len(match) == 0 {
if strings.Contains(variable, "{{") || strings.Contains(variable, "}}") {
return nil, trace.BadParameter(
"%q is using template brackets '{{' or '}}', however expression does not parse, make sure the format is {{variable}}",
variable)
}
return &Expression{
namespace: LiteralNamespace,
variable: variable,
}, nil
}
prefix, variable, suffix := match[1], match[2], match[3]
// parse and get the ast of the expression
expr, err := parser.ParseExpr(variable)
if err != nil {
return nil, trace.NotFound("no variable found in %q: %v", variable, err)
}
// walk the ast tree and gather the variable parts
result, err := walk(expr, 0)
if err != nil {
return nil, trace.Wrap(err)
}
// the variable must have two parts the prefix and the variable name itself
if len(result.parts) != 2 {
return nil, trace.NotFound("no variable found: %v", variable)
}
if result.match != nil {
return nil, trace.NotFound("matcher functions (like regexp.match) are not allowed here: %q", variable)
}
return &Expression{
prefix: strings.TrimLeftFunc(prefix, unicode.IsSpace),
namespace: result.parts[0],
variable: result.parts[1],
suffix: strings.TrimRightFunc(suffix, unicode.IsSpace),
transform: result.transform,
}, nil
}
// Matcher matches strings against some internal criteria (e.g. a regexp)
type Matcher interface {
Match(in string) bool
}
// MatcherFn converts function to a matcher interface
type MatcherFn func(in string) bool
// Match matches string against a regexp
func (fn MatcherFn) Match(in string) bool {
return fn(in)
}
// NewAnyMatcher returns a matcher function based
// on incoming values
func NewAnyMatcher(in []string) (Matcher, error) {
matchers := make([]Matcher, len(in))
for i, v := range in {
m, err := NewMatcher(v)
if err != nil {
return nil, trace.Wrap(err)
}
matchers[i] = m
}
return MatcherFn(func(in string) bool {
for _, m := range matchers {
if m.Match(in) {
return true
}
}
return false
}), nil
}
// NewMatcher parses a matcher expression. Currently supported expressions:
// - string literal: `foo`
// - wildcard expression: `*` or `foo*bar`
// - regexp expression: `^foo$`
// - regexp function calls:
// - positive match: `{{regexp.match("foo.*")}}`
// - negative match: `{{regexp.not_match("foo.*")}}`
//
// These expressions do not support variable interpolation (e.g.
// `{{internal.logins}}`), like Expression does.
func NewMatcher(value string) (m Matcher, err error) {
defer func() {
if err != nil {
err = trace.WrapWithMessage(err, "see supported syntax at https://goteleport.com/teleport/docs/enterprise/ssh-rbac/#rbac-for-hosts")
}
}()
match := reVariable.FindStringSubmatch(value)
if len(match) == 0 {
if strings.Contains(value, "{{") || strings.Contains(value, "}}") {
return nil, trace.BadParameter(
"%q is using template brackets '{{' or '}}', however expression does not parse, make sure the format is {{expression}}",
value)
}
return newRegexpMatcher(value, true)
}
prefix, variable, suffix := match[1], match[2], match[3]
// parse and get the ast of the expression
expr, err := parser.ParseExpr(variable)
if err != nil {
return nil, trace.BadParameter("failed to parse %q: %v", value, err)
}
// walk the ast tree and gather the variable parts
result, err := walk(expr, 0)
if err != nil {
return nil, trace.Wrap(err)
}
// For now, only support a single match expression. In the future, we could
// consider handling variables and transforms by propagating user traits to
// the matching logic. For example
// `{{regexp.match(external.allowed_env_trait)}}`.
if result.transform != nil || len(result.parts) > 0 {
return nil, trace.BadParameter("%q is not a valid matcher expression - no variables and transformations are allowed", value)
}
return newPrefixSuffixMatcher(prefix, suffix, result.match), nil
}
// regexpMatcher matches input string against a pre-compiled regexp.
type regexpMatcher struct {
re *regexp.Regexp
}
func (m regexpMatcher) Match(in string) bool {
return m.re.MatchString(in)
}
func newRegexpMatcher(raw string, escape bool) (*regexpMatcher, error) {
if escape {
if !strings.HasPrefix(raw, "^") || !strings.HasSuffix(raw, "$") {
// replace glob-style wildcards with regexp wildcards
// for plain strings, and quote all characters that could
// be interpreted in regular expression
raw = "^" + utils.GlobToRegexp(raw) + "$"
}
}
re, err := regexp.Compile(raw)
if err != nil {
return nil, trace.BadParameter("failed parsing regexp %q: %v", raw, err)
}
return ®expMatcher{re: re}, nil
}
// prefixSuffixMatcher matches prefix and suffix of input and passes the middle
// part to another matcher.
type prefixSuffixMatcher struct {
prefix, suffix string
m Matcher
}
func (m prefixSuffixMatcher) Match(in string) bool {
if !strings.HasPrefix(in, m.prefix) || !strings.HasSuffix(in, m.suffix) {
return false
}
in = strings.TrimPrefix(in, m.prefix)
in = strings.TrimSuffix(in, m.suffix)
return m.m.Match(in)
}
func newPrefixSuffixMatcher(prefix, suffix string, inner Matcher) prefixSuffixMatcher {
return prefixSuffixMatcher{prefix: prefix, suffix: suffix, m: inner}
}
// notMatcher inverts the result of another matcher.
type notMatcher struct{ m Matcher }
func (m notMatcher) Match(in string) bool { return !m.m.Match(in) }
const (
// LiteralNamespace is a namespace for Expressions that always return
// static literal values.
LiteralNamespace = "literal"
// EmailNamespace is a function namespace for email functions
EmailNamespace = "email"
// EmailLocalFnName is a name for email.local function
EmailLocalFnName = "local"
// RegexpNamespace is a function namespace for regexp functions.
RegexpNamespace = "regexp"
// RegexpMatchFnName is a name for regexp.match function.
RegexpMatchFnName = "match"
// RegexpNotMatchFnName is a name for regexp.not_match function.
RegexpNotMatchFnName = "not_match"
// RegexpReplaceFnName is a name for regexp.replace function.
RegexpReplaceFnName = "replace"
)
// transformer is an optional value transformer function that can take in
// string and replace it with another value
type transformer interface {
transform(in string) (string, error)
}
// getBasicString checks that arg is a properly quoted basic string and returns
// it. If arg is not a properly quoted basic string, the second return value
// will be false.
func getBasicString(arg ast.Expr) (string, bool) {
basicLit, ok := arg.(*ast.BasicLit)
if !ok {
return "", false
}
if basicLit.Kind != token.STRING {
return "", false
}
str, err := strconv.Unquote(basicLit.Value)
if err != nil {
return "", false
}
return str, true
}
// maxASTDepth is the maximum depth of the AST that func walk will traverse.
// The limit exists to protect against DoS via malicious inputs.
const maxASTDepth = 1000
type walkResult struct {
parts []string
transform transformer
match Matcher
}
// walk will walk the ast tree and gather all the variable parts into a slice and return it.
func walk(node ast.Node, depth int) (*walkResult, error) {
if depth > maxASTDepth {
return nil, trace.LimitExceeded("expression exceeds the maximum allowed depth")
}
var result walkResult
switch n := node.(type) {
case *ast.CallExpr:
switch call := n.Fun.(type) {
case *ast.Ident:
return nil, trace.BadParameter("function %v is not supported", call.Name)
case *ast.SelectorExpr:
// Selector expression looks like email.local(parameter)
namespaceNode, ok := call.X.(*ast.Ident)
if !ok {
return nil, trace.BadParameter("expected namespace, e.g. email.local, got %v", call.X)
}
namespace := namespaceNode.Name
fn := call.Sel.Name
switch namespace {
case EmailNamespace:
// This is a function name
if fn != EmailLocalFnName {
return nil, trace.BadParameter("unsupported function %v.%v, supported functions are: email.local", namespace, fn)
}
// Because only one function is supported for now,
// this makes sure that the function call has exactly one argument
if len(n.Args) != 1 {
return nil, trace.BadParameter("expected 1 argument for %v.%v got %v", namespace, fn, len(n.Args))
}
result.transform = emailLocalTransformer{}
ret, err := walk(n.Args[0], depth+1)
if err != nil {
return nil, trace.Wrap(err)
}
result.parts = ret.parts
return &result, nil
case RegexpNamespace:
switch fn {
// Both match and not_match parse the same way.
case RegexpMatchFnName, RegexpNotMatchFnName:
if len(n.Args) != 1 {
return nil, trace.BadParameter("expected 1 argument for %v.%v got %v", namespace, fn, len(n.Args))
}
re, ok := getBasicString(n.Args[0])
if !ok {
return nil, trace.BadParameter("argument to %v.%v must be a properly quoted string literal", namespace, fn)
}
var err error
result.match, err = newRegexpMatcher(re, false)
if err != nil {
return nil, trace.Wrap(err)
}
// If this is not_match, wrap the regexpMatcher to invert it.
if fn == RegexpNotMatchFnName {
result.match = notMatcher{result.match}
}
return &result, nil
case RegexpReplaceFnName:
if len(n.Args) != 3 {
return nil, trace.BadParameter("expected 3 arguments for %v.%v got %v", namespace, fn, len(n.Args))
}
ret, err := walk(n.Args[0], depth+1)
if err != nil {
return nil, trace.Wrap(err)
}
result.parts = ret.parts
expression, ok := getBasicString(n.Args[1])
if !ok {
return nil, trace.BadParameter("second argument to %v.%v must be a properly quoted string literal", namespace, fn)
}
replacement, ok := getBasicString(n.Args[2])
if !ok {
return nil, trace.BadParameter("third argument to %v.%v must be a properly quoted string literal", namespace, fn)
}
result.transform, err = newRegexpReplaceTransformer(expression, replacement)
if err != nil {
return nil, trace.Wrap(err)
}
return &result, nil
default:
return nil, trace.BadParameter("unsupported function %v.%v, supported functions are: regexp.match, regexp.not_match", namespace, fn)
}
default:
return nil, trace.BadParameter("unsupported function namespace %v, supported namespaces are %v and %v", call.X, EmailNamespace, RegexpNamespace)
}
default:
return nil, trace.BadParameter("unsupported function %T", n.Fun)
}
case *ast.IndexExpr:
ret, err := walk(n.X, depth+1)
if err != nil {
return nil, err
}
result.parts = append(result.parts, ret.parts...)
ret, err = walk(n.Index, depth+1)
if err != nil {
return nil, err
}
result.parts = append(result.parts, ret.parts...)
return &result, nil
case *ast.SelectorExpr:
ret, err := walk(n.X, depth+1)
if err != nil {
return nil, err
}
result.parts = append(result.parts, ret.parts...)
ret, err = walk(n.Sel, depth+1)
if err != nil {
return nil, err
}
result.parts = append(result.parts, ret.parts...)
return &result, nil
case *ast.Ident:
return &walkResult{parts: []string{n.Name}}, nil
case *ast.BasicLit:
if n.Kind == token.STRING {
var err error
n.Value, err = strconv.Unquote(n.Value)
if err != nil {
return nil, err
}
}
return &walkResult{parts: []string{n.Value}}, nil
default:
return nil, trace.BadParameter("unknown node type: %T", n)
}
}