/
stunnel.go
338 lines (301 loc) · 8.39 KB
/
stunnel.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
package stunnel
import (
"bytes"
"context"
"crypto/rand"
"fmt"
"math/big"
b64 "encoding/base64"
"github.com/backube/pvc-transfer/internal/utils"
"github.com/backube/pvc-transfer/transport"
"github.com/backube/pvc-transfer/transport/tls/certs"
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
)
const (
defaultStunnelImage = "quay.io/konveyor/rsync-transfer:latest"
stunnelConfig = "stunnel-config"
stunnelSecret = "stunnel-creds"
)
const (
CredentialsTypePSK transport.CredentialsType = "PSK"
CredentialsTypeSSL transport.CredentialsType = "SSL"
)
const (
TransportTypeStunnel transport.Type = "stunnel"
Container = "stunnel"
)
func getImage(options *transport.Options) string {
if options.Image == "" {
return defaultStunnelImage
} else {
return options.Image
}
}
func getResourceName(obj types.NamespacedName, component, prefix string) string {
resourceName := fmt.Sprintf("%s-%s-%s", prefix, component, obj.Name)
if len(resourceName) > 62 {
return resourceName[:62]
}
return resourceName
}
func isTLSSecretValid(ctx context.Context, c ctrlclient.Client, logger logr.Logger, secretRef types.NamespacedName) (bool, error) {
secret := &corev1.Secret{}
err := c.Get(ctx, secretRef, secret)
switch {
case k8serrors.IsNotFound(err):
return false, nil
case err != nil:
return false, err
}
_, ok := secret.Data["client.key"]
if !ok {
logger.Info("secret data missing key client.key", "secret", secretRef)
return false, nil
}
_, ok = secret.Data["server.key"]
if !ok {
logger.Info("secret data missing key server.key", "secret", secretRef)
return false, nil
}
clientCrt, ok := secret.Data["client.crt"]
if !ok {
logger.Info("secret data missing key client.crt", "secret", secretRef)
return false, nil
}
serverCrt, ok := secret.Data["server.crt"]
if !ok {
logger.Info("secret data missing key server.crt", "secret", secretRef)
return false, nil
}
ca, ok := secret.Data["ca.crt"]
if !ok {
logger.Info("secret data missing key ca.crt", "secret", secretRef)
return false, nil
}
verified, err := certs.VerifyCertificate(bytes.NewBuffer(ca), bytes.NewBuffer(clientCrt))
if err != nil {
return verified, err
}
return certs.VerifyCertificate(bytes.NewBuffer(ca), bytes.NewBuffer(serverCrt))
}
func isPSKSecretValid(ctx context.Context, c ctrlclient.Client, logger logr.Logger, secretRef types.NamespacedName) (bool, error) {
secret := &corev1.Secret{}
err := c.Get(ctx, secretRef, secret)
switch {
case k8serrors.IsNotFound(err):
return false, nil
case err != nil:
return false, err
}
_, ok := secret.Data["key"]
if !ok {
logger.Info("secret data missing PSK key", "secret", secretRef)
return false, nil
}
return true, nil
}
// reconcileCredentialSecret reconciles credential secrets for a stunnel transport
func reconcileCredentialSecret(ctx context.Context,
c ctrlclient.Client,
logger logr.Logger,
t transport.Transport,
o *transport.Options) error {
var err error
secretValid := false
credType := CredentialsTypeSSL
if o.Credentials != nil {
if o.Credentials.Type != "" {
credType = o.Credentials.Type
}
}
secretRef := getCredentialsSecretRef(t, o.Credentials)
switch credType {
case CredentialsTypePSK:
secretValid, err = isPSKSecretValid(ctx, c, logger, secretRef)
if err != nil {
logger.Error(err, "error getting existing PSK credentials from secret")
return err
}
case CredentialsTypeSSL:
secretValid, err = isTLSSecretValid(ctx, c, logger, secretRef)
if err != nil {
logger.Error(err, "error getting existing ssl certs from secret")
return err
}
default:
return fmt.Errorf("unsupported credentials type %s", credType)
}
if secretValid {
logger.V(4).Info("found secret with valid certs")
return nil
}
logger.Info("generating new certificate bundle")
switch credType {
case CredentialsTypeSSL:
crtBundle, err := certs.New()
if err != nil {
logger.Error(err, "error generating ssl certs for stunnel server")
return err
}
return reconcileSSLSecret(ctx, c, secretRef, o, crtBundle)
default:
return reconcilePSKSecret(ctx, c, secretRef, o)
}
}
// reconcileSSLSecret reconciles secret of TLS type
func reconcileSSLSecret(ctx context.Context,
c ctrlclient.Client,
secretRef types.NamespacedName,
options *transport.Options,
crtBundle *certs.CertificateBundle) error {
crtBundleSecret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Namespace: secretRef.Namespace,
Name: secretRef.Name,
},
}
_, err := controllerutil.CreateOrUpdate(ctx, c, crtBundleSecret, func() error {
crtBundleSecret.Labels = options.Labels
crtBundleSecret.OwnerReferences = options.Owners
crtBundleSecret.Data = map[string][]byte{
"server.crt": crtBundle.ServerCrt.Bytes(),
"server.key": crtBundle.ServerKey.Bytes(),
"client.crt": crtBundle.ClientCrt.Bytes(),
"client.key": crtBundle.ClientKey.Bytes(),
"ca.crt": crtBundle.CACrt.Bytes(),
"ca.key": crtBundle.CAKey.Bytes(),
}
return nil
})
if err != nil {
return err
}
return err
}
// reconcilePSKSecret reconciles secret of TLS type
func reconcilePSKSecret(ctx context.Context,
c ctrlclient.Client,
secretRef types.NamespacedName,
options *transport.Options) error {
pskSecret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Namespace: secretRef.Namespace,
Name: secretRef.Name,
},
}
pass, err := GeneratePassword()
if err != nil {
return err
}
_, err = controllerutil.CreateOrUpdate(ctx, c, pskSecret, func() error {
pskSecret.Labels = options.Labels
pskSecret.OwnerReferences = options.Owners
// stunnel requires key to be base64 encoded
pskSecret.Data = map[string][]byte{
"key": []byte(fmt.Sprintf(
"root:%s\n", b64.StdEncoding.EncodeToString([]byte(pass)))),
}
return nil
})
if err != nil {
return err
}
return err
}
func getCredentialsSecretRef(t transport.Transport, c *transport.Credentials) types.NamespacedName {
secretRef := types.NamespacedName{
Name: getResourceName(t.NamespacedName(), "certs", stunnelSecret),
Namespace: t.NamespacedName().Namespace,
}
if c != nil {
if c.SecretRef.Name != "" {
secretRef = c.SecretRef
}
}
return secretRef
}
func getCredentialsVolumeSource(t transport.Transport, c *transport.Credentials, key string) corev1.VolumeSource {
sslItems := []corev1.KeyToPath{
{
Key: fmt.Sprintf("%s.crt", key),
Path: fmt.Sprintf("%s.crt", key),
},
{
Key: fmt.Sprintf("%s.key", key),
Path: fmt.Sprintf("%s.key", key),
},
{
Key: "ca.crt",
Path: "ca.crt",
},
}
pskItems := []corev1.KeyToPath{
{
Key: "key",
Path: "key",
},
}
volumeSource := corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: getCredentialsSecretRef(t, c).Name,
Items: sslItems,
},
}
// when no existing credentials are provided, default to TLS
if c != nil {
switch c.Type {
case CredentialsTypeSSL:
volumeSource.Secret.Items = sslItems
return volumeSource
case CredentialsTypePSK:
volumeSource.Secret.Items = pskItems
return volumeSource
}
}
return volumeSource
}
func markForCleanup(ctx context.Context, c ctrlclient.Client, objKey types.NamespacedName, key, value, component string) error {
cm := &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: getResourceName(objKey, component, stunnelConfig),
Namespace: objKey.Namespace,
},
}
err := utils.UpdateWithLabel(ctx, c, cm, key, value)
if err != nil {
return err
}
clientSecret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: getResourceName(objKey, "certs", stunnelSecret),
Namespace: objKey.Namespace,
},
}
err = utils.UpdateWithLabel(ctx, c, clientSecret, key, value)
switch {
case k8serrors.IsNotFound(err):
break
case err != nil:
return err
}
return nil
}
// GeneratePassword can be used to generate random character string of 32 bytes
func GeneratePassword() (string, error) {
var letters = []byte("abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ")
password := make([]byte, 32)
for i := 0; i < 32; i++ {
num, err := rand.Int(rand.Reader, big.NewInt(int64(len(letters))))
if err != nil {
return "", err
}
password = append(password, letters[num.Int64()])
}
return string(password), nil
}