Add azure managed identity to azure package in blockstorage #1615
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
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 |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package azure | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/Azure/go-autorest/autorest/adal" | ||
| "github.com/Azure/go-autorest/autorest/azure/auth" | ||
| "github.com/kanisterio/kanister/pkg/blockstorage" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // currently avaialble types: https://docs.microsoft.com/en-us/azure/developer/go/azure-sdk-authorization | ||
| // to be available with azidentity: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity#readme-credential-types | ||
| // determine if the combination of creds are client secret creds | ||
| func isClientCredsAvailable(config map[string]string) bool { | ||
| return (config[blockstorage.AzureTenantID] != "" && | ||
| config[blockstorage.AzureCientID] != "" && | ||
| config[blockstorage.AzureClentSecret] != "") | ||
| } | ||
|
|
||
| // determine if the combination of creds are MSI creds | ||
| func isMSICredsAvailable(config map[string]string) bool { | ||
| return (config[blockstorage.AzureTenantID] == "" && | ||
| config[blockstorage.AzureCientID] != "" && | ||
leuyentran marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| config[blockstorage.AzureClentSecret] == "") | ||
| } | ||
|
|
||
| // Public interface to authenticate with different Azure credentials type | ||
| type AzureAuthenticator interface { | ||
| Authenticate(creds map[string]string) error | ||
| } | ||
|
|
||
| func NewAzureAutheticator(config map[string]string) (AzureAuthenticator, error) { | ||
|
There was a problem hiding this comment. Please add comments for exported methods/structs in this PR. |
||
| switch { | ||
| case isMSICredsAvailable(config): | ||
| return &msiAuthenticator{}, nil | ||
| case isClientCredsAvailable(config): | ||
| return &clientSecretAuthenticator{}, nil | ||
| default: | ||
| return nil, errors.New("Fail to get an authenticator for provided creds combination") | ||
| } | ||
| } | ||
|
|
||
| // authenticate with MSI creds | ||
| type msiAuthenticator struct{} | ||
|
There was a problem hiding this comment. nit: consider renaming to msiAzureAuthenticator |
||
|
|
||
| func (m *msiAuthenticator) Authenticate(creds map[string]string) error { | ||
| // check if MSI endpoint is available | ||
| if !adal.MSIAvailable(context.Background(), nil) { | ||
| return errors.New("MSI endpoint is not supported") | ||
| } | ||
| // create a service principal token | ||
| msiConfig := auth.NewMSIConfig() | ||
| msiConfig.ClientID = creds[blockstorage.AzureCientID] | ||
| spt, err := msiConfig.ServicePrincipalToken() | ||
| if err != nil { | ||
| return errors.Wrap(err, "Failed to create a service principal token") | ||
| } | ||
| // network call to check for token | ||
| err = spt.Refresh() | ||
| if err != nil { | ||
| return errors.Wrap(err, "Failed to refresh token") | ||
| } | ||
| // creds passed authentication | ||
| return nil | ||
|
Comment on lines
+59
to
+65
There was a problem hiding this comment. TIOLI: Consider just There was a problem hiding this comment. The caller, i.e. |
||
| } | ||
|
|
||
| // authenticate with client secret creds | ||
| type clientSecretAuthenticator struct{} | ||
|
There was a problem hiding this comment. nit: consider renaming to clientSecretAzureAuthenitcator. There was a problem hiding this comment. Since the package name is |
||
|
|
||
| func (c *clientSecretAuthenticator) Authenticate(creds map[string]string) error { | ||
| credConfig, err := getCredConfigForAuth(creds) | ||
| if err != nil { | ||
| return errors.Wrap(err, "Failed to get Client Secret config") | ||
| } | ||
| // create a service principal token | ||
| spt, err := credConfig.ServicePrincipalToken() | ||
| if err != nil { | ||
| return errors.Wrap(err, "Failed to create a service principal token") | ||
| } | ||
| // network call to check for token | ||
| err = spt.Refresh() | ||
| if err != nil { | ||
| return errors.Wrap(err, "Failed to refresh token") | ||
| } | ||
| // creds passed authentication | ||
| return nil | ||
| } | ||
|
|
||
| func getCredConfigForAuth(config map[string]string) (auth.ClientCredentialsConfig, error) { | ||
| tenantID, ok := config[blockstorage.AzureTenantID] | ||
| if !ok { | ||
| return auth.ClientCredentialsConfig{}, errors.New("Cannot get tenantID from config") | ||
| } | ||
|
|
||
| clientID, ok := config[blockstorage.AzureCientID] | ||
| if !ok { | ||
| return auth.ClientCredentialsConfig{}, errors.New("Cannot get clientID from config") | ||
| } | ||
|
|
||
| clientSecret, ok := config[blockstorage.AzureClentSecret] | ||
| if !ok { | ||
| return auth.ClientCredentialsConfig{}, errors.New("Cannot get clientSecret from config") | ||
| } | ||
|
|
||
| credConfig := auth.NewClientCredentialsConfig(clientID, clientSecret, tenantID) | ||
| return credConfig, nil | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| // Copyright 2022 The Kanister Authors. | ||
| // | ||
| // 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 azure | ||
|
|
||
| import ( | ||
| "github.com/kanisterio/kanister/pkg/blockstorage" | ||
| . "gopkg.in/check.v1" | ||
| ) | ||
|
|
||
| type AuthSuite struct{} | ||
|
|
||
| var _ = Suite(&AuthSuite{}) | ||
|
|
||
| func (s *AuthSuite) SetUpSuite(c *C) { | ||
| } | ||
|
|
||
| func (s *AuthSuite) TestIsClientCredsvailable(c *C) { | ||
| // success | ||
| config := map[string]string{ | ||
| blockstorage.AzureTenantID: "some-tenant-id", | ||
| blockstorage.AzureCientID: "some-client-id", | ||
| blockstorage.AzureClentSecret: "someclient-secret", | ||
| } | ||
| c.Assert(isClientCredsAvailable(config), Equals, true) | ||
|
|
||
| // remove tenantID | ||
| delete(config, blockstorage.AzureTenantID) | ||
| c.Assert(isClientCredsAvailable(config), Equals, false) | ||
|
|
||
| // remove client secret, only client ID left | ||
| delete(config, blockstorage.AzureClentSecret) | ||
| c.Assert(isClientCredsAvailable(config), Equals, false) | ||
| } | ||
|
|
||
| func (s *AuthSuite) TestIsMSICredsAvailable(c *C) { | ||
| // success | ||
| config := map[string]string{ | ||
| blockstorage.AzureTenantID: "some-tenant-id", | ||
| blockstorage.AzureCientID: "some-client-id", | ||
| blockstorage.AzureClentSecret: "someclient-secret", | ||
| } | ||
| c.Assert(isMSICredsAvailable(config), Equals, false) | ||
|
|
||
| // remove tenantID | ||
| delete(config, blockstorage.AzureTenantID) | ||
| c.Assert(isMSICredsAvailable(config), Equals, false) | ||
|
|
||
| // remove client secret, only client ID left | ||
| delete(config, blockstorage.AzureClentSecret) | ||
| c.Assert(isMSICredsAvailable(config), Equals, true) | ||
| } | ||
|
|
||
| func (s *AuthSuite) TestNewAzureAutheticator(c *C) { | ||
| // successful with client secret creds | ||
| config := map[string]string{ | ||
| blockstorage.AzureTenantID: "some-tenant-id", | ||
| blockstorage.AzureCientID: "some-client-id", | ||
| blockstorage.AzureClentSecret: "some-client-secret", | ||
| } | ||
| authenticator, err := NewAzureAutheticator(config) | ||
| c.Assert(err, IsNil) | ||
| _, ok := authenticator.(*clientSecretAuthenticator) | ||
| c.Assert(ok, Equals, true) | ||
|
|
||
| // successful with msi creds | ||
| config = map[string]string{ | ||
| blockstorage.AzureCientID: "some-client-id", | ||
| } | ||
| authenticator, err = NewAzureAutheticator(config) | ||
| c.Assert(err, IsNil) | ||
| _, ok = authenticator.(*msiAuthenticator) | ||
| c.Assert(ok, Equals, true) | ||
|
|
||
| // unsuccessful with an undefined combo of creds | ||
| config = map[string]string{ | ||
| blockstorage.AzureCientID: "some-client-id", | ||
| blockstorage.AzureClentSecret: "some-client-secret", | ||
| } | ||
| authenticator, err = NewAzureAutheticator(config) | ||
| c.Assert(err, NotNil) | ||
| c.Assert(authenticator, IsNil) | ||
| } |
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
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.
Looks like this package will be deprecated next year. Can we look into using
azidentityinstead?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.
The purpose of interface
Authenticate()is to validate Azure creds as a one-of action. These creds are then passed on to anAuthorizer()that later authenticates and return a token for every Azure API calls that interact with Azure resources.And for
Authorizer(), we are still usingadalindirectly as part ofgithub.com/Azure/go-autorest/autorest/azure/authFurthermore,
azidentityandadaldiffers slightly in their credential definitions and workflows. So I'd prefer not to useazidentityforAuthenticate()andadalforAuthorizer()in case we don't completely understand the nuances in expectations.Instead, I had abstracted out the logics as much as I can, which should make APIs swapping easier during migration :)
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.
Can you create a GH issue to track the migration task for both the
adalandauthpackages? Thanks.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.
#1621 fyi @ihcsim