|
@@ -0,0 +1,116 @@
|
|
|
+/*
|
|
|
+ * Copyright 2012-2017 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
|
|
|
+ *
|
|
|
+ * http://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.client.authentication;
|
|
|
+
|
|
|
+import org.springframework.security.authentication.AbstractAuthenticationToken;
|
|
|
+import org.springframework.security.core.GrantedAuthority;
|
|
|
+import org.springframework.security.core.SpringSecurityCoreVersion;
|
|
|
+import org.springframework.security.oauth2.client.registration.ClientRegistration;
|
|
|
+import org.springframework.security.oauth2.core.OAuth2AccessToken;
|
|
|
+import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange;
|
|
|
+import org.springframework.security.oauth2.core.user.OAuth2User;
|
|
|
+import org.springframework.util.Assert;
|
|
|
+
|
|
|
+import java.util.Collection;
|
|
|
+import java.util.Collections;
|
|
|
+
|
|
|
+/**
|
|
|
+ * An {@link AbstractAuthenticationToken} for <i>OAuth 2.0 Login</i>,
|
|
|
+ * which leverages the <i>OAuth 2.0 Authorization Code Grant</i> Flow.
|
|
|
+ *
|
|
|
+ * @author Joe Grandja
|
|
|
+ * @since 5.0
|
|
|
+ * @see AbstractAuthenticationToken
|
|
|
+ * @see OAuth2User
|
|
|
+ * @see ClientRegistration
|
|
|
+ * @see OAuth2AuthorizationExchange
|
|
|
+ * @see OAuth2AccessToken
|
|
|
+ * @see <a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.1">Section 4.1 Authorization Code Grant Flow</a>
|
|
|
+ */
|
|
|
+public class OAuth2LoginAuthenticationToken extends AbstractAuthenticationToken {
|
|
|
+ private static final long serialVersionUID = SpringSecurityCoreVersion.SERIAL_VERSION_UID;
|
|
|
+ private OAuth2User principal;
|
|
|
+ private ClientRegistration clientRegistration;
|
|
|
+ private OAuth2AuthorizationExchange authorizationExchange;
|
|
|
+ private OAuth2AccessToken accessToken;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * This constructor should be used when the Authorization Request/Response is complete.
|
|
|
+ *
|
|
|
+ * @param clientRegistration
|
|
|
+ * @param authorizationExchange
|
|
|
+ */
|
|
|
+ public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration,
|
|
|
+ OAuth2AuthorizationExchange authorizationExchange) {
|
|
|
+
|
|
|
+ super(Collections.emptyList());
|
|
|
+ Assert.notNull(clientRegistration, "clientRegistration cannot be null");
|
|
|
+ Assert.notNull(authorizationExchange, "authorizationExchange cannot be null");
|
|
|
+ this.clientRegistration = clientRegistration;
|
|
|
+ this.authorizationExchange = authorizationExchange;
|
|
|
+ this.setAuthenticated(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * This constructor should be used when the Access Token Request/Response is complete,
|
|
|
+ * which indicates that the Authorization Code Grant flow has fully completed
|
|
|
+ * and OAuth 2.0 Login has been achieved.
|
|
|
+ *
|
|
|
+ * @param principal
|
|
|
+ * @param authorities
|
|
|
+ * @param clientRegistration
|
|
|
+ * @param authorizationExchange
|
|
|
+ * @param accessToken
|
|
|
+ */
|
|
|
+ public OAuth2LoginAuthenticationToken(OAuth2User principal,
|
|
|
+ Collection<? extends GrantedAuthority> authorities,
|
|
|
+ ClientRegistration clientRegistration,
|
|
|
+ OAuth2AuthorizationExchange authorizationExchange,
|
|
|
+ OAuth2AccessToken accessToken) {
|
|
|
+ super(authorities);
|
|
|
+ Assert.notNull(principal, "principal cannot be null");
|
|
|
+ Assert.notNull(clientRegistration, "clientRegistration cannot be null");
|
|
|
+ Assert.notNull(authorizationExchange, "authorizationExchange cannot be null");
|
|
|
+ Assert.notNull(accessToken, "accessToken cannot be null");
|
|
|
+ this.principal = principal;
|
|
|
+ this.clientRegistration = clientRegistration;
|
|
|
+ this.authorizationExchange = authorizationExchange;
|
|
|
+ this.accessToken = accessToken;
|
|
|
+ this.setAuthenticated(true);
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public OAuth2User getPrincipal() {
|
|
|
+ return this.principal;
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public Object getCredentials() {
|
|
|
+ return "";
|
|
|
+ }
|
|
|
+
|
|
|
+ public ClientRegistration getClientRegistration() {
|
|
|
+ return this.clientRegistration;
|
|
|
+ }
|
|
|
+
|
|
|
+ public OAuth2AuthorizationExchange getAuthorizationExchange() {
|
|
|
+ return this.authorizationExchange;
|
|
|
+ }
|
|
|
+
|
|
|
+ public OAuth2AccessToken getAccessToken() {
|
|
|
+ return this.accessToken;
|
|
|
+ }
|
|
|
+}
|