com.tigergraph.spark.client.Auth Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tigergraph-spark-connector Show documentation
TigerGraph Ecosystem - Spark Connector
The newest version!
/**
 * Copyright (c) 2023 TigerGraph Inc.
 *
 * Licensed 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 com.tigergraph.spark.client;

import com.tigergraph.spark.client.common.RestppResponse;
import com.tigergraph.spark.util.Utils;
import feign.*;

/** APIs for RESTPP authentication */
public interface Auth {
  public static final long TOKEN_LIFETIME_SEC = 6 * 60 * 60; // 6h

  /**
   * A helper function to check whether RESTPP auth is enabled, if not, an exception of 401/403
   * error will be thrown.
   */
  @RequestLine("GET /restpp/version")
  RestppResponse getVersionWithoutToken();

  default Boolean checkAuthEnabled() {
    try {
      getVersionWithoutToken();
    } catch (FeignException e) {
      // The code is different in different RESTPP versions
      if (e.status() == 401 || e.status() == 403) {
        return true;
      }
    }
    return false;
  }

  /**
   * @deprecated TG 4.1.0
   */
  @RequestLine("POST /restpp/requesttoken")
  @Headers({"Content-Type: application/json", "Authorization: Basic {basicAuth}"})
  @Body("%7B\"graph\": \"{graph}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse requestTokenWithUserPassV0(
      @Param("graph") String graph,
      @Param("basicAuth") String basicAuth,
      @Param("lifetime") long lifetime);

  /**
   * @since TG 4.1.0
   */
  @RequestLine("POST /gsql/v1/tokens")
  @Headers({"Content-Type: application/json", "Authorization: Basic {basicAuth}"})
  @Body("%7B\"graph\": \"{graph}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse requestTokenWithUserPassV1(
      @Param("graph") String graph,
      @Param("basicAuth") String basicAuth,
      @Param("lifetime") long lifetime);

  default AuthResponse requestTokenWithUserPass(
      String version, String graph, String basicAuth, long lifetime) {
    if (Utils.versionCmp(version, "4.1.0") >= 0) {
      return requestTokenWithUserPassV1(graph, basicAuth, lifetime);
    } else {
      return requestTokenWithUserPassV0(graph, basicAuth, lifetime);
    }
  }

  /**
   * @deprecated TG 4.1.0
   */
  @RequestLine("POST /restpp/requesttoken")
  @Headers({"Content-Type: application/json"})
  @Body("%7B\"secret\": \"{secret}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse requestTokenWithSecretV0(
      @Param("secret") String secret, @Param("lifetime") long lifetime);

  /**
   * @since TG 4.1.0
   */
  @RequestLine("POST /gsql/v1/tokens")
  @Headers({"Content-Type: application/json"})
  @Body("%7B\"secret\": \"{secret}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse requestTokenWithSecretV1(
      @Param("secret") String secret, @Param("lifetime") long lifetime);

  default AuthResponse requestTokenWithSecret(String version, String secret, long lifetime) {
    if (Utils.versionCmp(version, "4.1.0") >= 0) {
      return requestTokenWithSecretV1(secret, lifetime);
    } else {
      return requestTokenWithSecretV0(secret, lifetime);
    }
  }

  /**
   * @deprecated TG 4.1.0
   */
  @RequestLine("PUT /restpp/requesttoken")
  @Headers({"Content-Type: application/json", "Authorization: Basic {basicAuth}"})
  @Body("%7B\"token\": \"{token}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse refreshTokenWithUserPass(
      @Param("token") String token,
      @Param("basicAuth") String basicAuth,
      @Param("lifetime") long lifetime);

  /**
   * @deprecated TG 4.1.0
   */
  @RequestLine("PUT /restpp/requesttoken")
  @Headers({"Content-Type: application/json"})
  @Body("%7B\"secret\": \"{secret}\", \"token\": \"{token}\", \"lifetime\": \"{lifetime}\"%7D")
  AuthResponse refreshTokenWithSecrect(
      @Param("token") String token,
      @Param("secret") String secret,
      @Param("lifetime") long lifetime);

  public class AuthResponse extends RestppResponse {
    public String expiration;
    public String token;

    /**
     * RESTPP has different response format in different versions, we need to try to parse token
     * from different places.
     */
    public String getToken() {
      if (!Utils.isEmpty(token)) {
        return token;
      } else if (results != null) {
        return results.path("token").asText();
      } else {
        return "";
      }
    }
  }
}