forked from jhump/protoreflect
/
validate.go
358 lines (322 loc) · 12 KB
/
validate.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
package protoparse
import (
"fmt"
"sort"
"github.com/golang/protobuf/proto"
dpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
"github.com/bakjos/protoreflect/desc/protoparse/ast"
)
func validateBasic(res *parseResult, containsErrors bool) {
fd := res.fd
isProto3 := fd.GetSyntax() == "proto3"
for _, md := range fd.MessageType {
if validateMessage(res, isProto3, "", md, containsErrors) != nil {
return
}
}
for _, ed := range fd.EnumType {
if validateEnum(res, isProto3, "", ed, containsErrors) != nil {
return
}
}
for _, fld := range fd.Extension {
if validateField(res, isProto3, "", fld) != nil {
return
}
}
}
func validateMessage(res *parseResult, isProto3 bool, prefix string, md *dpb.DescriptorProto, containsErrors bool) error {
nextPrefix := md.GetName() + "."
for _, fld := range md.Field {
if err := validateField(res, isProto3, nextPrefix, fld); err != nil {
return err
}
}
for _, fld := range md.Extension {
if err := validateField(res, isProto3, nextPrefix, fld); err != nil {
return err
}
}
for _, ed := range md.EnumType {
if err := validateEnum(res, isProto3, nextPrefix, ed, containsErrors); err != nil {
return err
}
}
for _, nmd := range md.NestedType {
if err := validateMessage(res, isProto3, nextPrefix, nmd, containsErrors); err != nil {
return err
}
}
scope := fmt.Sprintf("message %s%s", prefix, md.GetName())
if isProto3 && len(md.ExtensionRange) > 0 {
n := res.getExtensionRangeNode(md.ExtensionRange[0])
if err := res.errs.handleErrorWithPos(n.Start(), "%s: extension ranges are not allowed in proto3", scope); err != nil {
return err
}
}
if index, err := findOption(res, scope, md.Options.GetUninterpretedOption(), "map_entry"); err != nil {
return err
} else if index >= 0 {
opt := md.Options.UninterpretedOption[index]
optn := res.getOptionNode(opt)
md.Options.UninterpretedOption = removeOption(md.Options.UninterpretedOption, index)
valid := false
if opt.IdentifierValue != nil {
if opt.GetIdentifierValue() == "true" {
valid = true
if err := res.errs.handleErrorWithPos(optn.GetValue().Start(), "%s: map_entry option should not be set explicitly; use map type instead", scope); err != nil {
return err
}
} else if opt.GetIdentifierValue() == "false" {
valid = true
md.Options.MapEntry = proto.Bool(false)
}
}
if !valid {
if err := res.errs.handleErrorWithPos(optn.GetValue().Start(), "%s: expecting bool value for map_entry option", scope); err != nil {
return err
}
}
}
// reserved ranges should not overlap
rsvd := make(tagRanges, len(md.ReservedRange))
for i, r := range md.ReservedRange {
n := res.getMessageReservedRangeNode(r)
rsvd[i] = tagRange{start: r.GetStart(), end: r.GetEnd(), node: n}
}
sort.Sort(rsvd)
for i := 1; i < len(rsvd); i++ {
if rsvd[i].start < rsvd[i-1].end {
if err := res.errs.handleErrorWithPos(rsvd[i].node.Start(), "%s: reserved ranges overlap: %d to %d and %d to %d", scope, rsvd[i-1].start, rsvd[i-1].end-1, rsvd[i].start, rsvd[i].end-1); err != nil {
return err
}
}
}
// extensions ranges should not overlap
exts := make(tagRanges, len(md.ExtensionRange))
for i, r := range md.ExtensionRange {
n := res.getExtensionRangeNode(r)
exts[i] = tagRange{start: r.GetStart(), end: r.GetEnd(), node: n}
}
sort.Sort(exts)
for i := 1; i < len(exts); i++ {
if exts[i].start < exts[i-1].end {
if err := res.errs.handleErrorWithPos(exts[i].node.Start(), "%s: extension ranges overlap: %d to %d and %d to %d", scope, exts[i-1].start, exts[i-1].end-1, exts[i].start, exts[i].end-1); err != nil {
return err
}
}
}
// see if any extension range overlaps any reserved range
var i, j int // i indexes rsvd; j indexes exts
for i < len(rsvd) && j < len(exts) {
if rsvd[i].start >= exts[j].start && rsvd[i].start < exts[j].end ||
exts[j].start >= rsvd[i].start && exts[j].start < rsvd[i].end {
var pos *SourcePos
if rsvd[i].start >= exts[j].start && rsvd[i].start < exts[j].end {
pos = rsvd[i].node.Start()
} else {
pos = exts[j].node.Start()
}
// ranges overlap
if err := res.errs.handleErrorWithPos(pos, "%s: extension range %d to %d overlaps reserved range %d to %d", scope, exts[j].start, exts[j].end-1, rsvd[i].start, rsvd[i].end-1); err != nil {
return err
}
}
if rsvd[i].start < exts[j].start {
i++
} else {
j++
}
}
// now, check that fields don't re-use tags and don't try to use extension
// or reserved ranges or reserved names
rsvdNames := map[string]struct{}{}
for _, n := range md.ReservedName {
rsvdNames[n] = struct{}{}
}
fieldTags := map[int32]string{}
for _, fld := range md.Field {
fn := res.getFieldNode(fld)
if _, ok := rsvdNames[fld.GetName()]; ok {
if err := res.errs.handleErrorWithPos(fn.FieldName().Start(), "%s: field %s is using a reserved name", scope, fld.GetName()); err != nil {
return err
}
}
if existing := fieldTags[fld.GetNumber()]; existing != "" {
if err := res.errs.handleErrorWithPos(fn.FieldTag().Start(), "%s: fields %s and %s both have the same tag %d", scope, existing, fld.GetName(), fld.GetNumber()); err != nil {
return err
}
}
fieldTags[fld.GetNumber()] = fld.GetName()
// check reserved ranges
r := sort.Search(len(rsvd), func(index int) bool { return rsvd[index].end > fld.GetNumber() })
if r < len(rsvd) && rsvd[r].start <= fld.GetNumber() {
if err := res.errs.handleErrorWithPos(fn.FieldTag().Start(), "%s: field %s is using tag %d which is in reserved range %d to %d", scope, fld.GetName(), fld.GetNumber(), rsvd[r].start, rsvd[r].end-1); err != nil {
return err
}
}
// and check extension ranges
e := sort.Search(len(exts), func(index int) bool { return exts[index].end > fld.GetNumber() })
if e < len(exts) && exts[e].start <= fld.GetNumber() {
if err := res.errs.handleErrorWithPos(fn.FieldTag().Start(), "%s: field %s is using tag %d which is in extension range %d to %d", scope, fld.GetName(), fld.GetNumber(), exts[e].start, exts[e].end-1); err != nil {
return err
}
}
}
return nil
}
func validateEnum(res *parseResult, isProto3 bool, prefix string, ed *dpb.EnumDescriptorProto, containsErrors bool) error {
scope := fmt.Sprintf("enum %s%s", prefix, ed.GetName())
if !containsErrors && len(ed.Value) == 0 {
// we only check this if file parsing had no errors; otherwise, the file may have
// had an enum value, but the parser encountered an error processing it, in which
// case the value would be absent from the descriptor. In such a case, this error
// would be confusing and incorrect, so we just skip this check.
enNode := res.getEnumNode(ed)
if err := res.errs.handleErrorWithPos(enNode.Start(), "%s: enums must define at least one value", scope); err != nil {
return err
}
}
allowAlias := false
var allowAliasOpt *dpb.UninterpretedOption
if index, err := findOption(res, scope, ed.Options.GetUninterpretedOption(), "allow_alias"); err != nil {
return err
} else if index >= 0 {
allowAliasOpt = ed.Options.UninterpretedOption[index]
valid := false
if allowAliasOpt.IdentifierValue != nil {
if allowAliasOpt.GetIdentifierValue() == "true" {
allowAlias = true
valid = true
} else if allowAliasOpt.GetIdentifierValue() == "false" {
valid = true
}
}
if !valid {
optNode := res.getOptionNode(allowAliasOpt)
if err := res.errs.handleErrorWithPos(optNode.GetValue().Start(), "%s: expecting bool value for allow_alias option", scope); err != nil {
return err
}
}
}
if isProto3 && len(ed.Value) > 0 && ed.Value[0].GetNumber() != 0 {
evNode := res.getEnumValueNode(ed.Value[0])
if err := res.errs.handleErrorWithPos(evNode.GetNumber().Start(), "%s: proto3 requires that first value in enum have numeric value of 0", scope); err != nil {
return err
}
}
// check for aliases
vals := map[int32]string{}
hasAlias := false
for _, evd := range ed.Value {
existing := vals[evd.GetNumber()]
if existing != "" {
if allowAlias {
hasAlias = true
} else {
evNode := res.getEnumValueNode(evd)
if err := res.errs.handleErrorWithPos(evNode.GetNumber().Start(), "%s: values %s and %s both have the same numeric value %d; use allow_alias option if intentional", scope, existing, evd.GetName(), evd.GetNumber()); err != nil {
return err
}
}
}
vals[evd.GetNumber()] = evd.GetName()
}
if allowAlias && !hasAlias {
optNode := res.getOptionNode(allowAliasOpt)
if err := res.errs.handleErrorWithPos(optNode.GetValue().Start(), "%s: allow_alias is true but no values are aliases", scope); err != nil {
return err
}
}
// reserved ranges should not overlap
rsvd := make(tagRanges, len(ed.ReservedRange))
for i, r := range ed.ReservedRange {
n := res.getEnumReservedRangeNode(r)
rsvd[i] = tagRange{start: r.GetStart(), end: r.GetEnd(), node: n}
}
sort.Sort(rsvd)
for i := 1; i < len(rsvd); i++ {
if rsvd[i].start <= rsvd[i-1].end {
if err := res.errs.handleErrorWithPos(rsvd[i].node.Start(), "%s: reserved ranges overlap: %d to %d and %d to %d", scope, rsvd[i-1].start, rsvd[i-1].end, rsvd[i].start, rsvd[i].end); err != nil {
return err
}
}
}
// now, check that fields don't re-use tags and don't try to use extension
// or reserved ranges or reserved names
rsvdNames := map[string]struct{}{}
for _, n := range ed.ReservedName {
rsvdNames[n] = struct{}{}
}
for _, ev := range ed.Value {
evn := res.getEnumValueNode(ev)
if _, ok := rsvdNames[ev.GetName()]; ok {
if err := res.errs.handleErrorWithPos(evn.GetName().Start(), "%s: value %s is using a reserved name", scope, ev.GetName()); err != nil {
return err
}
}
// check reserved ranges
r := sort.Search(len(rsvd), func(index int) bool { return rsvd[index].end >= ev.GetNumber() })
if r < len(rsvd) && rsvd[r].start <= ev.GetNumber() {
if err := res.errs.handleErrorWithPos(evn.GetNumber().Start(), "%s: value %s is using number %d which is in reserved range %d to %d", scope, ev.GetName(), ev.GetNumber(), rsvd[r].start, rsvd[r].end); err != nil {
return err
}
}
}
return nil
}
func validateField(res *parseResult, isProto3 bool, prefix string, fld *dpb.FieldDescriptorProto) error {
scope := fmt.Sprintf("field %s%s", prefix, fld.GetName())
node := res.getFieldNode(fld)
if isProto3 {
if fld.GetType() == dpb.FieldDescriptorProto_TYPE_GROUP {
if err := res.errs.handleErrorWithPos(node.GetGroupKeyword().Start(), "%s: groups are not allowed in proto3", scope); err != nil {
return err
}
} else if fld.Label != nil && fld.GetLabel() == dpb.FieldDescriptorProto_LABEL_REQUIRED {
if err := res.errs.handleErrorWithPos(node.FieldLabel().Start(), "%s: label 'required' is not allowed in proto3", scope); err != nil {
return err
}
}
if index, err := findOption(res, scope, fld.Options.GetUninterpretedOption(), "default"); err != nil {
return err
} else if index >= 0 {
optNode := res.getOptionNode(fld.Options.GetUninterpretedOption()[index])
if err := res.errs.handleErrorWithPos(optNode.GetName().Start(), "%s: default values are not allowed in proto3", scope); err != nil {
return err
}
}
} else {
if fld.Label == nil && fld.OneofIndex == nil {
if err := res.errs.handleErrorWithPos(node.FieldName().Start(), "%s: field has no label; proto2 requires explicit 'optional' label", scope); err != nil {
return err
}
}
if fld.GetExtendee() != "" && fld.Label != nil && fld.GetLabel() == dpb.FieldDescriptorProto_LABEL_REQUIRED {
if err := res.errs.handleErrorWithPos(node.FieldLabel().Start(), "%s: extension fields cannot be 'required'", scope); err != nil {
return err
}
}
}
// finally, set any missing label to optional
if fld.Label == nil {
fld.Label = dpb.FieldDescriptorProto_LABEL_OPTIONAL.Enum()
}
return nil
}
type tagRange struct {
start int32
end int32
node ast.RangeDeclNode
}
type tagRanges []tagRange
func (r tagRanges) Len() int {
return len(r)
}
func (r tagRanges) Less(i, j int) bool {
return r[i].start < r[j].start ||
(r[i].start == r[j].start && r[i].end < r[j].end)
}
func (r tagRanges) Swap(i, j int) {
r[i], r[j] = r[j], r[i]
}