-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.go
340 lines (293 loc) · 11.5 KB
/
utils.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
package controllers
import (
"context"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/x509"
"crypto/x509/pkix"
"encoding/pem"
"fmt"
"reflect"
"sync"
"time"
"github.com/cloudflare/cfssl/config"
cflog "github.com/cloudflare/cfssl/log"
"github.com/cloudflare/cfssl/signer"
"github.com/cloudflare/cfssl/signer/local"
"github.com/go-logr/logr"
certificatesv1 "k8s.io/api/certificates/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
apisixoperatorv1alpha1 "github.com/chever-john/apisix-operator/apis/v1alpha1"
"github.com/chever-john/apisix-operator/internal/consts"
"github.com/chever-john/apisix-operator/internal/manager/logging"
k8sutils "github.com/chever-john/apisix-operator/internal/utils/kubernetes"
k8sresources "github.com/chever-john/apisix-operator/internal/utils/kubernetes/resources"
)
// -----------------------------------------------------------------------------
// Private Vars
// -----------------------------------------------------------------------------
const requeueWithoutBackoff = time.Millisecond * 200
// -----------------------------------------------------------------------------
// Private Functions - Certificate management
// -----------------------------------------------------------------------------
// cfssl uses its own internal logger which will yeet unformatted messages to stderr unless overidden
type loggerShim struct {
logger logr.Logger
}
func (l loggerShim) Debug(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
func (l loggerShim) Info(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
func (l loggerShim) Warning(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
func (l loggerShim) Err(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
func (l loggerShim) Crit(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
func (l loggerShim) Emerg(msg string) { l.logger.V(logging.InfoLevel).Info(msg) }
var caLoggerInit sync.Once
func setCALogger(logger logr.Logger) {
caLoggerInit.Do(func() {
cflog.SetLogger(loggerShim{logger: logger})
})
}
/*
Adapted from the Kubernetes CFSSL signer:
https://github.com/kubernetes/kubernetes/blob/v1.16.15/pkg/controller/certificates/signer/cfssl_signer.go
Modified to handle requests entirely in memory instead of via a controller watching for CertificateSigningRequests
in the API.
Copyright 2016 The Kubernetes 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.
*/
// signCertificate takes a CertificateSigningRequest and a TLS Secret and returns a PEM x.509 certificate
// signed by the certificate in the Secret.
func signCertificate(csr certificatesv1.CertificateSigningRequest, ca *corev1.Secret) ([]byte, error) {
caKeyBlock, _ := pem.Decode(ca.Data["tls.key"])
caCertBlock, _ := pem.Decode(ca.Data["tls.crt"])
priv, err := x509.ParseECPrivateKey(caKeyBlock.Bytes)
if err != nil {
return nil, err
}
caCert, err := x509.ParseCertificate(caCertBlock.Bytes)
if err != nil {
return nil, err
}
var usages []string
for _, usage := range csr.Spec.Usages {
usages = append(usages, string(usage))
}
certExpiryDuration := time.Second * time.Duration(*csr.Spec.ExpirationSeconds)
durationUntilExpiry := caCert.NotAfter.Sub(time.Now()) //nolint:gosimple
if durationUntilExpiry <= 0 {
return nil, fmt.Errorf("the signer has expired: %v", caCert.NotAfter)
}
if durationUntilExpiry < certExpiryDuration {
certExpiryDuration = durationUntilExpiry
}
policy := &config.Signing{
Default: &config.SigningProfile{
Usage: usages,
Expiry: certExpiryDuration,
ExpiryString: certExpiryDuration.String(),
},
}
cfs, err := local.NewSigner(priv, caCert, x509.ECDSAWithSHA256, policy)
if err != nil {
return nil, err
}
certBytes, err := cfs.Sign(signer.SignRequest{Request: string(csr.Spec.Request)})
if err != nil {
return nil, err
}
return certBytes, nil
}
// maybeCreateCertificateSecret creates a namespace/name Secret for subject signed by the CA in the
// mtlsCASecretNamespace/mtlsCASecretName Secret, or does nothing if a namespace/name Secret is
// already present. It returns a boolean indicating if it created a Secret and an error indicating
// any failures it encountered.
func maybeCreateCertificateSecret(ctx context.Context,
owner client.Object,
subject, mtlsCASecretName, mtlsCASecretNamespace string,
usages []certificatesv1.KeyUsage,
k8sClient client.Client,
) (bool, *corev1.Secret, error) {
logger := log.FromContext(ctx).WithName("MTLSCertificateCreation")
setCALogger(logger)
selectorKey, selectorValue := getManagedLabelForOwner(owner)
secrets, err := k8sutils.ListSecretsForOwner(
ctx,
k8sClient,
selectorKey,
selectorValue,
owner.GetUID(),
)
if err != nil {
return false, nil, err
}
count := len(secrets)
if count > 1 {
return false, nil, fmt.Errorf("found %d mTLS secrets for DataPlane currently unsupported: expected 1 or less", count)
}
ownerPrefix := getPrefixForOwner(owner)
generatedSecret := k8sresources.GenerateNewTLSSecret(owner.GetNamespace(), owner.GetName(), ownerPrefix)
k8sutils.SetOwnerForObject(generatedSecret, owner)
addLabelForOwner(generatedSecret, owner)
if count == 1 {
var updated bool
existingSecret := &secrets[0]
updated, existingSecret.ObjectMeta = k8sutils.EnsureObjectMetaIsUpdated(existingSecret.ObjectMeta, generatedSecret.ObjectMeta)
if updated {
return true, existingSecret, k8sClient.Update(ctx, existingSecret)
}
return false, existingSecret, nil
}
template := x509.CertificateRequest{
Subject: pkix.Name{
CommonName: subject,
Organization: []string{"Apisix, Inc."},
Country: []string{"US"},
},
SignatureAlgorithm: x509.ECDSAWithSHA256,
DNSNames: []string{subject},
}
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
return false, nil, err
}
der, err := x509.CreateCertificateRequest(rand.Reader, &template, priv)
if err != nil {
return false, nil, err
}
// This is effectively a placeholder so long as we handle signing internally. When actually creating CSR resources,
// this string is used by signers to filter which resources they pay attention to
signerName := "apisix-operator.apisix.apache.org/mtls"
// TODO This creates certificates that last for 10 years as an arbitrarily long period for the alpha. A production-
// ready implementation should use a shorter lifetime and rotate certificates. Rotation requires some mechanism to
// recognize that certificates have expired (ideally without permissions to read Secrets across the cluster) and
// to get Deployments to acknowledge them.
expiration := int32(315400000)
csr := certificatesv1.CertificateSigningRequest{
ObjectMeta: metav1.ObjectMeta{
Namespace: owner.GetNamespace(),
Name: owner.GetName(),
},
Spec: certificatesv1.CertificateSigningRequestSpec{
Request: pem.EncodeToMemory(&pem.Block{
Type: "CERTIFICATE REQUEST",
Bytes: der,
}),
SignerName: signerName,
ExpirationSeconds: &expiration,
Usages: usages,
},
}
ca := &corev1.Secret{}
err = k8sClient.Get(ctx, client.ObjectKey{Namespace: mtlsCASecretNamespace, Name: mtlsCASecretName}, ca)
if err != nil {
return false, nil, err
}
signed, err := signCertificate(csr, ca)
if err != nil {
return false, nil, err
}
privDer, err := x509.MarshalECPrivateKey(priv)
if err != nil {
return false, nil, err
}
generatedSecret.StringData = map[string]string{
"ca.crt": string(ca.Data["tls.crt"]),
"tls.crt": string(signed),
"tls.key": string(pem.EncodeToMemory(&pem.Block{
Type: "EC PRIVATE KEY",
Bytes: privDer,
})),
}
err = k8sClient.Create(ctx, generatedSecret)
if err != nil {
return false, nil, err
}
return true, generatedSecret, nil
}
// -----------------------------------------------------------------------------
// Private Functions - Logging
// -----------------------------------------------------------------------------
func info(log logr.Logger, msg string, rawOBJ interface{}, keysAndValues ...interface{}) {
if obj, ok := rawOBJ.(client.Object); ok {
kvs := append([]interface{}{"namespace", obj.GetNamespace(), "name", obj.GetName()}, keysAndValues...)
log.V(logging.InfoLevel).Info(msg, kvs...)
} else if req, ok := rawOBJ.(reconcile.Request); ok {
kvs := append([]interface{}{"namespace", req.Namespace, "name", req.Name}, keysAndValues...)
log.V(logging.InfoLevel).Info(msg, kvs...)
} else {
log.V(logging.InfoLevel).Info(fmt.Sprintf("unexpected type processed for info logging: %T, this is a bug!", rawOBJ))
}
}
func debug(log logr.Logger, msg string, rawOBJ interface{}, keysAndValues ...interface{}) {
if obj, ok := rawOBJ.(client.Object); ok {
kvs := append([]interface{}{"namespace", obj.GetNamespace(), "name", obj.GetName()}, keysAndValues...)
log.V(logging.DebugLevel).Info(msg, kvs...)
} else if req, ok := rawOBJ.(reconcile.Request); ok {
kvs := append([]interface{}{"namespace", req.Namespace, "name", req.Name}, keysAndValues...)
log.V(logging.DebugLevel).Info(msg, kvs...)
} else {
log.V(logging.DebugLevel).Info(fmt.Sprintf("unexpected type processed for debug logging: %T, this is a bug!", rawOBJ))
}
}
// -----------------------------------------------------------------------------
// DeploymentOptions - Private Functions - Equality Checks
// -----------------------------------------------------------------------------
func deploymentOptionsDeepEqual(opts1, opts2 *apisixoperatorv1alpha1.DeploymentOptions) bool {
if !reflect.DeepEqual(opts1.ContainerImage, opts2.ContainerImage) {
return false
}
if !reflect.DeepEqual(opts1.Version, opts2.Version) {
return false
}
if !reflect.DeepEqual(opts1.Env, opts2.Env) {
return false
}
if !reflect.DeepEqual(opts1.EnvFrom, opts2.EnvFrom) {
return false
}
return true
}
// -----------------------------------------------------------------------------
// Owner based metadata getters - Private Functions
// -----------------------------------------------------------------------------
func getPrefixForOwner(owner client.Object) string {
switch owner.(type) {
case *apisixoperatorv1alpha1.ControlPlane:
return consts.ControlPlanePrefix
case *apisixoperatorv1alpha1.DataPlane:
return consts.DataPlanePrefix
}
return ""
}
func getManagedLabelForOwner(owner client.Object) (key string, value string) {
switch owner.(type) {
case *apisixoperatorv1alpha1.ControlPlane:
return consts.GatewayOperatorControlledLabel, consts.ControlPlaneManagedLabelValue
case *apisixoperatorv1alpha1.DataPlane:
return consts.GatewayOperatorControlledLabel, consts.DataPlaneManagedLabelValue
}
return "", ""
}
// -----------------------------------------------------------------------------
// Owner based objects mutators - Private Functions
// -----------------------------------------------------------------------------
func addLabelForOwner(obj client.Object, owner client.Object) {
switch owner.(type) {
case *apisixoperatorv1alpha1.ControlPlane:
// addLabelForControlPlane(obj)
case *apisixoperatorv1alpha1.DataPlane:
addLabelForDataplane(obj)
}
}