Avoid UnsupportedOperationEx. with active SecurityManager

Issue: SPR-9970

Author: cbeams

spring-context/src/test/java/org/springframework/context/support/EnvironmentSecurityManagerIntegrationTests.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2002-2013 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.context.support;
+
+import static java.lang.String.format;
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertThat;
+
+import java.security.AccessControlException;
+import java.security.Permission;
+import java.util.Map;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
+import org.springframework.context.annotation.Profile;
+import org.springframework.core.env.AbstractEnvironment;
+import org.springframework.core.env.StandardEnvironmentTests;
+import org.springframework.stereotype.Component;
+
+
+/**
+ * Tests integration between Environment and SecurityManagers. See SPR-9970.
+ *
+ * @author Chris Beams
+ */
+public class EnvironmentSecurityManagerIntegrationTests {
+
+	private SecurityManager originalSecurityManager;
+	private Map<String, String> env;
+
+	@Before
+	public void setUp() {
+		originalSecurityManager = System.getSecurityManager();
+		env = StandardEnvironmentTests.getModifiableSystemEnvironment();
+		env.put(AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME, "p1");
+	}
+
+	@After
+	public void tearDown() {
+		env.remove(AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME);
+		System.setSecurityManager(originalSecurityManager);
+	}
+
+	@Test
+	public void securityManagerDisallowsAccessToSystemEnvironmentButAllowsAccessToIndividualKeys() {
+		SecurityManager securityManager = new SecurityManager() {
+			@Override
+			public void checkPermission(Permission perm) {
+				// disallowing access to System#getenv means that our
+				// ReadOnlySystemAttributesMap will come into play.
+				if ("getenv.*".equals(perm.getName())) {
+					throw new AccessControlException(
+							"Accessing the system environment is disallowed");
+				}
+			}
+		};
+		System.setSecurityManager(securityManager);
+
+		DefaultListableBeanFactory bf = new DefaultListableBeanFactory();
+		AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(bf);
+		reader.register(C1.class);
+		assertThat(bf.containsBean("c1"), is(true));
+	}
+
+	@Test
+	public void securityManagerDisallowsAccessToSystemEnvironmentAndDisallowsAccessToIndividualKey() {
+		SecurityManager securityManager = new SecurityManager() {
+			@Override
+			public void checkPermission(Permission perm) {
+				// disallowing access to System#getenv means that our
+				// ReadOnlySystemAttributesMap will come into play.
+				if ("getenv.*".equals(perm.getName())) {
+					throw new AccessControlException(
+							"Accessing the system environment is disallowed");
+				}
+				// disallowing access to the spring.profiles.active property means that
+				// the BeanDefinitionReader won't be able to determine which profiles are
+				// active. We should see an INFO-level message in the console about this
+				// and as a result, any components marked with a non-default profile will
+				// be ignored.
+				if (("getenv."+AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME).equals(perm.getName())) {
+					throw new AccessControlException(
+							format("Accessing system environment variable [%s] is disallowed",
+									AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME));
+				}
+			}
+		};
+		System.setSecurityManager(securityManager);
+
+		DefaultListableBeanFactory bf = new DefaultListableBeanFactory();
+		AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(bf);
+		reader.register(C1.class);
+		assertThat(bf.containsBean("c1"), is(false));
+	}
+
+	@Component("c1")
+	@Profile("p1")
+	static class C1 {
+	}
+}

spring-core/src/main/java/org/springframework/core/env/ReadOnlySystemAttributesMap.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2013 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.
@@ -17,17 +17,21 @@
 package org.springframework.core.env;
 
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Map;
 import java.util.Set;
 
 import org.springframework.util.Assert;
 
 /**
- * Read-only {@code Map<String, String>} implementation that is backed by system properties or environment
- * variables.
+ * Read-only {@code Map<String, String>} implementation that is backed by system
+ * properties or environment variables.
  *
- * <p>Used by {@link AbstractApplicationContext} when a {@link SecurityManager} prohibits access to {@link
- * System#getProperties()} or {@link System#getenv()}.
+ * <p>Used by {@link AbstractApplicationContext} when a {@link SecurityManager} prohibits
+ * access to {@link System#getProperties()} or {@link System#getenv()}. It is for this
+ * reason that the implementations of {@link #keySet()}, {@link #entrySet()}, and
+ * {@link #values()} always return empty even though {@link #get(Object)} may in fact
+ * return non-null if the current security manager allows access to individual keys.
  *
  * @author Arjen Poutsma
  * @author Chris Beams
@@ -85,19 +89,19 @@ public void clear() {
 	}
 
 	public Set<String> keySet() {
-		throw new UnsupportedOperationException();
+		return Collections.emptySet();
 	}
 
 	public void putAll(Map<? extends String, ? extends String> m) {
 		throw new UnsupportedOperationException();
 	}
 
 	public Collection<String> values() {
-		throw new UnsupportedOperationException();
+		return Collections.emptySet();
 	}
 
 	public Set<Entry<String, String>> entrySet() {
-		throw new UnsupportedOperationException();
+		return Collections.emptySet();
 	}
 
 }

spring-core/src/main/java/org/springframework/core/env/SystemEnvironmentPropertySource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2013 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.
@@ -76,7 +76,7 @@ public SystemEnvironmentPropertySource(String name, Map<String, Object> source)
 	 */
 	@Override
 	public boolean containsProperty(String name) {
-		return resolvePropertyName(name) != null;
+		return getProperty(name) != null;
 	}
 
 	/**
@@ -102,8 +102,8 @@ public Object getProperty(String name) {
 
 	/**
 	 * Check to see if this property source contains a property with the given name, or
-	 * any underscore / uppercase variation thereof. Return the resolved name or
-	 * {@code null} if none found.
+	 * any underscore / uppercase variation thereof. Return the resolved name if one is
+	 * found or otherwise the original name. Never returns {@code null}.
 	 */
 	private String resolvePropertyName(String name) {
 		if (super.containsProperty(name)) {
@@ -127,6 +127,6 @@ private String resolvePropertyName(String name) {
 			}
 		}
 
-		return null;
+		return name;
 	}
 }

spring-core/src/test/java/org/springframework/core/env/StandardEnvironmentTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 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.
@@ -456,7 +456,7 @@ public void checkPermission(Permission perm) {
 	}
 
 	@SuppressWarnings("unchecked")
-	private static Map<String, String> getModifiableSystemEnvironment() {
+	public static Map<String, String> getModifiableSystemEnvironment() {
 		// for os x / linux
 		Class<?>[] classes = Collections.class.getDeclaredClasses();
 		Map<String, String> env = System.getenv();