Github user zsxwing commented on a diff in the pull request:
https://github.com/apache/spark/pull/8880#discussion_r76328447
--- Diff:
core/src/main/scala/org/apache/spark/security/CryptoStreamUtils.scala ---
@@ -0,0 +1,106 @@
+/*
+ * 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.spark.security
+
+import java.io.{InputStream, OutputStream}
+import java.util.Properties
+import javax.crypto.spec.{IvParameterSpec, SecretKeySpec}
+
+import org.apache.commons.crypto.random._
+import org.apache.commons.crypto.stream._
+import org.apache.hadoop.io.Text
+
+import org.apache.spark.SparkConf
+import org.apache.spark.deploy.SparkHadoopUtil
+import org.apache.spark.internal.config._
+
+/**
+ * A util class for manipulating IO encryption and decryption streams.
+ */
+private[spark] object CryptoStreamUtils {
+ /**
+ * Constants and variables for spark IO encryption
+ */
+ val SPARK_IO_TOKEN = new Text("SPARK_IO_TOKEN")
+
+ // The initialization vector length in bytes.
+ val IV_LENGTH_IN_BYTES = 16
+ // The prefix of IO encryption related configurations in Spark
configuration.
+ val SPARK_IO_ENCRYPTION_COMMONS_CONFIG_PREFIX =
"spark.io.encryption.commons.config."
+ // The prefix for the configurations passing to Apache Commons Crypto
library.
+ val COMMONS_CRYPTO_CONF_PREFIX = "commons.crypto."
+
+ /**
+ * Helper method to wrap [[OutputStream]] with [[CryptoOutputStream]]
for encryption.
+ */
+ def createCryptoOutputStream(
+ os: OutputStream,
+ sparkConf: SparkConf): OutputStream = {
+ val properties = toCryptoConf(sparkConf,
SPARK_IO_ENCRYPTION_COMMONS_CONFIG_PREFIX,
+ COMMONS_CRYPTO_CONF_PREFIX)
+ val iv = createInitializationVector(properties)
+ os.write(iv)
+ val credentials = SparkHadoopUtil.get.getCurrentUserCredentials()
+ val key = credentials.getSecretKey(SPARK_IO_TOKEN)
+ val transformationStr = sparkConf.get(IO_CRYPTO_CIPHER_TRANSFORMATION)
+ new CryptoOutputStream(transformationStr, properties, os,
+ new SecretKeySpec(key, "AES"), new IvParameterSpec(iv))
+ }
+
+ /**
+ * Helper method to wrap [[InputStream]] with [[CryptoInputStream]] for
decryption.
+ */
+ def createCryptoInputStream(
+ is: InputStream,
+ sparkConf: SparkConf): InputStream = {
+ val properties = toCryptoConf(sparkConf,
SPARK_IO_ENCRYPTION_COMMONS_CONFIG_PREFIX,
+ COMMONS_CRYPTO_CONF_PREFIX)
+ val iv = new Array[Byte](IV_LENGTH_IN_BYTES)
+ is.read(iv, 0, iv.length)
+ val credentials = SparkHadoopUtil.get.getCurrentUserCredentials()
+ val key = credentials.getSecretKey(SPARK_IO_TOKEN)
+ val transformationStr = sparkConf.get(IO_CRYPTO_CIPHER_TRANSFORMATION)
+ new CryptoInputStream(transformationStr, properties, is,
+ new SecretKeySpec(key, "AES"), new IvParameterSpec(iv))
+ }
+
+ /**
+ * Get Commons-crypto configurations from Spark configurations
identified by prefix.
+ */
+ def toCryptoConf(
+ conf: SparkConf,
+ sparkPrefix: String,
+ cryptoPrefix: String): Properties = {
+ val props = new Properties()
+ conf.getAll.foreach { case (k, v) =>
+ if (k.startsWith(sparkPrefix)) {
+ props.put(COMMONS_CRYPTO_CONF_PREFIX + k.substring(
+ SPARK_IO_ENCRYPTION_COMMONS_CONFIG_PREFIX.length()), v)
+ }
+ }
+ props
+ }
+
+ /**
+ * This method to generate an IV (Initialization Vector) using secure
random.
+ */
+ private[this] def createInitializationVector(properties: Properties):
Array[Byte] = {
+ val iv = new Array[Byte](IV_LENGTH_IN_BYTES)
+ CryptoRandomFactory.getCryptoRandom(properties).nextBytes(iv)
--- End diff --
nit: could you add a warning log when this line is too slow (e.g., more
than 2 seconds)? Sometimes, it may take several seconds to collect enough
enough entropy.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
