• Home
• com.docusign
• docusign-esign-java
• 6.0.0
• source code
• OAuth.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.docusign.esign.client.auth.OAuth Maven / Gradle / Ivy

package com.docusign.esign.client.auth;

import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.Pair;
import com.docusign.esign.client.RFC3339DateFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.ws.rs.client.*;
import jakarta.ws.rs.core.Form;
import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.text.DateFormat;
import java.util.*;

/** OAuth class. */
public class OAuth implements Authentication {
  static final int MILLIS_PER_SECOND = 1000;

  // OAuth Scope constants
  /** create and send envelopes, and obtain links for starting signing sessions. */
  public static final String Scope_SIGNATURE = "signature";
  /** obtain a refresh token with an extended lifetime. */
  public static final String Scope_EXTENDED = "extended";
  /** obtain access to the user’s account when the user is not present. */
  public static final String Scope_IMPERSONATION = "impersonation";

  // OAuth ResponseType constants
  /** used by public/native client applications. */
  public static final String CODE = "code";
  /** used by private/trusted client application. */
  public static final String TOKEN = "token";

  // OAuth base path constants
  /** live/production base path. */
  public static final String PRODUCTION_OAUTH_BASEPATH = "account.docusign.com";
  /** sandbox/demo base path. */
  public static final String DEMO_OAUTH_BASEPATH = "account-d.docusign.com";
  /** stage base path. */
  public static final String STAGE_OAUTH_BASEPATH = "account-s.docusign.com";

  // OAuth grant types
  /** JWT grant type. */
  public static final String GRANT_TYPE_JWT = "urn:ietf:params:oauth:grant-type:jwt-bearer";

  // Client ID and secret for oauth
  private String clientId = null;
  private String clientSecret = null;

  // auth, token and redirect urls
  private String authorizationUrl = null;
  private String tokenUrl = null;
  private String redirectURI = null;

  // scopes and grant type
  private String scope = null;
  private OAuthFlow grantType = null;

  private volatile String accessToken;
  private volatile String refreshToken;
  private volatile String authCode;
  private volatile String jwtAssertion;

  private Long expirationTimeMillis;
  private AccessTokenListener accessTokenListener;

  private Client httpClient;

  /** OAuth constructor. */
  public OAuth() {}

  public OAuth(Client httpClient) {
    this.httpClient = httpClient;
  }

  /**
   * OAuth constructor.
   *
   * @param client The client to use
   * @param flow The OAuth flow
   * @param authorizationUrl The auth url
   * @param tokenUrl The token URL
   * @param scopes The scopes to use
   */
  public OAuth(
      Client client, OAuthFlow flow, String authorizationUrl, String tokenUrl, String scopes) {
    this.httpClient = client;
    setScope(scopes);
    setGrantType(flow);
    setAuthorizationUrl(authorizationUrl);
    setTokenUrl(tokenUrl);
  }

  /**
   * OAuth constructor.
   *
   * @param flow The OAuth flow
   * @param authorizationUrl The auth url
   * @param tokenUrl The token URL
   * @param scopes The scopes to use
   */
  public OAuth(OAuthFlow flow, String authorizationUrl, String tokenUrl, String scopes) {
    this(ClientBuilder.newBuilder().build(), flow, authorizationUrl, tokenUrl, scopes);
  }

  /**
   * applyToParams method.
   *
   * @param queryParams The query params
   * @param headerParams The header params
   */
  @Override
  public void applyToParams(List queryParams, Map headerParams) {
    // If first time, get the token
    if (expirationTimeMillis == null || System.currentTimeMillis() >= expirationTimeMillis) {
      try {
        updateAccessToken();
      } catch (ApiException e) {
        accessToken = null;
      }
    }
    if (accessToken != null) {
      headerParams.put("Authorization", "Bearer " + accessToken);
    }
  }

