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 2021/03/28 20:55:59 UTC
[GitHub] [zookeeper] anmolnar commented on a change in pull request #1658: ZOOKEEPER-4263 : Provided an option to encrypt keystore password
anmolnar commented on a change in pull request #1658:
URL: https://github.com/apache/zookeeper/pull/1658#discussion_r602930897
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/common/SSLUtil.java
##########
@@ -0,0 +1,105 @@
+/*
+ * 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.zookeeper.common;
+
+import java.lang.reflect.InvocationTargetException;
+import org.apache.zookeeper.common.crypto.Crypt;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SSLUtil {
+
+ private static final Logger LOG = LoggerFactory.getLogger(SSLUtil.class);
+ private static Crypt crypt;
+
+ /**
+ * This method will return an instance of the user configured Crypto class
+ * value for {@value ZKConfig#CONFIG_CRYPT_CLASS}.
+ *
+ * @return an instance of the Crypto class configured
+ */
+ private static Crypt getCrypt() {
+ if (crypt == null) {
+ String cryptClassName = System
+ .getProperty(ZKConfig.CONFIG_CRYPT_CLASS);
+ Class<?> cryptClass = null;
+ if (cryptClassName != null && !cryptClassName.isEmpty()) {
+ try {
+ cryptClass = Class.forName(cryptClassName.trim());
+ } catch (ClassNotFoundException e) {
+ throw new RuntimeException("Class configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " is not found ", e);
+ }
+ try {
+ crypt = (Crypt) cryptClass.getConstructor().newInstance();
+ } catch (NoSuchMethodException | InstantiationException
Review comment:
All of these exception (and ClassNotFound above) are `ReflectiveOperationException`s. Why do you convert them to RuntimeException?
I think I would rather just let them thrown by the method and add ReflectiveOperationException to the method signature.
(Clean code: if you can't do anything with the exception other then re-throwing it, you probably don't need to catch it.)
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/common/SSLUtil.java
##########
@@ -0,0 +1,105 @@
+/*
+ * 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.zookeeper.common;
+
+import java.lang.reflect.InvocationTargetException;
+import org.apache.zookeeper.common.crypto.Crypt;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SSLUtil {
+
+ private static final Logger LOG = LoggerFactory.getLogger(SSLUtil.class);
+ private static Crypt crypt;
+
+ /**
+ * This method will return an instance of the user configured Crypto class
+ * value for {@value ZKConfig#CONFIG_CRYPT_CLASS}.
+ *
+ * @return an instance of the Crypto class configured
+ */
+ private static Crypt getCrypt() {
+ if (crypt == null) {
+ String cryptClassName = System
+ .getProperty(ZKConfig.CONFIG_CRYPT_CLASS);
+ Class<?> cryptClass = null;
+ if (cryptClassName != null && !cryptClassName.isEmpty()) {
+ try {
+ cryptClass = Class.forName(cryptClassName.trim());
+ } catch (ClassNotFoundException e) {
+ throw new RuntimeException("Class configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " is not found ", e);
+ }
+ try {
+ crypt = (Crypt) cryptClass.getConstructor().newInstance();
+ } catch (NoSuchMethodException | InstantiationException
+ | IllegalAccessException | InvocationTargetException e) {
+ throw new RuntimeException(
+ "Could not access default constructor for the Class which is configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS
+ + " property ", e);
+ }
+
+ } else {
+ throw new RuntimeException(
+ "Class to decrypt the encrypted text is not configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " property ");
+ }
+ }
+ return crypt;
+ }
+
+ /**
+ * This method will decrypt the given text using the Crypto class client
+ * has configured if client has set the password encryption to true
+ *
+ * @param pwd string to decrypt
+ * @param decrypt client configured value whether the text is in plain or
+ * encrypted format
+ * @return decrypted text
+ */
+ public static String getDecryptedText(String pwd, boolean decrypt) {
+ if (decrypt) {
+ try {
+ getCrypt();
+ } catch (Exception e) {
+ throw new RuntimeException(
Review comment:
You caught a RuntimeException here and thrown an other.
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/common/SSLUtil.java
##########
@@ -0,0 +1,105 @@
+/*
+ * 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.zookeeper.common;
+
+import java.lang.reflect.InvocationTargetException;
+import org.apache.zookeeper.common.crypto.Crypt;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SSLUtil {
+
+ private static final Logger LOG = LoggerFactory.getLogger(SSLUtil.class);
+ private static Crypt crypt;
+
+ /**
+ * This method will return an instance of the user configured Crypto class
+ * value for {@value ZKConfig#CONFIG_CRYPT_CLASS}.
+ *
+ * @return an instance of the Crypto class configured
+ */
+ private static Crypt getCrypt() {
+ if (crypt == null) {
+ String cryptClassName = System
+ .getProperty(ZKConfig.CONFIG_CRYPT_CLASS);
+ Class<?> cryptClass = null;
+ if (cryptClassName != null && !cryptClassName.isEmpty()) {
+ try {
+ cryptClass = Class.forName(cryptClassName.trim());
+ } catch (ClassNotFoundException e) {
+ throw new RuntimeException("Class configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " is not found ", e);
+ }
+ try {
+ crypt = (Crypt) cryptClass.getConstructor().newInstance();
+ } catch (NoSuchMethodException | InstantiationException
+ | IllegalAccessException | InvocationTargetException e) {
+ throw new RuntimeException(
+ "Could not access default constructor for the Class which is configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS
+ + " property ", e);
+ }
+
+ } else {
+ throw new RuntimeException(
+ "Class to decrypt the encrypted text is not configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " property ");
+ }
+ }
+ return crypt;
+ }
+
+ /**
+ * This method will decrypt the given text using the Crypto class client
+ * has configured if client has set the password encryption to true
+ *
+ * @param pwd string to decrypt
+ * @param decrypt client configured value whether the text is in plain or
+ * encrypted format
+ * @return decrypted text
+ */
+ public static String getDecryptedText(String pwd, boolean decrypt) {
+ if (decrypt) {
+ try {
+ getCrypt();
+ } catch (Exception e) {
+ throw new RuntimeException(
+ "Failed to get the Crypt reference used for decrypting a text.",
+ e);
+ }
+ try {
+ pwd = crypt.decrypt(pwd);
+ } catch (Exception e) {
+ throw new RuntimeException(
Review comment:
Don't swallow the original exception. There won't be any info in the logs about what happened originally.
##########
File path: zookeeper-server/src/main/java/org/apache/zookeeper/common/SSLUtil.java
##########
@@ -0,0 +1,105 @@
+/*
+ * 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.zookeeper.common;
+
+import java.lang.reflect.InvocationTargetException;
+import org.apache.zookeeper.common.crypto.Crypt;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SSLUtil {
+
+ private static final Logger LOG = LoggerFactory.getLogger(SSLUtil.class);
+ private static Crypt crypt;
+
+ /**
+ * This method will return an instance of the user configured Crypto class
+ * value for {@value ZKConfig#CONFIG_CRYPT_CLASS}.
+ *
+ * @return an instance of the Crypto class configured
+ */
+ private static Crypt getCrypt() {
+ if (crypt == null) {
+ String cryptClassName = System
+ .getProperty(ZKConfig.CONFIG_CRYPT_CLASS);
+ Class<?> cryptClass = null;
+ if (cryptClassName != null && !cryptClassName.isEmpty()) {
+ try {
+ cryptClass = Class.forName(cryptClassName.trim());
+ } catch (ClassNotFoundException e) {
+ throw new RuntimeException("Class configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS + " is not found ", e);
+ }
+ try {
+ crypt = (Crypt) cryptClass.getConstructor().newInstance();
+ } catch (NoSuchMethodException | InstantiationException
+ | IllegalAccessException | InvocationTargetException e) {
+ throw new RuntimeException(
+ "Could not access default constructor for the Class which is configured for "
+ + ZKConfig.CONFIG_CRYPT_CLASS
+ + " property ", e);
+ }
+
+ } else {
+ throw new RuntimeException(
Review comment:
`IllegalArgumentException`
--
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