org.springframework.security.oauth2.provider.ClientAuthenticationToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-security-oauth
Module for providing OAuth support to Spring Security
The newest version!
package org.springframework.security.oauth2.provider;

import org.springframework.security.authentication.AbstractAuthenticationToken;
import org.springframework.security.core.GrantedAuthority;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;

/**
 * @author Ryan Heaton
 */
public class ClientAuthenticationToken extends AbstractAuthenticationToken {

  private final String clientId;
  private final String clientSecret;
  private final String flowType;
  private final Set scope;
  private final boolean requiresImmediateAuthentication;
  private final String state;
  private final transient HttpServletRequest request;
  private final String verificationCode;
  private final String requestedRedirect;
  private boolean denied;

  public ClientAuthenticationToken(String clientId, String clientSecret, Set scope, String flowType) {
    super(null);
    this.clientId = clientId;
    this.clientSecret = clientSecret;
    this.flowType = flowType;
    this.scope = scope;
    this.request = null;
    this.requiresImmediateAuthentication = false;
    this.state = null;
    this.verificationCode = null;
    this.requestedRedirect = null;
  }

  /**
   * Construct an unauthenticated Client Authentication from a request and a specific authorization type.
   *
   * @param request The request.
   * @param flowType The authorization type.
   */
  public ClientAuthenticationToken(HttpServletRequest request, String flowType) {
    super(null);
    this.clientId = request.getParameter("client_id");
    this.clientSecret = request.getParameter("client_secret");
    this.requiresImmediateAuthentication = "true".equalsIgnoreCase(request.getParameter("immediate"));
    this.requestedRedirect = request.getParameter("redirect_uri");
    this.state = request.getParameter("state");
    this.verificationCode = request.getParameter("code");

    Set scope = new TreeSet();
    String scopeValue = request.getParameter("scope");
    if (scopeValue != null) {
      //the spec says the scope is separated by spaces, but Facebook uses commas, so we'll include commas, too.
      String[] tokens = scopeValue.split("[\\s+,]");
      scope.addAll(Arrays.asList(tokens));
    }
    this.scope = scope;
    this.flowType = flowType;
    this.request = request;
  }

  /**
   * Construct an authenticated token from an unauthenticated token.
   *
   * @param unauthenticated The unauthenticated token.
   * @param authorities The authorities granted.
   */
  public ClientAuthenticationToken(ClientAuthenticationToken unauthenticated, Collection authorities) {
    super(authorities);
    this.clientId = unauthenticated.getClientId();
    this.clientSecret = unauthenticated.getClientSecret();
    this.scope = unauthenticated.getScope();
    this.flowType = unauthenticated.getFlowType();
    this.request = unauthenticated.getRequest();
    this.requestedRedirect = unauthenticated.getRequestedRedirect();
    this.requiresImmediateAuthentication = false; //irrelevant for authenticated requests.
    this.state = unauthenticated.getState();
    this.verificationCode = unauthenticated.getVerificationCode();
    setAuthenticated(true);
  }

  public String getClientId() {
    return this.clientId;
  }

  public Object getPrincipal() {
    return getClientId();
  }

  public String getClientSecret() {
    return this.clientSecret;
  }

  public Object getCredentials() {
    return getClientSecret();
  }

  public boolean isRequiresImmediateAuthentication() {
    return this.requiresImmediateAuthentication;
  }

  public String getRequestedRedirect() {
    return requestedRedirect;
  }

  public String getState() {
    return state;
  }

  public Set getScope() {
    return this.scope;
  }

  public String getFlowType() {
    return flowType;
  }

  public HttpServletRequest getRequest() {
    return request;
  }

  public String getVerificationCode() {
    return verificationCode;
  }

  public boolean isDenied() {
    return denied;
  }

  public void setDenied(boolean denied) {
    this.denied = denied;
    setAuthenticated(!denied);
  }
}