  /** updateAccessToken method. */
  public synchronized void updateAccessToken() throws ApiException {
    OAuthToken oauthToken = null;
    try {
      switch (getGrantType()) {
        case accessCode: // Authorization Grant
          oauthToken = generateAccessToken();
          break;
        case jwt: // JWT Grant
          oauthToken = requestJWTUserToken();
          break;
        default: // Implicit Grant - token will already be set by consuming app using
          // setAccessToken()
          break;
      }
    } catch (Exception e) {
      throw new ApiException(e.getMessage());
    }
    if (oauthToken != null) {
      if (oauthToken.getAccessToken() == null) {
        throw new ApiException("Error while requesting an access token. No 'access_token' found.");
      }
      if (oauthToken.getExpiresIn() == null) {
        throw new ApiException("Error while requesting an access token. No 'expires_in' found.");
      }

      setAccessToken(oauthToken.getAccessToken(), Long.valueOf(oauthToken.getExpiresIn()));
      if (this.accessTokenListener != null) {
        this.accessTokenListener.notify(oauthToken);
      }
    } else {
      // in case of HTTP error codes accessTokenResponse is null, thus no check of
      // accessTokenResponse.getResponseCode() possible :-(
      throw new ApiException(
          "Error while requesting an access token. No accessTokenResponse object recieved, maybe a non HTTP 200 received?");
    }
  }

