Skip to content

[SPARK-27270][SS] Add Kafka dynamic JAAS authentication debug possibility #24204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gaborgsomogyi wants to merge 2 commits into from
Closed

[SPARK-27270][SS] Add Kafka dynamic JAAS authentication debug possibility #24204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc210c6
[SPARK-27270][SS] Add Kafka dynamic JAAS authentication debug possibi…
gaborgsomogyi Mar 25, 2019
b3c467b
Switch to global debug flag
gaborgsomogyi Apr 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions ...l/kafka-0-10-token-provider/src/main/scala/org/apache/spark/kafka010/KafkaTokenUtil.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import org.apache.hadoop.security.token.{Token, TokenIdentifier}
import org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier
import org.apache.kafka.clients.CommonClientConfigs
import org.apache.kafka.clients.admin.{AdminClient, CreateDelegationTokenOptions}
import org.apache.kafka.common.config.SaslConfigs
import org.apache.kafka.common.config.{SaslConfigs, SslConfigs}
import org.apache.kafka.common.security.JaasContext
import org.apache.kafka.common.security.auth.SecurityProtocol.{SASL_PLAINTEXT, SASL_SSL, SSL}
import org.apache.kafka.common.security.scram.ScramLoginModule
Expand Down Expand Up @@ -136,29 +136,30 @@ private[spark] object KafkaTokenUtil extends Logging {

private def setTrustStoreProperties(sparkConf: SparkConf, properties: ju.Properties): Unit = {
sparkConf.get(Kafka.TRUSTSTORE_LOCATION).foreach { truststoreLocation =>
properties.put("ssl.truststore.location", truststoreLocation)
properties.put(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG, truststoreLocation)
}
sparkConf.get(Kafka.TRUSTSTORE_PASSWORD).foreach { truststorePassword =>
properties.put("ssl.truststore.password", truststorePassword)
properties.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, truststorePassword)
}
}

private def setKeyStoreProperties(sparkConf: SparkConf, properties: ju.Properties): Unit = {
sparkConf.get(Kafka.KEYSTORE_LOCATION).foreach { keystoreLocation =>
properties.put("ssl.keystore.location", keystoreLocation)
properties.put(SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG, keystoreLocation)
}
sparkConf.get(Kafka.KEYSTORE_PASSWORD).foreach { keystorePassword =>
properties.put("ssl.keystore.password", keystorePassword)
properties.put(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG, keystorePassword)
}
sparkConf.get(Kafka.KEY_PASSWORD).foreach { keyPassword =>
properties.put("ssl.key.password", keyPassword)
properties.put(SslConfigs.SSL_KEY_PASSWORD_CONFIG, keyPassword)
}
}

