You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@zookeeper.apache.org by GitBox <gi...@apache.org> on 2020/11/12 09:03:35 UTC
[GitHub] [zookeeper] ztzg commented on a change in pull request #1523: ZOOKEEPER-3978 : Adding additional security metrics to zookeeper
ztzg commented on a change in pull request #1523:
URL: https://github.com/apache/zookeeper/pull/1523#discussion_r521940802
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,95 @@
+/**
+ * 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
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
+ * 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.zookeeper.server;
+
+import static org.junit.Assert.assertTrue;
+import org.apache.zookeeper.PortAssignment;
+import org.apache.zookeeper.ZooKeeper;
+import org.apache.zookeeper.client.ZKClientConfig;
+import org.apache.zookeeper.common.ClientX509Util;
+import org.apache.zookeeper.test.ClientBase;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class X509AuthFailureTest {
+ protected static final Logger LOG = LoggerFactory.getLogger(X509AuthFailureTest.class);
+
+ private static ClientX509Util clientX509Util;
+ public static final int TIMEOUT = 5000;
+ public static int CONNECTION_TIMEOUT = 30000;
+
+ @BeforeEach
+ public void setup() throws Exception{
+ clientX509Util = new ClientX509Util();
+ String testDataPath = System.getProperty("test.data.dir", "src/test/resources/data");
+ System.setProperty(ServerCnxnFactory.ZOOKEEPER_SERVER_CNXN_FACTORY, "org.apache.zookeeper.server.NettyServerCnxnFactory");
+ System.setProperty(ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET, "org.apache.zookeeper.ClientCnxnSocketNetty");
+ System.setProperty(ZKClientConfig.SECURE_CLIENT, "true");
+ System.setProperty(clientX509Util.getSslKeystoreLocationProperty(), testDataPath + "/ssl/testKeyStore.jks");
+ System.setProperty(clientX509Util.getSslKeystorePasswdProperty(), "testpass");
+ System.setProperty(clientX509Util.getSslTruststoreLocationProperty(), testDataPath + "/ssl/testTrustStore.jks");
+ System.setProperty(clientX509Util.getSslTruststorePasswdProperty(), "testpass");
+ }
+
+ @AfterEach
+ public void teardown() throws Exception {
+ System.clearProperty(ServerCnxnFactory.ZOOKEEPER_SERVER_CNXN_FACTORY);
+ System.clearProperty(ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET);
+ System.clearProperty(ZKClientConfig.SECURE_CLIENT);
+ System.clearProperty(clientX509Util.getSslKeystoreLocationProperty());
+ System.clearProperty(clientX509Util.getSslKeystorePasswdProperty());
+ System.clearProperty(clientX509Util.getSslTruststoreLocationProperty());
+ System.clearProperty(clientX509Util.getSslTruststorePasswdProperty());
+ clientX509Util.close();
+ }
+
+ /**
+ * Developers might use standalone mode (which is the default for one server).
+ * This test checks metrics for authz failure in standalone server
+ */
+ @Test
+ public void testSecureStandaloneServerAuthZFailure() throws Exception {
+
+ final Integer CLIENT_PORT = PortAssignment.unique();
+ final Integer SECURE_CLIENT_PORT = PortAssignment.unique();
+ System.setProperty("zookeeper.ssl.allowedRoles", "testauthz");
Review comment:
This doesn't have a corresponding `System.clearProperty("zookeeper.ssl.allowedRoles")`; I suspect it should.
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,95 @@
+/**
+ * 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
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
+ * 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.zookeeper.server;
+
+import static org.junit.Assert.assertTrue;
Review comment:
Shouldn't this be `import static org.junit.jupiter.api.Assertions.assertTrue`?
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServerMXBean.java
##########
@@ -167,6 +179,14 @@
* Reset Fsync Threshold Exceed Count statistics only.
*/
void resetFsyncThresholdExceedCount();
+ /**
+ * Reset NonMTLSRemoteConnCount statistics only.
+ */
+ void resetNonMTLSConnCount();
Review comment:
This method actually resets local + remote counts, doesn't it?
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,95 @@
+/**
+ * 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
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
+ * 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.zookeeper.server;
+
+import static org.junit.Assert.assertTrue;
+import org.apache.zookeeper.PortAssignment;
+import org.apache.zookeeper.ZooKeeper;
+import org.apache.zookeeper.client.ZKClientConfig;
+import org.apache.zookeeper.common.ClientX509Util;
+import org.apache.zookeeper.test.ClientBase;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class X509AuthFailureTest {
+ protected static final Logger LOG = LoggerFactory.getLogger(X509AuthFailureTest.class);
+
+ private static ClientX509Util clientX509Util;
+ public static final int TIMEOUT = 5000;
+ public static int CONNECTION_TIMEOUT = 30000;
+
+ @BeforeEach
+ public void setup() throws Exception{
+ clientX509Util = new ClientX509Util();
+ String testDataPath = System.getProperty("test.data.dir", "src/test/resources/data");
+ System.setProperty(ServerCnxnFactory.ZOOKEEPER_SERVER_CNXN_FACTORY, "org.apache.zookeeper.server.NettyServerCnxnFactory");
+ System.setProperty(ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET, "org.apache.zookeeper.ClientCnxnSocketNetty");
+ System.setProperty(ZKClientConfig.SECURE_CLIENT, "true");
+ System.setProperty(clientX509Util.getSslKeystoreLocationProperty(), testDataPath + "/ssl/testKeyStore.jks");
+ System.setProperty(clientX509Util.getSslKeystorePasswdProperty(), "testpass");
+ System.setProperty(clientX509Util.getSslTruststoreLocationProperty(), testDataPath + "/ssl/testTrustStore.jks");
+ System.setProperty(clientX509Util.getSslTruststorePasswdProperty(), "testpass");
+ }
+
+ @AfterEach
+ public void teardown() throws Exception {
+ System.clearProperty(ServerCnxnFactory.ZOOKEEPER_SERVER_CNXN_FACTORY);
+ System.clearProperty(ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET);
+ System.clearProperty(ZKClientConfig.SECURE_CLIENT);
+ System.clearProperty(clientX509Util.getSslKeystoreLocationProperty());
+ System.clearProperty(clientX509Util.getSslKeystorePasswdProperty());
+ System.clearProperty(clientX509Util.getSslTruststoreLocationProperty());
+ System.clearProperty(clientX509Util.getSslTruststorePasswdProperty());
+ clientX509Util.close();
+ }
+
+ /**
+ * Developers might use standalone mode (which is the default for one server).
+ * This test checks metrics for authz failure in standalone server
+ */
+ @Test
+ public void testSecureStandaloneServerAuthZFailure() throws Exception {
+
+ final Integer CLIENT_PORT = PortAssignment.unique();
+ final Integer SECURE_CLIENT_PORT = PortAssignment.unique();
+ System.setProperty("zookeeper.ssl.allowedRoles", "testauthz");
+
+ ZooKeeperServerMainTest.MainThread mt = new ZooKeeperServerMainTest.MainThread(CLIENT_PORT, SECURE_CLIENT_PORT, true, null);
+ mt.start();
+
+ try {
+ ZooKeeper zk = createZKClnt("127.0.0.1:" + SECURE_CLIENT_PORT);
+ } catch (Exception e){
+ ServerStats serverStats = mt.getSecureCnxnFactory().getZooKeeperServer().serverStats();
+ assertTrue(serverStats.getAuthFailedCount() >= 1);
+ }
Review comment:
I would suggest adding a `fail("should not be reached")` in the try block. When I do, I observe that no exception is thrown, and the `catch` block is actually skipped. How about something akin to:
```java
try {
ZooKeeper zk = createZKClnt("127.0.0.1:" + SECURE_CLIENT_PORT);
fail("should not be reached");
} catch (Exception e){
// Expected
}
ServerStats serverStats = mt.getSecureCnxnFactory().getZooKeeperServer().serverStats();
assertTrue(serverStats.getAuthFailedCount() >= 1);
```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org