-
Notifications
You must be signed in to change notification settings - Fork 682
/
secrets.go
263 lines (232 loc) · 8.9 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
package entrypoint
import (
"context"
"strings"
amb "github.com/datawire/ambassador/pkg/api/getambassador.io/v2"
"github.com/datawire/ambassador/pkg/kates"
snapshotTypes "github.com/datawire/ambassador/pkg/snapshot/v1"
"github.com/datawire/dlib/dlog"
)
// ReconcileSecrets figures out which secrets we're actually using,
// since we don't want to send secrets to Ambassador unless we're
// using them, since any secret we send will be saved to disk.
func ReconcileSecrets(ctx context.Context, s *snapshotTypes.KubernetesSnapshot) {
// Start by building up a list of all the K8s objects that are
// allowed to mention secrets. Note that we vet the ambassador_id
// for all of these before putting them on the list.
var resources []kates.Object
// Annotations are straightforward, although honestly we should
// be filtering annotations by type here (or, even better, unfold
// them earlier so that we can treat them like any other resource
// here).
for _, a := range s.Annotations {
if include(GetAmbId(a)) {
resources = append(resources, a)
}
}
// Hosts are a little weird, because we have two ways to find the
// ambassador_id. Sorry about that.
for _, h := range s.Hosts {
var id amb.AmbassadorID
if len(h.Spec.AmbassadorID) > 0 {
id = h.Spec.AmbassadorID
} else {
id = h.Spec.DeprecatedAmbassadorID
}
if include(id) {
resources = append(resources, h)
}
}
// TLSContexts, Modules, and Ingresses are all straightforward.
for _, t := range s.TLSContexts {
if include(t.Spec.AmbassadorID) {
resources = append(resources, t)
}
}
for _, m := range s.Modules {
if include(m.Spec.AmbassadorID) {
resources = append(resources, m)
}
}
for _, i := range s.Ingresses {
resources = append(resources, i)
}
// OK. Once that's done, we can check to see if we should be
// doing secret namespacing or not -- this requires a look into
// the Ambassador Module, if it's present.
//
// XXX Linear searches suck, but whatever, it's just not gonna
// be all that many things. We won't bother optimizing this unless
// a profiler shows that it's a problem.
secretNamespacing := true
for _, resource := range resources {
mod, ok := resource.(*amb.Module)
// We don't need to recheck ambassador_id on this Module because
// the Module can't have made it into the resources list without
// its ambassador_id being checked.
if ok && mod.GetName() == "ambassador" {
// XXX ModuleSecrets is a _godawful_ hack. See the comment on
// ModuleSecrets itself for more.
secs := ModuleSecrets{}
err := convert(mod.Spec.Config, &secs)
if err != nil {
dlog.Errorf(ctx, "error parsing module: %v", err)
continue
}
secretNamespacing = secs.Defaults.TLSSecretNamespacing
break
}
}
// Once we have our list of secrets, go figure out the names of all
// the secrets we need. We'll use this "refs" map to hold all the names...
refs := map[snapshotTypes.SecretRef]bool{}
// ...and, uh, this "action" function is really just a closure to avoid
// needing to pass "refs" to find SecretRefs. Shrug. Arguably more
// complex than needed, but meh.
action := func(ref snapshotTypes.SecretRef) {
refs[ref] = true
}
// So. Walk the list of resources...
for _, resource := range resources {
// ...and for each resource, dig out any secrets being referenced.
findSecretRefs(ctx, resource, secretNamespacing, action)
}
if IsEdgeStack() {
// For Edge Stack, we _always_ have implicit references to the fallback
// cert secret and the license secret.
secretRef(GetAmbassadorNamespace(), "fallback-self-signed-cert", false, action)
secretRef(GetLicenseSecretNamespace(), GetLicenseSecretName(), false, action)
}
// OK! After all that, go copy all the matching secrets from FSSecrets and
// K8sSecrets to Secrets.
//
// The way this works is kind of simple: first we check everything in
// FSSecrets. Then, when we check K8sSecrets, we skip any secrets that are
// also in FSSecrets. End result: FSSecrets wins if there are any conflicts.
s.Secrets = make([]*kates.Secret, 0, len(refs))
for ref, secret := range s.FSSecrets {
if refs[ref] {
dlog.Debugf(ctx, "Taking FSSecret %#v", ref)
s.Secrets = append(s.Secrets, secret)
}
}
for _, secret := range s.K8sSecrets {
ref := snapshotTypes.SecretRef{Namespace: secret.GetNamespace(), Name: secret.GetName()}
_, found := s.FSSecrets[ref]
if found {
dlog.Debugf(ctx, "Conflict! skipping K8sSecret %#v", ref)
continue
}
if refs[ref] {
dlog.Debugf(ctx, "Taking K8sSecret %#v", ref)
s.Secrets = append(s.Secrets, secret)
}
}
}
// Find all the secrets a given Ambassador resource references.
func findSecretRefs(ctx context.Context, resource kates.Object, secretNamespacing bool, action func(snapshotTypes.SecretRef)) {
switch r := resource.(type) {
case *amb.Host:
// The Host resource is a little odd. Host.spec.tls, Host.spec.tlsSecret, and
// host.spec.acmeProvider.privateKeySecret can all refer to secrets.
if r.Spec == nil {
return
}
if r.Spec.TLS != nil {
// Host.spec.tls.caSecret is the thing to worry about here.
secretRef(r.GetNamespace(), r.Spec.TLS.CASecret, secretNamespacing, action)
}
// Host.spec.tlsSecret and Host.spec.acmeProvider.privateKeySecret are native-Kubernetes-style
// `core.v1.LocalObjectReference`s, not Ambassador-style `{name}.{namespace}` strings. If we
// ever decide that they should support cross-namespace references, we would do it by adding a
// `namespace:` field (i.e. changing them to `core.v1.SecretReference`s) rather than by
// adopting the `{name}.{namespace}` notation.
if r.Spec.TLSSecret != nil && r.Spec.TLSSecret.Name != "" {
secretRef(r.GetNamespace(), r.Spec.TLSSecret.Name, false, action)
}
if r.Spec.AcmeProvider != nil && r.Spec.AcmeProvider.PrivateKeySecret != nil &&
r.Spec.AcmeProvider.PrivateKeySecret.Name != "" {
secretRef(r.GetNamespace(), r.Spec.AcmeProvider.PrivateKeySecret.Name, false, action)
}
case *amb.TLSContext:
// TLSContext.spec.secret and TLSContext.spec.ca_secret are the things to worry about --
// but note well that TLSContexts can override the global secretNamespacing setting.
if r.Spec.Secret != "" {
if r.Spec.SecretNamespacing != nil {
secretNamespacing = *r.Spec.SecretNamespacing
}
secretRef(r.GetNamespace(), r.Spec.Secret, secretNamespacing, action)
}
if r.Spec.CASecret != "" {
if r.Spec.SecretNamespacing != nil {
secretNamespacing = *r.Spec.SecretNamespacing
}
secretRef(r.GetNamespace(), r.Spec.CASecret, secretNamespacing, action)
}
case *amb.Module:
// This whole thing is a hack. We probably _should_ check to make sure that
// this is an Ambassador Module or a TLS Module, but, well, those're the only
// supported kinds now, anyway...
//
// XXX ModuleSecrets is a godawful hack. See its comment for more.
secs := ModuleSecrets{}
err := convert(r.Spec.Config, &secs)
if err != nil {
// XXX
dlog.Errorf(ctx, "error extracting secrets from module: %v", err)
return
}
// XXX Technically, this is wrong -- _any_ element named in the module can
// refer to a secret. Hmmm.
if secs.Upstream.Secret != "" {
secretRef(r.GetNamespace(), secs.Upstream.Secret, secretNamespacing, action)
}
if secs.Server.Secret != "" {
secretRef(r.GetNamespace(), secs.Server.Secret, secretNamespacing, action)
}
if secs.Client.Secret != "" {
secretRef(r.GetNamespace(), secs.Client.Secret, secretNamespacing, action)
}
case *kates.Ingress:
// Ingress is pretty straightforward, too, just look in spec.tls.
for _, itls := range r.Spec.TLS {
if itls.SecretName != "" {
secretRef(r.GetNamespace(), itls.SecretName, secretNamespacing, action)
}
}
}
}
// Mark a secret as one we reference, handling secretNamespacing correctly.
func secretRef(namespace, name string, secretNamespacing bool, action func(snapshotTypes.SecretRef)) {
if secretNamespacing {
parts := strings.Split(name, ".")
if len(parts) > 1 {
namespace = parts[len(parts)-1]
name = strings.Join(parts[:len(parts)-1], ".")
}
}
action(snapshotTypes.SecretRef{Namespace: namespace, Name: name})
}
// ModuleSecrets is... a hack. It's sort of a mashup of the chunk of the Ambassador
// Module and the chunk of the TLS Module that are common, because they're able to
// specify secrets. However... first, I don't think the TLS Module actually supported
// tls_secret_namespacing. Second, the Ambassador Module at least supports arbitrary
// origination context names -- _any_ key in the TLS dictionary will get turned into
// an origination context.
//
// I seriously doubt that either of these will actually affect anyone at this remove,
// but... yeah.
type ModuleSecrets struct {
Defaults struct {
TLSSecretNamespacing bool `json:"tls_secret_namespacing"`
} `json:"defaults"`
Upstream struct {
Secret string `json:"secret"`
} `json:"upstream"`
Server struct {
Secret string `json:"secret"`
} `json:"server"`
Client struct {
Secret string `json:"secret"`
} `json:"client"`
}