对于最新的稳定版本，请使用 Spring Security 6.5.3！spring-doc.cadn.net.cn

认证<saml2:Response>s

为了验证 SAML 2.0 响应，Spring Security 使用Saml2AuthenticationTokenConverter以填充Authenticationrequest 和OpenSaml4AuthenticationProvider以验证它。spring-doc.cadn.net.cn

您可以通过多种方式进行配置，包括：spring-doc.cadn.net.cn

  1. 改变方式RelyingPartyRegistration查找spring-doc.cadn.net.cn

  2. 设置时钟偏差以进行时间戳验证spring-doc.cadn.net.cn

  3. 将响应映射到GrantedAuthority实例spring-doc.cadn.net.cn

  4. 自定义验证断言的策略spring-doc.cadn.net.cn

  5. 自定义解密响应和断言元素的策略spring-doc.cadn.net.cn

要配置这些，您将使用saml2Login#authenticationManager方法。spring-doc.cadn.net.cn

改变RelyingPartyRegistration查找

RelyingPartyRegistration查找是自定义的在RelyingPartyRegistrationResolver.spring-doc.cadn.net.cn

要应用RelyingPartyRegistrationResolver处理时<saml2:Response>有效负载，您应该首先发布一个Saml2AuthenticationTokenConverterbean 如下所示：spring-doc.cadn.net.cn

@Bean
Saml2AuthenticationTokenConverter authenticationConverter(InMemoryRelyingPartyRegistrationRepository registrations) {
	return new Saml2AuthenticationTokenConverter(new MyRelyingPartyRegistrationResolver(registrations));
}
@Bean
fun authenticationConverter(val registrations: InMemoryRelyingPartyRegistrationRepository): Saml2AuthenticationTokenConverter {
	return Saml2AuthenticationTokenConverter(MyRelyingPartyRegistrationResolver(registrations));
}

回想一下，断言消费者服务 URL 是/saml2/login/sso/{registrationId}默认情况下。 如果您不再需要registrationId在 URL 中，在筛选器链和信赖方元数据中更改它：spring-doc.cadn.net.cn

@Bean
SecurityFilterChain securityFilters(HttpSecurity http) throws Exception {
	http
        // ...
        .saml2Login((saml2) -> saml2.loginProcessingUrl("/saml2/login/sso"))
        // ...

    return http.build();
}
@Bean
fun securityFilters(val http: HttpSecurity): SecurityFilterChain {
	http {
        // ...
        .saml2Login {
            loginProcessingUrl = "/saml2/login/sso"
        }
        // ...
    }

    return http.build()
}

和：spring-doc.cadn.net.cn

relyingPartyRegistrationBuilder.assertionConsumerServiceLocation("/saml2/login/sso")
relyingPartyRegistrationBuilder.assertionConsumerServiceLocation("/saml2/login/sso")

设置时钟倾斜

断言方和信赖方的系统时钟未完全同步的情况并不少见。 因此，您可以配置OpenSaml4AuthenticationProvider的默认断言验证器，具有一定的容错性：spring-doc.cadn.net.cn

@Configuration
@EnableWebSecurity
public class SecurityConfig {

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        OpenSaml4AuthenticationProvider authenticationProvider = new OpenSaml4AuthenticationProvider();
        authenticationProvider.setAssertionValidator(OpenSaml4AuthenticationProvider
                .createDefaultAssertionValidator(assertionToken -> {
                    Map<String, Object> params = new HashMap<>();
                    params.put(CLOCK_SKEW, Duration.ofMinutes(10).toMillis());
                    // ... other validation parameters
                    return new ValidationContext(params);
                })
        );

        http
            .authorizeHttpRequests(authz -> authz
                .anyRequest().authenticated()
            )
            .saml2Login(saml2 -> saml2
                .authenticationManager(new ProviderManager(authenticationProvider))
            );
        return http.build();
    }
}
@Configuration
@EnableWebSecurity
open class SecurityConfig {
    @Bean
    open fun filterChain(http: HttpSecurity): SecurityFilterChain {
        val authenticationProvider = OpenSaml4AuthenticationProvider()
        authenticationProvider.setAssertionValidator(
            OpenSaml4AuthenticationProvider
                .createDefaultAssertionValidator(Converter<OpenSaml4AuthenticationProvider.AssertionToken, ValidationContext> {
                    val params: MutableMap<String, Any> = HashMap()
                    params[CLOCK_SKEW] =
                        Duration.ofMinutes(10).toMillis()
                    ValidationContext(params)
                })
        )
        http {
            authorizeRequests {
                authorize(anyRequest, authenticated)
            }
            saml2Login {
                authenticationManager = ProviderManager(authenticationProvider)
            }
        }
        return http.build()
    }
}

与UserDetailsService

或者，您可能希望包含旧版中的用户详细信息UserDetailsService. 在这种情况下，响应身份验证转换器可以派上用场，如下所示：spring-doc.cadn.net.cn

