2020-06-11 20:54:01 +07:00
|
|
|
/*
|
2021-02-05 18:30:12 +07:00
|
|
|
* Copyright 2020-2021 the original author or authors.
|
2020-06-11 20:54:01 +07:00
|
|
|
*
|
|
|
|
* 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;
|
|
|
|
|
2020-07-10 20:16:19 +07:00
|
|
|
import java.util.Collections;
|
2021-02-11 21:50:04 +07:00
|
|
|
import java.util.HashSet;
|
|
|
|
import java.util.Map;
|
2020-07-10 20:16:19 +07:00
|
|
|
import java.util.Set;
|
|
|
|
|
2021-02-11 21:50:04 +07:00
|
|
|
import org.springframework.lang.Nullable;
|
2021-02-05 18:30:12 +07:00
|
|
|
import org.springframework.security.core.Authentication;
|
|
|
|
import org.springframework.security.oauth2.core.AuthorizationGrantType;
|
|
|
|
|
2020-06-11 20:54:01 +07:00
|
|
|
/**
|
|
|
|
* An {@link Authentication} implementation used for the OAuth 2.0 Client Credentials Grant.
|
|
|
|
*
|
|
|
|
* @author Alexey Nesterov
|
|
|
|
* @since 0.0.1
|
2021-02-05 18:30:12 +07:00
|
|
|
* @see OAuth2AuthorizationGrantAuthenticationToken
|
2020-06-11 20:54:01 +07:00
|
|
|
* @see OAuth2ClientCredentialsAuthenticationProvider
|
|
|
|
*/
|
2021-02-05 18:30:12 +07:00
|
|
|
public class OAuth2ClientCredentialsAuthenticationToken extends OAuth2AuthorizationGrantAuthenticationToken {
|
2020-06-11 20:54:01 +07:00
|
|
|
private final Set<String> scopes;
|
|
|
|
|
2020-07-10 20:16:19 +07:00
|
|
|
/**
|
|
|
|
* Constructs an {@code OAuth2ClientCredentialsAuthenticationToken} using the provided parameters.
|
|
|
|
*
|
|
|
|
* @param clientPrincipal the authenticated client principal
|
|
|
|
* @param scopes the requested scope(s)
|
2021-02-11 21:50:04 +07:00
|
|
|
* @param additionalParameters the additional parameters
|
2020-07-10 20:16:19 +07:00
|
|
|
*/
|
2021-02-11 21:50:04 +07:00
|
|
|
public OAuth2ClientCredentialsAuthenticationToken(Authentication clientPrincipal,
|
|
|
|
@Nullable Set<String> scopes, @Nullable Map<String, Object> additionalParameters) {
|
|
|
|
super(AuthorizationGrantType.CLIENT_CREDENTIALS, clientPrincipal, additionalParameters);
|
|
|
|
this.scopes = Collections.unmodifiableSet(
|
|
|
|
scopes != null ? new HashSet<>(scopes) : Collections.emptySet());
|
2020-06-11 20:54:01 +07:00
|
|
|
}
|
|
|
|
|
2020-07-10 20:16:19 +07:00
|
|
|
/**
|
|
|
|
* Returns the requested scope(s).
|
|
|
|
*
|
|
|
|
* @return the requested scope(s), or an empty {@code Set} if not available
|
|
|
|
*/
|
2020-06-11 20:54:01 +07:00
|
|
|
public Set<String> getScopes() {
|
|
|
|
return this.scopes;
|
|
|
|
}
|
|
|
|
}
|