yaooqinn commented on a change in pull request #1015: URL: https://github.com/apache/incubator-kyuubi/pull/1015#discussion_r701743791
########## File path: kyuubi-server/src/main/scala/org/apache/kyuubi/credentials/HadoopCredentialsManager.scala ########## @@ -0,0 +1,252 @@ +/* + * 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.kyuubi.credentials + +import java.util.ServiceLoader +import java.util.concurrent._ + +import scala.collection.mutable +import scala.util.{Failure, Success, Try} + +import org.apache.hadoop.conf.Configuration +import org.apache.hadoop.security.Credentials + +import org.apache.kyuubi.Logging +import org.apache.kyuubi.config.KyuubiConf +import org.apache.kyuubi.config.KyuubiConf._ +import org.apache.kyuubi.service.AbstractService +import org.apache.kyuubi.util.{KyuubiHadoopUtils, ThreadUtils} + +/** + * [[HadoopCredentialsManager]] manages and renews delegation tokens, which are used by SQL engines + * to access kerberos secured services. + * + * Delegation tokens are sent to SQL engines by calling [[sendCredentialsIfNeeded]]. + * [[sendCredentialsIfNeeded]] executes the following steps: + * <ol> + * <li> + * Get or create a cached [[CredentialsRef]](contains delegation tokens) object by key + * appUser. If [[CredentialsRef]] is newly created, spawn a scheduled task to renew the + * delegation tokens. + * </li> + * <li> + * Get or create a cached session credentials epoch object by key sessionId. + * </li> + * <li> + * Compare [[CredentialsRef]] epoch with session credentials epoch. (Both epochs are set + * to -1 when created. [[CredentialsRef]] epoch is increased when delegation tokens are + * renewed.) + * </li> + * <li> + * If epochs are equal, return. Else, send delegation tokens to the SQL engine. + * </li> + * <li> + * If sending succeeds, set session credentials epoch to [[CredentialsRef]] epoch. Else, + * record the exception and return. + * </li> + * </ol> + * + * @note Session credentials epochs are created in session scope and should be removed using + * [[removeSessionCredentialsEpoch]] when session closes. + */ +class HadoopCredentialsManager private (name: String) extends AbstractService(name) + with Logging { + + def this() = this(classOf[HadoopCredentialsManager].getSimpleName) + + private val userCredentialsRefMap = new ConcurrentHashMap[String, CredentialsRef]() + private val sessionCredentialsEpochMap = new ConcurrentHashMap[String, Long]() + + private var providers: Map[String, HadoopDelegationTokenProvider] = _ + private var renewalInterval: Long = _ + private var renewalRetryWait: Long = _ + private var hadoopConf: Configuration = _ + + private[credentials] var renewalExecutor: Option[ScheduledExecutorService] = None + + override def initialize(conf: KyuubiConf): Unit = { + hadoopConf = KyuubiHadoopUtils.newHadoopConf(conf) + providers = HadoopCredentialsManager.loadProviders(conf) + .filter { case (_, provider) => + val required = provider.delegationTokensRequired(hadoopConf, conf) + if (!required) { + warn(s"Service ${provider.serviceName} does not require a token." + + s" Check your configuration to see if security is disabled or not.") + } + required + } + + if (providers.isEmpty) { + warn("No delegation token is required by services.") + } else { + info("Using the following builtin delegation token providers: " + + s"${providers.keys.mkString(", ")}.") + } + + renewalInterval = conf.get(CREDENTIALS_RENEWAL_INTERVAL) + renewalRetryWait = conf.get(CREDENTIALS_RENEWAL_RETRY_WAIT) + super.initialize(conf) + } + + override def start(): Unit = { + if (providers.nonEmpty) { + renewalExecutor = + Some(ThreadUtils.newDaemonSingleThreadScheduledExecutor("Delegation Token Renewal Thread")) + } + super.start() + } + + override def stop(): Unit = { + renewalExecutor.foreach { executor => + executor.shutdownNow() + try { + executor.awaitTermination(10, TimeUnit.SECONDS) + } catch { + case _: InterruptedException => + } + } + super.stop() + } + + /** + * Send credentials to SQL engine which the specified session is talking to if + * [[HadoopCredentialsManager]] has a newer credentials. + * + * @param sessionId Specify the session which is talking with SQL engine + * @param appUser User identity that the SQL engine uses. + * @param send Function to send encoded credentials to SQL engine + */ + def sendCredentialsIfNeeded( + sessionId: String, + appUser: String, + send: String => Unit): Unit = { + val userRef = getOrCreateUserCredentialsRef(appUser) Review comment: what can skip this if providers is empty? -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
