org.apache.hadoop.hive.druid.security.KerberosHttpClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hive-druid-handler Show documentation
There is a newer version: 4.0.1
/*
 * 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.hadoop.hive.druid.security;

import com.google.common.base.Throwables;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import org.apache.druid.java.util.http.client.AbstractHttpClient;
import org.apache.druid.java.util.http.client.HttpClient;
import org.apache.druid.java.util.http.client.Request;
import org.apache.druid.java.util.http.client.response.HttpResponseHandler;
import org.apache.hadoop.security.UserGroupInformation;
import org.jboss.netty.handler.codec.http.HttpHeaders;
import org.joda.time.Duration;
import org.slf4j.LoggerFactory;

import java.net.CookieManager;
import java.net.URI;
import java.security.PrivilegedExceptionAction;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 * This is a slightly modified version of kerberos module borrowed from druid project
 * Couple of reasons behind the copy/modification instead of mvn dependency.
 *  1/ Need to remove the authentication step since it not required
 *  2/ To avoid some un-needed transitive dependencies that can clash on the classpath like jetty-XX.
 */
public class KerberosHttpClient extends AbstractHttpClient {
  protected static final org.slf4j.Logger LOG = LoggerFactory.getLogger(KerberosHttpClient.class);
  private final HttpClient delegate;
  private final CookieManager cookieManager;

  public KerberosHttpClient(HttpClient delegate) {
    this.delegate = delegate;
    this.cookieManager = new CookieManager();
  }

  @Override public  ListenableFuture go(Request request,
      HttpResponseHandler httpResponseHandler,
      Duration duration) {
    final SettableFuture retVal = SettableFuture.create();
    innerGo(request, httpResponseHandler, duration, retVal);
    return retVal;
  }

  private  void innerGo(final Request request,
      final HttpResponseHandler httpResponseHandler,
      final Duration duration,
      final SettableFuture future) {
    try {
      final String host = request.getUrl().getHost();
      final URI uri = request.getUrl().toURI();

      /* Cookies Manager is used to cache cookie returned by service.
       The goal us to avoid doing KDC requests for every request.*/

      Map> cookieMap = cookieManager.get(uri, Collections.emptyMap());
      for (Map.Entry> entry : cookieMap.entrySet()) {
        request.addHeaderValues(entry.getKey(), entry.getValue());
      }
      final boolean shouldRetryOnUnauthorizedResponse;

      if (DruidKerberosUtil.needToSendCredentials(cookieManager.getCookieStore(), uri)) {
        // No Cookies for requested URI, authenticate user and add authentication header
        LOG.debug("No Auth Cookie found for URI{}. Existing Cookies{} Authenticating... ",
            uri,
            cookieManager.getCookieStore().getCookies());
        // Assuming that a valid UGI with kerberos cred is created by HS2 or LLAP
        UserGroupInformation currentUser = UserGroupInformation.getCurrentUser();
        currentUser.checkTGTAndReloginFromKeytab();
        LOG.debug("The user credential is {}", currentUser);
        String
            challenge =
            currentUser.doAs((PrivilegedExceptionAction) () -> DruidKerberosUtil.kerberosChallenge(host));
        request.setHeader(HttpHeaders.Names.AUTHORIZATION, "Negotiate " + challenge);
        /* no reason to retry if the challenge ticket is not valid. */
        shouldRetryOnUnauthorizedResponse = false;
      } else {
        /* In this branch we had already a cookie that did expire
        therefore we need to resend a valid Kerberos challenge*/
        LOG.debug("Found Auth Cookie found for URI {} cookie {}",
            uri,
            DruidKerberosUtil.getAuthCookie(cookieManager.getCookieStore(), uri).toString());
        shouldRetryOnUnauthorizedResponse = true;
      }

      @SuppressWarnings("unchecked") ListenableFuture>
          internalFuture =
          delegate.go(request,
              new RetryIfUnauthorizedResponseHandler(new ResponseCookieHandler(request.getUrl()
                  .toURI(), cookieManager, httpResponseHandler)),
              duration);

      RetryResponseHolder responseHolder = internalFuture.get();

      if (shouldRetryOnUnauthorizedResponse && responseHolder.shouldRetry()) {
        LOG.debug("Preparing for Retry boolean {} and result {}, object{} ", true,
            responseHolder.shouldRetry(),
            responseHolder.getObj());
        // remove Auth cookie
        DruidKerberosUtil.removeAuthCookie(cookieManager.getCookieStore(), uri);
        // clear existing cookie
        request.setHeader("Cookie", "");
        innerGo(request.copy(), httpResponseHandler, duration, future);

      } else {
        future.set(responseHolder.getObj());
      }
    } catch (Throwable e) {
      throw Throwables.propagate(e);
    }
  }

}