-
Notifications
You must be signed in to change notification settings - Fork 458
/
project.go
291 lines (236 loc) · 10.9 KB
/
project.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
// Copyright 2018 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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.
package validation
import (
"fmt"
"strings"
rbacv1 "k8s.io/api/rbac/v1"
apivalidation "k8s.io/apimachinery/pkg/api/validation"
"k8s.io/apimachinery/pkg/api/validation/path"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/apiserver/pkg/authentication/serviceaccount"
"github.com/gardener/gardener/pkg/apis/core"
"github.com/gardener/gardener/pkg/utils"
)
// ValidateProject validates a Project object.
func ValidateProject(project *core.Project) field.ErrorList {
allErrs := field.ErrorList{}
allErrs = append(allErrs, apivalidation.ValidateObjectMeta(&project.ObjectMeta, false, ValidateName, field.NewPath("metadata"))...)
maxProjectNameLength := 10
if len(project.Name) > maxProjectNameLength {
allErrs = append(allErrs, field.TooLong(field.NewPath("metadata", "name"), project.Name, maxProjectNameLength))
}
allErrs = append(allErrs, validateNameConsecutiveHyphens(project.Name, field.NewPath("metadata", "name"))...)
allErrs = append(allErrs, ValidateProjectSpec(&project.Spec, field.NewPath("spec"))...)
return allErrs
}
// ValidateProjectUpdate validates a Project object before an update.
func ValidateProjectUpdate(newProject, oldProject *core.Project) field.ErrorList {
allErrs := field.ErrorList{}
allErrs = append(allErrs, apivalidation.ValidateObjectMetaUpdate(&newProject.ObjectMeta, &oldProject.ObjectMeta, field.NewPath("metadata"))...)
allErrs = append(allErrs, ValidateProject(newProject)...)
if oldProject.Spec.CreatedBy != nil {
allErrs = append(allErrs, apivalidation.ValidateImmutableField(newProject.Spec.CreatedBy, oldProject.Spec.CreatedBy, field.NewPath("spec", "createdBy"))...)
}
if oldProject.Spec.Namespace != nil {
allErrs = append(allErrs, apivalidation.ValidateImmutableField(newProject.Spec.Namespace, oldProject.Spec.Namespace, field.NewPath("spec", "namespace"))...)
}
if oldProject.Spec.Owner != nil && newProject.Spec.Owner == nil {
allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "owner"), newProject.Spec.Owner, "owner cannot be reset"))
}
return allErrs
}
// ValidateProjectSpec validates the specification of a Project object.
func ValidateProjectSpec(projectSpec *core.ProjectSpec, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
if projectSpec.Namespace != nil && *projectSpec.Namespace == core.GardenerSeedLeaseNamespace {
allErrs = append(allErrs, field.Invalid(fldPath.Child("namespace"), projectSpec.Namespace, fmt.Sprintf("Project namespace %s is reserved by Gardener", core.GardenerSeedLeaseNamespace)))
}
ownerFound := false
members := make(map[string]struct{}, len(projectSpec.Members))
for i, member := range projectSpec.Members {
idxPath := fldPath.Child("members").Index(i)
apiGroup, kind, namespace, name, err := ProjectMemberProperties(member)
if err != nil {
allErrs = append(allErrs, field.Invalid(idxPath.Child("name"), member.Name, err.Error()))
continue
}
id := ProjectMemberId(apiGroup, kind, namespace, name)
if _, ok := members[id]; ok {
allErrs = append(allErrs, field.Duplicate(idxPath, member))
} else {
members[id] = struct{}{}
}
allErrs = append(allErrs, ValidateProjectMember(member, idxPath)...)
for j, role := range member.Roles {
if role == core.ProjectMemberOwner {
if ownerFound {
allErrs = append(allErrs, field.Forbidden(idxPath.Child("roles").Index(j), "cannot have more than one member having the owner role"))
} else {
ownerFound = true
}
}
}
}
if createdBy := projectSpec.CreatedBy; createdBy != nil {
allErrs = append(allErrs, ValidateSubject(*createdBy, fldPath.Child("createdBy"))...)
}
if owner := projectSpec.Owner; owner != nil {
allErrs = append(allErrs, ValidateSubject(*owner, fldPath.Child("owner"))...)
}
if description := projectSpec.Description; description != nil && len(*description) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("description"), "must provide a description when key is present"))
}
if purpose := projectSpec.Purpose; purpose != nil && len(*purpose) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("purpose"), "must provide a purpose when key is present"))
}
if projectSpec.Tolerations != nil {
allErrs = append(allErrs, ValidateTolerations(projectSpec.Tolerations.Defaults, fldPath.Child("tolerations", "defaults"))...)
allErrs = append(allErrs, ValidateTolerations(projectSpec.Tolerations.Whitelist, fldPath.Child("tolerations", "whitelist"))...)
allErrs = append(allErrs, ValidateTolerationsAgainstAllowlist(projectSpec.Tolerations.Defaults, projectSpec.Tolerations.Whitelist, fldPath.Child("tolerations", "defaults"))...)
}
return allErrs
}
// ValidateSubject validates the subject representing the owner.
func ValidateSubject(subject rbacv1.Subject, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
if len(subject.Name) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("name"), ""))
}
switch subject.Kind {
case rbacv1.ServiceAccountKind:
if len(subject.Name) > 0 {
for _, msg := range apivalidation.ValidateServiceAccountName(subject.Name, false) {
allErrs = append(allErrs, field.Invalid(fldPath.Child("name"), subject.Name, msg))
}
}
if len(subject.APIGroup) > 0 {
allErrs = append(allErrs, field.NotSupported(fldPath.Child("apiGroup"), subject.APIGroup, []string{""}))
}
if len(subject.Namespace) == 0 {
allErrs = append(allErrs, field.Required(fldPath.Child("namespace"), ""))
}
case rbacv1.UserKind, rbacv1.GroupKind:
if subject.APIGroup != rbacv1.GroupName {
allErrs = append(allErrs, field.NotSupported(fldPath.Child("apiGroup"), subject.APIGroup, []string{rbacv1.GroupName}))
}
default:
allErrs = append(allErrs, field.NotSupported(fldPath.Child("kind"), subject.Kind, []string{rbacv1.ServiceAccountKind, rbacv1.UserKind, rbacv1.GroupKind}))
}
return allErrs
}
var supportedRoles = sets.New[string](
core.ProjectMemberOwner,
core.ProjectMemberAdmin,
core.ProjectMemberViewer,
core.ProjectMemberUserAccessManager,
core.ProjectMemberServiceAccountManager,
)
const extensionRoleMaxLength = 20
// ValidateProjectMember validates the specification of a Project member.
func ValidateProjectMember(member core.ProjectMember, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
allErrs = append(allErrs, ValidateSubject(member.Subject, fldPath)...)
foundRoles := map[string]struct{}{}
for i, role := range member.Roles {
rolesPath := fldPath.Child("roles").Index(i)
if _, ok := foundRoles[role]; ok {
allErrs = append(allErrs, field.Duplicate(rolesPath, role))
}
foundRoles[role] = struct{}{}
if !supportedRoles.Has(role) && !strings.HasPrefix(role, core.ProjectMemberExtensionPrefix) {
allErrs = append(allErrs, field.NotSupported(rolesPath, role, append(sets.List(supportedRoles), core.ProjectMemberExtensionPrefix+"*")))
}
if strings.HasPrefix(role, core.ProjectMemberExtensionPrefix) {
extensionRoleName := strings.TrimPrefix(role, core.ProjectMemberExtensionPrefix)
if len(extensionRoleName) > extensionRoleMaxLength {
allErrs = append(allErrs, field.TooLong(rolesPath, role, extensionRoleMaxLength))
}
// the extension role name will be used as part of a ClusterRole name
if errs := path.IsValidPathSegmentName(extensionRoleName); len(errs) > 0 {
allErrs = append(allErrs, field.Invalid(rolesPath, role, strings.Join(errs, ", ")))
}
}
}
return allErrs
}
// ValidateTolerations validates the given tolerations.
func ValidateTolerations(tolerations []core.Toleration, fldPath *field.Path) field.ErrorList {
var (
allErrs field.ErrorList
keyValues = sets.New[string]()
)
for i, toleration := range tolerations {
idxPath := fldPath.Index(i)
if len(toleration.Key) == 0 {
allErrs = append(allErrs, field.Required(idxPath.Child("key"), "cannot be empty"))
}
id := utils.IDForKeyWithOptionalValue(toleration.Key, toleration.Value)
if keyValues.Has(id) || keyValues.Has(toleration.Key) {
allErrs = append(allErrs, field.Duplicate(idxPath, id))
}
keyValues.Insert(id)
}
return allErrs
}
// ValidateTolerationsAgainstAllowlist validates the given tolerations against the given allowlist.
func ValidateTolerationsAgainstAllowlist(tolerations, allowlist []core.Toleration, fldPath *field.Path) field.ErrorList {
var (
allErrs field.ErrorList
allowedTolerations = sets.New[string]()
)
for _, toleration := range allowlist {
allowedTolerations.Insert(utils.IDForKeyWithOptionalValue(toleration.Key, toleration.Value))
}
for i, toleration := range tolerations {
id := utils.IDForKeyWithOptionalValue(toleration.Key, toleration.Value)
if !allowedTolerations.Has(utils.IDForKeyWithOptionalValue(toleration.Key, nil)) && !allowedTolerations.Has(id) {
allErrs = append(allErrs, field.Forbidden(fldPath.Index(i), fmt.Sprintf("only the following tolerations are allowed: %+v", allowedTolerations.UnsortedList())))
}
}
return allErrs
}
// ValidateProjectStatusUpdate validates the status field of a Project object.
func ValidateProjectStatusUpdate(newProject, oldProject *core.Project) field.ErrorList {
allErrs := field.ErrorList{}
if len(oldProject.Status.Phase) > 0 && len(newProject.Status.Phase) == 0 {
allErrs = append(allErrs, field.Invalid(field.NewPath("status").Child("phase"), newProject.Status.Phase, "phase cannot be updated to an empty string"))
}
return allErrs
}
// ProjectMemberProperties returns the properties for the given project member.
func ProjectMemberProperties(member core.ProjectMember) (string, string, string, string, error) {
var (
apiGroup = member.APIGroup
kind = member.Kind
namespace = member.Namespace
name = member.Name
)
if member.Kind == rbacv1.UserKind && strings.HasPrefix(member.Name, serviceaccount.ServiceAccountUsernamePrefix) {
user := strings.Split(member.Name, serviceaccount.ServiceAccountUsernameSeparator)
if len(user) < 4 {
return "", "", "", "", fmt.Errorf("unsupported service account user name: %q", member.Name)
}
apiGroup = ""
kind = rbacv1.ServiceAccountKind
namespace = user[2]
name = user[3]
}
return apiGroup, kind, namespace, name, nil
}
// ProjectMemberId returns an internal ID for the project member.
func ProjectMemberId(apiGroup, kind, namespace, name string) string {
return fmt.Sprintf("%s_%s_%s_%s", apiGroup, kind, namespace, name)
}