Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix incompatibility between workload identity and managed identity auth #280

Merged
merged 6 commits into from
Feb 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions wrappers/azurekeyvault/azurekeyvault.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"net/http"
"os"
"strings"
"sync"
"sync/atomic"
"time"

Expand All @@ -34,6 +35,7 @@ const (

EnvAzureKeyVaultWrapperKeyName = "AZUREKEYVAULT_WRAPPER_KEY_NAME"
EnvVaultAzureKeyVaultKeyName = "VAULT_AZUREKEYVAULT_KEY_NAME"
EnvAzureClientId = "AZURE_CLIENT_ID"
)

// Wrapper is an Wrapper that uses Azure Key Vault
Expand Down Expand Up @@ -94,8 +96,8 @@ func (v *Wrapper) SetConfig(ctx context.Context, opt ...wrapping.Option) (*wrapp
}

switch {
case os.Getenv("AZURE_CLIENT_ID") != "" && !opts.withDisallowEnvVars:
v.clientID = os.Getenv("AZURE_CLIENT_ID")
case os.Getenv(EnvAzureClientId) != "" && !opts.withDisallowEnvVars:
v.clientID = os.Getenv(EnvAzureClientId)
case opts.withClientId != "":
v.clientID = opts.withClientId
}
Expand Down Expand Up @@ -287,6 +289,8 @@ func (v *Wrapper) buildBaseURL() string {
return fmt.Sprintf("https://%s.%s/", v.vaultName, v.environment.KeyVaultDNSSuffix)
}

var managedClientIdLock sync.Mutex

func (v *Wrapper) getKeyVaultClient(withCertPool *x509.CertPool) (*azkeys.Client, error) {
var err error
var cred azcore.TokenCredential
Expand All @@ -299,14 +303,28 @@ func (v *Wrapper) getKeyVaultClient(withCertPool *x509.CertPool) (*azkeys.Client
return nil, fmt.Errorf("failed to get client secret credentials %w", err)
}
case v.clientID != "":
// Try a managed service credential with a specified client id
clientID := azidentity.ClientID(v.clientID)
cred, err = azidentity.NewManagedIdentityCredential(&azidentity.ManagedIdentityCredentialOptions{
ID: clientID,
})
// Some hoops to jump through to make sure two wrappers being setup at the same time don't step on the
// env var
managedClientIdLock.Lock()
oldVal, found := os.LookupEnv(EnvAzureClientId)
unlock := func() {
if found {
os.Setenv(EnvAzureClientId, oldVal)
} else {
os.Unsetenv(EnvAzureClientId)
}
managedClientIdLock.Unlock()
}

// This could be a managed identity auth, so supply the default credential provider with clientId and let it
// figure it out. Sort of a hack, but Azure's library doesn't allow us to specify clientID as an option.
os.Setenv(EnvAzureClientId, v.clientID)
cred, err = azidentity.NewDefaultAzureCredential(nil)
if err != nil {
return nil, fmt.Errorf("failed to get managed identity credentials: %w", err)
unlock()
return nil, fmt.Errorf("failed to acquire managed identity credentials %w", err)
}
unlock()
// By default let Azure select existing credentials
default:
cred, err = azidentity.NewDefaultAzureCredential(nil)
Expand Down
Loading