exec/java-exec/src/main/java/org/apache/drill/exec/server/rest/PluginConfigWrapper.java

/*
 * 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.drill.exec.server.rest;

import java.util.Optional;

import javax.ws.rs.core.SecurityContext;
import javax.xml.bind.annotation.XmlRootElement;

import com.fasterxml.jackson.annotation.JacksonInject;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.apache.drill.common.logical.CredentialedStoragePluginConfig;
import org.apache.drill.common.logical.StoragePluginConfig;
import org.apache.drill.common.logical.security.CredentialsProvider;
import org.apache.drill.exec.store.StoragePluginRegistry;
import org.apache.drill.exec.store.StoragePluginRegistry.PluginException;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.drill.exec.store.security.UsernamePasswordCredentials;
import org.apache.drill.exec.store.security.oauth.OAuthTokenCredentials;

@XmlRootElement
public class PluginConfigWrapper {
  private final String name;
  private final StoragePluginConfig config;
  private final SecurityContext sc;

  @JsonCreator
  public PluginConfigWrapper(@JsonProperty("name") String name,
                             @JsonProperty("config") StoragePluginConfig config,
                             @JacksonInject SecurityContext sc) {
    this.name = name;
    this.config = config;
    this.sc = sc;
  }

  public String getName() { return name; }

  public StoragePluginConfig getConfig() { return config; }

  public boolean enabled() {
    return config.isEnabled();
  }

  @JsonIgnore
  public String getUserName() {
    if (!(config instanceof CredentialedStoragePluginConfig)) {
      return null;
    }

    CredentialedStoragePluginConfig securedStoragePluginConfig = (CredentialedStoragePluginConfig) config;
    CredentialsProvider credentialsProvider = securedStoragePluginConfig.getCredentialsProvider();
    String queryUser = sc.getUserPrincipal().getName();
    Optional<UsernamePasswordCredentials> credentials = new UsernamePasswordCredentials.Builder()
      .setCredentialsProvider(credentialsProvider)
      .setQueryUser(queryUser)
      .build();

    return credentials.map(UsernamePasswordCredentials::getUsername).orElse(null);
  }

  @JsonIgnore
  public String getPassword() {
    if (!(config instanceof CredentialedStoragePluginConfig)) {
      return null;
    }

    CredentialedStoragePluginConfig securedStoragePluginConfig = (CredentialedStoragePluginConfig) config;
    CredentialsProvider credentialsProvider = securedStoragePluginConfig.getCredentialsProvider();
    String queryUser = sc.getUserPrincipal().getName();
    Optional<UsernamePasswordCredentials> credentials = new UsernamePasswordCredentials.Builder()
      .setCredentialsProvider(credentialsProvider)
      .setQueryUser(queryUser)
      .build();

    return credentials.map(UsernamePasswordCredentials::getPassword).orElse(null);
  }

  public void createOrUpdateInStorage(StoragePluginRegistry storage) throws PluginException {
    storage.validatedPut(name, config);
  }

  /**
   * Determines whether the storage plugin in question needs the OAuth button in the UI.  In
   * order to be considered an OAuth plugin, the plugin must:
   * 1. Use AbstractSecuredStoragePluginConfig
   * 2. The credential provider must not be null
   * 3. The credentialsProvider must contain a client_id and client_secret
   * @return true if the plugin uses OAuth, false if not.
   */
  @JsonIgnore
  public boolean isOauth() {
    if (! (config instanceof CredentialedStoragePluginConfig)) {
      return false;
    }
    CredentialedStoragePluginConfig securedStoragePluginConfig = (CredentialedStoragePluginConfig) config;
    CredentialsProvider credentialsProvider = securedStoragePluginConfig.getCredentialsProvider();
    if (credentialsProvider == null) {
      return false;
    }

    Optional<OAuthTokenCredentials> tokenCredentials = new OAuthTokenCredentials.Builder()
      .setCredentialsProvider(credentialsProvider)
      .build();

    return tokenCredentials.map(OAuthTokenCredentials::getClientID).orElse(null) != null;
  }
}