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/03 14:06:38 UTC
[GitHub] [zookeeper] hanm commented on a change in pull request #1513: ZOOKEEPER-3978 : Adding additional security metrics to zookeeper
hanm commented on a change in pull request #1513:
URL: https://github.com/apache/zookeeper/pull/1513#discussion_r515749351
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/server/ServerStats.java
##########
@@ -41,6 +41,12 @@
private final BufferStats clientResponseStats = new BufferStats();
+ //This will be a P0 alert
Review comment:
I suggest we remove these comments because alerting and stats are separate things. Even we must say something here, I'd tend to make these suggestions instead of mandates (in which case I'd also clearly state the alert level - e.g. what P0 means). I would just remove these comments for clarity.
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServerMXBean.java
##########
@@ -164,6 +176,14 @@
* Reset Fsync Threshold Exceed Count statistics only.
*/
void resetFsyncThresholdExceedCount();
+ /**
+ * Reset resetNonMTLSRemoteConnCount statistics only.
Review comment:
should be `Reset NonMTLSRemoteConnCount statistics only`
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,242 @@
+/**
+ * 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 com.salesforce.sds.keystore.DynamicKeyStoreProvider;
+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.common.PathUtils;
+import org.apache.zookeeper.server.admin.JettyAdminServer;
+import org.apache.zookeeper.server.quorum.QuorumPeerTestBase;
+import org.apache.zookeeper.test.ClientBase;
+import org.junit.After;
+import org.junit.Before;
Review comment:
I think we are now using `org.junit.jupiter.api` - so for example here should be `org.junit.jupiter.api.BeforeEach` and the test api would be `org.junit.jupiter.api.Test`
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,242 @@
+/**
+ * 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 com.salesforce.sds.keystore.DynamicKeyStoreProvider;
+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.common.PathUtils;
+import org.apache.zookeeper.server.admin.JettyAdminServer;
+import org.apache.zookeeper.server.quorum.QuorumPeerTestBase;
+import org.apache.zookeeper.test.ClientBase;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.Map;
+
+import static org.junit.Assert.assertTrue;
+
+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;
+
+ @Before
+ 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");
+ //System.setProperty("zookeeper.authProvider.x509", "org.apache.zookeeper.server.auth.SFDCX509AuthenticationProvider");
Review comment:
dead code
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServerMXBean.java
##########
@@ -164,6 +176,14 @@
* Reset Fsync Threshold Exceed Count statistics only.
*/
void resetFsyncThresholdExceedCount();
+ /**
+ * Reset resetNonMTLSRemoteConnCount statistics only.
+ */
+ void resetNonMTLSConnCount();
+ /**
+ * Reset resetNonMTLSRemoteConnCount statistics only.
Review comment:
similar - remove reset prefix
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,242 @@
+/**
+ * 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 com.salesforce.sds.keystore.DynamicKeyStoreProvider;
+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.common.PathUtils;
+import org.apache.zookeeper.server.admin.JettyAdminServer;
+import org.apache.zookeeper.server.quorum.QuorumPeerTestBase;
+import org.apache.zookeeper.test.ClientBase;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.Map;
+
+import static org.junit.Assert.assertTrue;
+
+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;
+
+ @Before
+ 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");
+ //System.setProperty("zookeeper.authProvider.x509", "org.apache.zookeeper.server.auth.SFDCX509AuthenticationProvider");
+ //System.setProperty(clientX509Util.getSslProviderProperty(), DynamicKeyStoreProvider.PKIKS_PROVIDER_NAME);
+ }
+
+ @After
+ 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 {
+ System.setProperty("zookeeper.ssl.allowedRoles", "testauthz");
+ Integer secureClientPort = PortAssignment.unique();
+ MainThread mt = new MainThread(QuorumPeerTestBase.MainThread.UNSET_MYID, "", secureClientPort, false);
+ mt.start();
+
+ try {
+ ZooKeeper zk = createZKClnt("127.0.0.1:" + secureClientPort);
+ } catch (Exception e){
+ ServerStats serverStats = mt.getSecureCnxnFactory().getZooKeeperServer().serverStats();
+ assertTrue(serverStats.getAuthFailedCount()>=1);
+ }
+ mt.shutdown();
+
+ }
+
+ private ZooKeeper createZKClnt(String cxnString) throws Exception {
+ ClientBase.CountdownWatcher watcher = new ClientBase.CountdownWatcher();
+ ZooKeeper zk = new ZooKeeper(cxnString, TIMEOUT, watcher);
+ watcher.waitForConnected(CONNECTION_TIMEOUT);
+ return zk;
+ }
+
+ public static class MainThread extends Thread {
Review comment:
second this. We have same class from `QuorumPeerTestBase` - can we reuse that instead of copy paste?
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/NettyServerCnxnTest.java
##########
@@ -143,6 +152,52 @@ public void testClientResponseStatsUpdate() throws IOException, InterruptedExcep
}
}
+ @Test
+ public void testNonMTLSLocalConn() throws IOException, InterruptedException, KeeperException {
+ try (ZooKeeper zk = createClient()) {
+ ServerStats serverStats = serverFactory.getZooKeeperServer().serverStats();
+ //2 for local stat connection and this client
+ assertEquals(2,serverStats.getNonMTLSLocalConnCount());
+ assertEquals(0,serverStats.getNonMTLSRemoteConnCount());
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ @Test
+ public void testNonMTLSRemoteConn() throws Exception {
+ Channel channel = mock(Channel.class);
+ ChannelId id = mock(ChannelId.class);
+ ChannelFuture success = mock(ChannelFuture.class);
+ ChannelHandlerContext context = mock(ChannelHandlerContext.class);
+ ChannelPipeline channelPipeline = mock(ChannelPipeline.class);
+
+ when(context.channel()).thenReturn(channel);
+ when(channel.pipeline()).thenReturn(channelPipeline);
+ when(success.channel()).thenReturn(channel);
+ when(channel.closeFuture()).thenReturn(success);
+
+ InetSocketAddress address = new InetSocketAddress(0);
+ when(channel.remoteAddress()).thenReturn(address);
+ when(channel.id()).thenReturn(id);
+ NettyServerCnxnFactory factory = new NettyServerCnxnFactory();
+ LeaderZooKeeperServer zks = mock(LeaderZooKeeperServer.class);
+ factory.setZooKeeperServer(zks);
+ Attribute atr = mock(Attribute.class);
+ Mockito.doReturn(atr).when(channel).attr(
+ Mockito.any()
+ );
+ // when(channel.attr(Mockito.any(AttributeKey.class))).thenReturn(atr);
Review comment:
remove dead code
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/NettyServerCnxnTest.java
##########
@@ -26,7 +26,14 @@
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+import io.netty.channel.*;
Review comment:
please don't do wild card imports - only import what's needed. (I am surprised that checkstyle does not catch this.).
##########
File path: zookeeper-server/src/test/java/org/apache/zookeeper/server/X509AuthFailureTest.java
##########
@@ -0,0 +1,242 @@
+/**
+ * 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 com.salesforce.sds.keystore.DynamicKeyStoreProvider;
Review comment:
remove dead code
----------------------------------------------------------------
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