-
-
Notifications
You must be signed in to change notification settings - Fork 738
/
provider.go
301 lines (265 loc) · 9.96 KB
/
provider.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
/*
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 vault
import (
"context"
"errors"
"fmt"
"time"
vault "github.com/hashicorp/vault/api"
"github.com/spf13/pflag"
"k8s.io/client-go/kubernetes"
typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
ctrl "sigs.k8s.io/controller-runtime"
kclient "sigs.k8s.io/controller-runtime/pkg/client"
ctrlcfg "sigs.k8s.io/controller-runtime/pkg/client/config"
esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
"github.com/external-secrets/external-secrets/pkg/cache"
"github.com/external-secrets/external-secrets/pkg/feature"
"github.com/external-secrets/external-secrets/pkg/provider/vault/util"
"github.com/external-secrets/external-secrets/pkg/utils/resolvers"
)
var (
_ esv1beta1.Provider = &Provider{}
enableCache bool
logger = ctrl.Log.WithName("provider").WithName("vault")
clientCache *cache.Cache[util.Client]
)
const (
errVaultStore = "received invalid Vault SecretStore resource: %w"
errVaultClient = "cannot setup new vault client: %w"
errVaultCert = "cannot set Vault CA certificate: %w"
errConfigMapFmt = "cannot find config map data for key: %q"
errClientTLSAuth = "error from Client TLS Auth: %q"
errUnknownCAProvider = "unknown caProvider type given"
errCANamespace = "cannot read secret for CAProvider due to missing namespace on kind ClusterSecretStore"
)
type Provider struct {
// NewVaultClient is a function that returns a new Vault client.
// This is used for testing to inject a fake client.
NewVaultClient func(config *vault.Config) (util.Client, error)
}
// NewVaultClient returns a new Vault client.
func NewVaultClient(config *vault.Config) (util.Client, error) {
vaultClient, err := vault.NewClient(config)
if err != nil {
return nil, err
}
return &util.VaultClient{
SetTokenFunc: vaultClient.SetToken,
TokenFunc: vaultClient.Token,
ClearTokenFunc: vaultClient.ClearToken,
AuthField: vaultClient.Auth(),
AuthTokenField: vaultClient.Auth().Token(),
LogicalField: vaultClient.Logical(),
NamespaceFunc: vaultClient.Namespace,
SetNamespaceFunc: vaultClient.SetNamespace,
AddHeaderFunc: vaultClient.AddHeader,
}, nil
}
// Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
return esv1beta1.SecretStoreReadWrite
}
// NewClient implements the Client interface.
func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.SecretsClient, error) {
// controller-runtime/client does not support TokenRequest or other subresource APIs
// so we need to construct our own client and use it to fetch tokens
// (for Kubernetes service account token auth)
restCfg, err := ctrlcfg.GetConfig()
if err != nil {
return nil, err
}
clientset, err := kubernetes.NewForConfig(restCfg)
if err != nil {
return nil, err
}
return p.newClient(ctx, store, kube, clientset.CoreV1(), namespace)
}
func (p *Provider) NewGeneratorClient(ctx context.Context, kube kclient.Client, corev1 typedcorev1.CoreV1Interface, vaultSpec *esv1beta1.VaultProvider, namespace string) (util.Client, error) {
vStore, cfg, err := p.prepareConfig(ctx, kube, corev1, vaultSpec, nil, namespace, resolvers.EmptyStoreKind)
if err != nil {
return nil, err
}
client, err := p.NewVaultClient(cfg)
if err != nil {
return nil, err
}
_, err = p.initClient(ctx, vStore, client, cfg, vaultSpec)
if err != nil {
return nil, err
}
return client, nil
}
func (p *Provider) newClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, corev1 typedcorev1.CoreV1Interface, namespace string) (esv1beta1.SecretsClient, error) {
storeSpec := store.GetSpec()
if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Vault == nil {
return nil, errors.New(errVaultStore)
}
vaultSpec := storeSpec.Provider.Vault
vStore, cfg, err := p.prepareConfig(
ctx,
kube,
corev1,
vaultSpec,
storeSpec.RetrySettings,
namespace,
store.GetObjectKind().GroupVersionKind().Kind)
if err != nil {
return nil, err
}
client, err := getVaultClient(p, store, cfg)
if err != nil {
return nil, fmt.Errorf(errVaultClient, err)
}
return p.initClient(ctx, vStore, client, cfg, vaultSpec)
}
func (p *Provider) initClient(ctx context.Context, c *client, client util.Client, cfg *vault.Config, vaultSpec *esv1beta1.VaultProvider) (esv1beta1.SecretsClient, error) {
if vaultSpec.Namespace != nil {
client.SetNamespace(*vaultSpec.Namespace)
}
if vaultSpec.ReadYourWrites && vaultSpec.ForwardInconsistent {
client.AddHeader("X-Vault-Inconsistent", "forward-active-node")
}
c.client = client
c.auth = client.Auth()
c.logical = client.Logical()
c.token = client.AuthToken()
// allow SecretStore controller validation to pass
// when using referent namespace.
if c.storeKind == esv1beta1.ClusterSecretStoreKind && c.namespace == "" && isReferentSpec(vaultSpec) {
return c, nil
}
if err := c.setAuth(ctx, cfg); err != nil {
return nil, err
}
return c, nil
}
func (p *Provider) prepareConfig(ctx context.Context, kube kclient.Client, corev1 typedcorev1.CoreV1Interface, vaultSpec *esv1beta1.VaultProvider, retrySettings *esv1beta1.SecretStoreRetrySettings, namespace, storeKind string) (*client, *vault.Config, error) {
c := &client{
kube: kube,
corev1: corev1,
store: vaultSpec,
log: logger,
namespace: namespace,
storeKind: storeKind,
}
cfg, err := c.newConfig(ctx)
if err != nil {
return nil, nil, err
}
// Setup retry options if present
if retrySettings != nil {
if retrySettings.MaxRetries != nil {
cfg.MaxRetries = int(*retrySettings.MaxRetries)
} else {
// By default we rely only on the reconciliation process for retrying
cfg.MaxRetries = 0
}
if retrySettings.RetryInterval != nil {
retryWait, err := time.ParseDuration(*retrySettings.RetryInterval)
if err != nil {
return nil, nil, err
}
cfg.MinRetryWait = retryWait
cfg.MaxRetryWait = retryWait
}
}
return c, cfg, nil
}
func getVaultClient(p *Provider, store esv1beta1.GenericStore, cfg *vault.Config) (util.Client, error) {
isStaticToken := store.GetSpec().Provider.Vault.Auth.TokenSecretRef != nil
useCache := enableCache && !isStaticToken
key := cache.Key{
Name: store.GetObjectMeta().Name,
Namespace: store.GetObjectMeta().Namespace,
Kind: store.GetTypeMeta().Kind,
}
if useCache {
client, ok := clientCache.Get(store.GetObjectMeta().ResourceVersion, key)
if ok {
return client, nil
}
}
client, err := p.NewVaultClient(cfg)
if err != nil {
return nil, fmt.Errorf(errVaultClient, err)
}
if useCache && !clientCache.Contains(key) {
clientCache.Add(store.GetObjectMeta().ResourceVersion, key, client)
}
return client, nil
}
func isReferentSpec(prov *esv1beta1.VaultProvider) bool {
if prov.Auth.TokenSecretRef != nil && prov.Auth.TokenSecretRef.Namespace == nil {
return true
}
if prov.Auth.AppRole != nil && prov.Auth.AppRole.SecretRef.Namespace == nil {
return true
}
if prov.Auth.Kubernetes != nil && prov.Auth.Kubernetes.SecretRef != nil && prov.Auth.Kubernetes.SecretRef.Namespace == nil {
return true
}
if prov.Auth.Kubernetes != nil && prov.Auth.Kubernetes.ServiceAccountRef != nil && prov.Auth.Kubernetes.ServiceAccountRef.Namespace == nil {
return true
}
if prov.Auth.Ldap != nil && prov.Auth.Ldap.SecretRef.Namespace == nil {
return true
}
if prov.Auth.UserPass != nil && prov.Auth.UserPass.SecretRef.Namespace == nil {
return true
}
if prov.Auth.Jwt != nil && prov.Auth.Jwt.SecretRef != nil && prov.Auth.Jwt.SecretRef.Namespace == nil {
return true
}
if prov.Auth.Jwt != nil && prov.Auth.Jwt.KubernetesServiceAccountToken != nil && prov.Auth.Jwt.KubernetesServiceAccountToken.ServiceAccountRef.Namespace == nil {
return true
}
if prov.Auth.Cert != nil && prov.Auth.Cert.SecretRef.Namespace == nil {
return true
}
if prov.Auth.Iam != nil && prov.Auth.Iam.JWTAuth != nil && prov.Auth.Iam.JWTAuth.ServiceAccountRef != nil && prov.Auth.Iam.JWTAuth.ServiceAccountRef.Namespace == nil {
return true
}
if prov.Auth.Iam != nil && prov.Auth.Iam.SecretRef != nil &&
(prov.Auth.Iam.SecretRef.AccessKeyID.Namespace == nil ||
prov.Auth.Iam.SecretRef.SecretAccessKey.Namespace == nil ||
(prov.Auth.Iam.SecretRef.SessionToken != nil && prov.Auth.Iam.SecretRef.SessionToken.Namespace == nil)) {
return true
}
return false
}
func init() {
var vaultTokenCacheSize int
fs := pflag.NewFlagSet("vault", pflag.ExitOnError)
fs.BoolVar(&enableCache, "experimental-enable-vault-token-cache", false, "Enable experimental Vault token cache. External secrets will reuse the Vault token without creating a new one on each request.")
// max. 265k vault leases with 30bytes each ~= 7MB
fs.IntVar(&vaultTokenCacheSize, "experimental-vault-token-cache-size", 2<<17, "Maximum size of Vault token cache. When more tokens than Only used if --experimental-enable-vault-token-cache is set.")
lateInit := func() {
logger.Info("initializing vault cache", "size", vaultTokenCacheSize)
clientCache = cache.Must(vaultTokenCacheSize, func(client util.Client) {
err := revokeTokenIfValid(context.Background(), client)
if err != nil {
logger.Error(err, "unable to revoke cached token on eviction")
}
})
}
feature.Register(feature.Feature{
Flags: fs,
Initialize: lateInit,
})
esv1beta1.Register(&Provider{
NewVaultClient: NewVaultClient,
}, &esv1beta1.SecretStoreProvider{
Vault: &esv1beta1.VaultProvider{},
})
}