com.github.ulisesbocchio.spring.boot.security.saml.configurer

Interface ServiceProviderConfigurer

All Known Implementing Classes:

ServiceProviderConfigurerAdapter

public interface ServiceProviderConfigurer

Interface to be implemented when using EnableSAMLSSO and wanting to further customize the SAML Service Provider using the DSL provided by ServiceProviderBuilder, which exposes most aspects of configuring Spring Security SAML. Users of this interface are encouraged to use ServiceProviderConfigurerAdapter which is the default implementation with empty methods, so users can choose which method to actually override.

The following is a basic example:

     @Configuration
     public static class MyServiceProviderConfig extends ServiceProviderConfigurerAdapter {
         @Override
         public void configure(ServiceProviderSecurityBuilder serviceProvider) throws Exception {
             serviceProvider
                 .metadataGenerator()
                 .entityId("localhost-demo")
             .and()
                 .sso()
                 .defaultSuccessURL("/home")
                 .idpSelectionPageUrl("/idpselection")
             .and()
                 .logout()
                 .defaultTargetUrl("/")
             .and()
                 .metadataManager()
                 .metadataLocations("classpath:/idp-ssocircle.xml")
                 .refreshCheckInterval(0)
             .and()
                 .extendedMetadata()
                 .idpDiscoveryEnabled(true)
             .and()
                 .keyManager()
                 .privateKeyDerLocation("classpath:/localhost.key.der")
                 .publicKeyPemLocation("classpath:/localhost.cert");
         }
     }
 

A different method of configuration exists through configuration properties exposed by SAMLSSOProperties.

Author:

Ulises Bocchio

See Also:

ServiceProviderConfigurerAdapter, ServiceProviderBuilder, EnableSAMLSSO, SAMLSSOProperties

Method Summary

Modifier and Type	Method and Description
void	configure(org.springframework.security.config.annotation.web.builders.HttpSecurity http) Allows for customization of the HttpSecurity object exposed by WebSecurityConfigurerAdapter.
void	configure(ServiceProviderBuilder serviceProvider) Allows for customization the SAML Service Provider.
void	configure(org.springframework.security.config.annotation.web.builders.WebSecurity web) Allows for customization of the WebSecurity object exposed by WebSecurityConfigurerAdapter.

Method Detail

configure

void configure(ServiceProviderBuilder serviceProvider)
        throws Exception

Allows for customization the SAML Service Provider. The serviceProvider argument exposes a bunch of configurers with options to fully customize Spring Security SAML through a DSL-like configuration. A different method of configuration exists through configuration properties exposed by SAMLSSOProperties.

Parameters:

serviceProvider -

Throws:

Exception - Any exception coming from WebSecurityConfigurerAdapter.

See Also:

SAMLSSOProperties

configure

void configure(org.springframework.security.config.annotation.web.builders.HttpSecurity http)
        throws Exception

Allows for customization of the HttpSecurity object exposed by WebSecurityConfigurerAdapter.

Parameters:

http - the HttpSecurity object.

Throws:

Exception - Any exception coming from WebSecurityConfigurerAdapter.

configure

void configure(org.springframework.security.config.annotation.web.builders.WebSecurity web)

Allows for customization of the WebSecurity object exposed by WebSecurityConfigurerAdapter.

Parameters:

web - the WebSecurity object.

Throws:

Exception - Any exception coming from WebSecurityConfigurerAdapter.