Use azidentity instead of ADAL #2748
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,11 +20,15 @@ import ( | |
| "context" | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
|
|
||
| aadpodid "github.com/Azure/aad-pod-identity/pkg/apis/aadpodidentity" | ||
| aadpodv1 "github.com/Azure/aad-pod-identity/pkg/apis/aadpodidentity/v1" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azidentity" | ||
| "github.com/Azure/go-autorest/autorest" | ||
| "github.com/jongio/azidext/go/azidext" | ||
| "github.com/pkg/errors" | ||
| corev1 "k8s.io/api/core/v1" | ||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
|
|
@@ -43,7 +47,7 @@ const azureSecretKey = "clientSecret" | |
|
|
||
| // CredentialsProvider defines the behavior for azure identity based credential providers. | ||
| type CredentialsProvider interface { | ||
| GetAuthorizer(ctx context.Context, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience string) (autorest.Authorizer, error) | ||
| GetClientID() string | ||
| GetClientSecret(ctx context.Context) (string, error) | ||
| GetTenantID() string | ||
|
|
@@ -98,8 +102,8 @@ func NewAzureClusterCredentialsProvider(ctx context.Context, kubeClient client.C | |
| } | ||
|
|
||
| // GetAuthorizer returns an Azure authorizer based on the provided azure identity. It delegates to AzureCredentialsProvider with AzureCluster metadata. | ||
| func (p *AzureClusterCredentialsProvider) GetAuthorizer(ctx context.Context, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience string) (autorest.Authorizer, error) { | ||
| return p.AzureCredentialsProvider.GetAuthorizer(ctx, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience, p.AzureCluster.ObjectMeta) | ||
| } | ||
|
|
||
| // NewManagedControlPlaneCredentialsProvider creates a new ManagedControlPlaneCredentialsProvider from the supplied inputs. | ||
|
|
@@ -130,50 +134,61 @@ func NewManagedControlPlaneCredentialsProvider(ctx context.Context, kubeClient c | |
| } | ||
|
|
||
| // GetAuthorizer returns an Azure authorizer based on the provided azure identity. It delegates to AzureCredentialsProvider with AzureManagedControlPlane metadata. | ||
| func (p *ManagedControlPlaneCredentialsProvider) GetAuthorizer(ctx context.Context, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience string) (autorest.Authorizer, error) { | ||
| return p.AzureCredentialsProvider.GetAuthorizer(ctx, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience, p.AzureManagedControlPlane.ObjectMeta) | ||
| } | ||
|
|
||
| // GetAuthorizer returns an Azure authorizer based on the provided azure identity and cluster metadata. | ||
| func (p *AzureCredentialsProvider) GetAuthorizer(ctx context.Context, resourceManagerEndpoint, activeDirectoryEndpoint, tokenAudience string, clusterMeta metav1.ObjectMeta) (autorest.Authorizer, error) { | ||
| var authErr error | ||
| var cred azcore.TokenCredential | ||
|
There was a problem hiding this comment. Any particular reason for declaring these variables explicitly vs using shorthand in the switch case? e.g There was a problem hiding this comment. Yes. If I don't do this then I can't use them on lines https://github.com/kubernetes-sigs/cluster-api-provider-azure/pull/2748/files#diff-b6ab207506064afcbd1d777c1c7296e2953d2653a8843bfb39107af5cf5b0a87R174-R177. The alternative would be to duplicate those lines in each |
||
| switch p.Identity.Spec.Type { | ||
| case infrav1.ServicePrincipal, infrav1.ServicePrincipalCertificate, infrav1.UserAssignedMSI: | ||
| if err := createAzureIdentityWithBindings(ctx, p.Identity, resourceManagerEndpoint, activeDirectoryEndpoint, clusterMeta, p.Client); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| options := azidentity.ManagedIdentityCredentialOptions{ | ||
| ID: azidentity.ClientID(p.Identity.Spec.ClientID), | ||
| } | ||
| cred, authErr = azidentity.NewManagedIdentityCredential(&options) | ||
|
|
||
| case infrav1.ManualServicePrincipal: | ||
| clientSecret, err := p.GetClientSecret(ctx) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "failed to get client secret") | ||
| } | ||
|
|
||
| options := azidentity.ClientSecretCredentialOptions{ | ||
| ClientOptions: azcore.ClientOptions{ | ||
| Cloud: cloud.Configuration{ | ||
| ActiveDirectoryAuthorityHost: activeDirectoryEndpoint, | ||
| Services: map[cloud.ServiceName]cloud.ServiceConfiguration{ | ||
| cloud.ResourceManager: { | ||
| Audience: tokenAudience, | ||
| Endpoint: resourceManagerEndpoint, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| cred, authErr = azidentity.NewClientSecretCredential(p.GetTenantID(), p.Identity.Spec.ClientID, clientSecret, &options) | ||
|
|
||
| default: | ||
| return nil, errors.Errorf("identity type %s not supported", p.Identity.Spec.Type) | ||
| } | ||
|
|
||
| if authErr != nil { | ||
| return nil, errors.Errorf("failed to get token from service principal identity: %v", authErr) | ||
| } | ||
| // We must use TokenAudience for StackCloud, otherwise we get an | ||
| // AADSTS500011 error from the API | ||
| scope := tokenAudience | ||
| if !strings.HasSuffix(scope, "/.default") { | ||
| scope += "/.default" | ||
| } | ||
| authorizer := azidext.NewTokenCredentialAdapter(cred, []string{scope}) | ||
| return authorizer, nil | ||
| } | ||
|
|
||
| // GetClientID returns the Client ID associated with the AzureCredentialsProvider's Identity. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is this repo? it seems that it's in someone's personal GitHub org?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we be following https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/azidentity/MIGRATION.md instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's what I did. See the section https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/azidentity/MIGRATION.md#use-azidentity-credentials-with-older-packages where they recommend jongio's repo for getting an adapter so the new authorizer can work with older SDK clients.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it, thanks for clarifying