-
Notifications
You must be signed in to change notification settings - Fork 1
/
validators.go
311 lines (186 loc) · 6.51 KB
/
validators.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
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package ccmetadata
import (
"encoding/json"
"fmt"
"path/filepath"
"reflect"
"regexp"
"strings"
"github.com/mcc-github/blockchain/common/flogging"
)
var logger = flogging.MustGetLogger("chaincode.platform.metadata")
type fileValidator func(fileName string, fileBytes []byte) error
const AllowedCharsCollectionName = "[A-Za-z0-9_-]+"
var fileValidators = map[*regexp.Regexp]fileValidator{
regexp.MustCompile("^META-INF/statedb/couchdb/indexes/.*[.]json"): couchdbIndexFileValidator,
regexp.MustCompile("^META-INF/statedb/couchdb/collections/" + AllowedCharsCollectionName + "/indexes/.*[.]json"): couchdbIndexFileValidator,
}
var collectionNameValid = regexp.MustCompile("^" + AllowedCharsCollectionName)
var fileNameValid = regexp.MustCompile("^.*[.]json")
var validDatabases = []string{"couchdb"}
type UnhandledDirectoryError struct {
err string
}
func (e *UnhandledDirectoryError) Error() string {
return e.err
}
type InvalidIndexContentError struct {
err string
}
func (e *InvalidIndexContentError) Error() string {
return e.err
}
func ValidateMetadataFile(filePathName string, fileBytes []byte) error {
fileValidator := selectFileValidator(filePathName)
if fileValidator == nil {
return &UnhandledDirectoryError{buildMetadataFileErrorMessage(filePathName)}
}
err := fileValidator(filePathName, fileBytes)
if err != nil {
return err
}
return nil
}
func buildMetadataFileErrorMessage(filePathName string) string {
dir, filename := filepath.Split(filePathName)
if !strings.HasPrefix(filePathName, "META-INF/statedb") {
return fmt.Sprintf("metadata file path must begin with META-INF/statedb, found: %s", dir)
}
directoryArray := strings.Split(filepath.Clean(dir), "/")
if len(directoryArray) < 4 {
return fmt.Sprintf("metadata file path must include a database and index directory: %s", dir)
}
if !contains(validDatabases, directoryArray[2]) {
return fmt.Sprintf("database name [%s] is not supported, valid options: %s", directoryArray[2], validDatabases)
}
if len(directoryArray) == 4 && directoryArray[3] != "indexes" {
return fmt.Sprintf("metadata file path does not have an indexes directory: %s", dir)
}
if len(directoryArray) != 6 {
return fmt.Sprintf("metadata file path for collections must include a collections and index directory: %s", dir)
}
if directoryArray[3] != "collections" || directoryArray[5] != "indexes" {
return fmt.Sprintf("metadata file path for collections must have a collections and indexes directory: %s", dir)
}
if !collectionNameValid.MatchString(directoryArray[4]) {
return fmt.Sprintf("collection name is not valid: %s", directoryArray[4])
}
if !fileNameValid.MatchString(filename) {
return fmt.Sprintf("artifact file name is not valid: %s", filename)
}
return fmt.Sprintf("metadata file path or name is not supported: %s", dir)
}
func contains(validStrings []string, target string) bool {
for _, str := range validStrings {
if str == target {
return true
}
}
return false
}
func selectFileValidator(filePathName string) fileValidator {
for validateExp, fileValidator := range fileValidators {
isValid := validateExp.MatchString(filePathName)
if isValid {
return fileValidator
}
}
return nil
}
func couchdbIndexFileValidator(fileName string, fileBytes []byte) error {
boolIsJSON, indexDefinition := isJSON(fileBytes)
if !boolIsJSON {
return &InvalidIndexContentError{fmt.Sprintf("Index metadata file [%s] is not a valid JSON", fileName)}
}
err := validateIndexJSON(indexDefinition)
if err != nil {
return &InvalidIndexContentError{fmt.Sprintf("Index metadata file [%s] is not a valid index definition: %s", fileName, err)}
}
return nil
}
func isJSON(s []byte) (bool, map[string]interface{}) {
var js map[string]interface{}
return json.Unmarshal([]byte(s), &js) == nil, js
}
func validateIndexJSON(indexDefinition map[string]interface{}) error {
indexIncluded := false
for jsonKey, jsonValue := range indexDefinition {
switch jsonKey {
case "index":
if reflect.TypeOf(jsonValue).Kind() != reflect.Map {
return fmt.Errorf("Invalid entry, \"index\" must be a JSON")
}
err := processIndexMap(jsonValue.(map[string]interface{}))
if err != nil {
return err
}
indexIncluded = true
case "ddoc":
if reflect.TypeOf(jsonValue).Kind() != reflect.String {
return fmt.Errorf("Invalid entry, \"ddoc\" must be a string")
}
logger.Debugf("Found index object: \"%s\":\"%s\"", jsonKey, jsonValue)
case "name":
if reflect.TypeOf(jsonValue).Kind() != reflect.String {
return fmt.Errorf("Invalid entry, \"name\" must be a string")
}
logger.Debugf("Found index object: \"%s\":\"%s\"", jsonKey, jsonValue)
case "type":
if jsonValue != "json" {
return fmt.Errorf("Index type must be json")
}
logger.Debugf("Found index object: \"%s\":\"%s\"", jsonKey, jsonValue)
default:
return fmt.Errorf("Invalid Entry. Entry %s", jsonKey)
}
}
if !indexIncluded {
return fmt.Errorf("Index definition must include a \"fields\" definition")
}
return nil
}
func processIndexMap(jsonFragment map[string]interface{}) error {
for jsonKey, jsonValue := range jsonFragment {
switch jsonKey {
case "fields":
switch jsonValueType := jsonValue.(type) {
case []interface{}:
for _, itemValue := range jsonValueType {
switch reflect.TypeOf(itemValue).Kind() {
case reflect.String:
logger.Debugf("Found index field name: \"%s\"", itemValue)
case reflect.Map:
err := validateFieldMap(itemValue.(map[string]interface{}))
if err != nil {
return err
}
}
}
default:
return fmt.Errorf("Expecting a JSON array of fields")
}
case "partial_filter_selector":
default:
return fmt.Errorf("Invalid Entry. Entry %s", jsonKey)
}
}
return nil
}
func validateFieldMap(jsonFragment map[string]interface{}) error {
for jsonKey, jsonValue := range jsonFragment {
switch jsonValue.(type) {
case string:
if !(strings.ToLower(jsonValue.(string)) == "asc" || strings.ToLower(jsonValue.(string)) == "desc") {
return fmt.Errorf("Sort must be either \"asc\" or \"desc\". \"%s\" was found.", jsonValue)
}
logger.Debugf("Found index field name: \"%s\":\"%s\"", jsonKey, jsonValue)
default:
return fmt.Errorf("Invalid field definition, fields must be in the form \"fieldname\":\"sort\"")
}
}
return nil
}