/
acr.go
376 lines (350 loc) · 12.1 KB
/
acr.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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/*
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 acr
import (
"context"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strings"
"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/go-autorest/autorest/azure"
corev1 "k8s.io/api/core/v1"
apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/client-go/kubernetes"
kcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
ctrlcfg "sigs.k8s.io/controller-runtime/pkg/client/config"
"sigs.k8s.io/yaml"
"github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1"
smmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
"github.com/external-secrets/external-secrets/pkg/provider/azure/keyvault"
)
type Generator struct {
clientSecretCreds clientSecretCredentialFunc
}
type clientSecretCredentialFunc func(tenantID string, clientID string, clientSecret string, options *azidentity.ClientSecretCredentialOptions) (TokenGetter, error)
type TokenGetter interface {
GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error)
}
const (
defaultLoginUsername = "00000000-0000-0000-0000-000000000000"
errNoSpec = "no config spec provided"
errParseSpec = "unable to parse spec: %w"
errCreateSess = "unable to create aws session: %w"
errGetToken = "unable to get authorization token: %w"
)
// Generate generates a token that can be used to authenticate against Azure Container Registry.
// First, an Azure Active Directory access token is obtained with the desired authentication method.
// This AAD access token will be used to authenticate against ACR.
// Depending on the generator spec it generates an ACR access token or an ACR refresh token.
// * access tokens are scoped to a specific repository or action (pull,push)
// * refresh tokens can are scoped to whatever policy is attached to the identity that creates the acr refresh token
// details can be found here: https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview
func (g *Generator) Generate(ctx context.Context, jsonSpec *apiextensions.JSON, crClient client.Client, namespace string) (map[string][]byte, error) {
cfg, err := ctrlcfg.GetConfig()
if err != nil {
return nil, err
}
kubeClient, err := kubernetes.NewForConfig(cfg)
if err != nil {
return nil, err
}
g.clientSecretCreds = func(tenantID, clientID, clientSecret string, options *azidentity.ClientSecretCredentialOptions) (TokenGetter, error) {
return azidentity.NewClientSecretCredential(tenantID, clientID, clientSecret, options)
}
return g.generate(
ctx,
jsonSpec,
crClient,
namespace,
kubeClient,
fetchACRAccessToken,
fetchACRRefreshToken)
}
func (g *Generator) generate(
ctx context.Context,
jsonSpec *apiextensions.JSON,
crClient client.Client,
namespace string,
kubeClient kubernetes.Interface,
fetchAccessToken accessTokenFetcher,
fetchRefreshToken refreshTokenFetcher) (map[string][]byte, error) {
if jsonSpec == nil {
return nil, fmt.Errorf(errNoSpec)
}
res, err := parseSpec(jsonSpec.Raw)
if err != nil {
return nil, fmt.Errorf(errParseSpec, err)
}
var accessToken string
// pick authentication strategy to create an AAD access token
if res.Spec.Auth.ServicePrincipal != nil {
accessToken, err = g.accessTokenForServicePrincipal(
ctx,
crClient,
namespace,
res.Spec.EnvironmentType,
res.Spec.TenantID,
res.Spec.Auth.ServicePrincipal.SecretRef.ClientID,
res.Spec.Auth.ServicePrincipal.SecretRef.ClientSecret,
)
} else if res.Spec.Auth.ManagedIdentity != nil {
accessToken, err = accessTokenForManagedIdentity(
ctx,
res.Spec.EnvironmentType,
res.Spec.Auth.ManagedIdentity.IdentityID,
)
} else if res.Spec.Auth.WorkloadIdentity != nil {
accessToken, err = accessTokenForWorkloadIdentity(
ctx,
crClient,
kubeClient.CoreV1(),
res.Spec.EnvironmentType,
res.Spec.Auth.WorkloadIdentity.ServiceAccountRef,
namespace,
)
} else {
return nil, fmt.Errorf("unexpeted configuration")
}
if err != nil {
return nil, err
}
var acrToken string
acrToken, err = fetchRefreshToken(accessToken, res.Spec.TenantID, res.Spec.ACRRegistry)
if err != nil {
return nil, err
}
if res.Spec.Scope != "" {
acrToken, err = fetchAccessToken(acrToken, res.Spec.TenantID, res.Spec.ACRRegistry, res.Spec.Scope)
if err != nil {
return nil, err
}
}
return map[string][]byte{
"username": []byte(defaultLoginUsername),
"password": []byte(acrToken),
}, nil
}
type accessTokenFetcher func(acrRefreshToken, tenantID, registryURL, scope string) (string, error)
func fetchACRAccessToken(acrRefreshToken, _, registryURL, scope string) (string, error) {
formData := url.Values{
"grant_type": {"refresh_token"},
"service": {registryURL},
"scope": {scope},
"refresh_token": {acrRefreshToken},
}
res, err := http.PostForm(fmt.Sprintf("https://%s/oauth2/token", registryURL), formData)
if err != nil {
return "", err
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return "", fmt.Errorf("could not generate access token, unexpected status code: %d", res.StatusCode)
}
body, err := io.ReadAll(res.Body)
if err != nil {
return "", err
}
var payload map[string]string
err = json.Unmarshal(body, &payload)
if err != nil {
return "", err
}
accessToken, ok := payload["access_token"]
if !ok {
return "", fmt.Errorf("unable to get token")
}
return accessToken, nil
}
type refreshTokenFetcher func(aadAccessToken, tenantID, registryURL string) (string, error)
func fetchACRRefreshToken(aadAccessToken, tenantID, registryURL string) (string, error) {
// https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview
// https://docs.microsoft.com/en-us/azure/container-registry/container-registry-authentication?tabs=azure-cli
formData := url.Values{
"grant_type": {"access_token"},
"service": {registryURL},
"tenant": {tenantID},
"access_token": {aadAccessToken},
}
res, err := http.PostForm(fmt.Sprintf("https://%s/oauth2/exchange", registryURL), formData)
if err != nil {
return "", err
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return "", fmt.Errorf("count not generate refresh token, unexpected status code %d, expected %d", res.StatusCode, http.StatusOK)
}
body, err := io.ReadAll(res.Body)
if err != nil {
return "", err
}
var payload map[string]string
err = json.Unmarshal(body, &payload)
if err != nil {
return "", err
}
refreshToken, ok := payload["refresh_token"]
if !ok {
return "", fmt.Errorf("unable to get token")
}
return refreshToken, nil
}
func accessTokenForWorkloadIdentity(ctx context.Context, crClient client.Client, kubeClient kcorev1.CoreV1Interface, envType v1beta1.AzureEnvironmentType, serviceAccountRef *smmeta.ServiceAccountSelector, namespace string) (string, error) {
aadEndpoint := keyvault.AadEndpointForType(envType)
scope := keyvault.ServiceManagementEndpointForType(envType)
// if no serviceAccountRef was provided
// we expect certain env vars to be present.
// They are set by the azure workload identity webhook.
if serviceAccountRef == nil {
clientID := os.Getenv("AZURE_CLIENT_ID")
tenantID := os.Getenv("AZURE_TENANT_ID")
tokenFilePath := os.Getenv("AZURE_FEDERATED_TOKEN_FILE")
if clientID == "" || tenantID == "" || tokenFilePath == "" {
return "", errors.New("missing environment variables")
}
token, err := os.ReadFile(tokenFilePath)
if err != nil {
return "", fmt.Errorf("unable to read token file %s: %w", tokenFilePath, err)
}
tp, err := keyvault.NewTokenProvider(ctx, string(token), clientID, tenantID, aadEndpoint, scope)
if err != nil {
return "", err
}
return tp.OAuthToken(), nil
}
var sa corev1.ServiceAccount
err := crClient.Get(ctx, types.NamespacedName{
Name: serviceAccountRef.Name,
Namespace: namespace,
}, &sa)
if err != nil {
return "", err
}
clientID, ok := sa.ObjectMeta.Annotations[keyvault.AnnotationClientID]
if !ok {
return "", fmt.Errorf("service account is missing annoation: %s", keyvault.AnnotationClientID)
}
tenantID, ok := sa.ObjectMeta.Annotations[keyvault.AnnotationTenantID]
if !ok {
return "", fmt.Errorf("service account is missing annotation: %s", keyvault.AnnotationTenantID)
}
audiences := []string{keyvault.AzureDefaultAudience}
if len(serviceAccountRef.Audiences) > 0 {
audiences = append(audiences, serviceAccountRef.Audiences...)
}
token, err := keyvault.FetchSAToken(ctx, namespace, serviceAccountRef.Name, audiences, kubeClient)
if err != nil {
return "", err
}
tp, err := keyvault.NewTokenProvider(ctx, token, clientID, tenantID, aadEndpoint, scope)
if err != nil {
return "", err
}
return tp.OAuthToken(), nil
}
func accessTokenForManagedIdentity(ctx context.Context, envType v1beta1.AzureEnvironmentType, identityID string) (string, error) {
// handle workload identity
creds, err := azidentity.NewManagedIdentityCredential(
&azidentity.ManagedIdentityCredentialOptions{
ID: azidentity.ResourceID(identityID),
},
)
if err != nil {
return "", err
}
aud := audienceForType(envType)
accessToken, err := creds.GetToken(ctx, policy.TokenRequestOptions{
Scopes: []string{aud},
})
if err != nil {
return "", err
}
return accessToken.Token, nil
}
func (g *Generator) accessTokenForServicePrincipal(ctx context.Context, crClient client.Client, namespace string, envType v1beta1.AzureEnvironmentType, tenantID string, idRef, secretRef smmeta.SecretKeySelector) (string, error) {
cid, err := secretKeyRef(ctx, crClient, namespace, idRef)
if err != nil {
return "", err
}
csec, err := secretKeyRef(ctx, crClient, namespace, secretRef)
if err != nil {
return "", err
}
aadEndpoint := keyvault.AadEndpointForType(envType)
p := azidentity.ClientSecretCredentialOptions{}
p.Cloud.ActiveDirectoryAuthorityHost = aadEndpoint
creds, err := g.clientSecretCreds(
tenantID,
cid,
csec,
&p)
if err != nil {
return "", err
}
aud := audienceForType(envType)
accessToken, err := creds.GetToken(ctx, policy.TokenRequestOptions{
Scopes: []string{aud},
})
if err != nil {
return "", err
}
return accessToken.Token, nil
}
// secretKeyRef fetches a secret key.
func secretKeyRef(ctx context.Context, crClient client.Client, namespace string, secretRef smmeta.SecretKeySelector) (string, error) {
var secret corev1.Secret
ref := types.NamespacedName{
Namespace: namespace,
Name: secretRef.Name,
}
err := crClient.Get(ctx, ref, &secret)
if err != nil {
return "", fmt.Errorf("unable to find namespace=%q secret=%q %w", ref.Namespace, ref.Name, err)
}
keyBytes, ok := secret.Data[secretRef.Key]
if !ok {
return "", fmt.Errorf("unable to find key=%q secret=%q namespace=%q", secretRef.Key, secretRef.Name, namespace)
}
value := strings.TrimSpace(string(keyBytes))
return value, nil
}
func audienceForType(t v1beta1.AzureEnvironmentType) string {
suffix := ".default"
switch t {
case v1beta1.AzureEnvironmentChinaCloud:
return azure.ChinaCloud.TokenAudience + suffix
case v1beta1.AzureEnvironmentGermanCloud:
return azure.GermanCloud.TokenAudience + suffix
case v1beta1.AzureEnvironmentUSGovernmentCloud:
return azure.USGovernmentCloud.TokenAudience + suffix
case v1beta1.AzureEnvironmentPublicCloud, "":
return azure.PublicCloud.TokenAudience + suffix
}
return azure.PublicCloud.TokenAudience + suffix
}
func parseSpec(data []byte) (*genv1alpha1.ACRAccessToken, error) {
var spec genv1alpha1.ACRAccessToken
err := yaml.Unmarshal(data, &spec)
return &spec, err
}
func init() {
genv1alpha1.Register(genv1alpha1.ACRAccessTokenKind, &Generator{})
}