ResourceServerTokenServicesConfiguration.java

/*
 * Copyright 2013-2014 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.cloud.security.oauth2.resource;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.OrderComparator;
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.security.oauth2.client.OAuth2ClientContext;
import org.springframework.security.oauth2.client.OAuth2RestOperations;
import org.springframework.security.oauth2.client.OAuth2RestTemplate;
import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResourceDetails;
import org.springframework.security.oauth2.client.token.AccessTokenRequest;
import org.springframework.security.oauth2.client.token.RequestEnhancer;
import org.springframework.security.oauth2.client.token.grant.code.AuthorizationCodeAccessTokenProvider;
import org.springframework.security.oauth2.client.token.grant.code.AuthorizationCodeResourceDetails;
import org.springframework.security.oauth2.provider.token.DefaultTokenServices;
import org.springframework.security.oauth2.provider.token.RemoteTokenServices;
import org.springframework.security.oauth2.provider.token.ResourceServerTokenServices;
import org.springframework.security.oauth2.provider.token.TokenStore;
import org.springframework.security.oauth2.provider.token.store.JwtAccessTokenConverter;
import org.springframework.security.oauth2.provider.token.store.JwtTokenStore;
import org.springframework.social.connect.ConnectionFactoryLocator;
import org.springframework.social.connect.support.OAuth2ConnectionFactory;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestTemplate;

/**
 * @author Dave Syer
 *
 */
@Configuration
public class ResourceServerTokenServicesConfiguration {

	@Configuration
	protected static class UserInfoRestTemplateConfiguration {

		private static final AuthorizationCodeResourceDetails DEFAULT_RESOURCE_DETAILS = new AuthorizationCodeResourceDetails();

		static {
			DEFAULT_RESOURCE_DETAILS.setClientId("<N/A>");
			DEFAULT_RESOURCE_DETAILS
					.setUserAuthorizationUri("Not a URI because there is no client");
			DEFAULT_RESOURCE_DETAILS
					.setAccessTokenUri("Not a URI because there is no client");
		}

		@Autowired(required = false)
		private List<UserInfoRestTemplateCustomizer> customizers = Collections
				.emptyList();
		
		@Autowired(required = false)
		private OAuth2ProtectedResourceDetails details;

		@Autowired(required = false)
		private OAuth2ClientContext oauth2ClientContext;

		@Bean(name = "userInfoRestTemplate")
		public OAuth2RestTemplate userInfoRestTemplate() {
			OAuth2RestTemplate template;
			if (details == null) {
				details = DEFAULT_RESOURCE_DETAILS;
			}
			if (oauth2ClientContext == null) {
				template = new OAuth2RestTemplate(details);
			}
			else {
				template = new OAuth2RestTemplate(details, oauth2ClientContext);
			}
			template.setInterceptors(Arrays
					.<ClientHttpRequestInterceptor> asList(new ClientHttpRequestInterceptor() {
						@Override
						public ClientHttpResponse intercept(HttpRequest request,
								byte[] body, ClientHttpRequestExecution execution)
								throws IOException {
							request.getHeaders().setAccept(
									Arrays.asList(MediaType.APPLICATION_JSON));
							return execution.execute(request, body);
						}
					}));
			AuthorizationCodeAccessTokenProvider accessTokenProvider = new AuthorizationCodeAccessTokenProvider();
			accessTokenProvider.setTokenRequestEnhancer(new RequestEnhancer() {
				@Override
				public void enhance(AccessTokenRequest request,
						OAuth2ProtectedResourceDetails resource,
						MultiValueMap<String, String> form, HttpHeaders headers) {
					headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
				}
			});
			template.setAccessTokenProvider(accessTokenProvider);
			OrderComparator.sort(customizers);
			for (UserInfoRestTemplateCustomizer customizer : customizers) {
				customizer.customize(template);
			}
			return template;
		}

	}

	@Configuration
	protected static class ResourceServerPropertiesConfiguration {

		@Autowired(required = false)
		private OAuth2ProtectedResourceDetails client;

		@Bean
		public ResourceServerProperties resourceServerProperties() {
			String clientId = client == null ? null : client.getClientId();
			String clientSecret = client == null ? null : client.getClientSecret();
			return new ResourceServerProperties(clientId, clientSecret);
		}
	}

	@Configuration
	@Conditional(NotJwtToken.class)
	protected static class RemoteTokenServicesConfiguration {

		@Configuration
		@Conditional(TokenInfo.class)
		protected static class TokenInfoServicesConfiguration {

			@Autowired
			private ResourceServerProperties resource;

			@Bean
			protected ResourceServerTokenServices remoteTokenServices() {
				RemoteTokenServices services = new RemoteTokenServices();
				services.setCheckTokenEndpointUrl(resource.getTokenInfoUri());
				services.setClientId(resource.getClientId());
				services.setClientSecret(resource.getClientSecret());
				return services;
			}

		}

		@Configuration
		@ConditionalOnClass(OAuth2ConnectionFactory.class)
		@Conditional(NotTokenInfo.class)
		protected static class SocialTokenServicesConfiguration {

			@Autowired
			private ResourceServerProperties sso;

			@Autowired(required = false)
			private OAuth2ConnectionFactory<?> connectionFactory;

			@Autowired(required = false)
			@Qualifier("userInfoRestTemplate")
			private OAuth2RestOperations restTemplate;

			@Bean
			@ConditionalOnBean(ConnectionFactoryLocator.class)
			@ConditionalOnMissingBean(ResourceServerTokenServices.class)
			public SpringSocialTokenServices socialTokenServices() {
				return new SpringSocialTokenServices(connectionFactory, sso.getClientId());
			}

