Spring/spring-boot-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Spring Boot auto-configuration for Apache Geode Security, and primarily authentication between a client and a server.

Browse Source 
Introduces a basic class template to auto-configure security based on context (e.g. PCF when using PCC) along with some other Conditions identifying certain Apache Geode properties necessitating the need to configure security.
This commit is contained in:
John Blum
2018-04-03 19:23:59 -07:00
parent 29438d9768
commit 64eedc0b10
2 changed files with 177 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
geode-spring-boot-starter/src/main/java/org/springframework/boot/data/geode/autoconfigure/SecurityAutoConfiguration.java Normal file
View File

@@ -0,0 +1,174 @@
/*
* Copyright 2018 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
*
* 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 org.springframework.boot.data.geode.autoconfigure;
import java.util.Optional;
import org.apache.geode.cache.client.ClientCache;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnCloudPlatform;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.cloud.CloudPlatform;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.data.gemfire.client.ClientCacheFactoryBean;
import org.springframework.data.gemfire.config.annotation.EnableSecurity;
import org.springframework.data.gemfire.config.annotation.support.AutoConfiguredAuthenticationInitializer;
import org.springframework.util.Assert;
/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} enabling Apache Geode's Security functionality,
* and specifically Authentication between a client and server using Spring Data Geode Security annotations.
*
* @author John Blum
* @see org.apache.geode.cache.client.ClientCache
* @see org.springframework.boot.data.geode.autoconfigure.ClientCacheAutoConfiguration
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.data.gemfire.client.ClientCacheFactoryBean
* @see org.springframework.data.gemfire.config.annotation.EnableSecurity
* @since 1.0.0
*/
@Configuration
@ConditionalOnClass({ ClientCacheFactoryBean.class, ClientCache.class })
@Conditional(SecurityAutoConfiguration.EnableSecurityCondition.class)
@AutoConfigureBefore(ClientCacheAutoConfiguration.class)
@EnableSecurity
@SuppressWarnings("unused")
public class SecurityAutoConfiguration {
private static final String POOL_LOCATORS_PROPERTY = "spring.data.gemfire.pool.locators";
private static final String SECURITY_USERNAME_PROPERTY =
AutoConfiguredAuthenticationInitializer.SDG_SECURITY_USERNAME_PROPERTY;
private static final String SECURITY_PASSWORD_PROPERTY =
AutoConfiguredAuthenticationInitializer.SDG_SECURITY_PASSWORD_PROPERTY;
private static final String VCAP_PROPERTY_SOURCE_NAME = "vcap";
@Bean
AutoConfiguredSecurityEnvironmentProcessor securityEnvironmentProcessor(Environment environment) {
return AutoConfiguredSecurityEnvironmentProcessor.with(environment);
}
static class AutoConfiguredSecurityEnvironmentProcessor implements InitializingBean {
private final Environment environment;
/**
* Factory method used to construct a new instance of {@link AutoConfiguredSecurityEnvironmentProcessor}
* initialized with the given {@link Environment} from which to extract environment and contextual-based
* meta-data used to configure Apache Geode/Pivotal GemFire client Security (specifically Authentication).
*
* @param environment {@link Environment} to evaluate.
* @return a new {@link AutoConfiguredSecurityEnvironmentProcessor} initialized with
* the given {@link Environment}.
* @throws IllegalArgumentException if {@link Environment} is {@literal null}.
* @see #AutoConfiguredSecurityEnvironmentProcessor(Environment)
* @see org.springframework.core.env.Environment
*/
static AutoConfiguredSecurityEnvironmentProcessor with(Environment environment) {
return new AutoConfiguredSecurityEnvironmentProcessor(environment);
}
/**
* Constructs a new instance of {@link AutoConfiguredSecurityEnvironmentProcessor} initialized with
* the given {@link Environment} from which to extract environment and contextual-based meta-data
* used to configure Apache Geode/Pivotal GemFire client Security (specifically Authentication).
*
* @param environment {@link Environment} to evaluate.
* @throws IllegalArgumentException if {@link Environment} is {@literal null}.
* @see org.springframework.core.env.Environment
*/
AutoConfiguredSecurityEnvironmentProcessor(Environment environment) {
Assert.notNull(environment, "Environment is required");
this.environment = environment;
}
/**
* Returns a reference to the configured {@link Environment}.
*
* @return a reference to the configured {@link Environment}.
* @see org.springframework.core.env.Environment
*/
Environment getEnvironment() {
return this.environment;
}
@Override
public void afterPropertiesSet() throws Exception {
Optional.of(getEnvironment())
.filter(this::securityPropertiesAreNotSet)
.ifPresent(environment -> {
System.setProperty(SECURITY_USERNAME_PROPERTY, resolveUsername(environment));
System.setProperty(SECURITY_PASSWORD_PROPERTY, resolvePassword(environment));
});
}
private boolean securityPropertiesAreSet(Environment environment) {
return environment.containsProperty(SECURITY_USERNAME_PROPERTY)
&& environment.containsProperty(SECURITY_PASSWORD_PROPERTY);
}
private boolean securityPropertiesAreNotSet(Environment environment) {
return !securityPropertiesAreSet(environment);
}
private String resolveUsername(Environment environment) {
return "me";
}
private String resolvePassword(Environment environment) {
return "password";
}
}
static class EnableSecurityCondition extends AnyNestedCondition {
public EnableSecurityCondition() {
super(ConfigurationPhase.PARSE_CONFIGURATION);
}
@ConditionalOnCloudPlatform(CloudPlatform.CLOUD_FOUNDRY)
static class CloudSecurityContextCondition { }
@ConditionalOnProperty({
"spring.data.gemfire.security.username",
"spring.data.gemfire.security.password",
})
static class SpringDataGeodeSecurityContextCondition { }
@ConditionalOnProperty({
"gemfire.security-username",
"gemfire.security-password",
"security-username",
"security-password"
})
static class StandaloneApacheGeodeSecurityContextCondition { }
}
}

4
geode-spring-boot-starter/src/main/resources/META-INF/spring.factories
View File

@@ -4,4 +4,6 @@ org.springframework.boot.data.geode.autoconfigure.ClientCacheAutoConfiguration,\
org.springframework.boot.data.geode.autoconfigure.CachingProviderAutoConfiguration,\
org.springframework.boot.data.geode.autoconfigure.ContinuousQueryAutoConfiguration,\
org.springframework.boot.data.geode.autoconfigure.FunctionExecutionAutoConfiguration,\
org.springframework.boot.data.geode.autoconfigure.RepositoriesAutoConfiguration
org.springframework.boot.data.geode.autoconfigure.RepositoriesAutoConfiguration,\
org.springframework.boot.data.geode.autoconfigure.SecurityAutoConfiguration