forked from grafana/loki
-
Notifications
You must be signed in to change notification settings - Fork 0
/
secrets.go
475 lines (406 loc) · 15.3 KB
/
secrets.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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
package storage
import (
"context"
"crypto/sha1"
"encoding/json"
"errors"
"fmt"
"sort"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"sigs.k8s.io/controller-runtime/pkg/client"
configv1 "github.com/grafana/loki/operator/apis/config/v1"
lokiv1 "github.com/grafana/loki/operator/apis/loki/v1"
"github.com/grafana/loki/operator/internal/external/k8s"
"github.com/grafana/loki/operator/internal/manifests/storage"
"github.com/grafana/loki/operator/internal/status"
)
var (
hashSeparator = []byte(",")
errSecretUnknownType = errors.New("unknown secret type")
errSecretMissingField = errors.New("missing secret field")
errSecretFieldNotAllowed = errors.New("secret field not allowed")
errSecretUnknownSSEType = errors.New("unsupported SSE type (supported: SSE-KMS, SSE-S3)")
errSecretHashError = errors.New("error calculating hash for secret")
errS3NoAuth = errors.New("missing secret fields for static or sts authentication")
errAzureNoCredentials = errors.New("azure storage secret does contain neither account_key or client_id")
errAzureMixedCredentials = errors.New("azure storage secret can not contain both account_key and client_id")
errAzureManagedIdentityNoOverride = errors.New("when in managed mode, storage secret can not contain credentials")
errGCPParseCredentialsFile = errors.New("gcp storage secret cannot be parsed from JSON content")
errGCPWrongCredentialSourceFile = errors.New("credential source in secret needs to point to token file")
)
const gcpAccountTypeExternal = "external_account"
func getSecrets(ctx context.Context, k k8s.Client, stack *lokiv1.LokiStack, fg configv1.FeatureGates) (*corev1.Secret, *corev1.Secret, error) {
var (
storageSecret corev1.Secret
managedAuthSecret corev1.Secret
)
key := client.ObjectKey{Name: stack.Spec.Storage.Secret.Name, Namespace: stack.Namespace}
if err := k.Get(ctx, key, &storageSecret); err != nil {
if apierrors.IsNotFound(err) {
return nil, nil, &status.DegradedError{
Message: "Missing object storage secret",
Reason: lokiv1.ReasonMissingObjectStorageSecret,
Requeue: false,
}
}
return nil, nil, fmt.Errorf("failed to lookup lokistack storage secret: %w", err)
}
if fg.OpenShift.ManagedAuthEnv {
secretName := storage.ManagedCredentialsSecretName(stack.Name)
managedAuthCredsKey := client.ObjectKey{Name: secretName, Namespace: stack.Namespace}
if err := k.Get(ctx, managedAuthCredsKey, &managedAuthSecret); err != nil {
if apierrors.IsNotFound(err) {
return nil, nil, &status.DegradedError{
Message: "Missing OpenShift cloud credentials secret",
Reason: lokiv1.ReasonMissingManagedAuthSecret,
Requeue: true,
}
}
return nil, nil, fmt.Errorf("failed to lookup OpenShift CCO managed authentication credentials secret: %w", err)
}
return &storageSecret, &managedAuthSecret, nil
}
return &storageSecret, nil, nil
}
// extractSecrets reads the k8s obj storage secret into a manifest object storage struct if valid.
// The managed auth is also read into the manifest object under the right circumstances.
func extractSecrets(secretType lokiv1.ObjectStorageSecretType, objStore, managedAuth *corev1.Secret, fg configv1.FeatureGates) (storage.Options, error) {
hash, err := hashSecretData(objStore)
if err != nil {
return storage.Options{}, errSecretHashError
}
storageOpts := storage.Options{
SecretName: objStore.Name,
SecretSHA1: hash,
SharedStore: secretType,
}
if fg.OpenShift.ManagedAuthEnv {
var managedAuthHash string
managedAuthHash, err = hashSecretData(managedAuth)
if err != nil {
return storage.Options{}, errSecretHashError
}
storageOpts.OpenShift = storage.OpenShiftOptions{
CloudCredentials: storage.CloudCredentials{
SecretName: managedAuth.Name,
SHA1: managedAuthHash,
},
}
}
switch secretType {
case lokiv1.ObjectStorageSecretAzure:
storageOpts.Azure, err = extractAzureConfigSecret(objStore, fg)
case lokiv1.ObjectStorageSecretGCS:
storageOpts.GCS, err = extractGCSConfigSecret(objStore)
case lokiv1.ObjectStorageSecretS3:
storageOpts.S3, err = extractS3ConfigSecret(objStore, fg)
case lokiv1.ObjectStorageSecretSwift:
storageOpts.Swift, err = extractSwiftConfigSecret(objStore)
case lokiv1.ObjectStorageSecretAlibabaCloud:
storageOpts.AlibabaCloud, err = extractAlibabaCloudConfigSecret(objStore)
default:
return storage.Options{}, fmt.Errorf("%w: %s", errSecretUnknownType, secretType)
}
if err != nil {
return storage.Options{}, err
}
return storageOpts, nil
}
func hashSecretData(s *corev1.Secret) (string, error) {
keys := make([]string, 0, len(s.Data))
for k := range s.Data {
keys = append(keys, k)
}
sort.Strings(keys)
h := sha1.New()
for _, k := range keys {
if _, err := h.Write([]byte(k)); err != nil {
return "", err
}
if _, err := h.Write(hashSeparator); err != nil {
return "", err
}
if _, err := h.Write(s.Data[k]); err != nil {
return "", err
}
if _, err := h.Write(hashSeparator); err != nil {
return "", err
}
}
return fmt.Sprintf("%x", h.Sum(nil)), nil
}
func extractAzureConfigSecret(s *corev1.Secret, fg configv1.FeatureGates) (*storage.AzureStorageConfig, error) {
// Extract and validate mandatory fields
env := s.Data[storage.KeyAzureEnvironmentName]
if len(env) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAzureEnvironmentName)
}
accountName := s.Data[storage.KeyAzureStorageAccountName]
if len(accountName) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAzureStorageAccountName)
}
container := s.Data[storage.KeyAzureStorageContainerName]
if len(container) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAzureStorageContainerName)
}
workloadIdentity, err := validateAzureCredentials(s, fg)
if err != nil {
return nil, err
}
// Extract and validate optional fields
endpointSuffix := s.Data[storage.KeyAzureStorageEndpointSuffix]
audience := s.Data[storage.KeyAzureAudience]
if !workloadIdentity && len(audience) > 0 {
return nil, fmt.Errorf("%w: %s", errSecretFieldNotAllowed, storage.KeyAzureAudience)
}
return &storage.AzureStorageConfig{
Env: string(env),
Container: string(container),
EndpointSuffix: string(endpointSuffix),
Audience: string(audience),
WorkloadIdentity: workloadIdentity,
}, nil
}
func validateAzureCredentials(s *corev1.Secret, fg configv1.FeatureGates) (workloadIdentity bool, err error) {
accountKey := s.Data[storage.KeyAzureStorageAccountKey]
clientID := s.Data[storage.KeyAzureStorageClientID]
tenantID := s.Data[storage.KeyAzureStorageTenantID]
subscriptionID := s.Data[storage.KeyAzureStorageSubscriptionID]
if fg.OpenShift.ManagedAuthEnv {
if len(accountKey) > 0 || len(clientID) > 0 || len(tenantID) > 0 || len(subscriptionID) > 0 {
return false, errAzureManagedIdentityNoOverride
}
return true, nil
}
if len(accountKey) == 0 && len(clientID) == 0 {
return false, errAzureNoCredentials
}
if len(accountKey) > 0 && len(clientID) > 0 {
return false, errAzureMixedCredentials
}
if len(accountKey) > 0 {
// have both account_name and account_key -> no workload identity federation
return false, nil
}
// assume workload-identity from here on
if len(tenantID) == 0 {
return false, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAzureStorageTenantID)
}
if len(subscriptionID) == 0 {
return false, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAzureStorageSubscriptionID)
}
return true, nil
}
func extractGCSConfigSecret(s *corev1.Secret) (*storage.GCSStorageConfig, error) {
// Extract and validate mandatory fields
bucket := s.Data[storage.KeyGCPStorageBucketName]
if len(bucket) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyGCPStorageBucketName)
}
// Check if google authentication credentials is provided
keyJSON := s.Data[storage.KeyGCPServiceAccountKeyFilename]
if len(keyJSON) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyGCPServiceAccountKeyFilename)
}
credentialsFile := struct {
CredentialsType string `json:"type"`
CredentialsSource struct {
File string `json:"file"`
} `json:"credential_source"`
}{}
err := json.Unmarshal(keyJSON, &credentialsFile)
if err != nil {
return nil, errGCPParseCredentialsFile
}
var (
audience = s.Data[storage.KeyGCPWorkloadIdentityProviderAudience]
isWorkloadIdentity = credentialsFile.CredentialsType == gcpAccountTypeExternal
)
if isWorkloadIdentity {
if len(audience) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyGCPWorkloadIdentityProviderAudience)
}
if credentialsFile.CredentialsSource.File != storage.ServiceAccountTokenFilePath {
return nil, fmt.Errorf("%w: %s", errGCPWrongCredentialSourceFile, storage.ServiceAccountTokenFilePath)
}
}
return &storage.GCSStorageConfig{
Bucket: string(bucket),
WorkloadIdentity: isWorkloadIdentity,
Audience: string(audience),
}, nil
}
func extractS3ConfigSecret(s *corev1.Secret, fg configv1.FeatureGates) (*storage.S3StorageConfig, error) {
// Extract and validate mandatory fields
buckets := s.Data[storage.KeyAWSBucketNames]
if len(buckets) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSBucketNames)
}
var (
// Fields related with static authentication
endpoint = s.Data[storage.KeyAWSEndpoint]
id = s.Data[storage.KeyAWSAccessKeyID]
secret = s.Data[storage.KeyAWSAccessKeySecret]
// Fields related with STS authentication
roleArn = s.Data[storage.KeyAWSRoleArn]
audience = s.Data[storage.KeyAWSAudience]
// Optional fields
region = s.Data[storage.KeyAWSRegion]
)
sseCfg, err := extractS3SSEConfig(s.Data)
if err != nil {
return nil, err
}
cfg := &storage.S3StorageConfig{
Buckets: string(buckets),
Region: string(region),
SSE: sseCfg,
}
var (
isManagedAuthEnv = len(roleArn) != 0
isStaticAuthEnv = !isManagedAuthEnv
)
switch {
case fg.OpenShift.ManagedAuthEnv:
cfg.STS = true
cfg.Audience = string(audience)
// Do not allow users overriding the role arn provided on Loki Operator installation
if len(roleArn) != 0 {
return nil, fmt.Errorf("%w: %s", errSecretFieldNotAllowed, storage.KeyAWSRoleArn)
}
// In the STS case region is not an optional field
if len(region) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSRegion)
}
return cfg, nil
case isStaticAuthEnv:
cfg.Endpoint = string(endpoint)
if len(endpoint) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSEndpoint)
}
if len(id) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSAccessKeyID)
}
if len(secret) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSAccessKeySecret)
}
return cfg, nil
case isManagedAuthEnv: // Extract STS from user provided values
cfg.STS = true
cfg.Audience = string(audience)
// In the STS case region is not an optional field
if len(region) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSRegion)
}
return cfg, nil
default:
return nil, errS3NoAuth
}
}
func extractS3SSEConfig(d map[string][]byte) (storage.S3SSEConfig, error) {
var (
sseType storage.S3SSEType
kmsKeyId, kmsEncryptionCtx string
)
switch sseType = storage.S3SSEType(d[storage.KeyAWSSSEType]); sseType {
case storage.SSEKMSType:
kmsEncryptionCtx = string(d[storage.KeyAWSSseKmsEncryptionContext])
kmsKeyId = string(d[storage.KeyAWSSseKmsKeyID])
if kmsKeyId == "" {
return storage.S3SSEConfig{}, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAWSSseKmsKeyID)
}
case storage.SSES3Type:
case "":
return storage.S3SSEConfig{}, nil
default:
return storage.S3SSEConfig{}, fmt.Errorf("%w: %s", errSecretUnknownSSEType, sseType)
}
return storage.S3SSEConfig{
Type: sseType,
KMSKeyID: kmsKeyId,
KMSEncryptionContext: kmsEncryptionCtx,
}, nil
}
func extractSwiftConfigSecret(s *corev1.Secret) (*storage.SwiftStorageConfig, error) {
// Extract and validate mandatory fields
url := s.Data[storage.KeySwiftAuthURL]
if len(url) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftAuthURL)
}
username := s.Data[storage.KeySwiftUsername]
if len(username) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftUsername)
}
userDomainName := s.Data[storage.KeySwiftUserDomainName]
if len(userDomainName) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftUserDomainName)
}
userDomainID := s.Data[storage.KeySwiftUserDomainID]
if len(userDomainID) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftUserDomainID)
}
userID := s.Data[storage.KeySwiftUserID]
if len(userID) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftUserID)
}
password := s.Data[storage.KeySwiftPassword]
if len(password) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftPassword)
}
domainID := s.Data[storage.KeySwiftDomainID]
if len(domainID) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftDomainID)
}
domainName := s.Data[storage.KeySwiftDomainName]
if len(domainName) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftDomainName)
}
containerName := s.Data[storage.KeySwiftContainerName]
if len(containerName) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeySwiftContainerName)
}
// Extract and validate optional fields
projectID := s.Data[storage.KeySwiftProjectID]
projectName := s.Data[storage.KeySwiftProjectName]
projectDomainID := s.Data[storage.KeySwiftProjectDomainId]
projectDomainName := s.Data[storage.KeySwiftProjectDomainName]
region := s.Data[storage.KeySwiftRegion]
return &storage.SwiftStorageConfig{
AuthURL: string(url),
UserDomainName: string(userDomainName),
UserDomainID: string(userDomainID),
UserID: string(userID),
DomainID: string(domainID),
DomainName: string(domainName),
ProjectID: string(projectID),
ProjectName: string(projectName),
ProjectDomainID: string(projectDomainID),
ProjectDomainName: string(projectDomainName),
Region: string(region),
Container: string(containerName),
}, nil
}
func extractAlibabaCloudConfigSecret(s *corev1.Secret) (*storage.AlibabaCloudStorageConfig, error) {
// Extract and validate mandatory fields
endpoint := s.Data[storage.KeyAlibabaCloudEndpoint]
if len(endpoint) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAlibabaCloudEndpoint)
}
bucket := s.Data[storage.KeyAlibabaCloudBucket]
if len(bucket) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAlibabaCloudBucket)
}
id := s.Data[storage.KeyAlibabaCloudAccessKeyID]
if len(id) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAlibabaCloudAccessKeyID)
}
secret := s.Data[storage.KeyAlibabaCloudSecretAccessKey]
if len(secret) == 0 {
return nil, fmt.Errorf("%w: %s", errSecretMissingField, storage.KeyAlibabaCloudSecretAccessKey)
}
return &storage.AlibabaCloudStorageConfig{
Endpoint: string(endpoint),
Bucket: string(bucket),
}, nil
}