133 lines
4.5 KiB
Java
133 lines
4.5 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.oauth2.core.ClientAuthenticationMethod;
|
|
import org.springframework.security.oauth2.core.Version;
|
|
import org.springframework.security.oauth2.server.authorization.client.RegisteredClient;
|
|
import org.springframework.util.Assert;
|
|
|
|
import java.util.Collections;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* An {@link Authentication} implementation used for OAuth 2.0 Client Authentication.
|
|
*
|
|
* @author Joe Grandja
|
|
* @author Patryk Kostrzewa
|
|
* @author Anoop Garlapati
|
|
* @since 0.0.1
|
|
* @see AbstractAuthenticationToken
|
|
* @see RegisteredClient
|
|
* @see OAuth2ClientAuthenticationProvider
|
|
*/
|
|
public class OAuth2ClientAuthenticationToken extends AbstractAuthenticationToken {
|
|
private static final long serialVersionUID = Version.SERIAL_VERSION_UID;
|
|
private String clientId;
|
|
private String clientSecret;
|
|
private ClientAuthenticationMethod clientAuthenticationMethod;
|
|
private Map<String, Object> additionalParameters;
|
|
private RegisteredClient registeredClient;
|
|
|
|
/**
|
|
* Constructs an {@code OAuth2ClientAuthenticationToken} using the provided parameters.
|
|
*
|
|
* @param clientId the client identifier
|
|
* @param clientSecret the client secret
|
|
* @param clientAuthenticationMethod the authentication method used by the client
|
|
* @param additionalParameters the additional parameters
|
|
*/
|
|
public OAuth2ClientAuthenticationToken(String clientId, String clientSecret,
|
|
ClientAuthenticationMethod clientAuthenticationMethod,
|
|
@Nullable Map<String, Object> additionalParameters) {
|
|
this(clientId, additionalParameters);
|
|
Assert.hasText(clientSecret, "clientSecret cannot be empty");
|
|
Assert.notNull(clientAuthenticationMethod, "clientAuthenticationMethod cannot be null");
|
|
this.clientSecret = clientSecret;
|
|
this.clientAuthenticationMethod = clientAuthenticationMethod;
|
|
}
|
|
|
|
/**
|
|
* Constructs an {@code OAuth2ClientAuthenticationToken} using the provided parameters.
|
|
*
|
|
* @param clientId the client identifier
|
|
* @param additionalParameters the additional parameters
|
|
*/
|
|
public OAuth2ClientAuthenticationToken(String clientId,
|
|
@Nullable Map<String, Object> additionalParameters) {
|
|
super(Collections.emptyList());
|
|
Assert.hasText(clientId, "clientId cannot be empty");
|
|
this.clientId = clientId;
|
|
this.additionalParameters = additionalParameters != null ?
|
|
Collections.unmodifiableMap(additionalParameters) : null;
|
|
this.clientAuthenticationMethod = ClientAuthenticationMethod.NONE;
|
|
}
|
|
|
|
/**
|
|
* Constructs an {@code OAuth2ClientAuthenticationToken} using the provided parameters.
|
|
*
|
|
* @param registeredClient the registered client
|
|
*/
|
|
public OAuth2ClientAuthenticationToken(RegisteredClient registeredClient) {
|
|
super(Collections.emptyList());
|
|
Assert.notNull(registeredClient, "registeredClient cannot be null");
|
|
this.registeredClient = registeredClient;
|
|
setAuthenticated(true);
|
|
}
|
|
|
|
@Override
|
|
public Object getPrincipal() {
|
|
return this.registeredClient != null ?
|
|
this.registeredClient.getClientId() :
|
|
this.clientId;
|
|
}
|
|
|
|
@Override
|
|
public Object getCredentials() {
|
|
return this.clientSecret;
|
|
}
|
|
|
|
/**
|
|
* Returns the additional parameters
|
|
*
|
|
* @return the additional parameters
|
|
*/
|
|
public @Nullable Map<String, Object> getAdditionalParameters() {
|
|
return this.additionalParameters;
|
|
}
|
|
|
|
/**
|
|
* Returns the {@link RegisteredClient registered client}.
|
|
*
|
|
* @return the {@link RegisteredClient}
|
|
*/
|
|
public @Nullable RegisteredClient getRegisteredClient() {
|
|
return this.registeredClient;
|
|
}
|
|
|
|
/**
|
|
* Returns the {@link ClientAuthenticationMethod client authentication method}.
|
|
*
|
|
* @return the {@link ClientAuthenticationMethod}
|
|
*/
|
|
public @Nullable ClientAuthenticationMethod getClientAuthenticationMethod() {
|
|
return this.clientAuthenticationMethod;
|
|
}
|
|
}
|