Skip to content

Commit

Permalink
Enable Locator applications bootstrapped with SDG to be configured wi…
Browse files Browse the repository at this point in the history
…th Security (Auth) using @EnableSecurity.

Closes spring-projects#621.
  • Loading branch information
jxblum committed Aug 30, 2022
1 parent fa4d247 commit 6f40c1b
Show file tree
Hide file tree
Showing 21 changed files with 1,065 additions and 310 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,17 @@ protected ListableBeanFactory getListableBeanFactory() {
@Bean
public BeanFactoryPostProcessor shiroGemFireBeanFactoryPostProcessor() {

return configurableListableBeanFactory ->
SpringExtensions.addDependsOn(configurableListableBeanFactory.getBeanDefinition("gemfireCache"),
"shiroSecurityManager");
return configurableListableBeanFactory -> {

if (configurableListableBeanFactory.containsBean("gemfireCache")) {
SpringExtensions.addDependsOn(configurableListableBeanFactory.getBeanDefinition("gemfireCache"),
"shiroSecurityManager");
}
else if (configurableListableBeanFactory.containsBean("locatorApplication")) {
SpringExtensions.addDependsOn(configurableListableBeanFactory.getBeanDefinition("locatorApplication"),
"shiroSecurityManager");
}
};
}

/**
Expand Down Expand Up @@ -251,9 +259,6 @@ private boolean isEnabled(Environment environment) {
return environment.getProperty(SPRING_DATA_GEMFIRE_SECURITY_SHIRO_ENABLED, Boolean.class, true);
}

/**
* @inheritDoc
*/
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
return isEnabled(context.getEnvironment()) && isApacheShiroPresent(context);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
/*
* Copyright 2022 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 org.springframework.data.gemfire.config.annotation;

import java.lang.annotation.Annotation;
import java.util.function.Supplier;

import org.apache.shiro.util.Assert;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportAware;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport;
import org.springframework.data.gemfire.config.annotation.support.Authentication;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;

/**
* Spring {@link Configuration} class used to configure and register an {@link Authentication} object
* based on security (auth) configuration metadata supplied in the {@link EnableSecurity} annotation.
*
* @author John Blum
* @see java.lang.annotation.Annotation
* @see org.springframework.beans.factory.config.BeanDefinition
* @see org.springframework.beans.factory.support.BeanDefinitionBuilder
* @see org.springframework.beans.factory.support.BeanDefinitionRegistry
* @see org.springframework.beans.factory.support.BeanNameGenerator
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.ImportAware
* @see org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport
* @see org.springframework.data.gemfire.config.annotation.support.Authentication
* @since 1.0.0
*/
@Configuration
public class AuthenticationBeanConfiguration extends AbstractAnnotationConfigSupport implements ImportAware {

private static final char[] EMPTY_CHAR_ARRAY = {};

private String username;
private String password;

@Override
protected Class<? extends Annotation> getAnnotationType() {
return EnableSecurity.class;
}

protected void setUsername(@Nullable String username) {
this.username = username;
}

private @Nullable String getUsername() {
return this.username;
}

protected void setPassword(@Nullable String password) {
this.password = password;
}

private @Nullable String getPassword() {
return this.password;
}

@Override
public void setImportMetadata(@NonNull AnnotationMetadata importMetadata) {

if (isAnnotationPresent(importMetadata)) {

AnnotationAttributes enableSecurityAttributes = getAnnotationAttributes(importMetadata);

setUsername(resolveProperty(securityProperty("username"), String.class,
enableSecurityAttributes.getString("securityUsername")));

setPassword(resolveProperty(securityProperty("password"), String.class,
enableSecurityAttributes.getString("securityPassword")));
}
}

@Bean
@SuppressWarnings("unused")
public @NonNull Authentication<String, String> springDataGeodeAuthentication() {
return SpringDataGeodeAuthentication.from(this::getUsername, this::getPassword);
}

private void registerAuthenticationBean(@NonNull BeanDefinitionRegistry registry,
@NonNull BeanNameGenerator beanNameGenerator) {

if (isAuthenticationCredentialsSet(getUsername(), nullSafeToCharArray(getPassword()))) {

BeanDefinition authenticationBean =
BeanDefinitionBuilder.rootBeanDefinition(SpringDataGeodeAuthentication.class)
.addConstructorArgValue(getUsername())
.addConstructorArgValue(getPassword())
.setRole(BeanDefinition.ROLE_INFRASTRUCTURE)
.getBeanDefinition();

String beanName = beanNameGenerator.generateBeanName(authenticationBean, registry);

registry.registerBeanDefinition(beanName, authenticationBean);
}
}

protected boolean isAuthenticationCredentialsSet(String username, char[] password) {
return StringUtils.hasText(username) && nullSafeCharArray(password).length > 0;
}

private @NonNull char[] nullSafeCharArray(@Nullable char[] array) {
return array != null ? array : EMPTY_CHAR_ARRAY;
}

private @NonNull char[] nullSafeToCharArray(@Nullable String value) {
return value != null ? value.trim().toCharArray() : EMPTY_CHAR_ARRAY;
}

protected static class SpringDataGeodeAuthentication implements Authentication<String, String> {

public static @NonNull SpringDataGeodeAuthentication from(@NonNull Supplier<String> username,
@NonNull Supplier<String> password) {

return new SpringDataGeodeAuthentication(username, password);
}

private final Supplier<String> username;
private final Supplier<String> password;

protected SpringDataGeodeAuthentication(@NonNull Supplier<String> username, @NonNull Supplier<String> password) {
this.username = require(username, "Username [%s] is required", username);
this.password = require(password, "Password [%s] is required", password);
}

private <T> T require(T target, String message, Object... arguments) {
Assert.notNull(target, String.format(message, arguments));
return target;
}

@Override
public boolean isRequested() {
return StringUtils.hasText(getPrincipal()) && StringUtils.hasText(getCredentials());
}

@Override
public @NonNull String getPrincipal() {
return this.username.get();
}

@Override
public @NonNull String getCredentials() {
return this.password.get();
}

@Override
public String toString() {
return getPrincipal();
}
}
}
Loading

0 comments on commit 6f40c1b

Please # to comment.