@Configuration
@EnableWebSecurity
public class SecurityConfig {
    @Autowired
    UserDetailsService userDetailsService;

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        OpenSaml4AuthenticationProvider authenticationProvider = new OpenSaml4AuthenticationProvider();
        authenticationProvider.setResponseAuthenticationConverter(responseToken -> {
            Saml2Authentication authentication = OpenSaml4AuthenticationProvider
                    .createDefaultResponseAuthenticationConverter() (1)
                    .convert(responseToken);
            Assertion assertion = responseToken.getResponse().getAssertions().get(0);
            String username = assertion.getSubject().getNameID().getValue();
            UserDetails userDetails = this.userDetailsService.loadUserByUsername(username); (2)
            return MySaml2Authentication(userDetails, authentication); (3)
        });

        http
            .authorizeHttpRequests(authz -> authz
                .anyRequest().authenticated()
            )
            .saml2Login(saml2 -> saml2
                .authenticationManager(new ProviderManager(authenticationProvider))
            );
        return http.build();
    }
}
@Configuration
@EnableWebSecurity
open class SecurityConfig {
    @Autowired
    var userDetailsService: UserDetailsService? = null

    @Bean
    open fun filterChain(http: HttpSecurity): SecurityFilterChain {
        val authenticationProvider = OpenSaml4AuthenticationProvider()
        authenticationProvider.setResponseAuthenticationConverter { responseToken: OpenSaml4AuthenticationProvider.ResponseToken ->
            val authentication = OpenSaml4AuthenticationProvider
                .createDefaultResponseAuthenticationConverter() (1)
                .convert(responseToken)
            val assertion: Assertion = responseToken.response.assertions[0]
            val username: String = assertion.subject.nameID.value
            val userDetails = userDetailsService!!.loadUserByUsername(username) (2)
            MySaml2Authentication(userDetails, authentication) (3)
        }
        http {
            authorizeRequests {
                authorize(anyRequest, authenticated)
            }
            saml2Login {
                authenticationManager = ProviderManager(authenticationProvider)
            }
        }
        return http.build()
    }
}
1 首先，调用默认转换器，它从响应中提取属性和权限
2 其次，调用UserDetailsService使用相关信息
3 第三，返回包含用户详细信息的自定义身份验证
不需要调用OpenSaml4AuthenticationProvider的默认身份验证转换器。 它返回一个Saml2AuthenticatedPrincipal包含从中提取的属性AttributeStatements 以及单曲ROLE_USER柄。

执行其他响应验证

OpenSaml4AuthenticationProvider验证Issuer和Destination值在解密Response. 您可以通过扩展默认验证器与您自己的响应验证器连接来自定义验证，也可以将其完全替换为您的响应验证器。spring-doc.cadn.net.cn

例如，可以抛出自定义异常，其中包含Response对象，如下所示：spring-doc.cadn.net.cn

OpenSaml4AuthenticationProvider provider = new OpenSaml4AuthenticationProvider();
provider.setResponseValidator((responseToken) -> {
	Saml2ResponseValidatorResult result = OpenSamlAuthenticationProvider
		.createDefaultResponseValidator()
		.convert(responseToken)
		.concat(myCustomValidator.convert(responseToken));
	if (!result.getErrors().isEmpty()) {
		String inResponseTo = responseToken.getInResponseTo();
		throw new CustomSaml2AuthenticationException(result, inResponseTo);
	}
	return result;
});

执行其他断言验证

OpenSaml4AuthenticationProvider对 SAML 2.0 断言执行最少的验证。 验证签名后，它将：spring-doc.cadn.net.cn

  1. 驗證<AudienceRestriction>和<DelegationRestriction>条件spring-doc.cadn.net.cn

  2. 驗證<SubjectConfirmation>s，期望任何 IP 地址信息spring-doc.cadn.net.cn

要执行其他验证，您可以配置自己的断言验证器，该验证器委托给OpenSaml4AuthenticationProvider的默认值，然后执行自己的。spring-doc.cadn.net.cn

例如，您可以使用 OpenSAML 的OneTimeUseConditionValidator以同时验证<OneTimeUse>条件，如下所示：spring-doc.cadn.net.cn

OpenSaml4AuthenticationProvider provider = new OpenSaml4AuthenticationProvider();
OneTimeUseConditionValidator validator = ...;
provider.setAssertionValidator(assertionToken -> {
    Saml2ResponseValidatorResult result = OpenSaml4AuthenticationProvider
            .createDefaultAssertionValidator()
            .convert(assertionToken);
    Assertion assertion = assertionToken.getAssertion();
    OneTimeUse oneTimeUse = assertion.getConditions().getOneTimeUse();
    ValidationContext context = new ValidationContext();
    try {
        if (validator.validate(oneTimeUse, assertion, context) = ValidationResult.VALID) {
            return result;
        }
    } catch (Exception e) {
        return result.concat(new Saml2Error(INVALID_ASSERTION, e.getMessage()));
    }
    return result.concat(new Saml2Error(INVALID_ASSERTION, context.getValidationFailureMessage()));
});
var provider = OpenSaml4AuthenticationProvider()
var validator: OneTimeUseConditionValidator = ...
provider.setAssertionValidator { assertionToken ->
    val result = OpenSaml4AuthenticationProvider
        .createDefaultAssertionValidator()
        .convert(assertionToken)
    val assertion: Assertion = assertionToken.assertion
    val oneTimeUse: OneTimeUse = assertion.conditions.oneTimeUse
    val context = ValidationContext()
    try {
        if (validator.validate(oneTimeUse, assertion, context) = ValidationResult.VALID) {
            return@setAssertionValidator result
        }
    } catch (e: Exception) {
        return@setAssertionValidator result.concat(Saml2Error(INVALID_ASSERTION, e.message))
    }
    result.concat(Saml2Error(INVALID_ASSERTION, context.validationFailureMessage))
}
虽然建议，但无需调用OpenSaml4AuthenticationProvider的默认断言验证器。 如果您不需要它来检查<AudienceRestriction>或<SubjectConfirmation>因为你自己做这些。

