140 lines
4.4 KiB
Java
140 lines
4.4 KiB
Java
/*
|
|
* Copyright 2020 the original author or authors.
|
|
*
|
|
* 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
|
|
*
|
|
* https://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.springframework.security.oauth2.server.authorization.authentication;
|
|
|
|
import org.springframework.lang.Nullable;
|
|
import org.springframework.security.authentication.AbstractAuthenticationToken;
|
|
import org.springframework.security.core.Authentication;
|
|
import org.springframework.security.core.SpringSecurityCoreVersion2;
|
|
import org.springframework.util.Assert;
|
|
|
|
import java.util.Collections;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* An {@link Authentication} implementation used for the OAuth 2.0 Authorization Code Grant.
|
|
*
|
|
* @author Joe Grandja
|
|
* @author Madhu Bhat
|
|
* @author Daniel Garnier-Moiroux
|
|
* @since 0.0.1
|
|
* @see AbstractAuthenticationToken
|
|
* @see OAuth2AuthorizationCodeAuthenticationProvider
|
|
* @see OAuth2ClientAuthenticationToken
|
|
*/
|
|
public class OAuth2AuthorizationCodeAuthenticationToken extends AbstractAuthenticationToken {
|
|
private static final long serialVersionUID = SpringSecurityCoreVersion2.SERIAL_VERSION_UID;
|
|
private final String code;
|
|
private final Authentication clientPrincipal;
|
|
private final String clientId;
|
|
private final String redirectUri;
|
|
private final Map<String, Object> additionalParameters;
|
|
|
|
/**
|
|
* Constructs an {@code OAuth2AuthorizationCodeAuthenticationToken} using the provided parameters.
|
|
*
|
|
* @param code the authorization code
|
|
* @param clientPrincipal the authenticated client principal
|
|
* @param redirectUri the redirect uri
|
|
* @param additionalParameters the additional parameters
|
|
*/
|
|
public OAuth2AuthorizationCodeAuthenticationToken(String code, Authentication clientPrincipal,
|
|
@Nullable String redirectUri, @Nullable Map<String, Object> additionalParameters) {
|
|
super(Collections.emptyList());
|
|
Assert.hasText(code, "code cannot be empty");
|
|
Assert.notNull(clientPrincipal, "clientPrincipal cannot be null");
|
|
this.code = code;
|
|
this.clientPrincipal = clientPrincipal;
|
|
this.clientId = OAuth2ClientAuthenticationToken.class.isAssignableFrom(this.clientPrincipal.getClass()) ?
|
|
(String) this.clientPrincipal.getPrincipal() :
|
|
null;
|
|
this.redirectUri = redirectUri;
|
|
this.additionalParameters = Collections.unmodifiableMap(
|
|
additionalParameters != null ?
|
|
additionalParameters :
|
|
Collections.emptyMap());
|
|
}
|
|
|
|
/**
|
|
* Constructs an {@code OAuth2AuthorizationCodeAuthenticationToken} using the provided parameters.
|
|
*
|
|
* @param code the authorization code
|
|
* @param clientId the client identifier
|
|
* @param redirectUri the redirect uri
|
|
* @param additionalParameters the additional parameters
|
|
*/
|
|
public OAuth2AuthorizationCodeAuthenticationToken(String code, String clientId,
|
|
@Nullable String redirectUri, @Nullable Map<String, Object> additionalParameters) {
|
|
super(Collections.emptyList());
|
|
Assert.hasText(code, "code cannot be empty");
|
|
Assert.hasText(clientId, "clientId cannot be empty");
|
|
this.code = code;
|
|
this.clientPrincipal = null;
|
|
this.clientId = clientId;
|
|
this.redirectUri = redirectUri;
|
|
this.additionalParameters = Collections.unmodifiableMap(
|
|
additionalParameters != null ?
|
|
additionalParameters :
|
|
Collections.emptyMap());
|
|
}
|
|
|
|
@Override
|
|
public Object getPrincipal() {
|
|
return this.clientPrincipal != null ? this.clientPrincipal : this.clientId;
|
|
}
|
|
|
|
@Override
|
|
public Object getCredentials() {
|
|
return "";
|
|
}
|
|
|
|
/**
|
|
* Returns the authorization code.
|
|
*
|
|
* @return the authorization code
|
|
*/
|
|
public String getCode() {
|
|
return this.code;
|
|
}
|
|
|
|
/**
|
|
* Returns the client identifier
|
|
*
|
|
* @return the client identifier
|
|
*/
|
|
public @Nullable String getClientId() {
|
|
return this.clientId;
|
|
}
|
|
|
|
/**
|
|
* Returns the redirect uri.
|
|
*
|
|
* @return the redirect uri
|
|
*/
|
|
public @Nullable String getRedirectUri() {
|
|
return this.redirectUri;
|
|
}
|
|
|
|
/**
|
|
* Returns the additional parameters
|
|
*
|
|
* @return the additional parameters
|
|
*/
|
|
public Map<String, Object> getAdditionalParameters() {
|
|
return this.additionalParameters;
|
|
}
|
|
}
|