private def getKeytabJaasParams(sparkConf: SparkConf): String = {
val params =
s"""
|${getKrb5LoginModuleName} required
| debug=${isGlobalKrbDebugEnabled()}
| useKeyTab=true
| serviceName="${sparkConf.get(Kafka.KERBEROS_SERVICE_NAME)}"
| keyTab="${sparkConf.get(KEYTAB).get}"
Expand All @@ -175,6 +176,7 @@ private[spark] object KafkaTokenUtil extends Logging {
val params =
s"""
|${getKrb5LoginModuleName} required
| debug=${isGlobalKrbDebugEnabled()}
| useTicketCache=true
| serviceName="${sparkConf.get(Kafka.KERBEROS_SERVICE_NAME)}";
""".stripMargin.replace("\n", "")
Expand All @@ -194,6 +196,16 @@ private[spark] object KafkaTokenUtil extends Logging {
}
}

private def isGlobalKrbDebugEnabled(): Boolean = {
if (System.getProperty("java.vendor").contains("IBM")) {
val debug = System.getenv("com.ibm.security.krb5.Krb5Debug")
debug != null && debug.equalsIgnoreCase("all")
} else {
val debug = System.getenv("sun.security.krb5.debug")
debug != null && debug.equalsIgnoreCase("true")
}
}

private def printToken(token: DelegationToken): Unit = {
if (log.isDebugEnabled) {
val dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm")
Expand Down
40 changes: 24 additions & 16 deletions ...ka-0-10-token-provider/src/test/scala/org/apache/spark/kafka010/KafkaTokenUtilSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import java.security.PrivilegedExceptionAction

import org.apache.hadoop.security.UserGroupInformation
import org.apache.kafka.clients.CommonClientConfigs
import org.apache.kafka.common.config.SaslConfigs
import org.apache.kafka.common.config.{SaslConfigs, SslConfigs}
import org.apache.kafka.common.security.auth.SecurityProtocol.{SASL_PLAINTEXT, SASL_SSL, SSL}

import org.apache.spark.{SparkConf, SparkFunSuite}
Expand Down Expand Up @@ -83,11 +83,11 @@ class KafkaTokenUtilSuite extends SparkFunSuite with KafkaDelegationTokenTest {
=== bootStrapServers)
assert(adminClientProperties.get(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG)
=== SASL_PLAINTEXT.name)
assert(!adminClientProperties.containsKey("ssl.truststore.location"))
assert(!adminClientProperties.containsKey("ssl.truststore.password"))
assert(!adminClientProperties.containsKey("ssl.keystore.location"))
assert(!adminClientProperties.containsKey("ssl.keystore.password"))
assert(!adminClientProperties.containsKey("ssl.key.password"))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEY_PASSWORD_CONFIG))
}

test("createAdminClientProperties with SASL_SSL protocol should include truststore config") {
Expand All @@ -105,11 +105,13 @@ class KafkaTokenUtilSuite extends SparkFunSuite with KafkaDelegationTokenTest {
=== bootStrapServers)
assert(adminClientProperties.get(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG)
=== SASL_SSL.name)
assert(adminClientProperties.get("ssl.truststore.location") === trustStoreLocation)
assert(adminClientProperties.get("ssl.truststore.password") === trustStorePassword)
assert(!adminClientProperties.containsKey("ssl.keystore.location"))
assert(!adminClientProperties.containsKey("ssl.keystore.password"))
assert(!adminClientProperties.containsKey("ssl.key.password"))
assert(adminClientProperties.get(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG)
=== trustStoreLocation)
assert(adminClientProperties.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG)
=== trustStorePassword)
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG))
assert(!adminClientProperties.containsKey(SslConfigs.SSL_KEY_PASSWORD_CONFIG))
}

test("createAdminClientProperties with SSL protocol should include keystore and truststore " +
Expand All @@ -128,11 +130,13 @@ class KafkaTokenUtilSuite extends SparkFunSuite with KafkaDelegationTokenTest {
=== bootStrapServers)
assert(adminClientProperties.get(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG)
=== SSL.name)
assert(adminClientProperties.get("ssl.truststore.location") === trustStoreLocation)
assert(adminClientProperties.get("ssl.truststore.password") === trustStorePassword)
assert(adminClientProperties.get("ssl.keystore.location") === keyStoreLocation)
assert(adminClientProperties.get("ssl.keystore.password") === keyStorePassword)
assert(adminClientProperties.get("ssl.key.password") === keyPassword)
assert(adminClientProperties.get(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG)
=== trustStoreLocation)
assert(adminClientProperties.get(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG)
=== trustStorePassword)
assert(adminClientProperties.get(SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG) === keyStoreLocation)
assert(adminClientProperties.get(SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG) === keyStorePassword)
assert(adminClientProperties.get(SslConfigs.SSL_KEY_PASSWORD_CONFIG) === keyPassword)
}

test("createAdminClientProperties with global config should not set dynamic jaas config") {
Expand Down Expand Up @@ -165,7 +169,10 @@ class KafkaTokenUtilSuite extends SparkFunSuite with KafkaDelegationTokenTest {
assert(adminClientProperties.containsKey(SaslConfigs.SASL_MECHANISM))
val saslJaasConfig = adminClientProperties.getProperty(SaslConfigs.SASL_JAAS_CONFIG)
assert(saslJaasConfig.contains("Krb5LoginModule required"))
assert(saslJaasConfig.contains(s"debug="))
assert(saslJaasConfig.contains("useKeyTab=true"))
assert(saslJaasConfig.contains(s"""keyTab="$keytab""""))
assert(saslJaasConfig.contains(s"""principal="$principal""""))
}

test("createAdminClientProperties without keytab should set ticket cache dynamic jaas config") {
Expand All @@ -181,6 +188,7 @@ class KafkaTokenUtilSuite extends SparkFunSuite with KafkaDelegationTokenTest {
assert(adminClientProperties.containsKey(SaslConfigs.SASL_MECHANISM))
val saslJaasConfig = adminClientProperties.getProperty(SaslConfigs.SASL_JAAS_CONFIG)
assert(saslJaasConfig.contains("Krb5LoginModule required"))
assert(saslJaasConfig.contains(s"debug="))
assert(saslJaasConfig.contains("useTicketCache=true"))
}

Expand Down