kirklund commented on a change in pull request #6787: URL: https://github.com/apache/geode/pull/6787#discussion_r694196896
########## File path: geode-core/src/upgradeTest/java/org/apache/geode/security/AuthExpirationDUnitTest.java ########## @@ -0,0 +1,181 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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.apache.geode.security; + +import static org.apache.geode.distributed.ConfigurationProperties.SECURITY_CLIENT_AUTH_INIT; +import static org.apache.geode.test.version.VersionManager.CURRENT_VERSION; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +import org.junit.After; +import org.junit.Rule; +import org.junit.Test; +import org.junit.contrib.java.lang.system.RestoreSystemProperties; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +import org.apache.geode.cache.Region; +import org.apache.geode.cache.RegionService; +import org.apache.geode.cache.RegionShortcut; +import org.apache.geode.cache.client.ClientCache; +import org.apache.geode.cache.client.ClientRegionFactory; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.apache.geode.test.dunit.rules.ClientVM; +import org.apache.geode.test.dunit.rules.ClusterStartupRule; +import org.apache.geode.test.junit.categories.SecurityTest; +import org.apache.geode.test.junit.rules.ServerStarterRule; +import org.apache.geode.test.junit.runners.CategoryWithParameterizedRunnerFactory; + +@Category({SecurityTest.class}) +@RunWith(Parameterized.class) [email protected](CategoryWithParameterizedRunnerFactory.class) +public class AuthExpirationDUnitTest { + static RegionService user0Service; + static RegionService user1Service; Review comment: These should be `private`. ########## File path: geode-core/src/main/java/org/apache/geode/security/SecurityManager.java ########## @@ -74,8 +74,11 @@ default void init(Properties securityProps) {} * @param principal The principal that's requesting the permission * @param permission The permission requested * @return true if authorized, false if not + * + * @throw AuthenticationExpiredException if the principal has expired. */ - default boolean authorize(Object principal, ResourcePermission permission) { + default boolean authorize(Object principal, ResourcePermission permission) + throws AuthenticationExpiredException { Review comment: Not sure if this breaks binary compatibility for User's existing impls. I think it probably does. ########## File path: geode-core/src/upgradeTest/java/org/apache/geode/security/AuthExpirationDUnitTest.java ########## @@ -0,0 +1,181 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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.apache.geode.security; + +import static org.apache.geode.distributed.ConfigurationProperties.SECURITY_CLIENT_AUTH_INIT; +import static org.apache.geode.test.version.VersionManager.CURRENT_VERSION; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +import org.junit.After; +import org.junit.Rule; +import org.junit.Test; +import org.junit.contrib.java.lang.system.RestoreSystemProperties; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +import org.apache.geode.cache.Region; +import org.apache.geode.cache.RegionService; +import org.apache.geode.cache.RegionShortcut; +import org.apache.geode.cache.client.ClientCache; +import org.apache.geode.cache.client.ClientRegionFactory; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.apache.geode.test.dunit.rules.ClientVM; +import org.apache.geode.test.dunit.rules.ClusterStartupRule; +import org.apache.geode.test.junit.categories.SecurityTest; +import org.apache.geode.test.junit.rules.ServerStarterRule; +import org.apache.geode.test.junit.runners.CategoryWithParameterizedRunnerFactory; + +@Category({SecurityTest.class}) +@RunWith(Parameterized.class) [email protected](CategoryWithParameterizedRunnerFactory.class) +public class AuthExpirationDUnitTest { + static RegionService user0Service; + static RegionService user1Service; + + @Parameterized.Parameter + public String clientVersion; + + @Parameterized.Parameters(name = "{0}") + public static Collection<String> data() { + // only test the current version and the latest released version + return Arrays.asList(CURRENT_VERSION, "1.13.3"); + } + + @Rule + public ClusterStartupRule lsRule = new ClusterStartupRule(); + + @Rule + public RestoreSystemProperties restore = new RestoreSystemProperties(); + + @Rule + public ServerStarterRule server = new ServerStarterRule() + .withSecurityManager(ExpirableSecurityManager.class) + .withRegion(RegionShortcut.REPLICATE, "region"); + + @After + public void after() { + // make sure after each test, the values of the ExpirationManager are reset + ExpirableSecurityManager.reset(); + } + + @Test + public void clientShouldReAuthenticateWhenCredentialExpiredAndOperationSucceed() + throws Exception { + int serverPort = server.getPort(); + ClientVM clientVM = lsRule.startClientVM(0, clientVersion, + c -> c.withProperty(SECURITY_CLIENT_AUTH_INIT, UpdatableUserAuthInitialize.class.getName()) + .withPoolSubscription(true) + .withServerConnection(serverPort)); + + clientVM.invoke(() -> { + ClientCache clientCache = ClusterStartupRule.getClientCache(); + UpdatableUserAuthInitialize.setUser("user1"); + assert clientCache != null; Review comment: Let's remove all `assert` uses. Only use AssertJ Assertions in a test. You probably don't need to assert that a cache is not null; just let it throw an NPE. ########## File path: geode-core/src/upgradeTest/java/org/apache/geode/security/AuthExpirationDUnitTest.java ########## @@ -0,0 +1,181 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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.apache.geode.security; + +import static org.apache.geode.distributed.ConfigurationProperties.SECURITY_CLIENT_AUTH_INIT; +import static org.apache.geode.test.version.VersionManager.CURRENT_VERSION; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +import org.junit.After; +import org.junit.Rule; +import org.junit.Test; +import org.junit.contrib.java.lang.system.RestoreSystemProperties; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +import org.apache.geode.cache.Region; +import org.apache.geode.cache.RegionService; +import org.apache.geode.cache.RegionShortcut; +import org.apache.geode.cache.client.ClientCache; +import org.apache.geode.cache.client.ClientRegionFactory; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.apache.geode.test.dunit.rules.ClientVM; +import org.apache.geode.test.dunit.rules.ClusterStartupRule; +import org.apache.geode.test.junit.categories.SecurityTest; +import org.apache.geode.test.junit.rules.ServerStarterRule; +import org.apache.geode.test.junit.runners.CategoryWithParameterizedRunnerFactory; + +@Category({SecurityTest.class}) +@RunWith(Parameterized.class) [email protected](CategoryWithParameterizedRunnerFactory.class) +public class AuthExpirationDUnitTest { + static RegionService user0Service; + static RegionService user1Service; + + @Parameterized.Parameter + public String clientVersion; + + @Parameterized.Parameters(name = "{0}") + public static Collection<String> data() { + // only test the current version and the latest released version + return Arrays.asList(CURRENT_VERSION, "1.13.3"); + } + + @Rule + public ClusterStartupRule lsRule = new ClusterStartupRule(); + + @Rule + public RestoreSystemProperties restore = new RestoreSystemProperties(); + + @Rule + public ServerStarterRule server = new ServerStarterRule() + .withSecurityManager(ExpirableSecurityManager.class) + .withRegion(RegionShortcut.REPLICATE, "region"); + + @After + public void after() { + // make sure after each test, the values of the ExpirationManager are reset + ExpirableSecurityManager.reset(); + } + + @Test + public void clientShouldReAuthenticateWhenCredentialExpiredAndOperationSucceed() + throws Exception { + int serverPort = server.getPort(); + ClientVM clientVM = lsRule.startClientVM(0, clientVersion, + c -> c.withProperty(SECURITY_CLIENT_AUTH_INIT, UpdatableUserAuthInitialize.class.getName()) + .withPoolSubscription(true) + .withServerConnection(serverPort)); + + clientVM.invoke(() -> { + ClientCache clientCache = ClusterStartupRule.getClientCache(); + UpdatableUserAuthInitialize.setUser("user1"); + assert clientCache != null; + ClientRegionFactory<Object, Object> clientRegionFactory = + clientCache.createClientRegionFactory(ClientRegionShortcut.PROXY); + Region<Object, Object> region = clientRegionFactory.create("region"); + region.put(0, "value0"); + }); + + // expire the current user + ExpirableSecurityManager.addExpiredUser("user1"); + + // do a second put, if this is successful, it means new credentials are provided + clientVM.invoke(() -> { + UpdatableUserAuthInitialize.setUser("user2"); + ClientCache clientCache = ClusterStartupRule.getClientCache(); + assert clientCache != null; + Region<Object, Object> region = clientCache.getRegion("region"); + region.put(1, "value1"); + }); + + // all put operation succeeded + Region<Object, Object> region = server.getCache().getRegion("/region"); + assertThat(region.size()).isEqualTo(2); + Map<String, List<String>> authorizedOps = ExpirableSecurityManager.getAuthorizedOps(); + Map<String, List<String>> unAuthorizedOps = ExpirableSecurityManager.getUnAuthorizedOps(); + assertThat(authorizedOps.keySet().size()).isEqualTo(2); + assertThat(authorizedOps.get("user1")).asList().containsExactly("DATA:WRITE:region:0"); + assertThat(authorizedOps.get("user2")).asList().containsExactly("DATA:WRITE:region:1"); + assertThat(unAuthorizedOps.keySet().size()).isEqualTo(1); + assertThat(unAuthorizedOps.get("user1")).asList().containsExactly("DATA:WRITE:region:1"); + } + + @Test + public void userShouldReAuthenticateWhenCredentialExpiredAndOperationSucceed() throws Exception { + int serverPort = server.getPort(); + ClientVM clientVM = lsRule.startClientVM(0, clientVersion, + c -> c.withMultiUser(true) + .withProperty(SECURITY_CLIENT_AUTH_INIT, UpdatableUserAuthInitialize.class.getName()) + .withPoolSubscription(true) + .withServerConnection(serverPort)); + + clientVM.invoke(() -> { + UpdatableUserAuthInitialize.setUser("user0"); + ClientCache clientCache = ClusterStartupRule.getClientCache(); + clientCache.createClientRegionFactory(ClientRegionShortcut.PROXY).create("region"); + Properties userSecurityProperties = new Properties(); + userSecurityProperties.put(SECURITY_CLIENT_AUTH_INIT, + UpdatableUserAuthInitialize.class.getName()); + user0Service = clientCache.createAuthenticatedView(userSecurityProperties); + Region<Object, Object> region = user0Service.getRegion("/region"); + region.put(0, "value0"); + + UpdatableUserAuthInitialize.setUser("user1"); + userSecurityProperties.put(SECURITY_CLIENT_AUTH_INIT, + UpdatableUserAuthInitialize.class.getName()); + user1Service = clientCache.createAuthenticatedView(userSecurityProperties); + region = user1Service.getRegion("/region"); + region.put(1, "value1"); + }); + + ExpirableSecurityManager.addExpiredUser("user1"); + + clientVM.invoke(() -> { + + Region<Object, Object> region = user0Service.getRegion("/region"); + region.put(2, "value3"); + + UpdatableUserAuthInitialize.setUser("user1_extended"); + region = user1Service.getRegion("/region"); + region.put(3, "value2"); + + user0Service.close(); + user1Service.close(); + }); + + Region<Object, Object> region = server.getCache().getRegion("/region"); + assertThat(region.size()).isEqualTo(4); + + Map<String, List<String>> authorizedOps = ExpirableSecurityManager.getAuthorizedOps(); + assertThat(authorizedOps.keySet().size()).isEqualTo(3); Review comment: `assertThat(authorizedOps.keySet()).hasSize(3);` will provide much better failure messages if this ever fails. ########## File path: geode-core/src/upgradeTest/java/org/apache/geode/security/AuthExpirationMultiServerDUnitTest.java ########## @@ -0,0 +1,136 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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.apache.geode.security; + +import static org.apache.geode.distributed.ConfigurationProperties.SECURITY_CLIENT_AUTH_INIT; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +import java.io.Serializable; +import java.util.List; +import java.util.Map; + +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.junit.experimental.categories.Category; + +import org.apache.geode.cache.Region; +import org.apache.geode.cache.RegionShortcut; +import org.apache.geode.internal.cache.InternalCache; +import org.apache.geode.test.dunit.rules.ClusterStartupRule; +import org.apache.geode.test.dunit.rules.MemberVM; +import org.apache.geode.test.junit.categories.SecurityTest; +import org.apache.geode.test.junit.rules.ClientCacheRule; + +@Category({SecurityTest.class}) +public class AuthExpirationMultiServerDUnitTest implements Serializable { + public static final String REPLICATE_REGION = "replicateRegion"; + public static final String PARTITION_REGION = "partitionRegion"; + private MemberVM locator, server1, server2; Review comment: Spotless allows this but it's not part of our code standard. Please separate all declarations. ########## File path: geode-junit/src/main/java/org/apache/geode/security/ExpirableSecurityManager.java ########## @@ -0,0 +1,86 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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.apache.geode.security; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +import org.apache.geode.examples.SimpleSecurityManager; + +/** + * this is a test security manager that will authenticate credentials when username matches the + * password. It will authorize all operations. It keeps a list of expired users, and will throw + * AuthenticationExpiredException if the user is in that list. This security manager is usually used + * with NewCredentialAuthInitialize. + * + * make sure to call reset after each test to clean things up. + */ +public class ExpirableSecurityManager extends SimpleSecurityManager { Review comment: Product APIs that are supported for Users shouldn't extend anything in an `examples` package. `ExpirableSecurityManager` should be moved to `examples` or something needs to be reworked here. I recommend reviewing product User APIs on dev list or with Jake and Dan at a minimum. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