自定义解密

Spring Security 解密<saml2:EncryptedAssertion>,<saml2:EncryptedAttribute>和<saml2:EncryptedID>元素通过使用解密自动Saml2X509Credential实例在RelyingPartyRegistration.spring-doc.cadn.net.cn

OpenSaml4AuthenticationProvider公开了两种解密策略。 响应解密器用于解密<saml2:Response>喜欢<saml2:EncryptedAssertion>. 断言解密器用于解密<saml2:Assertion>喜欢<saml2:EncryptedAttribute>和<saml2:EncryptedID>.spring-doc.cadn.net.cn

您可以将OpenSaml4AuthenticationProvider的默认解密策略与您自己的解密策略。 例如，如果您有一个单独的服务来解密<saml2:Response>，您可以这样使用它：spring-doc.cadn.net.cn

MyDecryptionService decryptionService = ...;
OpenSaml4AuthenticationProvider provider = new OpenSaml4AuthenticationProvider();
provider.setResponseElementsDecrypter((responseToken) -> decryptionService.decrypt(responseToken.getResponse()));
val decryptionService: MyDecryptionService = ...
val provider = OpenSaml4AuthenticationProvider()
provider.setResponseElementsDecrypter { responseToken -> decryptionService.decrypt(responseToken.response) }

如果您还要解密<saml2:Assertion>，您也可以自定义断言解密器：spring-doc.cadn.net.cn

provider.setAssertionElementsDecrypter((assertionToken) -> decryptionService.decrypt(assertionToken.getAssertion()));
provider.setAssertionElementsDecrypter { assertionToken -> decryptionService.decrypt(assertionToken.assertion) }
有两个独立的解密器，因为断言可以与响应分开签名。 在签名验证之前尝试解密已签名断言的元素可能会使签名失效。 如果断言方仅对响应进行签名，则仅使用响应解密器解密所有元素是安全的。

使用自定义身份验证管理器

当然，authenticationManagerDSL 方法还可用于执行完全自定义的 SAML 2.0 身份验证。 此身份验证管理器应期望Saml2AuthenticationToken包含 SAML 2.0 响应 XML 数据的对象。spring-doc.cadn.net.cn

@Configuration
@EnableWebSecurity
public class SecurityConfig {

    @Bean
	public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        AuthenticationManager authenticationManager = new MySaml2AuthenticationManager(...);
        http
            .authorizeHttpRequests(authorize -> authorize
                .anyRequest().authenticated()
            )
            .saml2Login(saml2 -> saml2
                .authenticationManager(authenticationManager)
            )
        ;
        return http.build();
    }
}
@Configuration
@EnableWebSecurity
open class SecurityConfig {
    @Bean
    open fun filterChain(http: HttpSecurity): SecurityFilterChain {
        val customAuthenticationManager: AuthenticationManager = MySaml2AuthenticationManager(...)
        http {
            authorizeRequests {
                authorize(anyRequest, authenticated)
            }
            saml2Login {
                authenticationManager = customAuthenticationManager
            }
        }
        return http.build()
    }
}

用Saml2AuthenticatedPrincipal

为给定断言方正确配置信赖方后，它就可以接受断言了。 信赖方验证断言后，结果是Saml2Authentication使用Saml2AuthenticatedPrincipal.spring-doc.cadn.net.cn

这意味着您可以像这样访问控制器中的主体：spring-doc.cadn.net.cn

@Controller
public class MainController {
	@GetMapping("/")
	public String index(@AuthenticationPrincipal Saml2AuthenticatedPrincipal principal, Model model) {
		String email = principal.getFirstAttribute("email");
		model.setAttribute("email", email);
		return "index";
	}
}
@Controller
class MainController {
    @GetMapping("/")
    fun index(@AuthenticationPrincipal principal: Saml2AuthenticatedPrincipal, model: Model): String {
        val email = principal.getFirstAttribute<String>("email")
        model.setAttribute("email", email)
        return "index"
    }
}
由于 SAML 2.0 规范允许每个属性具有多个值，因此可以调用getAttribute获取属性列表或getFirstAttribute获取列表中的第一个。getFirstAttribute当您知道只有一个值时，非常方便。