generated from micronaut-projects/micronaut-project-template
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for Azure KeyVault (#347)
* Add keyvault feature Co-authored-by: Nemanja Mikic <nemanja.mikic@oracle.com>
- Loading branch information
1 parent
1a9e169
commit a6924d9
Showing
19 changed files
with
598 additions
and
0 deletions.
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,30 @@ | ||
| plugins { | ||
| id 'io.micronaut.build.internal.azure-module' | ||
| } | ||
|
|
||
| micronautBuild { | ||
| // new module, so no binary check | ||
| binaryCompatibility { | ||
| enabled.set(false) | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| annotationProcessor(libs.micronaut.inject.java) | ||
| implementation platform(project(":azure-bom")) | ||
|
|
||
| api(libs.micronaut.inject) | ||
| api(libs.micronaut.http.server) | ||
| api project(":azure-sdk") | ||
| api(libs.azure.identity) | ||
| api(libs.azure.security.keyvault.secrets) | ||
|
|
||
| implementation(libs.micronaut.discovery.client) | ||
| implementation(libs.micronaut.reactor) | ||
|
|
||
| testAnnotationProcessor(libs.micronaut.inject.java) | ||
| testCompileOnly(libs.micronaut.inject.groovy) | ||
| testImplementation(libs.micronaut.runtime) | ||
| testImplementation(libs.micronaut.http.client) | ||
| } | ||
|
|
135 changes: 135 additions & 0 deletions
135
...manager/src/main/java/io/micronaut/azure/secretmanager/AzureVaultConfigurationClient.java
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,135 @@ | ||
| /* | ||
| * Copyright 2017-2020 original 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 | ||
| * | ||
| * https://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 io.micronaut.azure.secretmanager; | ||
|
|
||
| import com.azure.security.keyvault.secrets.SecretClient; | ||
| import com.azure.security.keyvault.secrets.models.KeyVaultSecret; | ||
| import io.micronaut.azure.secretmanager.client.SecretKeyVaultClient; | ||
| import io.micronaut.azure.secretmanager.configuration.AzureKeyVaultConfigurationProperties; | ||
| import io.micronaut.context.annotation.BootstrapContextCompatible; | ||
| import io.micronaut.context.annotation.Requires; | ||
| import io.micronaut.context.env.Environment; | ||
| import io.micronaut.context.env.PropertySource; | ||
| import io.micronaut.core.annotation.Nullable; | ||
| import io.micronaut.core.util.StringUtils; | ||
| import io.micronaut.discovery.config.ConfigurationClient; | ||
| import io.micronaut.scheduling.TaskExecutors; | ||
| import jakarta.inject.Named; | ||
| import jakarta.inject.Singleton; | ||
| import org.reactivestreams.Publisher; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import reactor.core.publisher.Flux; | ||
| import reactor.core.scheduler.Scheduler; | ||
| import reactor.core.scheduler.Schedulers; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ExecutorService; | ||
|
|
||
| /** | ||
| * Distributed configuration client implementation that fetches application secret values from Azure keyvalut. | ||
| * @author Nemanja Mikic | ||
| */ | ||
| @Singleton | ||
| @Requires(beans = SecretClient.class) | ||
| @BootstrapContextCompatible | ||
| public class AzureVaultConfigurationClient implements ConfigurationClient { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(AzureVaultConfigurationClient.class); | ||
|
|
||
| private final AzureKeyVaultConfigurationProperties azureKeyVaultConfigurationProperties; | ||
| private final ExecutorService executorService; | ||
| private final SecretKeyVaultClient secretClient; | ||
| private final String vaultUrl; | ||
|
|
||
| /** | ||
| * Default Constructor. | ||
| * | ||
| * @param azureKeyVaultConfigurationProperties Azure Secret Vault Client Configuration | ||
| * @param executorService Executor Service | ||
| * @param secretClient The secrets client | ||
| */ | ||
| public AzureVaultConfigurationClient( | ||
| AzureKeyVaultConfigurationProperties azureKeyVaultConfigurationProperties, | ||
| @Named(TaskExecutors.IO) @Nullable ExecutorService executorService, | ||
| SecretKeyVaultClient secretClient) { | ||
| this.azureKeyVaultConfigurationProperties = azureKeyVaultConfigurationProperties; | ||
| this.executorService = executorService; | ||
| this.secretClient = secretClient; | ||
| this.vaultUrl = azureKeyVaultConfigurationProperties.getVaultURL(); | ||
| } | ||
|
|
||
| @Override | ||
| public Publisher<PropertySource> getPropertySources(Environment environment) { | ||
|
|
||
| if (StringUtils.isEmpty(vaultUrl)) { | ||
| return Flux.empty(); | ||
| } | ||
|
|
||
| List<Flux<PropertySource>> propertySources = new ArrayList<>(); | ||
| Scheduler scheduler = executorService != null ? Schedulers.fromExecutor(executorService) : null; | ||
|
|
||
| Map<String, Object> secrets = new HashMap<>(); | ||
|
|
||
| int retrieved = 0; | ||
|
|
||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("Retrieving secrets from Azure Secret Vault with URL: {}", azureKeyVaultConfigurationProperties.getVaultURL()); | ||
| } | ||
|
|
||
| for (KeyVaultSecret keyVaultSecret : secretClient.listSecrets()) { | ||
|
|
||
| retrieved += 1; | ||
| secrets.put( | ||
| keyVaultSecret.getName(), | ||
| keyVaultSecret.getValue() | ||
| ); | ||
| secrets.put( | ||
| keyVaultSecret.getName().replace('-', '.'), | ||
| keyVaultSecret.getValue() | ||
| ); | ||
| secrets.put( | ||
| keyVaultSecret.getName().replace('-', '_'), | ||
| keyVaultSecret.getValue() | ||
| ); | ||
| if (LOG.isTraceEnabled()) { | ||
| LOG.trace("Retrieved secret: {}", keyVaultSecret.getName()); | ||
| } | ||
|
|
||
| } | ||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("{} secrets were retrieved from Azure Secret Vault with URL: {}", retrieved, azureKeyVaultConfigurationProperties.getVaultURL()); | ||
| } | ||
|
|
||
| Flux<PropertySource> propertySourceFlowable = Flux.just( | ||
| PropertySource.of(secrets) | ||
| ); | ||
|
|
||
| if (scheduler != null) { | ||
| propertySourceFlowable = propertySourceFlowable.subscribeOn(scheduler); | ||
| } | ||
| propertySources.add(propertySourceFlowable); | ||
| return Flux.merge(propertySources); | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "Retrieves secrets from Azure key vaults"; | ||
| } | ||
| } |
Oops, something went wrong.