-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Uses a ConfigDataLocationResolver to configure authorization intercep…
…tor (#399)
- Loading branch information
Showing
16 changed files
with
451 additions
and
457 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
75 changes: 0 additions & 75 deletions
75
...io/pivotal/spring/cloud/config/client/ConfigClientOAuth2BootstrapRegistryInitializer.java
This file was deleted.
Oops, something went wrong.
149 changes: 149 additions & 0 deletions
149
...a/io/pivotal/spring/cloud/config/client/ConfigClientOAuth2ConfigDataLocationResolver.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,149 @@ | ||
| /* | ||
| * Copyright 2023-2024 the original author or 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.pivotal.spring.cloud.config.client; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.springframework.boot.BootstrapRegistry; | ||
| import org.springframework.boot.context.config.*; | ||
| import org.springframework.boot.logging.DeferredLogFactory; | ||
| import org.springframework.cloud.config.client.ConfigClientProperties; | ||
| import org.springframework.cloud.config.client.ConfigClientRequestTemplateFactory; | ||
| import org.springframework.cloud.config.client.ConfigServerConfigDataLocationResolver; | ||
| import org.springframework.cloud.config.client.ConfigServerConfigDataResource; | ||
| import org.springframework.core.Ordered; | ||
| import org.springframework.security.oauth2.client.registration.ClientRegistration; | ||
| import org.springframework.security.oauth2.core.AuthorizationGrantType; | ||
| import org.springframework.web.client.RestTemplate; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Using oauth2 properties to configure an authorization interceptor for the | ||
| * <code>RestTemplate</code> that calls config server. | ||
| * <p> | ||
| * Note: Despite implementing {@link ConfigDataLocationResolver}, this class does not | ||
| * resolve any location. It only configures and registers the | ||
| * {@link ConfigClientRequestTemplateFactory} which later will be used by | ||
| * {@link ConfigServerConfigDataLocationResolver} to create <code>RestTemplate</code> for | ||
| * calling config server. | ||
| * <p> | ||
| * Finally, it registers the <code>RestTemplate</code> bean to be consumed by | ||
| * {@link ConfigResourceClientAutoConfiguration} and | ||
| * {@link VaultTokenRenewalAutoConfiguration} after application startup. | ||
| */ | ||
| public class ConfigClientOAuth2ConfigDataLocationResolver | ||
| implements ConfigDataLocationResolver<ConfigServerConfigDataResource>, Ordered { | ||
|
|
||
| private final Log log; | ||
|
|
||
| public ConfigClientOAuth2ConfigDataLocationResolver(DeferredLogFactory factory) { | ||
| this.log = factory.getLog(ConfigClientOAuth2ConfigDataLocationResolver.class); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isResolvable(ConfigDataLocationResolverContext resolverContext, ConfigDataLocation location) { | ||
| if (!location.hasPrefix(ConfigServerConfigDataLocationResolver.PREFIX)) { | ||
| return false; | ||
| } | ||
|
|
||
| var binder = resolverContext.getBinder(); | ||
| var isConfigEnabled = binder.bind(ConfigClientProperties.PREFIX + ".enabled", Boolean.class).orElse(true); | ||
| if (!isConfigEnabled) { | ||
| return false; | ||
| } | ||
|
|
||
| var oAuth2Properties = binder.bind(ConfigClientOAuth2Properties.PREFIX, ConfigClientOAuth2Properties.class) | ||
| .orElse(null); | ||
| if (oAuth2Properties == null) { | ||
| log.warn("Config Client oauth2 properties are missing. Skipping the auth interceptor configuration"); | ||
| return false; | ||
| } | ||
|
|
||
| var bootstrapContext = resolverContext.getBootstrapContext(); | ||
|
|
||
| // Register the oauth2 properties | ||
| bootstrapContext.registerIfAbsent(ConfigClientOAuth2Properties.class, | ||
| BootstrapRegistry.InstanceSupplier.of(oAuth2Properties).withScope(BootstrapRegistry.Scope.PROTOTYPE)); | ||
|
|
||
| // Register the custom factory with oauth2 interceptor. | ||
| bootstrapContext.registerIfAbsent(ConfigClientRequestTemplateFactory.class, | ||
| context -> new ConfigClientOAuth2RequestTemplateFactory(this.log, | ||
| context.get(ConfigClientProperties.class), oAuth2Properties)); | ||
|
|
||
| bootstrapContext.addCloseListener(event -> { | ||
| var beanFactory = event.getApplicationContext().getBeanFactory(); | ||
|
|
||
| // Add the RestTemplate as bean, once the startup is finished. | ||
| beanFactory.registerSingleton("configClientRestTemplate", | ||
| event.getBootstrapContext().get(RestTemplate.class)); | ||
|
|
||
| // Add the OAuth2 Properties as bean, once the startup is finished. | ||
| beanFactory.registerSingleton("configClientOAuth2Properties", | ||
| event.getBootstrapContext().get(ConfigClientOAuth2Properties.class)); | ||
| }); | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public List<ConfigServerConfigDataResource> resolve(ConfigDataLocationResolverContext context, | ||
| ConfigDataLocation location) | ||
| throws ConfigDataLocationNotFoundException, ConfigDataResourceNotFoundException { | ||
| throw new IllegalStateException("Unexpected call. This resolver should not resolve any location"); | ||
| } | ||
|
|
||
| @Override | ||
| public List<ConfigServerConfigDataResource> resolveProfileSpecific(ConfigDataLocationResolverContext context, | ||
| ConfigDataLocation location, Profiles profiles) throws ConfigDataLocationNotFoundException { | ||
| throw new IllegalStateException("Unexpected call. This resolver should not resolve any location"); | ||
| } | ||
|
|
||
| /** | ||
| * It should be registered before {@link ConfigServerConfigDataLocationResolver}. See | ||
| * {@link ConfigServerConfigDataLocationResolver#getOrder()} | ||
| */ | ||
| @Override | ||
| public int getOrder() { | ||
| return -2; | ||
| } | ||
|
|
||
| private static class ConfigClientOAuth2RequestTemplateFactory extends ConfigClientRequestTemplateFactory { | ||
|
|
||
| private final ClientRegistration clientRegistration; | ||
|
|
||
| public ConfigClientOAuth2RequestTemplateFactory(Log log, ConfigClientProperties clientProperties, | ||
| ConfigClientOAuth2Properties oAuth2Properties) { | ||
| super(log, clientProperties); | ||
|
|
||
| this.clientRegistration = ClientRegistration.withRegistrationId("config-client") | ||
| .clientId(oAuth2Properties.getClientId()) | ||
| .clientSecret(oAuth2Properties.getClientSecret()) | ||
| .tokenUri(oAuth2Properties.getAccessTokenUri()) | ||
| .scope(oAuth2Properties.getScope()) | ||
| .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS) | ||
| .build(); | ||
| } | ||
|
|
||
| @Override | ||
| public RestTemplate create() { | ||
| var restTemplate = super.create(); | ||
| restTemplate.getInterceptors().add(new OAuth2AuthorizedClientHttpRequestInterceptor(clientRegistration)); | ||
| return restTemplate; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.