-
Notifications
You must be signed in to change notification settings - Fork 3
/
secret_validator.go
223 lines (184 loc) · 6.76 KB
/
secret_validator.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 manifest
import (
"code.cloudfoundry.org/cli/util/manifestparser"
"fmt"
"golang.org/x/exp/slices"
"reflect"
"regexp"
"strings"
)
const tagName = "secretAllowed"
var reservedKeyNames = []string{"value"}
var UnsupportedSecretError = func(fieldName string) error {
return fmt.Errorf("'%s' is not allowed to contain a secret", fieldName)
}
var InvalidSecretConcourseError = func(secret, fieldName string) error {
return fmt.Errorf("'%s' at '%s' is not a valid key, must be in format of ((mapName.keyName)) or ((path/to/mapName.keyName))", secret, fieldName)
}
var InvalidSecretActionsError = func(secret, fieldName string) error {
return fmt.Errorf("'%s' at '%s' is not a valid key, must be in format of ((mapName.keyName)), ((path/to/mapName.keyName)) or ((/springernature/data/path/to/mapName keyName))", secret, fieldName)
}
type SecretValidator interface {
Validate(Manifest) []error
}
type secretValidator struct {
}
func NewSecretValidator() SecretValidator {
return secretValidator{}
}
func (s secretValidator) getRealFieldName(fieldName string, jsonTag string) string {
if fieldName == "API" {
return "api"
}
if jsonTag == "" || jsonTag == "-" || jsonTag == "omitempty" {
return strings.ToLower(string(fieldName[0])) + fieldName[1:]
}
return strings.Split(jsonTag, ",")[0]
}
func (s secretValidator) validate(i interface{}, fieldName string, secretTag string, errs *[]error, platform Platform) {
v := reflect.ValueOf(i)
switch v.Type() {
case reflect.TypeOf(Manifest{}),
reflect.TypeOf(Repo{}),
reflect.TypeOf(Run{}),
reflect.TypeOf(Docker{}),
reflect.TypeOf(DockerPush{}),
reflect.TypeOf(DockerCompose{}),
reflect.TypeOf(DeployCF{}),
reflect.TypeOf(DeployKatee{}),
reflect.TypeOf(ConsumerIntegrationTest{}),
reflect.TypeOf(DeployMLZip{}),
reflect.TypeOf(DeployMLModules{}),
reflect.TypeOf(ArtifactConfig{}),
reflect.TypeOf(GitTrigger{}),
reflect.TypeOf(TimerTrigger{}),
reflect.TypeOf(DockerTrigger{}),
reflect.TypeOf(PipelineTrigger{}):
for i := 0; i < v.NumField(); i++ {
field := v.Field(i)
name := v.Type().Field(i).Name
jsonTag := v.Type().Field(i).Tag.Get("json")
secretTag := v.Type().Field(i).Tag.Get(tagName)
var realFieldName string
if fieldName == "" {
realFieldName = s.getRealFieldName(name, jsonTag)
} else {
realFieldName = fmt.Sprintf("%s.%s", fieldName, s.getRealFieldName(name, jsonTag))
}
s.validate(field.Interface(), realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(TaskList{}):
for i, elem := range v.Interface().(TaskList) {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(TriggerList{}):
for i, elem := range v.Interface().(TriggerList) {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(Parallel{}):
for i, elem := range v.Interface().(Parallel).Tasks {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(Sequence{}):
for i, elem := range v.Interface().(Sequence).Tasks {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf([]string{"stringArray"}):
for i, elem := range v.Interface().([]string) {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(FeatureToggles{}):
for i, elem := range v.Interface().(FeatureToggles) {
realFieldName := fmt.Sprintf("%s[%d]", fieldName, i)
s.validate(elem, realFieldName, secretTag, errs, platform)
}
case reflect.TypeOf(Vars{}):
for key, value := range v.Interface().(Vars) {
realKeyName := fmt.Sprintf("key %s[%s]", fieldName, key)
s.validate(key, realKeyName, "false", errs, "")
realValueName := fmt.Sprintf("%s[%s]", fieldName, key)
s.validate(value, realValueName, secretTag, errs, platform)
}
case reflect.TypeOf("string"):
secret := v.Interface().(string)
r := regexp.MustCompile(`\(\(.*\)\)`)
if r.MatchString(secret) {
if secretTag != "true" {
*errs = append(*errs, UnsupportedSecretError(fieldName))
return
}
if platform.IsConcourse() {
if !validateKeyValueSecret(secret) && !validateMultipleLevelSecret(secret) {
*errs = append(*errs, InvalidSecretConcourseError(secret, fieldName))
return
}
}
if platform.IsActions() {
splitOnSpaceSecret := strings.Split(secret, " ")
if len(splitOnSpaceSecret) == 2 {
if !validateSecretAbsolutePath(secret) {
*errs = append(*errs, InvalidSecretActionsError(secret, fieldName))
return
}
} else {
if !validateKeyValueSecret(secret) && !validateMultipleLevelSecret(secret) {
*errs = append(*errs, InvalidSecretActionsError(secret, fieldName))
return
}
}
}
}
case reflect.TypeOf(true), reflect.TypeOf(0), reflect.TypeOf(manifestparser.Application{}):
// Stuff that we don't care about as they cannot contain secrets.
return
case reflect.TypeOf(Update{}):
return
case reflect.TypeOf(Platform("")):
return
case reflect.TypeOf(ComposeFiles{}):
return
case reflect.TypeOf(Notifications{}):
notifications := v.Interface().(Notifications)
for ni, success := range notifications.OnSuccess {
fieldName := fmt.Sprintf("%s.on_success[%d]", fieldName, ni)
s.validate(success, fieldName, secretTag, errs, platform)
}
for ni, success := range notifications.OnFailure {
fieldName := fmt.Sprintf("%s.on_failure[%d]", fieldName, ni)
s.validate(success, fieldName, secretTag, errs, platform)
}
return
default:
panic(fmt.Sprintf("Not implemented for %s", v.Type()))
}
}
func validateMultipleLevelSecret(secret string) bool {
// regex matches ((path/to/secret.value)) and ((path/to/more/levels/secret.value))
return regexp.MustCompile(`\(\(([a-zA-Z0-9\-_]+\/){1,}[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\)\)`).MatchString(secret)
}
func validateKeyValueSecret(secret string) bool {
splitSecret := strings.Split(secret, ".")
if len(splitSecret) != 2 || !regexp.MustCompile(`^\(\([a-zA-Z0-9\-_\.]+\)\)$`).MatchString(secret) {
return false
}
return true
}
func validateSecretAbsolutePath(secret string) bool {
splitSecret := strings.Split(secret, " ")
prefix := strings.HasPrefix(splitSecret[0], "((/springernature/data/")
containsSlash := strings.Contains(splitSecret[1], "/")
return prefix && !containsSlash
}
func (s secretValidator) Validate(man Manifest) (errors []error) {
var errs []error
s.validate(man, "", "", &errs, man.Platform)
return errs
}
func (s secretValidator) IsReservedKeyName(keyName string) bool {
return slices.ContainsFunc(reservedKeyNames, func(s string) bool { return s == keyName })
}