This repository has been archived by the owner on Oct 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
quarkssecret_reconciler.go
905 lines (785 loc) · 30.9 KB
/
quarkssecret_reconciler.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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
package quarkssecret
import (
"context"
"encoding/base64"
"fmt"
"strconv"
"time"
"github.com/pkg/errors"
certv1 "k8s.io/api/certificates/v1beta1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"code.cloudfoundry.org/quarks-secret/pkg/credsgen"
qsv1a1 "code.cloudfoundry.org/quarks-secret/pkg/kube/apis/quarkssecret/v1alpha1"
"code.cloudfoundry.org/quarks-secret/pkg/kube/util/mutate"
"code.cloudfoundry.org/quarks-utils/pkg/config"
"code.cloudfoundry.org/quarks-utils/pkg/ctxlog"
"code.cloudfoundry.org/quarks-utils/pkg/meltdown"
"code.cloudfoundry.org/quarks-utils/pkg/names"
"code.cloudfoundry.org/quarks-utils/pkg/pointers"
)
type setReferenceFunc func(owner, object metav1.Object, scheme *runtime.Scheme) error
// NewQuarksSecretReconciler returns a new ReconcileQuarksSecret
func NewQuarksSecretReconciler(ctx context.Context, config *config.Config, mgr manager.Manager, generator credsgen.Generator, srf setReferenceFunc) reconcile.Reconciler {
return &ReconcileQuarksSecret{
ctx: ctx,
config: config,
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
generator: generator,
setReference: srf,
}
}
// ReconcileQuarksSecret reconciles an QuarksSecret object
type ReconcileQuarksSecret struct {
ctx context.Context
client client.Client
generator credsgen.Generator
scheme *runtime.Scheme
setReference setReferenceFunc
config *config.Config
}
type caNotReadyError struct {
message string
}
func newCaNotReadyError(message string) *caNotReadyError {
return &caNotReadyError{message: message}
}
// Error returns the error message
func (e *caNotReadyError) Error() string {
return e.message
}
func isCaNotReady(o interface{}) bool {
err := o.(error)
err = errors.Cause(err)
_, ok := err.(*caNotReadyError)
return ok
}
type secNotReadyError struct {
message string
}
func newSecNotReadyError(message string) *secNotReadyError {
return &secNotReadyError{message: message}
}
// Error returns the error message
func (e *secNotReadyError) Error() string {
return e.message
}
func isSecNotReady(o interface{}) bool {
err := o.(error)
err = errors.Cause(err)
_, ok := err.(*secNotReadyError)
return ok
}
// Reconcile reads that state of the cluster for a QuarksSecret object and makes changes based on the state read
// and what is in the QuarksSecret.Spec
// Note:
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (r *ReconcileQuarksSecret) Reconcile(request reconcile.Request) (reconcile.Result, error) {
qsec := &qsv1a1.QuarksSecret{}
// Set the ctx to be Background, as the top-level context for incoming requests.
ctx, cancel := context.WithTimeout(r.ctx, r.config.CtxTimeOut)
defer cancel()
ctxlog.Infof(ctx, "Reconciling QuarksSecret %s", request.NamespacedName)
err := r.client.Get(ctx, request.NamespacedName, qsec)
if err != nil {
if apierrors.IsNotFound(err) {
// Request object not found, could have been deleted after reconcile request.
// Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
// Return and don't requeue
ctxlog.Info(ctx, "Skip reconcile: quarks secret not found")
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
ctxlog.Info(ctx, "Error reading the object")
return reconcile.Result{}, errors.Wrap(err, "Error reading quarksSecret")
}
if meltdown.NewWindow(r.config.MeltdownDuration, qsec.Status.LastReconcile).Contains(time.Now()) {
ctxlog.WithEvent(qsec, "Meltdown").Debugf(ctx, "Resource '%s' is in meltdown, requeue reconcile after %s", qsec.GetNamespacedName(), r.config.MeltdownRequeueAfter)
return reconcile.Result{RequeueAfter: r.config.MeltdownRequeueAfter}, nil
}
// Create secret
switch qsec.Spec.Type {
case qsv1a1.Password:
ctxlog.Info(ctx, "Generating password")
err = r.createPasswordSecret(ctx, qsec)
if err != nil {
ctxlog.Infof(ctx, "Error generating password secret: %s", err.Error())
return reconcile.Result{}, errors.Wrap(err, "generating password secret failed.")
}
case qsv1a1.RSAKey:
ctxlog.Info(ctx, "Generating RSA Key")
err = r.createRSASecret(ctx, qsec)
if err != nil {
ctxlog.Infof(ctx, "Error generating RSA key secret: %s", err.Error())
return reconcile.Result{}, errors.Wrap(err, "generating RSA key secret failed.")
}
case qsv1a1.SSHKey:
ctxlog.Info(ctx, "Generating SSH Key")
err = r.createSSHSecret(ctx, qsec)
if err != nil {
ctxlog.Infof(ctx, "Error generating SSH key secret: %s", err.Error())
return reconcile.Result{}, errors.Wrap(err, "generating SSH key secret failed.")
}
case qsv1a1.Certificate:
ctxlog.Info(ctx, "Generating certificate")
err = r.createCertificateSecret(ctx, qsec)
if err != nil {
if isCaNotReady(err) {
ctxlog.Info(ctx, fmt.Sprintf("CA for secret '%s' is not ready yet: %s", request.NamespacedName, err))
return reconcile.Result{RequeueAfter: time.Second * 5}, nil
}
ctxlog.Info(ctx, "Error generating certificate secret: "+err.Error())
return reconcile.Result{}, errors.Wrap(err, "generating certificate secret.")
}
case qsv1a1.BasicAuth:
err = r.createBasicAuthSecret(ctx, qsec)
if err != nil {
return reconcile.Result{}, errors.Wrap(err, "generating basic-auth secret")
}
case qsv1a1.SecretCopy:
// noop
return reconcile.Result{}, nil
case qsv1a1.DockerConfigJSON:
ctxlog.Info(ctx, "Generating dockerConfigJson")
err = r.createDockerConfigJSON(ctx, qsec)
if err != nil {
if isSecNotReady(err) {
ctxlog.Info(ctx, fmt.Sprintf("Secrets '%s' is not ready yet: %s", request.NamespacedName, err))
return reconcile.Result{RequeueAfter: time.Second * 5}, nil
}
ctxlog.Info(ctx, "Error generating dockerConfigJson secret: "+err.Error())
return reconcile.Result{}, errors.Wrap(err, "generating dockerConfigJson secret.")
}
default:
err = ctxlog.WithEvent(qsec, "InvalidTypeError").Errorf(ctx, "Invalid type: %s", qsec.Spec.Type)
return reconcile.Result{}, err
}
r.updateStatus(ctx, qsec)
return reconcile.Result{}, nil
}
func (r *ReconcileQuarksSecret) updateStatus(ctx context.Context, qsec *qsv1a1.QuarksSecret) {
qsec.Status.Generated = pointers.Bool(true)
now := metav1.Now()
qsec.Status.LastReconcile = &now
err := r.client.Status().Update(ctx, qsec)
if err != nil {
ctxlog.Errorf(ctx, "could not create or update QuarksSecret status '%s': %v", qsec.GetNamespacedName(), err)
}
}
func (r *ReconcileQuarksSecret) createPasswordSecret(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
request := credsgen.PasswordGenerationRequest{}
password := r.generator.GeneratePassword(qsec.GetName(), request)
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
Labels: qsec.Spec.SecretLabels,
Annotations: qsec.Spec.SecretAnnotations,
},
StringData: map[string]string{
"password": password,
},
}
return r.createSecrets(ctx, qsec, secret)
}
func (r *ReconcileQuarksSecret) createRSASecret(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
key, err := r.generator.GenerateRSAKey(qsec.GetName())
if err != nil {
return err
}
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
Labels: qsec.Spec.SecretLabels,
Annotations: qsec.Spec.SecretAnnotations,
},
StringData: map[string]string{
"private_key": string(key.PrivateKey),
"public_key": string(key.PublicKey),
},
}
return r.createSecrets(ctx, qsec, secret)
}
func (r *ReconcileQuarksSecret) createSSHSecret(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
key, err := r.generator.GenerateSSHKey(qsec.GetName())
if err != nil {
return err
}
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
Labels: qsec.Spec.SecretLabels,
Annotations: qsec.Spec.SecretAnnotations,
},
StringData: map[string]string{
"private_key": string(key.PrivateKey),
"public_key": string(key.PublicKey),
"public_key_fingerprint": key.Fingerprint,
},
}
return r.createSecrets(ctx, qsec, secret)
}
func (r *ReconcileQuarksSecret) createCertificateSecret(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
serviceIPForEKSWorkaround := ""
for _, serviceRef := range qsec.Spec.Request.CertificateRequest.ServiceRef {
service := &corev1.Service{}
err := r.client.Get(ctx, types.NamespacedName{Namespace: qsec.Namespace, Name: serviceRef.Name}, service)
if err != nil {
return errors.Wrapf(err, "Failed to get service reference '%s' for QuarksSecret '%s'", serviceRef.Name, qsec.GetNamespacedName())
}
if serviceIPForEKSWorkaround == "" {
serviceIPForEKSWorkaround = service.Spec.ClusterIP
}
qsec.Spec.Request.CertificateRequest.AlternativeNames = append(append(
qsec.Spec.Request.CertificateRequest.AlternativeNames,
service.Name,
service.Name+"."+service.Namespace,
"*."+service.Name,
"*."+service.Name+"."+service.Namespace,
service.Spec.ClusterIP,
service.Spec.LoadBalancerIP,
service.Spec.ExternalName,
), service.Spec.ExternalIPs...)
}
if len(qsec.Spec.Request.CertificateRequest.SignerType) == 0 {
qsec.Spec.Request.CertificateRequest.SignerType = qsv1a1.LocalSigner
}
generationRequest, err := r.generateCertificateGenerationRequest(ctx, qsec.Namespace, qsec.Spec.Request.CertificateRequest)
if err != nil {
return errors.Wrap(err, "generating certificate generation request")
}
switch qsec.Spec.Request.CertificateRequest.SignerType {
case qsv1a1.ClusterSigner:
if qsec.Spec.Request.CertificateRequest.ActivateEKSWorkaroundForSAN {
if serviceIPForEKSWorkaround == "" {
return errors.Errorf("can't activate EKS workaround for QuarksSecret '%s'; couldn't find a ClusterIP for any service reference", qsec.GetNamespacedName())
}
ctxlog.Infof(ctx, "Activating EKS workaround for QuarksSecret '%s'. Using IP '%s' as a common name. See 'https://github.com/awslabs/amazon-eks-ami/issues/341' for more details.", qsec.GetNamespacedName(), serviceIPForEKSWorkaround)
generationRequest.CommonName = serviceIPForEKSWorkaround
}
ctxlog.Info(ctx, "Generating certificate signing request and its key")
csr, key, err := r.generator.GenerateCertificateSigningRequest(generationRequest)
if err != nil {
return err
}
// private key Secret which will be merged to certificate Secret later
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: names.CsrPrivateKeySecretName(names.CSRName(qsec.Namespace, qsec.Name)),
Namespace: qsec.GetNamespace(),
Labels: qsec.Spec.SecretLabels,
Annotations: qsec.Spec.SecretAnnotations,
},
StringData: map[string]string{
"private_key": string(key),
"is_ca": strconv.FormatBool(qsec.Spec.Request.CertificateRequest.IsCA),
},
}
err = r.createSecrets(ctx, qsec, secret)
if err != nil {
return err
}
return r.createCertificateSigningRequest(ctx, qsec, csr)
case qsv1a1.LocalSigner:
// Generate certificate
cert, err := r.generator.GenerateCertificate(qsec.GetName(), generationRequest)
if err != nil {
return err
}
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
Labels: qsec.Spec.SecretLabels,
Annotations: qsec.Spec.SecretAnnotations,
},
StringData: map[string]string{
"certificate": string(cert.Certificate),
"private_key": string(cert.PrivateKey),
"is_ca": strconv.FormatBool(qsec.Spec.Request.CertificateRequest.IsCA),
},
}
if len(generationRequest.CA.Certificate) > 0 {
secret.StringData["ca"] = string(generationRequest.CA.Certificate)
}
return r.createSecrets(ctx, qsec, secret)
default:
return fmt.Errorf("unrecognized signer type: %s", qsec.Spec.Request.CertificateRequest.SignerType)
}
}
func (r *ReconcileQuarksSecret) createBasicAuthSecret(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
username := qsec.Spec.Request.BasicAuthRequest.Username
if username == "" {
username = r.generator.GeneratePassword(fmt.Sprintf("%s/username", qsec.Name), credsgen.PasswordGenerationRequest{})
}
password := r.generator.GeneratePassword(fmt.Sprintf("%s/password", qsec.Name), credsgen.PasswordGenerationRequest{})
secret := &corev1.Secret{
Type: corev1.SecretTypeBasicAuth,
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
},
StringData: map[string]string{
"username": username,
"password": password,
},
}
return r.createSecrets(ctx, qsec, secret)
}
func (r *ReconcileQuarksSecret) createDockerConfigJSON(ctx context.Context, qsec *qsv1a1.QuarksSecret) error {
// Fetch username and password.
username := ""
if len(qsec.Spec.Request.ImageCredentialsRequest.Username.Name) > 0 {
userSecret := &corev1.Secret{}
userNamespacedName := types.NamespacedName{
Namespace: qsec.Namespace,
Name: qsec.Spec.Request.ImageCredentialsRequest.Username.Name,
}
err := r.client.Get(ctx, userNamespacedName, userSecret)
if err != nil {
if apierrors.IsNotFound(err) {
return newSecNotReadyError("username secret not found")
}
return errors.Wrap(err, "getting username secret")
}
data, ok := userSecret.Data[qsec.Spec.Request.ImageCredentialsRequest.Username.Key]
if !ok {
return errors.Errorf("Failed to get username data by key: %s", qsec.Spec.Request.ImageCredentialsRequest.Username.Key)
}
username = string(data)
}
if username == "" {
username = r.generator.GeneratePassword(fmt.Sprintf("%s/username", qsec.Name), credsgen.PasswordGenerationRequest{})
}
password := ""
if len(qsec.Spec.Request.ImageCredentialsRequest.Password.Name) > 0 {
passSecret := &corev1.Secret{}
passNamespacedName := types.NamespacedName{
Namespace: qsec.Namespace,
Name: qsec.Spec.Request.ImageCredentialsRequest.Password.Name,
}
err := r.client.Get(ctx, passNamespacedName, passSecret)
if err != nil {
if apierrors.IsNotFound(err) {
return newSecNotReadyError("password secret not found")
}
return errors.Wrap(err, "getting password secret")
}
data, ok := passSecret.Data[qsec.Spec.Request.ImageCredentialsRequest.Password.Key]
if !ok {
return errors.Errorf("Failed to get password data key: %s", qsec.Spec.Request.ImageCredentialsRequest.Password.Key)
}
password = string(data)
}
if password == "" {
password = r.generator.GeneratePassword(fmt.Sprintf("%s/password", qsec.Name), credsgen.PasswordGenerationRequest{})
}
authEncode := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", username, password)))
dockerConfigJSONData := fmt.Sprintf("{\"auths\":{\"%s\":{\"username\":\"%s\",\"password\":\"%s\",\"email\":\"%s\",\"auth\":\"%s\"}}}",
qsec.Spec.Request.ImageCredentialsRequest.Registry,
username,
password,
qsec.Spec.Request.ImageCredentialsRequest.Email,
authEncode,
)
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: qsec.Spec.SecretName,
Namespace: qsec.GetNamespace(),
},
Type: corev1.SecretTypeDockerConfigJson,
StringData: map[string]string{
corev1.DockerConfigJsonKey: dockerConfigJSONData,
},
}
return r.createSecrets(ctx, qsec, secret)
}
// Skip creation when
// * secret is already generated according to qsecs status field
// * secret exists, but was not generated (user created secret)
func (r *ReconcileQuarksSecret) skipCreation(ctx context.Context, qsec *qsv1a1.QuarksSecret) (bool, *corev1.Secret, error) {
if qsec.Status.Generated != nil && *qsec.Status.Generated {
ctxlog.Debugf(ctx, "Existing secret %s/%s has already been generated",
qsec.Namespace,
qsec.Spec.SecretName,
)
return true, nil, nil
}
secretName := qsec.Spec.SecretName
existingSecret := &corev1.Secret{}
err := r.client.Get(ctx, types.NamespacedName{Name: secretName, Namespace: qsec.GetNamespace()}, existingSecret)
if err != nil {
if apierrors.IsNotFound(err) {
return false, nil, nil
}
return false, nil, errors.Wrapf(err, "could not get secret")
}
secretLabels := existingSecret.GetLabels()
if secretLabels == nil {
secretLabels = map[string]string{}
}
// skip if the secret was not created by the operator
if secretLabels[qsv1a1.LabelKind] != qsv1a1.GeneratedSecretKind {
ctxlog.Debugf(ctx, "Existing secret %s/%s doesn't have a label %s=%s",
existingSecret.GetNamespace(),
existingSecret.GetName(),
qsv1a1.LabelKind,
qsv1a1.GeneratedSecretKind,
)
return true, existingSecret, nil
}
return false, nil, nil
}
// Skip copy creation when
// * secret and qsecret (copy type) doesn't exist
// * (q)secret exists, but it's not marked as generated (label) and a copy (annotation)
func (r *ReconcileQuarksSecret) skipCopy(ctx context.Context, qsec *qsv1a1.QuarksSecret, sourceQsec *qsv1a1.QuarksSecret, userCreatedSecret bool) (bool, bool, *unstructured.Unstructured, error) {
copyOf := sourceQsec.GetNamespacedName()
if qsec.Status.Generated != nil && *qsec.Status.Generated {
ctxlog.Debugf(ctx, "Existing secret %s/%s has already been generated",
qsec.Namespace,
qsec.Spec.SecretName,
)
return true, false, nil, nil
}
secretName := qsec.Spec.SecretName
notFoundQsec := false
notFoundSec := false
// We use an unstructured object so we don't hit the _namespaced_ cache
// since our object could live in another namespace
existingSecret := &unstructured.Unstructured{}
existingSecret.SetGroupVersionKind(schema.GroupVersionKind{
Group: "",
Kind: "Secret",
Version: "v1",
})
// We want to create the secret if a qsec is present, or update a secret if the secret is already there (with the correct annotation)
existingQSec := &qsv1a1.QuarksSecret{}
err := r.client.Get(ctx, types.NamespacedName{Name: qsec.Name, Namespace: qsec.GetNamespace()}, existingQSec)
if err != nil {
if apierrors.IsNotFound(err) {
notFoundQsec = true
} else {
return false, false, nil, errors.Wrapf(err, "could not get qsecret")
}
}
err = r.client.Get(ctx, types.NamespacedName{Name: secretName, Namespace: qsec.GetNamespace()}, existingSecret)
if err != nil {
if apierrors.IsNotFound(err) {
notFoundSec = true
} else {
return false, false, nil, errors.Wrapf(err, "could not get secret")
}
}
// If both are absent, we will skip the copy
if notFoundSec && notFoundQsec {
ctxlog.WithEvent(sourceQsec, "SkipCreation").Infof(ctx, "No Valid QSecret or Secret found")
return true, false, nil, nil
}
needsCreation := true
// If both of them are false, give preference to qsec
if !notFoundSec && !notFoundQsec {
ctxlog.WithEvent(sourceQsec, "SkipCreation").Infof(ctx, "Both QSecret & Secret found. Giving preference to QSecret")
notFoundSec = true
needsCreation = false
}
if notFoundSec {
// Validate QSecret
ctxlog.WithEvent(sourceQsec, "SkipCreation").Infof(ctx, "Valid QSecret found")
secretLabels := existingQSec.GetLabels()
if secretLabels == nil {
secretLabels = map[string]string{}
}
secretAnnotations := existingQSec.GetAnnotations()
if secretAnnotations == nil {
secretAnnotations = map[string]string{}
}
if existingQSec.Spec.Type != qsv1a1.SecretCopy {
ctxlog.WithEvent(sourceQsec, "SkipCreation").Infof(ctx, "Invalid type for QSecret. It must be 'copy' type.")
return true, false, nil, nil
}
return !validateCopySecret(ctx, sourceQsec, secretLabels, secretAnnotations, copyOf, userCreatedSecret), needsCreation, nil, nil
} else if notFoundQsec {
// Validate Secret
secretLabels := existingSecret.GetLabels()
if secretLabels == nil {
secretLabels = map[string]string{}
}
secretAnnotations := existingSecret.GetAnnotations()
if secretAnnotations == nil {
secretAnnotations = map[string]string{}
}
return !validateCopySecret(ctx, sourceQsec, secretLabels, secretAnnotations, copyOf, userCreatedSecret), false, existingSecret, nil
}
return true, false, nil, nil
}
func validateCopySecret(ctx context.Context, qsec *qsv1a1.QuarksSecret, secretLabels, secretAnnotations map[string]string, copyOf string, userCreatedSecret bool) bool {
valid := true
// check if the secret is marked as generated
if secretLabels[qsv1a1.LabelKind] != qsv1a1.GeneratedSecretKind && !userCreatedSecret {
ctxlog.WithEvent(qsec, "SkipCopyCreation").Infof(ctx, "Secret doesn't have generated label")
valid = false
}
// skip if this is a copy, and we're missing a copy-of label
if secretAnnotations[qsv1a1.AnnotationCopyOf] != copyOf {
ctxlog.WithEvent(qsec, "SkipCopyCreation").Infof(ctx, "Secret doesn't have the corresponding annotation %s vs %s", secretAnnotations[qsv1a1.AnnotationCopyOf], copyOf)
valid = false
}
return valid
}
func (r *ReconcileQuarksSecret) createSecrets(ctx context.Context, qsec *qsv1a1.QuarksSecret, secret *corev1.Secret) error {
// Create the main secret
// Check if allowed to generate secret, could be already done or
// created manually by a user
userCreatedSecret := false
skipCreation, existingSecret, err := r.skipCreation(ctx, qsec)
if err != nil {
ctxlog.Errorf(ctx, "Error reading the secret: %v", err.Error())
}
if skipCreation {
ctxlog.WithEvent(qsec, "SkipCreation").Infof(ctx, "Skip creation: Secret '%s/%s' already exists and it's not generated", qsec.Namespace, qsec.Spec.SecretName)
secret = existingSecret
// Add user created annotation
if secret != nil {
if secret.Annotations == nil {
secret.Annotations = map[string]string{}
}
secret.Annotations[qsv1a1.AnnotationUserCreatedSecret] = "true"
userCreatedSecret = true
}
} else {
if err := r.createSecret(ctx, qsec, secret); err != nil {
return err
}
}
for _, copy := range qsec.Spec.Copies {
copiedQSec := qsec.DeepCopy()
copiedQSec.Spec.SecretName = copy.Name
copiedQSec.Namespace = copy.Namespace
copiedSecret := &corev1.Secret{}
// We look and see if the secret is of the generated type
// And also check if we're allowed to create the resource in the target namespace
// We require an existing secret or qsecret with a label already be present in the target namespace
skip, needsCreation, existingSecretCopyNamespace, err := r.skipCopy(ctx, copiedQSec, qsec, userCreatedSecret)
if err != nil {
ctxlog.Errorf(ctx, "Error reading the secret: %v", err.Error())
}
if existingSecretCopyNamespace != nil {
if secret.Annotations == nil {
secret.Annotations = map[string]string{}
}
if secret.Labels == nil {
secret.Labels = map[string]string{}
}
for k, v := range existingSecretCopyNamespace.GetAnnotations() {
secret.Annotations[k] = v
}
for k, v := range existingSecretCopyNamespace.GetLabels() {
secret.Labels[k] = v
}
}
copiedSecret.Name = copy.Name
copiedSecret.Namespace = copy.Namespace
copiedSecret.Data = secret.Data
copiedSecret.Annotations = secret.Annotations
copiedSecret.Labels = secret.Labels
if skip {
ctxlog.WithEvent(qsec, "SkipCreation").Infof(ctx, "Skip copy creation: Secret/QSecret '%s' must exist and have the appropriate labels and annotations to receive a copy", copy.String())
} else if needsCreation {
if err := r.createCopySecret(ctx, copiedQSec, copiedSecret, qsec.GetNamespacedName(), userCreatedSecret); err != nil {
return err
}
ctxlog.WithEvent(qsec, "SkipCreation").Infof(ctx, "Copy secret '%s' has been created in namespace '%s'", copy.Name, copy.Namespace)
} else {
ctxlog.Infof(ctx, "%v", copiedSecret.Data)
if err := r.updateCopySecret(ctx, qsec, copiedSecret); err != nil {
return err
}
ctxlog.WithEvent(qsec, "SkipCreation").Infof(ctx, "Copy secret '%s' has been updated in namespace '%s'", copy.Name, copy.Namespace)
}
}
return nil
}
// createCopySecret applies common properties(labels and ownerReferences) to the secret and creates it
func (r *ReconcileQuarksSecret) createCopySecret(ctx context.Context, qsec *qsv1a1.QuarksSecret, secret *corev1.Secret, copyOf string, userCreatedSecret bool) error {
ctxlog.Debugf(ctx, "Creating secret '%s/%s', owned by quarks secret '%s'", secret.Namespace, secret.Name, qsec.GetNamespacedName())
secretLabels := secret.GetLabels()
if secretLabels == nil {
secretLabels = map[string]string{}
}
secretAnnotations := secret.GetAnnotations()
if secretAnnotations == nil {
secretAnnotations = map[string]string{}
}
if !userCreatedSecret {
secretLabels[qsv1a1.LabelKind] = qsv1a1.GeneratedSecretKind
}
secretAnnotations[qsv1a1.AnnotationCopyOf] = copyOf
secret.SetLabels(secretLabels)
secret.SetAnnotations(secretAnnotations)
if err := r.setReference(qsec, secret, r.scheme); err != nil {
return errors.Wrapf(err, "error setting owner for secret '%s' to QuarksSecret '%s'", secret.GetName(), qsec.GetNamespacedName())
}
op, err := controllerutil.CreateOrUpdate(ctx, r.client, secret, mutate.SecretMutateFn(secret))
if err != nil {
return errors.Wrapf(err, "could not create or update secret '%s/%s'", secret.Namespace, secret.GetName())
}
if op != "unchanged" {
ctxlog.Debugf(ctx, "Secret '%s' has been %s", secret.Name, op)
}
return nil
}
// createSecret applies common properties(labels and ownerReferences) to the secret and creates it
func (r *ReconcileQuarksSecret) createSecret(ctx context.Context, qsec *qsv1a1.QuarksSecret, secret *corev1.Secret) error {
ctxlog.Debugf(ctx, "Creating secret '%s/%s', owned by quarks secret '%s'", secret.Namespace, secret.Name, qsec.GetNamespacedName())
secretLabels := secret.GetLabels()
if secretLabels == nil {
secretLabels = map[string]string{}
}
secretLabels[qsv1a1.LabelKind] = qsv1a1.GeneratedSecretKind
secret.SetLabels(secretLabels)
if err := r.setReference(qsec, secret, r.scheme); err != nil {
return errors.Wrapf(err, "error setting owner for secret '%s' to QuarksSecret '%s'", secret.GetName(), qsec.GetNamespacedName())
}
op, err := controllerutil.CreateOrUpdate(ctx, r.client, secret, mutate.SecretMutateFn(secret))
if err != nil {
return errors.Wrapf(err, "could not create or update secret '%s/%s'", secret.Namespace, secret.GetName())
}
if op != "unchanged" {
ctxlog.Debugf(ctx, "Secret '%s' has been %s", secret.Name, op)
}
return nil
}
// updateCopySecret updates a copied destination Secret
func (r *ReconcileQuarksSecret) updateCopySecret(ctx context.Context, qsec *qsv1a1.QuarksSecret, secret *corev1.Secret) error {
// If this is a copy (lives in a different namespace), we only do an update,
// since we're not allowed to create, and we don't set a reference, because
// cross namespace references are not supported
uncachedSecret := &unstructured.Unstructured{}
uncachedSecret.SetGroupVersionKind(schema.GroupVersionKind{
Group: "",
Kind: "Secret",
Version: "v1",
})
uncachedSecret.SetName(secret.Name)
uncachedSecret.SetNamespace(secret.Namespace)
uncachedSecret.SetLabels(secret.Labels)
uncachedSecret.SetAnnotations(secret.Annotations)
uncachedSecret.Object["data"] = secret.Data
err := r.client.Update(ctx, uncachedSecret)
if err != nil {
return errors.Wrapf(err, "could not update secret '%s/%s'", secret.Namespace, secret.GetName())
}
return nil
}
// generateCertificateGenerationRequest generates CertificateGenerationRequest for certificate
func (r *ReconcileQuarksSecret) generateCertificateGenerationRequest(ctx context.Context, namespace string, certificateRequest qsv1a1.CertificateRequest) (credsgen.CertificateGenerationRequest, error) {
var request credsgen.CertificateGenerationRequest
switch certificateRequest.SignerType {
case qsv1a1.ClusterSigner:
// Generate cluster-signed CA certificate
request = credsgen.CertificateGenerationRequest{
CommonName: certificateRequest.CommonName,
AlternativeNames: certificateRequest.AlternativeNames,
}
case qsv1a1.LocalSigner:
// Generate local-issued CA certificate
request = credsgen.CertificateGenerationRequest{
IsCA: certificateRequest.IsCA,
CommonName: certificateRequest.CommonName,
AlternativeNames: certificateRequest.AlternativeNames,
}
if len(certificateRequest.CARef.Name) > 0 {
// Get CA certificate
caSecret := &corev1.Secret{}
caNamespacedName := types.NamespacedName{
Namespace: namespace,
Name: certificateRequest.CARef.Name,
}
err := r.client.Get(ctx, caNamespacedName, caSecret)
if err != nil {
if apierrors.IsNotFound(err) {
return request, newCaNotReadyError("CA secret not found")
}
return request, errors.Wrap(err, "getting CA secret")
}
ca := caSecret.Data[certificateRequest.CARef.Key]
// Get CA key
if certificateRequest.CAKeyRef.Name != certificateRequest.CARef.Name {
caSecret = &corev1.Secret{}
caNamespacedName = types.NamespacedName{
Namespace: namespace,
Name: certificateRequest.CAKeyRef.Name,
}
err = r.client.Get(ctx, caNamespacedName, caSecret)
if err != nil {
if apierrors.IsNotFound(err) {
return request, newCaNotReadyError("CA key secret not found")
}
return request, errors.Wrap(err, "getting CA Key secret")
}
}
key := caSecret.Data[certificateRequest.CAKeyRef.Key]
request.CA = credsgen.Certificate{
IsCA: true,
PrivateKey: key,
Certificate: ca,
}
}
default:
return request, fmt.Errorf("unrecognized signer type: %s", certificateRequest.SignerType)
}
return request, nil
}
// createCertificateSigningRequest creates CertificateSigningRequest Object
func (r *ReconcileQuarksSecret) createCertificateSigningRequest(ctx context.Context, qsec *qsv1a1.QuarksSecret, csr []byte) error {
csrName := names.CSRName(qsec.Namespace, qsec.Name)
ctxlog.Debugf(ctx, "Creating certificatesigningrequest '%s'", csrName)
annotations := qsec.GetAnnotations()
if annotations == nil {
annotations = map[string]string{}
}
annotations[qsv1a1.AnnotationCertSecretName] = qsec.Spec.SecretName
annotations[qsv1a1.AnnotationQSecNamespace] = qsec.Namespace
annotations[qsv1a1.AnnotationQSecName] = qsec.Name
annotations[qsv1a1.AnnotationMonitoredID] = r.config.MonitoredID
csrObj := &certv1.CertificateSigningRequest{
ObjectMeta: metav1.ObjectMeta{
Name: csrName,
Labels: qsec.Labels,
Annotations: annotations,
},
Spec: certv1.CertificateSigningRequestSpec{
Request: csr,
Usages: qsec.Spec.Request.CertificateRequest.Usages,
},
}
oldCsrObj := &certv1.CertificateSigningRequest{}
// CSR spec is immutable after the request is created
err := r.client.Get(ctx, types.NamespacedName{Name: csrObj.Name}, oldCsrObj)
if err != nil {
if apierrors.IsNotFound(err) {
err = r.client.Create(ctx, csrObj)
if err != nil {
return errors.Wrapf(err, "could not create certificatesigningrequest '%s'", csrObj.Name)
}
return nil
}
return errors.Wrapf(err, "could not get certificatesigningrequest '%s'", csrObj.Name)
}
ctxlog.Infof(ctx, "Ignoring immutable CSR '%s'", csrObj.Name)
return nil
}