  /**
   * Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign.
   *
   * @return OAuth.OAuthToken object.
   * @throws IllegalArgumentException if one of the arguments is invalid
   * @throws ApiException if there is an error while exchanging the JWT with an access token
   * @throws IOException if there is an issue with either the public or private file
   */
  public OAuth.OAuthToken requestJWTUserToken()
      throws IllegalArgumentException, ApiException, IOException {
    java.util.Map form = new java.util.HashMap<>();
    form.put("assertion", getJwtAssertion());
    form.put("grant_type", OAuth.GRANT_TYPE_JWT);

    WebTarget target = httpClient.target(getTokenUrl());
    Invocation.Builder invocationBuilder = target.request();
    invocationBuilder =
        invocationBuilder.header("Cache-Control", "no-store").header("Pragma", "no-cache");

    Entity entity = serialize(null, form, MediaType.APPLICATION_FORM_URLENCODED);

    Response response = null;

    try {
      response = invocationBuilder.post(entity);

      if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) {
        String message = "error";
        String respBody = null;
        if (response.hasEntity()) {
          try {
            respBody = String.valueOf(response.readEntity(String.class));
            message =
                "Error while requesting server, received a non successful HTTP code "
                    + response.getStatusInfo().getStatusCode()
                    + " with response Body: '"
                    + respBody
                    + "'";
          } catch (RuntimeException e) {
            // e.printStackTrace();
          }
        }
        throw new ApiException(
            response.getStatusInfo().getStatusCode(),
            message,
            buildResponseHeaders(response),
            respBody);
      }

      GenericType returnType = new GenericType() {};
      OAuth.OAuthToken oAuthToken = deserialize(response, returnType);
      if (oAuthToken.getAccessToken() == null
          || "".equals(oAuthToken.getAccessToken())
          || oAuthToken.getExpiresIn() <= 0) {
        throw new ApiException("Error while requesting an access token: " + response.toString());
      }
      return oAuthToken;
    } finally {
      try {
        if (response != null) {
          response.close();
        }
      } catch (Exception e) {
        // it's not critical, since the response object is local in method invokeAPI; that's fine,
        // just continue
      }
    }
  }

  /**
   * Helper method to configure the OAuth accessCode/implicit flow parameters.
   *
   * @return OAuth.OAuthToken object.
   * @throws ApiException if the HTTP call status is different than 2xx.
   * @throws IOException if there is a problem while parsing the reponse object.
   * @see OAuth.OAuthToken
   */
  public OAuth.OAuthToken generateAccessToken() throws ApiException, IOException {
    String clientId = getClientId();
    String clientSecret = getClientSecret();
    String code = getAuthCode();
    String clientStr =
        (clientId == null ? "" : clientId) + ":" + (clientSecret == null ? "" : clientSecret);
    java.util.Map form = new java.util.HashMap<>();
    form.put("code", code);
    form.put("grant_type", "authorization_code");

    WebTarget target = httpClient.target(getTokenUrl());

    Invocation.Builder invocationBuilder = target.request();
    invocationBuilder =
        invocationBuilder
            .header(
                "Authorization",
                "Basic "
                    + Base64.getEncoder()
                        .encodeToString(clientStr.getBytes(StandardCharsets.UTF_8)))
            .header("Cache-Control", "no-store")
            .header("Pragma", "no-cache");

    Entity entity = serialize(null, form, MediaType.APPLICATION_FORM_URLENCODED);

    Response response = null;

    try {
      response = invocationBuilder.post(entity);

      if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) {
        String message = "error";
        String respBody = null;
        if (response.hasEntity()) {
          try {
            respBody = String.valueOf(response.readEntity(String.class));
            message =
                "Error while requesting server, received a non successful HTTP code "
                    + response.getStatusInfo().getStatusCode()
                    + " with response Body: '"
                    + respBody
                    + "'";
          } catch (RuntimeException e) {
            // e.printStackTrace();
          }
        }
        throw new ApiException(
            response.getStatusInfo().getStatusCode(),
            message,
            buildResponseHeaders(response),
            respBody);
      }

      GenericType returnType = new GenericType() {};
      return deserialize(response, returnType);
    } finally {
      try {
        if (response != null) {
          response.close();
        }
      } catch (Exception e) {
        // it's not critical, since the response object is local in method invokeAPI; that's fine,
        // just continue
      }
    }
  }

  /**
   * registerAccessTokenListener method.
   *
   * @param accessTokenListener The access token listener
   */
  public synchronized void registerAccessTokenListener(AccessTokenListener accessTokenListener) {
    this.accessTokenListener = accessTokenListener;
  }

  /**
   * getAccessToken method.
   *
   * @return String
   */
  public synchronized String getAccessToken() {
    return accessToken;
  }

  public Long getExpirationTimeMillis() {
    return expirationTimeMillis;
  }

  public void setExpirationTimeMillis(Long expirationTimeMillis) {
    this.expirationTimeMillis = expirationTimeMillis;
  }

  public synchronized void setAccessToken(String accessToken, Long expiresIn) {
    this.accessToken = accessToken;
    this.expirationTimeMillis = System.currentTimeMillis() + expiresIn * MILLIS_PER_SECOND;
  }

  public String getClientId() {
    return clientId;
  }

  public void setClientId(String clientId) {
    this.clientId = clientId;
  }

  public String getClientSecret() {
    return clientSecret;
  }

  public void setClientSecret(String clientSecret) {
    this.clientSecret = clientSecret;
  }

  public String getAuthorizationUrl() {
    return authorizationUrl;
  }

  public void setAuthorizationUrl(String authorizationUrl) {
    this.authorizationUrl = authorizationUrl;
  }

  public String getTokenUrl() {
    return tokenUrl;
  }

  public void setTokenUrl(String tokenUrl) {
    this.tokenUrl = tokenUrl;
  }

  public String getRedirectURI() {
    return redirectURI;
  }

  public void setRedirectURI(String redirectURI) {
    this.redirectURI = redirectURI;
  }

  public String getScope() {
    return scope;
  }

  public void setScope(String scope) {
    this.scope = scope;
  }

  public OAuthFlow getGrantType() {
    return grantType;
  }

  public void setGrantType(OAuthFlow grantType) {
    this.grantType = grantType;
  }

  public String getJwtAssertion() {
    return jwtAssertion;
  }

  public void setJwtAssertion(String jwtAssertion) {
    this.jwtAssertion = jwtAssertion;
  }

  public String getAuthCode() {
    return authCode;
  }

  public void setAuthCode(String authCode) {
    this.authCode = authCode;
  }

  protected Map> buildResponseHeaders(Response response) {
    Map> responseHeaders = new HashMap>();
    for (Map.Entry> entry : response.getHeaders().entrySet()) {
      List