此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Security 6.5.3spring-doc.cadn.net.cn

Saml 2.0 元数据

Spring Security 可以解析断言方元数据以生成AssertingPartyMetadata实例以及RelyingPartyRegistration实例。spring-doc.cadn.net.cn

解析<saml2:IDPSSODescriptor>元数据

您可以解析断言方的元数据RelyingPartyRegistrations.spring-doc.cadn.net.cn

使用 OpenSAML 提供商支持时,生成的AssertingPartyMetadata将是类型OpenSamlAssertingPartyDetails. 这意味着你可以通过执行以下作来获取底层 OpenSAML XMLObject:spring-doc.cadn.net.cn

OpenSamlAssertingPartyDetails details = (OpenSamlAssertingPartyDetails)
        registration.getAssertingPartyMetadata();
EntityDescriptor openSamlEntityDescriptor = details.getEntityDescriptor();
val details: OpenSamlAssertingPartyDetails =
        registration.getAssertingPartyMetadata() as OpenSamlAssertingPartyDetails
val openSamlEntityDescriptor: EntityDescriptor = details.getEntityDescriptor()

AssertingPartyMetadataRepository

你也可以比RelyingPartyRegistrations通过使用AssertingPartyMetadataRepository,一个仅允许检索断言方元数据的接口。spring-doc.cadn.net.cn

这允许三个有价值的功能:spring-doc.cadn.net.cn

例如OpenSaml5AssertingPartyMetadataRepository使用 OpenSAML 的MetadataResolver,以及 API,其实现会定期以过期感知方式刷新底层元数据。spring-doc.cadn.net.cn

这意味着您现在可以创建一个可刷新的RelyingPartyRegistrationRepository只需几行代码:spring-doc.cadn.net.cn

@Component
public class RefreshableRelyingPartyRegistrationRepository
        implements IterableRelyingPartyRegistrationRepository {

	private final AssertingPartyMetadataRepository metadata =
            OpenSaml5AssertingPartyMetadataRepository
                .fromTrustedMetadataLocation("https://idp.example.org/metadata").build();

	@Override
    public RelyingPartyRegistration findByRegistrationId(String registrationId) {
		AssertingPartyMetadata metadata = this.metadata.findByEntityId(registrationId);
        if (metadata == null) {
            return null;
        }
		return applyRelyingParty(metadata);
    }

	@Override
    public Iterator<RelyingPartyRegistration> iterator() {
		return StreamSupport.stream(this.metadata.spliterator(), false)
            .map(this::applyRelyingParty).iterator();
    }

	private RelyingPartyRegistration applyRelyingParty(AssertingPartyMetadata metadata) {
		return RelyingPartyRegistration.withAssertingPartyMetadata(metadata)
            // apply any relying party configuration
            .build();
	}

}
@Component
class RefreshableRelyingPartyRegistrationRepository : IterableRelyingPartyRegistrationRepository {

    private val metadata: AssertingPartyMetadataRepository =
        OpenSaml5AssertingPartyMetadataRepository.fromTrustedMetadataLocation(
            "https://idp.example.org/metadata").build()

    fun findByRegistrationId(registrationId:String?): RelyingPartyRegistration {
        val metadata = this.metadata.findByEntityId(registrationId)
        if (metadata == null) {
            return null
        }
        return applyRelyingParty(metadata)
    }

    fun iterator(): Iterator<RelyingPartyRegistration> {
        return StreamSupport.stream(this.metadata.spliterator(), false)
            .map(this::applyRelyingParty).iterator()
    }

    private fun applyRelyingParty(metadata: AssertingPartyMetadata): RelyingPartyRegistration {
        val details: AssertingPartyMetadata = metadata as AssertingPartyMetadata
        return RelyingPartyRegistration.withAssertingPartyMetadata(details)
            // apply any relying party configuration
            .build()
    }
 }
OpenSaml5AssertingPartyMetadataRepository还附带一个构造函数,以便你可以提供自定义MetadataResolver.由于基础MetadataResolver正在进行过期和刷新,如果您直接使用构造函数,则只有通过提供这样做的实现才能获得这些功能。

验证元数据签名

您还可以使用OpenSaml5AssertingPartyMetadataRepository通过提供适当的Saml2X509Credentials 如下所示:spring-doc.cadn.net.cn

OpenSaml5AssertingPartyMetadataRepository.withMetadataLocation("https://idp.example.org/metadata")
    .verificationCredentials((c) -> c.add(myVerificationCredential))
    .build();
OpenSaml5AssertingPartyMetadataRepository.withMetadataLocation("https://idp.example.org/metadata")
    .verificationCredentials({ c : Collection<Saml2X509Credential> ->
        c.add(myVerificationCredential) })
    .build()
如果未提供凭据,则组件将不会执行签名验证。

生产<saml2:SPSSODescriptor>元数据

您可以使用saml2MetadataDSL 方法,如下所示:spring-doc.cadn.net.cn

http
    // ...
    .saml2Login(withDefaults())
    .saml2Metadata(withDefaults());
http {
    //...
    saml2Login { }
    saml2Metadata { }
}

可以使用此元数据终结点向断言方注册信赖方。 这通常就像找到正确的表单字段来提供元数据端点一样简单。spring-doc.cadn.net.cn

默认情况下,元数据终结点为/saml2/metadata,尽管它也响应/saml2/metadata/{registrationId}/saml2/service-provider-metadata/{registrationId}.spring-doc.cadn.net.cn

您可以通过调用metadataUrlDSL 中的方法:spring-doc.cadn.net.cn

.saml2Metadata((saml2) -> saml2.metadataUrl("/saml/metadata"))
saml2Metadata {
	metadataUrl = "/saml/metadata"
}

改变方式RelyingPartyRegistration被查找

如果您有不同的策略来确定哪些RelyingPartyRegistration要使用,您可以配置自己的Saml2MetadataResponseResolver如下图所示:spring-doc.cadn.net.cn

@Bean
Saml2MetadataResponseResolver metadataResponseResolver(RelyingPartyRegistrationRepository registrations) {
	RequestMatcherMetadataResponseResolver metadata = new RequestMatcherMetadataResponseResolver(
			(id) -> registrations.findByRegistrationId("relying-party"));
	metadata.setMetadataFilename("metadata.xml");
	return metadata;
}
@Bean
fun metadataResponseResolver(val registrations: RelyingPartyRegistrationRepository): Saml2MetadataResponseResolver {
    val metadata = new RequestMatcherMetadataResponseResolver(
			id: String -> registrations.findByRegistrationId("relying-party"))
	metadata.setMetadataFilename("metadata.xml")
	return metadata
}