/
provider.go
162 lines (141 loc) · 5.12 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
/*
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 secretmanager
import (
"context"
"fmt"
"sync"
secretmanager "cloud.google.com/go/secretmanager/apiv1"
"golang.org/x/oauth2"
"google.golang.org/api/option"
kclient "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
"github.com/external-secrets/external-secrets/pkg/utils"
)
// Provider is a secrets provider for GCP Secret Manager.
// It implements the necessary NewClient() and ValidateStore() funcs.
type Provider struct{}
// https://github.com/external-secrets/external-secrets/issues/644
var _ esv1beta1.SecretsClient = &Client{}
var _ esv1beta1.Provider = &Provider{}
func init() {
esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
GCPSM: &esv1beta1.GCPSMProvider{},
})
}
/*
Currently, GCPSM client has a limitation around how concurrent connections work
This limitation causes memory leaks due to random disconnects from living clients
and also payload switches when sending a call (such as using a credential from one
thread to ask secrets from another thread).
A Mutex was implemented to make sure only one connection can be in place at a time.
*/
var useMu = sync.Mutex{}
func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
return esv1beta1.SecretStoreReadWrite
}
// NewClient constructs a GCP Provider.
func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.SecretsClient, error) {
storeSpec := store.GetSpec()
if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.GCPSM == nil {
return nil, fmt.Errorf(errGCPSMStore)
}
gcpStore := storeSpec.Provider.GCPSM
useMu.Lock()
client := &Client{
kube: kube,
store: gcpStore,
storeKind: store.GetKind(),
namespace: namespace,
}
defer func() {
if client.smClient == nil {
_ = client.Close(ctx)
}
}()
// this project ID is used for authentication (currently only relevant for workload identity)
clusterProjectID, err := clusterProjectID(storeSpec)
if err != nil {
return nil, err
}
isClusterKind := store.GetObjectKind().GroupVersionKind().Kind == esv1beta1.ClusterSecretStoreKind
// allow SecretStore controller validation to pass
// when using referent namespace.
if namespace == "" && isClusterKind && isReferentSpec(gcpStore) {
// placeholder smClient to prevent closing the client twice
client.smClient, _ = secretmanager.NewClient(ctx, option.WithTokenSource(oauth2.StaticTokenSource(&oauth2.Token{})))
return client, nil
}
ts, err := NewTokenSource(ctx, gcpStore.Auth, clusterProjectID, store.GetKind(), kube, namespace)
if err != nil {
return nil, fmt.Errorf(errUnableCreateGCPSMClient, err)
}
// check if we can get credentials
_, err = ts.Token()
if err != nil {
return nil, fmt.Errorf(errUnableGetCredentials, err)
}
clientGCPSM, err := secretmanager.NewClient(ctx, option.WithTokenSource(ts))
if err != nil {
return nil, fmt.Errorf(errUnableCreateGCPSMClient, err)
}
client.smClient = clientGCPSM
return client, nil
}
func (p *Provider) ValidateStore(store esv1beta1.GenericStore) (admission.Warnings, error) {
if store == nil {
return nil, fmt.Errorf(errInvalidStore)
}
spc := store.GetSpec()
if spc == nil {
return nil, fmt.Errorf(errInvalidStoreSpec)
}
if spc.Provider == nil {
return nil, fmt.Errorf(errInvalidStoreProv)
}
g := spc.Provider.GCPSM
if p == nil {
return nil, fmt.Errorf(errInvalidGCPProv)
}
if g.Auth.SecretRef != nil {
if err := utils.ValidateReferentSecretSelector(store, g.Auth.SecretRef.SecretAccessKey); err != nil {
return nil, fmt.Errorf(errInvalidAuthSecretRef, err)
}
}
if g.Auth.WorkloadIdentity != nil {
if err := utils.ValidateReferentServiceAccountSelector(store, g.Auth.WorkloadIdentity.ServiceAccountRef); err != nil {
return nil, fmt.Errorf(errInvalidWISARef, err)
}
}
return nil, nil
}
func clusterProjectID(spec *esv1beta1.SecretStoreSpec) (string, error) {
if spec.Provider.GCPSM.Auth.WorkloadIdentity != nil && spec.Provider.GCPSM.Auth.WorkloadIdentity.ClusterProjectID != "" {
return spec.Provider.GCPSM.Auth.WorkloadIdentity.ClusterProjectID, nil
} else if spec.Provider.GCPSM.ProjectID != "" {
return spec.Provider.GCPSM.ProjectID, nil
} else {
return "", fmt.Errorf(errNoProjectID)
}
}
func isReferentSpec(prov *esv1beta1.GCPSMProvider) bool {
if prov.Auth.SecretRef != nil &&
prov.Auth.SecretRef.SecretAccessKey.Namespace == nil {
return true
}
if prov.Auth.WorkloadIdentity != nil &&
prov.Auth.WorkloadIdentity.ServiceAccountRef.Namespace == nil {
return true
}
return false
}