-
Notifications
You must be signed in to change notification settings - Fork 95
/
kubernetes.go
351 lines (304 loc) · 11.6 KB
/
kubernetes.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
/*
Copyright 2023 The Radius Authors.
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 secretstores
import (
"context"
"encoding/base64"
"errors"
"fmt"
"strings"
"github.com/radius-project/radius/pkg/armrpc/frontend/controller"
"github.com/radius-project/radius/pkg/armrpc/rest"
"github.com/radius-project/radius/pkg/corerp/datamodel"
"github.com/radius-project/radius/pkg/kubernetes"
"github.com/radius-project/radius/pkg/kubeutil"
rpv1 "github.com/radius-project/radius/pkg/rp/v1"
"github.com/radius-project/radius/pkg/to"
"github.com/radius-project/radius/pkg/ucp/resources"
resources_kubernetes "github.com/radius-project/radius/pkg/ucp/resources/kubernetes"
"github.com/radius-project/radius/pkg/ucp/store"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
runtimeclient "sigs.k8s.io/controller-runtime/pkg/client"
)
func getOrDefaultType(t datamodel.SecretType) (datamodel.SecretType, error) {
var err error
switch t {
case datamodel.SecretTypeNone:
t = datamodel.SecretTypeGeneric
case datamodel.SecretTypeCert:
case datamodel.SecretTypeGeneric:
case datamodel.SecretTypeBasicAuthentication:
case datamodel.SecretTypeAzureWorkloadIdentity:
case datamodel.SecretTypeAWSIRSA:
default:
err = fmt.Errorf("'%s' is invalid secret type", t)
}
return t, err
}
func getOrDefaultEncoding(t datamodel.SecretType, e datamodel.SecretValueEncoding) (datamodel.SecretValueEncoding, error) {
var err error
switch e {
case datamodel.SecretValueEncodingBase64:
// no-op
case datamodel.SecretValueEncodingNone:
// certificate value must be base64-encoded.
if t == datamodel.SecretTypeCert {
e = datamodel.SecretValueEncodingBase64
} else {
e = datamodel.SecretValueEncodingRaw
}
case datamodel.SecretValueEncodingRaw:
if t == datamodel.SecretTypeCert {
err = fmt.Errorf("%s type doesn't support %s", datamodel.SecretTypeCert, datamodel.SecretValueEncodingRaw)
}
default:
err = fmt.Errorf("%s is the invalid encoding type", e)
}
return e, err
}
// Define a map of required keys for each SecretType
var requiredKeys = map[datamodel.SecretType][]string{
datamodel.SecretTypeBasicAuthentication: {RequiredUsername, RequiredPassword},
datamodel.SecretTypeAzureWorkloadIdentity: {RequiredClientId, RequiredTenantId},
datamodel.SecretTypeAWSIRSA: {RequiredRoleARN},
}
// ValidateAndMutateRequest checks the type and encoding of the secret store, and ensures that the secret store data is
// valid and required keys are present for the secret type. If any of these checks fail, a BadRequestResponse is returned.
func ValidateAndMutateRequest(ctx context.Context, newResource *datamodel.SecretStore, oldResource *datamodel.SecretStore, options *controller.Options) (rest.Response, error) {
var err error
newResource.Properties.Type, err = getOrDefaultType(newResource.Properties.Type)
if err != nil {
return rest.NewBadRequestResponse(err.Error()), nil
}
if oldResource != nil {
if oldResource.Properties.Type != newResource.Properties.Type {
return rest.NewBadRequestResponse(fmt.Sprintf("$.properties.type cannot change from '%s' to '%s'.", oldResource.Properties.Type, newResource.Properties.Type)), nil
}
if newResource.Properties.Resource == "" {
newResource.Properties.Resource = oldResource.Properties.Resource
}
}
refResourceID := newResource.Properties.Resource
if _, _, err := fromResourceID(refResourceID); err != nil {
return nil, err
}
for k, secret := range newResource.Properties.Data {
// Kubernetes secret does not support valueFrom. Note that this property is reserved to
// reference the secret in the external secret stores, such as Azure KeyVault and AWS secrets manager.
if secret.ValueFrom != nil && secret.ValueFrom.Name != "" {
return rest.NewBadRequestResponse(fmt.Sprintf("$.properties.data[%s].valueFrom.Name is specified. Kubernetes secret resource doesn't support secret reference. ", k)), nil
}
secret.Encoding, err = getOrDefaultEncoding(newResource.Properties.Type, secret.Encoding)
if err != nil {
return rest.NewBadRequestResponse(fmt.Sprintf("'%s' encoding is not valid: %q", k, err)), nil
}
if refResourceID == "" && secret.Value == nil {
return rest.NewBadRequestResponse(fmt.Sprintf("$.properties.data[%s].Value must be given to create the secret.", k)), nil
}
}
// Validate that required keys for the secret type are present in the secret data
if keys, ok := requiredKeys[newResource.Properties.Type]; ok {
for _, key := range keys {
if _, ok := newResource.Properties.Data[key]; !ok {
return rest.NewBadRequestResponse(fmt.Sprintf("$.properties.data must contain '%s' key for %s type.", key, newResource.Properties.Type)), nil
}
}
}
return nil, nil
}
func getNamespace(ctx context.Context, res *datamodel.SecretStore, options *controller.Options) (string, error) {
prop := res.Properties
if prop.Application != "" {
app, err := store.GetResource[datamodel.Application](ctx, options.StorageClient, prop.Application)
if err != nil {
return "", err
}
compute := app.Properties.Status.Compute
if compute != nil && compute.KubernetesCompute.Namespace != "" {
return compute.KubernetesCompute.Namespace, nil
}
}
if prop.Environment != "" {
env, err := store.GetResource[datamodel.Environment](ctx, options.StorageClient, prop.Environment)
if err != nil {
return "", err
}
namespace := env.Properties.Compute.KubernetesCompute.Namespace
if namespace != "" {
return namespace, nil
}
}
return "", errors.New("no Kubernetes namespace")
}
func toResourceID(ns, name string) string {
if ns == "" {
return name
}
return fmt.Sprintf("%s/%s", ns, name)
}
func fromResourceID(id string) (ns string, name string, err error) {
res := strings.Split(id, "/")
if len(res) == 2 {
ns, name = res[0], res[1]
} else if len(res) == 1 {
ns, name = "", res[0]
} else {
err = fmt.Errorf("'%s' is the invalid resource id", id)
return
}
if name != "" && !kubernetes.IsValidObjectName(name) {
err = fmt.Errorf("'%s' is the invalid resource name. This must be at most 63 alphanumeric characters or '-'", name)
return
}
if ns != "" && !kubernetes.IsValidObjectName(ns) {
err = fmt.Errorf("'%s' is the invalid namespace. This must be at most 63 alphanumeric characters or '-'", ns)
return
}
return
}
// UpsertSecret creates or updates a Kubernetes secret based on the incoming request and returns the secret's location in
// the output resource.
func UpsertSecret(ctx context.Context, newResource, old *datamodel.SecretStore, options *controller.Options) (rest.Response, error) {
ref := newResource.Properties.Resource
if ref == "" && old != nil {
ref = old.Properties.Resource
}
// resource property cannot be empty for global scoped resource.
if newResource.Properties.BasicResourceProperties.IsGlobalScopedResource() && ref == "" {
return rest.NewBadRequestResponse("$.properties.resource cannot be empty for global scoped resource."), nil
}
ns, name, err := fromResourceID(ref)
if err != nil {
return nil, err
}
if ns == "" {
if ns, err = getNamespace(ctx, newResource, options); err != nil {
return nil, err
}
}
// Create namespace if not exists.
err = kubeutil.PatchNamespace(ctx, options.KubeClient, ns)
if err != nil {
return nil, err
}
if name == "" {
name = newResource.Name
}
newResource.Properties.Resource = toResourceID(ns, name)
if old != nil && old.Properties.Resource != newResource.Properties.Resource {
return rest.NewBadRequestResponse(fmt.Sprintf("'%s' of $.properties.resource must be same as '%s'.", newResource.Properties.Resource, old.Properties.Resource)), nil
}
ksecret := &corev1.Secret{}
err = options.KubeClient.Get(ctx, runtimeclient.ObjectKey{Namespace: ns, Name: name}, ksecret)
if apierrors.IsNotFound(err) {
// If resource in incoming request references resource, then the resource must exist for a application/environment scoped resource.
// For global scoped resource create the kubernetes resource if not exists.
if ref != "" && !newResource.Properties.BasicResourceProperties.IsGlobalScopedResource() {
return rest.NewBadRequestResponse(fmt.Sprintf("'%s' referenced resource does not exist.", ref)), nil
}
app, _ := resources.ParseResource(newResource.Properties.Application)
ksecret = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: ns,
Labels: kubernetes.MakeDescriptiveLabels(app.Name(), name, ResourceTypeName),
},
Data: map[string][]byte{},
}
} else if err != nil {
return nil, err
}
updateRequired := false
for k, secret := range newResource.Properties.Data {
val := to.String(secret.Value)
if val != "" {
// Kubernetes secret data expects base64 encoded value.
if secret.Encoding == datamodel.SecretValueEncodingRaw {
encoded := base64.StdEncoding.EncodeToString([]byte(val))
ksecret.Data[k] = []byte(encoded)
} else {
ksecret.Data[k] = []byte(val)
}
updateRequired = true
// Remove secret from metadata before storing it to data store.
secret.Value = nil
} else {
if _, ok := ksecret.Data[k]; !ok {
return rest.NewBadRequestResponse(fmt.Sprintf("'%s' resource does not have key, '%s'.", newResource.Properties.Resource, k)), nil
}
}
}
if ksecret.ResourceVersion == "" {
switch newResource.Properties.Type {
case datamodel.SecretTypeCert:
ksecret.Type = corev1.SecretTypeTLS
case datamodel.SecretTypeGeneric:
ksecret.Type = corev1.SecretTypeOpaque
}
err = options.KubeClient.Create(ctx, ksecret)
} else if updateRequired {
err = options.KubeClient.Update(ctx, ksecret)
}
if err != nil {
return nil, err
}
// In order to get the secret data, we need to get the actual secret location from output resource.
newResource.Properties.Status.OutputResources = []rpv1.OutputResource{
{
LocalID: rpv1.LocalIDSecret,
ID: resources_kubernetes.IDFromParts(
resources_kubernetes.PlaneNameTODO,
"",
resources_kubernetes.KindSecret,
ns,
name),
},
}
return nil, nil
}
// DeleteRadiusSecret deletes the Kubernetes secret associated with the given secret store if it is a
// Radius managed resource.
func DeleteRadiusSecret(ctx context.Context, oldResource *datamodel.SecretStore, options *controller.Options) (rest.Response, error) {
ksecret, err := getSecretFromOutputResources(oldResource.Properties.Status.OutputResources, options)
if err != nil {
return nil, err
}
if ksecret != nil {
// Delete only Radius managed resource.
if _, ok := ksecret.Labels[kubernetes.LabelRadiusResourceType]; ok {
if err := options.KubeClient.Delete(ctx, ksecret); err != nil {
return nil, err
}
}
}
return nil, nil
}
func getSecretFromOutputResources(resources []rpv1.OutputResource, options *controller.Options) (*corev1.Secret, error) {
name, ns := "", ""
for _, resource := range resources {
if strings.EqualFold(resource.ID.Type(), "core/Secret") {
_, _, ns, name = resources_kubernetes.ToParts(resource.ID)
break
}
}
ksecret := &corev1.Secret{}
err := options.KubeClient.Get(context.Background(), runtimeclient.ObjectKey{Namespace: ns, Name: name}, ksecret)
if apierrors.IsNotFound(err) {
return nil, nil
} else if err != nil {
return nil, err
}
return ksecret, nil
}