org.apereo.cas.config.SamlGoogleAppsConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cas-server-support-saml-googleapps Show documentation
cas-server-support-saml-googleapps
The newest version!
package org.apereo.cas.config;

import org.apereo.cas.authentication.principal.ResponseBuilder;
import org.apereo.cas.authentication.principal.ServiceFactory;
import org.apereo.cas.authentication.principal.ServiceFactoryConfigurer;
import org.apereo.cas.configuration.CasConfigurationProperties;
import org.apereo.cas.services.ServicesManager;
import org.apereo.cas.support.saml.OpenSamlConfigBean;
import org.apereo.cas.support.saml.authentication.principal.GoogleAccountsServiceFactory;
import org.apereo.cas.support.saml.authentication.principal.GoogleAccountsServiceResponseBuilder;
import org.apereo.cas.support.saml.util.GoogleSaml20ObjectBuilder;
import org.apereo.cas.util.AsciiArtUtils;
import org.apereo.cas.util.CollectionUtils;
import org.apereo.cas.web.UrlValidator;

import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Lazy;
import org.springframework.context.annotation.ScopedProxyMode;

/**
 * This is {@link SamlGoogleAppsConfiguration}.
 *
 * @author Misagh Moayyed
 * @since 5.0.0
 * @deprecated Since 6.2, to be replaced with CAS SAML2 identity provider functionality.
 */
@EnableConfigurationProperties(CasConfigurationProperties.class)
@Slf4j
@Deprecated(since = "6.2.0")
@AutoConfiguration
public class SamlGoogleAppsConfiguration implements InitializingBean {

    @Bean
    public ServiceFactoryConfigurer googleAccountsServiceFactoryConfigurer(
        @Qualifier("googleAccountsServiceFactory")
        final ServiceFactory googleAccountsServiceFactory) {
        return () -> CollectionUtils.wrap(googleAccountsServiceFactory);
    }

    @ConditionalOnMissingBean(name = "googleAccountsServiceFactory")
    @Bean
    @RefreshScope(proxyMode = ScopedProxyMode.DEFAULT)
    public ServiceFactory googleAccountsServiceFactory(
        @Qualifier("googleSaml20ObjectBuilder")
        final GoogleSaml20ObjectBuilder googleSaml20ObjectBuilder) {
        return new GoogleAccountsServiceFactory(googleSaml20ObjectBuilder);
    }

    @ConditionalOnMissingBean(name = "googleSaml20ObjectBuilder")
    @Bean
    public GoogleSaml20ObjectBuilder googleSaml20ObjectBuilder(
        @Qualifier(OpenSamlConfigBean.DEFAULT_BEAN_NAME)
        final OpenSamlConfigBean openSamlConfigBean) {
        return new GoogleSaml20ObjectBuilder(openSamlConfigBean);
    }

    @ConditionalOnMissingBean(name = "googleAccountsServiceResponseBuilder")
    @Bean
    @Lazy
    public ResponseBuilder googleAccountsServiceResponseBuilder(
        final CasConfigurationProperties casProperties,
        @Qualifier("googleSaml20ObjectBuilder")
        final GoogleSaml20ObjectBuilder googleSaml20ObjectBuilder,
        @Qualifier(UrlValidator.BEAN_NAME)
        final UrlValidator urlValidator,
        @Qualifier(ServicesManager.BEAN_NAME)
        final ServicesManager servicesManager) {
        val gApps = casProperties.getGoogleApps();
        return new GoogleAccountsServiceResponseBuilder(gApps.getPrivateKeyLocation(), gApps.getPublicKeyLocation(), gApps.getKeyAlgorithm(), servicesManager, googleSaml20ObjectBuilder,
            casProperties.getSamlCore().getSkewAllowance(), casProperties.getServer().getPrefix(), urlValidator);
    }

    @Override
    public void afterPropertiesSet() {
        AsciiArtUtils.printAsciiArtWarning(LOGGER, "CAS integration with Google Apps is now deprecated and scheduled to be removed in the future. "
                                                   + "The functionality is now redundant and unnecessary with CAS able to provide SAML2 identity provider features."
                                                   + "To handle the integration, you should configure CAS to act as a SAML2 identity provider and remove "
                                                   + "this integration from your deployment to protected against future removals and surprises.");
    }
}