对于最新的稳定版本,请使用 Spring Security 6.5.3! |
SAML 2.0 登录概述
我们首先检查 SAML 2.0 信赖方身份验证在 Spring Security 中的工作原理。 首先,我们看到,与 OAuth 2.0 登录一样,Spring Security 将用户带到第三方进行身份验证。 它通过一系列重定向来做到这一点:

首先,用户向
/private
资源,但未授权。
Spring Security 的
FilterSecurityInterceptor
表示通过抛出AccessDeniedException
.
由于用户缺乏授权,因此
ExceptionTranslationFilter
启动启动身份验证。
配置的AuthenticationEntryPoint
是LoginUrlAuthenticationEntryPoint
,重定向到这<saml2:AuthnRequest>
生成端点,Saml2WebSsoAuthenticationRequestFilter
.
或者,如果您配置了多个断言方,它首先重定向到选取器页面。
接下来,
Saml2WebSsoAuthenticationRequestFilter
创建、签名、序列化和编码<saml2:AuthnRequest>
使用其配置的Saml2AuthenticationRequestFactory
.
然后浏览器会接受这个
<saml2:AuthnRequest>
并将其提交给主张方。
断言方尝试对用户进行身份验证。
如果成功,它将返回一个<saml2:Response>
返回浏览器。
然后浏览器会 POST
<saml2:Response>
到断言消费者服务端点。
下图显示了 Spring Security 如何对<saml2:Response>
.

