Bridge azure properties to spring starter to authenticate #5
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.spring; | ||
|
|
||
| import com.azure.spring.autoconfigure.unity.CredentialProperties; | ||
| import com.azure.spring.autoconfigure.unity.EnvironmentProperties; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * An abstract implementation to provide all credential related properties based on properties subclass. | ||
| */ | ||
| public abstract class AbstractMappingCredentialPropertiesProvider implements MappingCredentialPropertiesProvider { | ||
|
|
||
| CredentialProperties credentialProperties; | ||
| EnvironmentProperties environment; | ||
|
|
||
| @Override | ||
| public void mapAzureProperties( | ||
| CredentialProperties credentialProperties, | ||
| EnvironmentProperties environment) { | ||
| this.credentialProperties = credentialProperties; | ||
| this.environment = environment; | ||
| } | ||
|
|
||
| @Override | ||
| public String getTenantId() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getTenantId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getClientId() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getClientId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getClientSecret() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getClientId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getClientCertificatePath() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getClientId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getUsername() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getClientId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getPassword() { | ||
| return Optional.ofNullable(credentialProperties).map(CredentialProperties::getClientId).orElse(null); | ||
| } | ||
|
|
||
| @Override | ||
| public String getAuthorityHost() { | ||
| return Optional.ofNullable(environment) | ||
| .map(EnvironmentProperties::getAuthorityHost).orElse(null); | ||
| } | ||
| } | ||
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,19 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.spring; | ||
|
|
||
| import com.azure.core.credential.TokenCredential; | ||
| import com.azure.spring.autoconfigure.unity.CredentialProperties; | ||
| import com.azure.spring.autoconfigure.unity.EnvironmentProperties; | ||
| import com.azure.spring.identity.CredentialPropertiesProvider; | ||
|
|
||
| /** | ||
| * An interface to provide all credential related properties based on the properties subclass. | ||
| */ | ||
| public interface MappingCredentialPropertiesProvider extends CredentialPropertiesProvider { | ||
|
|
||
| void mapAzureProperties(CredentialProperties credentialProperties, EnvironmentProperties environment); | ||
|
|
||
| TokenCredential mappingTokenCredential(); | ||
| } |
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 |
|---|---|---|
|
|
@@ -4,21 +4,26 @@ | |
| package com.azure.spring.autoconfigure.cosmos; | ||
|
|
||
| import com.azure.core.credential.AzureKeyCredential; | ||
| import com.azure.core.credential.TokenCredential; | ||
| import com.azure.cosmos.ConnectionMode; | ||
| import com.azure.cosmos.CosmosAsyncClient; | ||
| import com.azure.cosmos.CosmosClientBuilder; | ||
| import com.azure.spring.MappingCredentialPropertiesProvider; | ||
| import com.azure.spring.autoconfigure.unity.identity.AzureDefaultTokenCredentialAutoConfiguration; | ||
| import com.azure.spring.data.cosmos.config.AbstractCosmosConfiguration; | ||
| import com.azure.spring.data.cosmos.config.CosmosConfig; | ||
| import com.azure.spring.data.cosmos.core.CosmosTemplate; | ||
| import org.springframework.beans.factory.ObjectProvider; | ||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnResource; | ||
| import org.springframework.boot.context.properties.EnableConfigurationProperties; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * Auto Configure Cosmos properties and connection policy. | ||
|
|
@@ -27,15 +32,12 @@ | |
| @ConditionalOnClass({ CosmosAsyncClient.class, CosmosTemplate.class }) | ||
| @ConditionalOnResource(resources = "classpath:cosmos.enable.config") | ||
| @EnableConfigurationProperties(CosmosProperties.class) | ||
| @AutoConfigureAfter(AzureDefaultTokenCredentialAutoConfiguration.class) | ||
| public class CosmosAutoConfiguration extends AbstractCosmosConfiguration { | ||
| private final CosmosProperties cosmosProperties; | ||
|
|
||
| public CosmosAutoConfiguration(CosmosProperties cosmosProperties) { | ||
| this.cosmosProperties = cosmosProperties; | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -44,20 +46,44 @@ protected String getDatabaseName() { | |
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
|
There was a problem hiding this comment. Do we really need this to be a bean? There was a problem hiding this comment. I mean the source of this key could only be the CosmosProperties. There was a problem hiding this comment. For @saragluna, we need to check the key rotation logic here. |
||
| public AzureKeyCredential azureKeyCredential() { | ||
| return Optional.ofNullable(cosmosProperties.getKey()) | ||
| .filter(StringUtils::hasText) | ||
| .map(AzureKeyCredential::new) | ||
| .orElse(null); | ||
|
|
||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean | ||
| public CosmosClientBuilder cosmosClientBuilder( | ||
| ObjectProvider<AzureKeyCredential> azureKeyCredentials, | ||
| ObjectProvider<MappingCredentialPropertiesProvider> mappingPropertiesProviders, | ||
| ObjectProvider<TokenCredential> defaultTokenCredentials) { | ||
| CosmosClientBuilder cosmosClientBuilder = new CosmosClientBuilder() | ||
| .consistencyLevel(cosmosProperties.getConsistencyLevel()) | ||
| .endpoint(cosmosProperties.getUri()); | ||
| if (ConnectionMode.GATEWAY == cosmosProperties.getConnectionMode()) { | ||
| cosmosClientBuilder.gatewayMode(); | ||
| } | ||
| AzureKeyCredential azureKeyCredential = azureKeyCredentials.getIfAvailable(); | ||
| if (azureKeyCredential != null) { | ||
|
There was a problem hiding this comment. What will happen if we set both AzureKeyCredential and TokenCredential in an Azure SDK builder? |
||
| return cosmosClientBuilder.credential(azureKeyCredential); | ||
| } | ||
|
|
||
| MappingCredentialPropertiesProvider propertiesProvider = mappingPropertiesProviders.orderedStream() | ||
|
There was a problem hiding this comment. How about using this EnvironemtCredential and the Azure Default Token Credential to construct a chained token credential? |
||
| .findFirst() | ||
| .orElse(null); | ||
| if (propertiesProvider != null) { | ||
| return cosmosClientBuilder.credential(propertiesProvider.mappingTokenCredential()); | ||
| } | ||
|
|
||
| TokenCredential defaultTokenCredential = defaultTokenCredentials.orderedStream().findFirst().orElse(null); | ||
| if (defaultTokenCredential != null) { | ||
| return cosmosClientBuilder.credential(defaultTokenCredential); | ||
| } | ||
|
|
||
| throw new IllegalStateException("Not found any credential properties configured."); | ||
| } | ||
|
|
||
| @Override | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| package com.azure.spring.autoconfigure.unity; | ||
|
|
||
| public interface SpringAzureProperties { | ||
|
There was a problem hiding this comment. Per discussion, maybe we could remove this now. |
||
| } | ||
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,31 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.spring.autoconfigure.unity.identity; | ||
|
|
||
| import com.azure.core.credential.TokenCredential; | ||
| import com.azure.spring.AbstractMappingCredentialPropertiesProvider; | ||
| import com.azure.spring.autoconfigure.unity.AzureProperties; | ||
| import com.azure.spring.identity.SpringEnvironmentCredentialBuilder; | ||
| import org.springframework.core.Ordered; | ||
|
|
||
| public class SpringMappingCredentialPropertiesProvider extends AbstractMappingCredentialPropertiesProvider implements Ordered { | ||
|
|
||
| public SpringMappingCredentialPropertiesProvider(AzureProperties azureProperties) { | ||
| if (azureProperties != null) { | ||
| mapAzureProperties(azureProperties.getCredential(), azureProperties.getEnvironment()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public int getOrder() { | ||
| return Ordered.LOWEST_PRECEDENCE; | ||
| } | ||
|
|
||
| @Override | ||
| public TokenCredential mappingTokenCredential() { | ||
| SpringEnvironmentCredentialBuilder mapEnvironmentCredentialBuilder = | ||
| new SpringEnvironmentCredentialBuilder().credentialPropertiesProvider(this); | ||
| return mapEnvironmentCredentialBuilder.build(); | ||
| } | ||
| } |
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.
Personally I don't like this code style.