			@Bean
			@ConditionalOnMissingBean({ ConnectionFactoryLocator.class,
					ResourceServerTokenServices.class })
			public UserInfoTokenServices userInfoTokenServices() {
				UserInfoTokenServices services = new UserInfoTokenServices(
						sso.getUserInfoUri(), sso.getClientId());
				services.setRestTemplate(restTemplate);
				return services;
			}

		}

		@Configuration
		@ConditionalOnMissingClass(name = "org.springframework.social.connect.support.OAuth2ConnectionFactory")
		@Conditional(NotTokenInfo.class)
		protected static class UserInfoTokenServicesConfiguration {

			@Autowired
			private ResourceServerProperties sso;

			@Autowired(required = false)
			@Qualifier("userInfoRestTemplate")
			private OAuth2RestOperations restTemplate;

			@Bean
			@ConditionalOnMissingBean(ResourceServerTokenServices.class)
			public UserInfoTokenServices userInfoTokenServices() {
				UserInfoTokenServices services = new UserInfoTokenServices(
						sso.getUserInfoUri(), sso.getClientId());
				services.setRestTemplate(restTemplate);
				return services;
			}

		}

	}

	@Configuration
	@Conditional(JwtToken.class)
	@Slf4j
	protected static class JwtTokenServicesConfiguration {

		@Autowired
		private ResourceServerProperties resource;

		@Autowired(required = false)
		private List<JwtAccessTokenConverterConfigurer> configurers = Collections
				.emptyList();

		@Bean
		@ConditionalOnMissingBean(ResourceServerTokenServices.class)
		public ResourceServerTokenServices jwtTokenServices() {
			DefaultTokenServices services = new DefaultTokenServices();
			services.setTokenStore(jwtTokenStore());
			return services;
		}

		@Bean
		public TokenStore jwtTokenStore() {
			return new JwtTokenStore(jwtTokenEnhancer());
		}

		@Bean
		public JwtAccessTokenConverter jwtTokenEnhancer() {
			JwtAccessTokenConverter converter = new JwtAccessTokenConverter();
			String keyValue = resource.getJwt().getKeyValue();
			if (!StringUtils.hasText(keyValue)) {
				try {
					keyValue = (String) new RestTemplate().getForObject(
							resource.getJwt().getKeyUri(), Map.class).get("value");
				}
				catch (ResourceAccessException e) {
					// ignore
					log.warn("Failed to fetch token key (you may need to refresh when the auth server is back)");
				}
			}
			else {
				if (StringUtils.hasText(keyValue) && !keyValue.startsWith("-----BEGIN")) {
					converter.setSigningKey(keyValue);
				}
			}
			if (keyValue != null) {
				converter.setVerifierKey(keyValue);
			}
			AnnotationAwareOrderComparator.sort(configurers);
			for (JwtAccessTokenConverterConfigurer configurer : configurers) {
				configurer.configure(converter);
			}
			return converter;
		}

	}

	private static class TokenInfo extends SpringBootCondition {

		@Override
		public ConditionOutcome getMatchOutcome(ConditionContext context,
				AnnotatedTypeMetadata metadata) {
			Environment environment = context.getEnvironment();
			boolean preferTokenInfo = environment
					.resolvePlaceholders(
							"${spring.oauth2.resource.preferTokenInfo:${OAUTH2_RESOURCE_PREFERTOKENINFO:true}}")
					.equals("true");
			boolean hasTokenInfo = !environment.resolvePlaceholders(
					"${spring.oauth2.resource.tokenInfoUri:}").equals("");
			boolean hasUserInfo = !environment.resolvePlaceholders(
					"${spring.oauth2.resource.userInfoUri:}").equals("");
			if (!hasUserInfo) {
				return ConditionOutcome.match("No user info provided");
			}
			if (hasTokenInfo) {
				if (preferTokenInfo) {
					return ConditionOutcome
							.match("Token info endpoint is preferred and user info provided");
				}
			}
			return ConditionOutcome.noMatch("Token info endpoint is not provided");
		}

	}

	private static class JwtToken extends SpringBootCondition {

		@Override
		public ConditionOutcome getMatchOutcome(ConditionContext context,
				AnnotatedTypeMetadata metadata) {
			if (StringUtils.hasText(context.getEnvironment().getProperty(
					"spring.oauth2.resource.jwt.keyValue"))
					|| StringUtils.hasText(context.getEnvironment().getProperty(
							"spring.oauth2.resource.jwt.keyUri"))) {
				return ConditionOutcome.match("Public key is provided");
			}
			return ConditionOutcome.noMatch("Public key is not provided");
		}

	}

	private static class NotTokenInfo extends SpringBootCondition {

		private TokenInfo opposite = new TokenInfo();

		@Override
		public ConditionOutcome getMatchOutcome(ConditionContext context,
				AnnotatedTypeMetadata metadata) {
			ConditionOutcome outcome = opposite.getMatchOutcome(context, metadata);
			if (outcome.isMatch()) {
				return ConditionOutcome.noMatch(outcome.getMessage());
			}
			return ConditionOutcome.match(outcome.getMessage());
		}

	}

	private static class NotJwtToken extends SpringBootCondition {

		private JwtToken opposite = new JwtToken();

		@Override
		public ConditionOutcome getMatchOutcome(ConditionContext context,
				AnnotatedTypeMetadata metadata) {
			ConditionOutcome outcome = opposite.getMatchOutcome(context, metadata);
			if (outcome.isMatch()) {
				return ConditionOutcome.noMatch(outcome.getMessage());
			}
			return ConditionOutcome.match(outcome.getMessage());
		}

	}
}