<saml2:Response>
该图建立在我们的 |
当浏览器提交
<saml2:Response>
到应用程序,它委托给Saml2WebSsoAuthenticationFilter
.
此过滤器调用其已配置的AuthenticationConverter
创建Saml2AuthenticationToken
通过从HttpServletRequest
.
该转换器还解析了RelyingPartyRegistration
并将其供应给Saml2AuthenticationToken
.
接下来,筛选器将Tokens传递给其配置的
AuthenticationManager
.
默认情况下,它使用OpenSamlAuthenticationProvider
.
如果身份验证失败,则失败。
-
这
AuthenticationEntryPoint
调用以重新启动身份验证过程。
如果身份验证成功,则成功。
-
这
Saml2WebSsoAuthenticationFilter
调用FilterChain#doFilter(request,response)
以继续其余的应用程序逻辑。
最少的配置
使用 Spring Boot 时,将应用程序配置为服务提供商包括两个基本步骤: .包括所需的依赖项。 .指示必要的断言方元数据。
此外,此配置假定您已向断言方注册了信赖方。 |
指定标识提供者元数据
在 Spring Boot 应用程序中,要指定身份提供程序的元数据,请创建类似于以下内容的配置:
spring:
security:
saml2:
relyingparty:
registration:
adfs:
identityprovider:
entity-id: https://idp.example.com/issuer
verification.credentials:
- certificate-location: "classpath:idp.crt"
singlesignon.url: https://idp.example.com/issuer/sso
singlesignon.sign-request: false
哪里:
-
idp.example.com/issuer
是Issuer
身份提供程序发出的 SAML 响应的属性。 -
classpath:idp.crt
是身份提供程序证书的类路径上用于验证 SAML 响应的位置。 -
idp.example.com/issuer/sso
是身份提供者期望的终结点AuthnRequest
实例。 -
adfs
是您选择的任意标识符
就是这样!
身份提供者和断言方是同义词,服务提供商和信赖方也是如此。 这些通常分别缩写为 AP 和 RP。 |
运行时预期
如前所述,应用程序处理任何POST /login/saml2/sso/{registrationId}
包含SAMLResponse
参数:
POST /login/saml2/sso/adfs HTTP/1.1
SAMLResponse=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...
有两种方法可以诱导您的断言方生成SAMLResponse
:
-
您可以导航到您的断言方。 它可能为每个已注册的信赖方提供某种链接或按钮,您可以单击这些链接或按钮来发送
SAMLResponse
. -
您可以导航到应用程序中的受保护页面,例如
localhost:8080
. 然后,您的应用程序重定向到配置的断言方,然后该方将SAMLResponse
.
从这里,考虑跳转到:
SAML 2.0 登录如何与 OpenSAML 集成
Spring Security 的 SAML 2.0 支持有几个设计目标:
-
依赖 SAML 2.0作和域对象的库。 为了实现这一点,Spring Security 使用 OpenSAML。
-
确保在使用 Spring Security 的 SAML 支持时不需要此库。 为了实现这一点,Spring Security 在合约中使用 OpenSAML 的任何接口或类都保持封装状态。 这使您可以将 OpenSAML 切换到其他库或不受支持的 OpenSAML 版本。
作为这两个目标的自然结果,Spring Security 的 SAML API 相对于其他模块来说非常小。
相反,像OpenSamlAuthenticationRequestFactory
和OpenSamlAuthenticationProvider
暴露Converter
自定义身份验证过程中各个步骤的实现。
例如,一旦您的应用程序收到SAMLResponse
并委托Saml2WebSsoAuthenticationFilter
,则过滤器委托给OpenSamlAuthenticationProvider
:
Response
这个数字建立在Saml2WebSsoAuthenticationFilter
图.
这
Saml2WebSsoAuthenticationFilter
制定Saml2AuthenticationToken
并调用AuthenticationManager
.
这
AuthenticationManager
调用 OpenSAML 身份验证提供程序。
身份验证提供程序将响应反序列化为 OpenSAML
Response
并检查其签名。
如果签名无效,则身份验证失败。
然后,提供者解密任何
EncryptedAssertion
元素.
如果任何解密失败,则身份验证失败。
接下来,提供程序验证响应的
Issuer
和Destination
值。
如果它们与RelyingPartyRegistration
,则身份验证失败。
之后,提供商验证每个
Assertion
.
如果任何签名无效,则身份验证失败。
此外,如果响应和断言都没有签名,则身份验证失败。
响应或所有断言都必须有签名。
然后,提供者解密任何
EncryptedID
或EncryptedAttribute
元素]。
如果任何解密失败,则身份验证失败。
接下来,提供程序验证每个断言的
ExpiresAt
和NotBefore
timestamps,<Subject>
和任何<AudienceRestriction>
条件。
如果任何验证失败,则身份验证失败。
之后,提供者采用第一个断言的
AttributeStatement
并将其映射到Map<String, List<Object>>
.
它还授予ROLE_USER
授予权力。
最后,它需要
NameID
从第一个断言来看,Map
属性,以及GrantedAuthority
并构造一个Saml2AuthenticatedPrincipal
.
然后,它将该主体和权限放入Saml2Authentication
.
由此产生的Authentication#getPrincipal
是 Spring SecuritySaml2AuthenticatedPrincipal
对象,以及Authentication#getName
映射到第一个断言的NameID
元素。Saml2AuthenticatedPrincipal#getRelyingPartyRegistrationId
持有identifier 添加到关联的RelyingPartyRegistration
.
自定义 OpenSAML 配置
任何同时使用 Spring Security 和 OpenSAML 的类都应该静态初始化OpenSamlInitializationService
在课程开始时:
-
Java
-
Kotlin
static {
OpenSamlInitializationService.initialize();
}
companion object {
init {
OpenSamlInitializationService.initialize()
}
}
这取代了 OpenSAML 的InitializationService#initialize
.
有时,自定义 OpenSAML 构建、封组和取消封组 SAML 对象的方式可能很有价值。
在这些情况下,您可能希望调用OpenSamlInitializationService#requireInitialize(Consumer)
使您可以访问 OpenSAML 的XMLObjectProviderFactory
.
例如,发送未签名的 AuthNRequest 时,您可能希望强制重新身份验证。
在这种情况下,您可以注册自己的AuthnRequestMarshaller
这样:
-
Java
-
Kotlin
static {
OpenSamlInitializationService.requireInitialize(factory -> {
AuthnRequestMarshaller marshaller = new AuthnRequestMarshaller() {
@Override
public Element marshall(XMLObject object, Element element) throws MarshallingException {
configureAuthnRequest((AuthnRequest) object);
return super.marshall(object, element);
}
public Element marshall(XMLObject object, Document document) throws MarshallingException {
configureAuthnRequest((AuthnRequest) object);
return super.marshall(object, document);
}
private void configureAuthnRequest(AuthnRequest authnRequest) {
authnRequest.setForceAuthn(true);
}
}
factory.getMarshallerFactory().registerMarshaller(AuthnRequest.DEFAULT_ELEMENT_NAME, marshaller);
});
}
companion object {
init {
OpenSamlInitializationService.requireInitialize {
val marshaller = object : AuthnRequestMarshaller() {
override fun marshall(xmlObject: XMLObject, element: Element): Element {
configureAuthnRequest(xmlObject as AuthnRequest)
return super.marshall(xmlObject, element)
}
override fun marshall(xmlObject: XMLObject, document: Document): Element {
configureAuthnRequest(xmlObject as AuthnRequest)
return super.marshall(xmlObject, document)
}
private fun configureAuthnRequest(authnRequest: AuthnRequest) {
authnRequest.isForceAuthn = true
}
}
it.marshallerFactory.registerMarshaller(AuthnRequest.DEFAULT_ELEMENT_NAME, marshaller)
}
}
}
这requireInitialize
每个应用程序实例只能调用一次方法。
覆盖或替换引导自动配置
Spring Boot 生成两个@Bean
信赖方的对象。
第一个是SecurityFilterChain
将应用程序配置为信赖方。
当包括spring-security-saml2-service-provider
这SecurityFilterChain
看来:
-
Java
-
Kotlin
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.anyRequest().authenticated()
)
.saml2Login(withDefaults());
return http.build();
}
@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
authorizeRequests {
authorize(anyRequest, authenticated)
}
saml2Login { }
}
return http.build()
}
如果应用程序未公开SecurityFilterChain
bean,Spring Boot 公开前面的默认版本。
您可以通过在应用程序中公开 bean 来替换它:
-
Java
-
Kotlin
@Configuration
@EnableWebSecurity
public class MyCustomSecurityConfiguration {
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.requestMatchers("/messages/**").hasAuthority("ROLE_USER")
.anyRequest().authenticated()
)
.saml2Login(withDefaults());
return http.build();
}
}
@Configuration
@EnableWebSecurity
class MyCustomSecurityConfiguration {
@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
authorizeRequests {
authorize("/messages/**", hasAuthority("ROLE_USER"))
authorize(anyRequest, authenticated)
}
saml2Login {
}
}
return http.build()
}
}
前面的示例需要USER
对于任何以/messages/
.
第二个@Bean
Spring Boot 创建的是一个RelyingPartyRegistrationRepository
,表示断言方和信赖方元数据。
这包括信赖方在请求向断言方请求身份验证时应使用的 SSO 终结点的位置等内容。
您可以通过发布自己的RelyingPartyRegistrationRepository
豆。
例如,您可以通过点击其元数据端点来查找断言方的配置:
-
Java
-
Kotlin
@Value("${metadata.location}")
String assertingPartyMetadataLocation;
@Bean
public RelyingPartyRegistrationRepository relyingPartyRegistrations() {
RelyingPartyRegistration registration = RelyingPartyRegistrations
.fromMetadataLocation(assertingPartyMetadataLocation)
.registrationId("example")
.build();
return new InMemoryRelyingPartyRegistrationRepository(registration);
}
@Value("\${metadata.location}")
var assertingPartyMetadataLocation: String? = null
@Bean
open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository? {
val registration = RelyingPartyRegistrations
.fromMetadataLocation(assertingPartyMetadataLocation)
.registrationId("example")
.build()
return InMemoryRelyingPartyRegistrationRepository(registration)
}
这registrationId 是您选择的用于区分注册的任意值。 |
或者,您可以手动提供每个详细信息:
-
Java
-
Kotlin
@Value("${verification.key}")
File verificationKey;
@Bean
public RelyingPartyRegistrationRepository relyingPartyRegistrations() throws Exception {
X509Certificate certificate = X509Support.decodeCertificate(this.verificationKey);
Saml2X509Credential credential = Saml2X509Credential.verification(certificate);
RelyingPartyRegistration registration = RelyingPartyRegistration
.withRegistrationId("example")
.assertingPartyDetails(party -> party
.entityId("https://idp.example.com/issuer")
.singleSignOnServiceLocation("https://idp.example.com/SSO.saml2")
.wantAuthnRequestsSigned(false)
.verificationX509Credentials(c -> c.add(credential))
)
.build();
return new InMemoryRelyingPartyRegistrationRepository(registration);
}
@Value("\${verification.key}")
var verificationKey: File? = null
@Bean
open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository {
val certificate: X509Certificate? = X509Support.decodeCertificate(verificationKey!!)
val credential: Saml2X509Credential = Saml2X509Credential.verification(certificate)
val registration = RelyingPartyRegistration
.withRegistrationId("example")
.assertingPartyDetails { party: AssertingPartyDetails.Builder ->
party
.entityId("https://idp.example.com/issuer")
.singleSignOnServiceLocation("https://idp.example.com/SSO.saml2")
.wantAuthnRequestsSigned(false)
.verificationX509Credentials { c: MutableCollection<Saml2X509Credential?> ->
c.add(
credential
)
}
}
.build()
return InMemoryRelyingPartyRegistrationRepository(registration)
}
|
或者,您可以使用 DSL 直接连接存储库,这也会覆盖自动配置的SecurityFilterChain
:
-
Java
-
Kotlin
@Configuration
@EnableWebSecurity
public class MyCustomSecurityConfiguration {
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.requestMatchers("/messages/**").hasAuthority("ROLE_USER")
.anyRequest().authenticated()
)
.saml2Login(saml2 -> saml2
.relyingPartyRegistrationRepository(relyingPartyRegistrations())
);
return http.build();
}
}
@Configuration
@EnableWebSecurity
class MyCustomSecurityConfiguration {
@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
authorizeRequests {
authorize("/messages/**", hasAuthority("ROLE_USER"))
authorize(anyRequest, authenticated)
}
saml2Login {
relyingPartyRegistrationRepository = relyingPartyRegistrations()
}
}
return http.build()
}
}
信赖方可以通过在 |
RelyingParty注册
一个RelyingPartyRegistration
instance 表示信赖方和断言方元数据之间的链接。
在RelyingPartyRegistration
,则可以提供信赖方元数据,例如其Issuer
值,它期望将 SAML 响应发送到的位置,以及它拥有的用于签署或解密有效负载的任何凭据。
此外,您还可以提供断言方元数据,例如其Issuer
值,它期望将 AuthnRequests 发送到的位置,以及它为信赖方验证或加密有效负载而拥有的任何公共凭据。
以下内容RelyingPartyRegistration
是大多数设置所需的最低要求:
-
Java
-
Kotlin
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistrations
.fromMetadataLocation("https://ap.example.org/metadata")
.registrationId("my-id")
.build();
val relyingPartyRegistration = RelyingPartyRegistrations
.fromMetadataLocation("https://ap.example.org/metadata")
.registrationId("my-id")
.build()
请注意,您还可以创建一个RelyingPartyRegistration
从任意InputStream
源。
一个这样的例子是元数据存储在数据库中时:
String xml = fromDatabase();
try (InputStream source = new ByteArrayInputStream(xml.getBytes())) {
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistrations
.fromMetadata(source)
.registrationId("my-id")
.build();
}
还可以进行更复杂的设置:
-
Java
-
Kotlin
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.withRegistrationId("my-id")
.entityId("{baseUrl}/{registrationId}")
.decryptionX509Credentials(c -> c.add(relyingPartyDecryptingCredential()))
.assertionConsumerServiceLocation("/my-login-endpoint/{registrationId}")
.assertingPartyDetails(party -> party
.entityId("https://ap.example.org")
.verificationX509Credentials(c -> c.add(assertingPartyVerifyingCredential()))
.singleSignOnServiceLocation("https://ap.example.org/SSO.saml2")
)
.build();
val relyingPartyRegistration =
RelyingPartyRegistration.withRegistrationId("my-id")
.entityId("{baseUrl}/{registrationId}")
.decryptionX509Credentials { c: MutableCollection<Saml2X509Credential?> ->
c.add(relyingPartyDecryptingCredential())
}
.assertionConsumerServiceLocation("/my-login-endpoint/{registrationId}")
.assertingPartyDetails { party -> party
.entityId("https://ap.example.org")
.verificationX509Credentials { c -> c.add(assertingPartyVerifyingCredential()) }
.singleSignOnServiceLocation("https://ap.example.org/SSO.saml2")
}
.build()
顶级元数据方法是有关信赖方的详细信息。
里面的方法 |
信赖方期望 SAML 响应的位置是断言使用者服务位置。 |
信赖方的默认值entityId
是{baseUrl}/saml2/service-provider-metadata/{registrationId}
.
这是配置断言方以了解信赖方时所需的此值。
默认值assertionConsumerServiceLocation
是/login/saml2/sso/{registrationId}
.
默认情况下,它映射到Saml2WebSsoAuthenticationFilter
在过滤器链中。
URI 模式
您可能注意到{baseUrl}
和{registrationId}
占位符。
这些对于生成 URI 很有用。因此,信赖方的entityId
和assertionConsumerServiceLocation
支持以下占位符:
-
baseUrl
- 已部署应用程序的方案、主机和端口 -
registrationId
- 此信赖方的注册 ID -
baseScheme
- 已部署应用程序的方案 -
baseHost
- 已部署应用程序的主机 -
basePort
- 已部署应用程序的端口
例如,assertionConsumerServiceLocation
之前的定义是:
/my-login-endpoint/{registrationId}
在已部署的应用程序中,它转换为:
/my-login-endpoint/adfs
这entityId
前面显示的定义为:
{baseUrl}/{registrationId}
在已部署的应用程序中,这转换为:
https://rp.example.com/adfs
流行的 URI 模式如下所示:
-
/saml2/authenticate/{registrationId}
- 终结点生成一个<saml2:AuthnRequest>
基于该配置RelyingPartyRegistration
并将其发送给主张方 -
/saml2/login/sso/{registrationId}
- 终结点验证断言方的<saml2:Response>
基于该配置RelyingPartyRegistration
-
/saml2/logout/sso
- 终结点过程<saml2:LogoutRequest>
和<saml2:LogoutResponse>
负载;这RelyingPartyRegistration
从以前经过身份验证的状态查找 -
/saml2/saml2-service-provider/metadata/{registrationId}
- 该信赖方元数据RelyingPartyRegistration
由于registrationId
是RelyingPartyRegistration
,则在未经身份验证的方案中需要它在 URL 中。
如果您希望删除registrationId
出于任何原因,您可以从 URL指定一个RelyingPartyRegistrationResolver
告诉 Spring Security 如何查找registrationId
.
凭据
在前面显示的示例中,您可能还注意到使用的凭据。
通常,信赖方使用相同的密钥对有效负载进行签名和解密。 或者,它可以使用相同的密钥来验证有效负载并对其进行加密。
因此,Spring Security 附带了Saml2X509Credential
,这是一种特定于 SAML 的凭据,可简化为不同用例配置同一密钥的过程。
至少,您需要拥有断言方的证书,以便可以验证断言方的签名响应。
要构造一个Saml2X509Credential
您可以使用来验证断言方的断言,您可以加载文件并使用
这CertificateFactory
:
-
Java
-
Kotlin
Resource resource = new ClassPathResource("ap.crt");
try (InputStream is = resource.getInputStream()) {
X509Certificate certificate = (X509Certificate)
CertificateFactory.getInstance("X.509").generateCertificate(is);
return Saml2X509Credential.verification(certificate);
}
val resource = ClassPathResource("ap.crt")
resource.inputStream.use {
return Saml2X509Credential.verification(
CertificateFactory.getInstance("X.509").generateCertificate(it) as X509Certificate?
)
}
假设断言方也将对断言进行加密。 在这种情况下,信赖方需要一个私钥来解密加密的值。
在这种情况下,您需要一个RSAPrivateKey
以及其对应的X509Certificate
.
您可以使用 Spring Security 的RsaKeyConverters
实用程序类和第二个,就像你之前所做的那样:
-
Java
-
Kotlin
X509Certificate certificate = relyingPartyDecryptionCertificate();
Resource resource = new ClassPathResource("rp.crt");
try (InputStream is = resource.getInputStream()) {
RSAPrivateKey rsa = RsaKeyConverters.pkcs8().convert(is);
return Saml2X509Credential.decryption(rsa, certificate);
}
val certificate: X509Certificate = relyingPartyDecryptionCertificate()
val resource = ClassPathResource("rp.crt")
resource.inputStream.use {
val rsa: RSAPrivateKey = RsaKeyConverters.pkcs8().convert(it)
return Saml2X509Credential.decryption(rsa, certificate)
}
将这些文件的位置指定为适当的 Spring Boot 属性时,Spring Boot 会为您执行这些转换。 |
重复的信赖方配置
当应用程序使用多个断言方时,某些配置会在RelyingPartyRegistration
实例:
-
信赖方的
entityId
-
其
assertionConsumerServiceLocation
-
其凭据 — 例如,其签名或解密凭据
与其他身份提供商相比,此设置可以让某些身份提供商更轻松地轮换凭据。
可以通过几种不同的方式缓解重复。
首先,在 YAML 中,可以通过引用来缓解这种情况:
spring:
security:
saml2:
relyingparty:
okta:
signing.credentials: &relying-party-credentials
- private-key-location: classpath:rp.key
certificate-location: classpath:rp.crt
identityprovider:
entity-id: ...
azure:
signing.credentials: *relying-party-credentials
identityprovider:
entity-id: ...
其次,在数据库中,不需要复制RelyingPartyRegistration
.
第三,在 Java 中,您可以创建一个自定义配置方法:
-
Java
-
Kotlin
private RelyingPartyRegistration.Builder
addRelyingPartyDetails(RelyingPartyRegistration.Builder builder) {
Saml2X509Credential signingCredential = ...
builder.signingX509Credentials(c -> c.addAll(signingCredential));
// ... other relying party configurations
}
@Bean
public RelyingPartyRegistrationRepository relyingPartyRegistrations() {
RelyingPartyRegistration okta = addRelyingPartyDetails(
RelyingPartyRegistrations
.fromMetadataLocation(oktaMetadataUrl)
.registrationId("okta")).build();
RelyingPartyRegistration azure = addRelyingPartyDetails(
RelyingPartyRegistrations
.fromMetadataLocation(oktaMetadataUrl)
.registrationId("azure")).build();
return new InMemoryRelyingPartyRegistrationRepository(okta, azure);
}
private fun addRelyingPartyDetails(builder: RelyingPartyRegistration.Builder): RelyingPartyRegistration.Builder {
val signingCredential: Saml2X509Credential = ...
builder.signingX509Credentials { c: MutableCollection<Saml2X509Credential?> ->
c.add(
signingCredential
)
}
// ... other relying party configurations
}
@Bean
open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository? {
val okta = addRelyingPartyDetails(
RelyingPartyRegistrations
.fromMetadataLocation(oktaMetadataUrl)
.registrationId("okta")
).build()
val azure = addRelyingPartyDetails(
RelyingPartyRegistrations
.fromMetadataLocation(oktaMetadataUrl)
.registrationId("azure")
).build()
return InMemoryRelyingPartyRegistrationRepository(okta, azure)
}
解决RelyingPartyRegistration
从请求
到目前为止,Spring Security 解析了RelyingPartyRegistration
通过在 URI 路径中查找注册 ID。
您可能想要自定义它的原因有很多。其中:
-
您可能正在联合许多主张方
要自定义RelyingPartyRegistration
已解决,您可以配置自定义RelyingPartyRegistrationResolver
. 默认从 URI 的最后一个路径元素中查找注册 ID,并在RelyingPartyRegistrationRepository
.
请记住,如果您的RelyingPartyRegistration ,解析器实现应该可以解决它们。 |
解析为单个一致性RelyingPartyRegistration
例如,您可以提供一个解析器,该解析器始终返回相同的RelyingPartyRegistration
:
-
Java
-
Kotlin
public class SingleRelyingPartyRegistrationResolver implements RelyingPartyRegistrationResolver {
private final RelyingPartyRegistrationResolver delegate;
public SingleRelyingPartyRegistrationResolver(RelyingPartyRegistrationRepository registrations) {
this.delegate = new DefaultRelyingPartyRegistrationResolver(registrations);
}
@Override
public RelyingPartyRegistration resolve(HttpServletRequest request, String registrationId) {
return this.delegate.resolve(request, "single");
}
}
class SingleRelyingPartyRegistrationResolver(delegate: RelyingPartyRegistrationResolver) : RelyingPartyRegistrationResolver {
override fun resolve(request: HttpServletRequest?, registrationId: String?): RelyingPartyRegistration? {
return this.delegate.resolve(request, "single")
}
}
接下来,您可以看看如何使用此解析器进行自定义<saml2:SPSSODescriptor> 元数据生产. |
基于<saml2:Response#Issuer>
当您有一个信赖方可以接受来自多个断言方的断言时,您将拥有同样多的断言RelyingPartyRegistration
s 作为断言方,信赖方信息在每个实例中重复。
这意味着每个断言方的断言消费者服务端点将不同,这可能不是可取的。
您可以改为解决registrationId
通过Issuer
. 自定义实现RelyingPartyRegistrationResolver
这样做可能看起来像:
-
Java
-
Kotlin
public class SamlResponseIssuerRelyingPartyRegistrationResolver implements RelyingPartyRegistrationResolver {
private final InMemoryRelyingPartyRegistrationRepository registrations;
// ... constructor
@Override
RelyingPartyRegistration resolve(HttpServletRequest request, String registrationId) {
if (registrationId != null) {
return this.registrations.findByRegistrationId(registrationId);
}
String entityId = resolveEntityIdFromSamlResponse(request);
for (RelyingPartyRegistration registration : this.registrations) {
if (registration.getAssertingPartyDetails().getEntityId().equals(entityId)) {
return registration;
}
}
return null;
}
private String resolveEntityIdFromSamlResponse(HttpServletRequest request) {
// ...
}
}
class SamlResponseIssuerRelyingPartyRegistrationResolver(val registrations: InMemoryRelyingPartyRegistrationRepository):
RelyingPartyRegistrationResolver {
@Override
fun resolve(val request: HttpServletRequest, val registrationId: String): RelyingPartyRegistration {
if (registrationId != null) {
return this.registrations.findByRegistrationId(registrationId)
}
String entityId = resolveEntityIdFromSamlResponse(request)
for (val registration : this.registrations) {
if (registration.getAssertingPartyDetails().getEntityId().equals(entityId)) {
return registration
}
}
return null
}
private resolveEntityIdFromSamlResponse(val request: HttpServletRequest): String {
// ...
}
}
接下来,您可以看看如何使用此解析器进行自定义<saml2:Response> 认证. |
联合登录
SAML 2.0 的一种常见安排是具有多个断言方的标识提供者。在这种情况下,标识提供者的元数据终结点返回多个<md:IDPSSODescriptor>
元素。
这些多个断言方可以在一次调用中访问RelyingPartyRegistrations
这样:
-
Java
-
Kotlin
Collection<RelyingPartyRegistration> registrations = RelyingPartyRegistrations
.collectionFromMetadataLocation("https://example.org/saml2/idp/metadata.xml")
.stream().map((builder) -> builder
.registrationId(UUID.randomUUID().toString())
.entityId("https://example.org/saml2/sp")
.build()
)
.collect(Collectors.toList()));
var registrations: Collection<RelyingPartyRegistration> = RelyingPartyRegistrations
.collectionFromMetadataLocation("https://example.org/saml2/idp/metadata.xml")
.stream().map { builder : RelyingPartyRegistration.Builder -> builder
.registrationId(UUID.randomUUID().toString())
.entityId("https://example.org/saml2/sp")
.build()
}
.collect(Collectors.toList()));
请注意,由于注册 ID 设置为随机值,因此这会将某些 SAML 2.0 端点更改为不可预测。有几种方法可以解决这个问题;让我们专注于一种适合联合特定用例的方法。
在许多联合情况下,所有断言方共享服务提供商配置。鉴于 Spring Security 默认将包含registrationId
在其所有 SAML 2.0 URI 中,下一步通常是更改这些 URI 以排除registrationId
.
您需要按照这些思路更改两个主要 URI:
(可选)您可能还希望更改身份验证请求位置,但由于这是应用程序内部的 URI,并且不会发布给断言方,因此好处通常很小。 |
您可以在以下位置看到一个完整的示例我们saml-extension-federation
样本.
使用 Spring Security SAML 扩展 URI
如果您从 Spring Security SAML 扩展迁移,则将应用程序配置为使用 SAML 扩展 URI 默认值可能会有一些好处。
有关这方面的更多信息,请参阅我们custom-urls
样本和我们saml-extension-federation
样本.