-
Notifications
You must be signed in to change notification settings - Fork 791
/
queryValidator.go
211 lines (186 loc) · 6.64 KB
/
queryValidator.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to qvom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, qvETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package validator
import (
"errors"
"fmt"
"strings"
"github.com/xwb1989/sqlparser"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/definition"
"github.com/uber/cadence/common/dynamicconfig"
"github.com/uber/cadence/common/types"
)
// VisibilityQueryValidator for sql query validation
type VisibilityQueryValidator struct {
validSearchAttributes dynamicconfig.MapPropertyFn
enableQueryAttributeValidation dynamicconfig.BoolPropertyFn
}
// NewQueryValidator create VisibilityQueryValidator
func NewQueryValidator(
validSearchAttributes dynamicconfig.MapPropertyFn,
enableQueryAttributeValidation dynamicconfig.BoolPropertyFn) *VisibilityQueryValidator {
return &VisibilityQueryValidator{
validSearchAttributes: validSearchAttributes,
enableQueryAttributeValidation: enableQueryAttributeValidation,
}
}
// ValidateQuery validates that search attributes in the query are legal.
// Adds attr prefix for customized fields and returns modified query.
func (qv *VisibilityQueryValidator) ValidateQuery(whereClause string) (string, error) {
if len(whereClause) != 0 {
// Build a placeholder query that allows us to easily parse the contents of the where clause.
// IMPORTANT: This query is never executed, it is just used to parse and validate whereClause
var placeholderQuery string
whereClause := strings.TrimSpace(whereClause)
// #nosec
if common.IsJustOrderByClause(whereClause) { // just order by
placeholderQuery = fmt.Sprintf("SELECT * FROM dummy %s", whereClause)
} else {
placeholderQuery = fmt.Sprintf("SELECT * FROM dummy WHERE %s", whereClause)
}
stmt, err := sqlparser.Parse(placeholderQuery)
if err != nil {
return "", &types.BadRequestError{Message: "Invalid query."}
}
sel, ok := stmt.(*sqlparser.Select)
if !ok {
return "", &types.BadRequestError{Message: "Invalid select query."}
}
buf := sqlparser.NewTrackedBuffer(nil)
// validate where expr
if sel.Where != nil {
err = qv.validateWhereExpr(sel.Where.Expr)
if err != nil {
return "", &types.BadRequestError{Message: err.Error()}
}
sel.Where.Expr.Format(buf)
}
// validate order by
err = qv.validateOrderByExpr(sel.OrderBy)
if err != nil {
return "", &types.BadRequestError{Message: err.Error()}
}
sel.OrderBy.Format(buf)
return buf.String(), nil
}
return whereClause, nil
}
func (qv *VisibilityQueryValidator) validateWhereExpr(expr sqlparser.Expr) error {
if expr == nil {
return nil
}
switch expr := expr.(type) {
case *sqlparser.AndExpr, *sqlparser.OrExpr:
return qv.validateAndOrExpr(expr)
case *sqlparser.ComparisonExpr:
return qv.validateComparisonExpr(expr)
case *sqlparser.RangeCond:
return qv.validateRangeExpr(expr)
case *sqlparser.ParenExpr:
return qv.validateWhereExpr(expr.Expr)
default:
return errors.New("invalid where clause")
}
}
func (qv *VisibilityQueryValidator) validateAndOrExpr(expr sqlparser.Expr) error {
var leftExpr sqlparser.Expr
var rightExpr sqlparser.Expr
switch expr := expr.(type) {
case *sqlparser.AndExpr:
leftExpr = expr.Left
rightExpr = expr.Right
case *sqlparser.OrExpr:
leftExpr = expr.Left
rightExpr = expr.Right
}
if err := qv.validateWhereExpr(leftExpr); err != nil {
return err
}
return qv.validateWhereExpr(rightExpr)
}
func (qv *VisibilityQueryValidator) validateComparisonExpr(expr sqlparser.Expr) error {
comparisonExpr := expr.(*sqlparser.ComparisonExpr)
colName, ok := comparisonExpr.Left.(*sqlparser.ColName)
if !ok {
return errors.New("invalid comparison expression")
}
colNameStr := colName.Name.String()
if !qv.isValidSearchAttributes(colNameStr) {
return fmt.Errorf("invalid search attribute %q", colNameStr)
}
if !definition.IsSystemIndexedKey(colNameStr) { // add search attribute prefix
comparisonExpr.Left = &sqlparser.ColName{
Metadata: colName.Metadata,
Name: sqlparser.NewColIdent(definition.Attr + "." + colNameStr),
Qualifier: colName.Qualifier,
}
}
return nil
}
func (qv *VisibilityQueryValidator) validateRangeExpr(expr sqlparser.Expr) error {
rangeCond := expr.(*sqlparser.RangeCond)
colName, ok := rangeCond.Left.(*sqlparser.ColName)
if !ok {
return errors.New("invalid range expression")
}
colNameStr := colName.Name.String()
if !qv.isValidSearchAttributes(colNameStr) {
return fmt.Errorf("invalid search attribute %q", colNameStr)
}
if !definition.IsSystemIndexedKey(colNameStr) { // add search attribute prefix
rangeCond.Left = &sqlparser.ColName{
Metadata: colName.Metadata,
Name: sqlparser.NewColIdent(definition.Attr + "." + colNameStr),
Qualifier: colName.Qualifier,
}
}
return nil
}
func (qv *VisibilityQueryValidator) validateOrderByExpr(orderBy sqlparser.OrderBy) error {
for _, orderByExpr := range orderBy {
colName, ok := orderByExpr.Expr.(*sqlparser.ColName)
if !ok {
return errors.New("invalid order by expression")
}
colNameStr := colName.Name.String()
if qv.isValidSearchAttributes(colNameStr) {
if !definition.IsSystemIndexedKey(colNameStr) { // add search attribute prefix
orderByExpr.Expr = &sqlparser.ColName{
Metadata: colName.Metadata,
Name: sqlparser.NewColIdent(definition.Attr + "." + colNameStr),
Qualifier: colName.Qualifier,
}
}
} else {
return errors.New("invalid order by attribute")
}
}
return nil
}
// isValidSearchAttributes return true if key is registered
func (qv *VisibilityQueryValidator) isValidSearchAttributes(key string) bool {
if qv.enableQueryAttributeValidation() {
validAttr := qv.validSearchAttributes()
_, isValidKey := validAttr[key]
return isValidKey
}
return true
}