/
secret.go
240 lines (209 loc) · 8.71 KB
/
secret.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
/*
Copyright 2020 The cert-manager 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 secretsmanager
import (
"bytes"
"context"
"fmt"
"strings"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
corelisters "k8s.io/client-go/listers/core/v1"
apiutil "github.com/jetstack/cert-manager/pkg/api/util"
cmapi "github.com/jetstack/cert-manager/pkg/apis/certmanager/v1"
cmmeta "github.com/jetstack/cert-manager/pkg/apis/meta/v1"
utilpki "github.com/jetstack/cert-manager/pkg/util/pki"
)
var (
certificateGvk = cmapi.SchemeGroupVersion.WithKind("Certificate")
)
type SecretsManager struct {
kubeClient kubernetes.Interface
secretLister corelisters.SecretLister
// if true, Secret resources created by the controller will have an
// 'owner reference' set, meaning when the Certificate is deleted, the
// Secret resource will be automatically deleted.
// This option is disabled by default.
enableSecretOwnerReferences bool
}
// SecretData is a structure wrapping private key, Certificate and CA data
type SecretData struct {
PrivateKey, Certificate, CA []byte
}
func New(
kubeClient kubernetes.Interface,
secretLister corelisters.SecretLister,
enableSecretOwnerReferences bool,
) *SecretsManager {
return &SecretsManager{
kubeClient: kubeClient,
secretLister: secretLister,
enableSecretOwnerReferences: enableSecretOwnerReferences,
}
}
// UpdateData will ensure the Secret resource contains the given secret
// data as well as appropriate metadata.
// If the Secret resource does not exist, it will be created.
// Otherwise, the existing resource will be updated.
// The first return argument will be true if the resource was updated/created
// without error.
// UpdateData will also update deprecated annotations if they exist.
func (s *SecretsManager) UpdateData(ctx context.Context, crt *cmapi.Certificate, data SecretData) error {
// Fetch a copy of the existing Secret resource
secret, err := s.secretLister.Secrets(crt.Namespace).Get(crt.Spec.SecretName)
if !apierrors.IsNotFound(err) && err != nil {
// If secret doesn't exist yet, then don't error
return err
}
secretExists := (secret != nil)
// If the seret does not exist yet, then we need to create one
if !secretExists {
secret = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: crt.Spec.SecretName,
Namespace: crt.Namespace,
},
Type: corev1.SecretTypeTLS,
}
}
// secret will be overwritten by 'existingSecret' if existingSecret is non-nil
if s.enableSecretOwnerReferences {
secret.OwnerReferences = []metav1.OwnerReference{*metav1.NewControllerRef(crt, certificateGvk)}
}
err = s.setValues(crt, secret, data)
if err != nil {
return err
}
// If secret does not exist then create it
if !secretExists {
_, err = s.kubeClient.CoreV1().Secrets(secret.Namespace).Create(ctx, secret, metav1.CreateOptions{})
return err
}
// Currently we are always updating. We should devise a way to not have to call an update if it is not necessary.
_, err = s.kubeClient.CoreV1().Secrets(secret.Namespace).Update(ctx, secret, metav1.UpdateOptions{})
return err
}
// setValues will update the Secret resource 'secret' with the data contained
// in the given secretData.
// It will update labels and annotations on the Secret resource appropriately.
// The Secret resource 's' must be non-nil, although may be a resource that does
// not exist in the Kubernetes apiserver yet.
// setValues will NOT actually update the resource in the apiserver.
// If updating an existing Secret resource returned by an api client 'lister',
// make sure to DeepCopy the object first to avoid modifying data in-cache.
// It will also update depreciated issuer name and kind annotations if they exist.
func (s *SecretsManager) setValues(crt *cmapi.Certificate, secret *corev1.Secret, data SecretData) error {
// initialize the `Data` field if it is nil
if secret.Data == nil {
secret.Data = make(map[string][]byte)
}
// Only write a new PKCS12/JKS file if any of the private key/certificate/CA
// data has actually changed.
if data.PrivateKey != nil && data.Certificate != nil &&
(!bytes.Equal(secret.Data[corev1.TLSPrivateKeyKey], data.PrivateKey) ||
!bytes.Equal(secret.Data[corev1.TLSCertKey], data.Certificate) ||
!bytes.Equal(secret.Data[cmmeta.TLSCAKey], data.CA)) {
// Handle the experimental PKCS12 support
if crt.Spec.Keystores != nil && crt.Spec.Keystores.PKCS12 != nil && crt.Spec.Keystores.PKCS12.Create {
ref := crt.Spec.Keystores.PKCS12.PasswordSecretRef
pwSecret, err := s.secretLister.Secrets(crt.Namespace).Get(ref.Name)
if err != nil {
return fmt.Errorf("fetching PKCS12 keystore password from Secret: %v", err)
}
if pwSecret.Data == nil || len(pwSecret.Data[ref.Key]) == 0 {
return fmt.Errorf("PKCS12 keystore password Secret contains no data for key %q", ref.Key)
}
pw := pwSecret.Data[ref.Key]
keystoreData, err := encodePKCS12Keystore(string(pw), data.PrivateKey, data.Certificate, data.CA)
if err != nil {
return fmt.Errorf("error encoding PKCS12 bundle: %w", err)
}
// always overwrite the keystore entry for now
secret.Data[pkcs12SecretKey] = keystoreData
if len(data.CA) > 0 {
truststoreData, err := encodePKCS12Truststore(string(pw), data.CA)
if err != nil {
return fmt.Errorf("error encoding PKCS12 trust store bundle: %w", err)
}
// always overwrite the truststore entry
secret.Data[pkcs12TruststoreKey] = truststoreData
}
} else {
delete(secret.Data, pkcs12SecretKey)
delete(secret.Data, pkcs12TruststoreKey)
}
// Handle the experimental JKS support
if crt.Spec.Keystores != nil && crt.Spec.Keystores.JKS != nil && crt.Spec.Keystores.JKS.Create {
ref := crt.Spec.Keystores.JKS.PasswordSecretRef
pwSecret, err := s.secretLister.Secrets(crt.Namespace).Get(ref.Name)
if err != nil {
return fmt.Errorf("fetching JKS keystore password from Secret: %v", err)
}
if pwSecret.Data == nil || len(pwSecret.Data[ref.Key]) == 0 {
return fmt.Errorf("JKS keystore password Secret contains no data for key %q", ref.Key)
}
pw := pwSecret.Data[ref.Key]
keystoreData, err := encodeJKSKeystore(pw, data.PrivateKey, data.Certificate, data.CA)
if err != nil {
return fmt.Errorf("error encoding JKS bundle: %w", err)
}
// always overwrite the keystore entry
secret.Data[jksSecretKey] = keystoreData
if len(data.CA) > 0 {
truststoreData, err := encodeJKSTruststore(pw, data.CA)
if err != nil {
return fmt.Errorf("error encoding JKS trust store bundle: %w", err)
}
// always overwrite the keystore entry
secret.Data[jksTruststoreKey] = truststoreData
}
} else {
delete(secret.Data, jksSecretKey)
delete(secret.Data, jksTruststoreKey)
}
}
secret.Data[corev1.TLSPrivateKeyKey] = data.PrivateKey
secret.Data[corev1.TLSCertKey] = data.Certificate
if len(data.CA) > 0 {
secret.Data[cmmeta.TLSCAKey] = data.CA
} else {
delete(secret.Data, cmmeta.TLSCAKey)
}
if secret.Annotations == nil {
secret.Annotations = make(map[string]string)
}
secret.Annotations[cmapi.CertificateNameKey] = crt.Name
secret.Annotations[cmapi.IssuerNameAnnotationKey] = crt.Spec.IssuerRef.Name
secret.Annotations[cmapi.IssuerKindAnnotationKey] = apiutil.IssuerKind(crt.Spec.IssuerRef)
secret.Annotations[cmapi.IssuerGroupAnnotationKey] = crt.Spec.IssuerRef.Group
// if the certificate data is empty, clear the subject related annotations
if len(data.Certificate) == 0 {
delete(secret.Annotations, cmapi.CommonNameAnnotationKey)
delete(secret.Annotations, cmapi.AltNamesAnnotationKey)
delete(secret.Annotations, cmapi.IPSANAnnotationKey)
delete(secret.Annotations, cmapi.URISANAnnotationKey)
} else {
x509Cert, err := utilpki.DecodeX509CertificateBytes(data.Certificate)
// TODO: handle InvalidData here?
if err != nil {
return err
}
secret.Annotations[cmapi.CommonNameAnnotationKey] = x509Cert.Subject.CommonName
secret.Annotations[cmapi.AltNamesAnnotationKey] = strings.Join(x509Cert.DNSNames, ",")
secret.Annotations[cmapi.IPSANAnnotationKey] = strings.Join(utilpki.IPAddressesToString(x509Cert.IPAddresses), ",")
secret.Annotations[cmapi.URISANAnnotationKey] = strings.Join(utilpki.URLsToString(x509Cert.URIs), ",")
}
return nil
}