|
对于最新的稳定版本,请使用 Spring Security 6.5.3! |
执行单次注销
在其其他注销机制中,Spring Security 支持 RP 和 AP 启动的 SAML 2.0 单次注销。
简而言之,Spring Security 支持两个用例:
-
RP-Initiated - 您的应用程序有一个端点,当 POST 到 该端点时,将注销用户并发送
saml2:LogoutRequest到主张方。 此后,断言方将发回saml2:LogoutResponse并允许应用程序响应 -
AP 启动 - 您的应用程序具有一个终结点,该终结点将接收
saml2:LogoutRequest来自主张方。 您的应用程序将在此时完成注销,然后发送saml2:LogoutResponse到主张方。
在 AP 启动方案中,应用程序在注销后执行的任何本地重定向都变得毫无意义。
一旦您的应用程序发送了saml2:LogoutResponse,它不再控制浏览器。 |
单次注销的最小配置
要使用 Spring Security 的 SAML 2.0 单次注销功能,您需要以下内容:
-
首先,断言方必须支持 SAML 2.0 单次注销
-
其次,应将断言方配置为签名和 POST
saml2:LogoutRequests 和saml2:LogoutResponse应用程序的/logout/saml2/slo端点 -
第三,应用程序必须具有 PKCS#8 私钥和 X.509 证书才能进行签名
saml2:LogoutRequests 和saml2:LogoutResponses
您可以通过以下方式在 Spring Boot 中实现此目的:
spring:
security:
saml2:
relyingparty:
registration:
metadata:
signing.credentials: (3)
- private-key-location: classpath:credentials/rp-private.key
certificate-location: classpath:credentials/rp-certificate.crt
singlelogout.url: "{baseUrl}/logout/saml2/slo" (2)
assertingparty:
metadata-uri: https://ap.example.com/metadata (1)
| 1 | - IDP 的元数据 URI,它将向您的应用程序指示它对 SLO 的支持 |
| 2 | - 应用程序中的 SLO 端点 |
| 3 | - 要签名的签名凭据<saml2:LogoutRequest>s 和<saml2:LogoutResponse>s |
An asserting party supports Single Logout if their metadata includes the `<SingleLogoutService>` element in their metadata.
就是这样!
Spring Security 的注销支持提供了许多配置点。 考虑以下用例:
创业期望
使用这些属性时,除了登录之外,SAML 2.0 服务提供商还会自动配置自身,以便通过以下方式注销<saml2:LogoutRequest>s 和<saml2:LogoutResponse>使用 RP 或 AP 启动的注销。
它通过确定性启动过程实现这一点:
-
查询 Identity Server 元数据端点的
<SingleLogoutService>元素 -
扫描元数据并缓存任何公共签名验证密钥
-
准备适当的终结点
此过程的结果是,身份服务器必须启动并接收请求,服务提供商才能成功启动。
| 如果服务提供商查询身份服务器时身份服务器已关闭(给定适当的超时),则启动将失败。 |
运行时预期
鉴于上述配置,任何登录用户都可以发送POST /logout到您的应用程序以执行 RP 启动的 SLO。然后,您的应用程序将执行以下作:
-
注销用户并使会话失效
-
生成一个
<saml2:LogoutRequest>并将其 POST 到关联的断言方的 SLO 端点 -
然后,如果断言方以
<saml2:LogoutResponse>,应用程序会验证它并重定向到配置的成功端点
此外,当断言方发送<saml2:LogoutRequest>自/logout/saml2/slo.
发生这种情况时,您的应用程序将执行以下作:
-
验证
<saml2:LogoutRequest> -
注销用户并使会话失效
-
生成一个
<saml2:LogoutResponse>并将其 POST 回断言方的 SLO 端点
最小配置无启动
除了 Boot 属性,您还可以通过直接发布 bean 来实现相同的结果,如下所示:
-
Java
-
Kotlin
@Configuration
public class SecurityConfig {
@Value("${private.key}") RSAPrivateKey key;
@Value("${public.certificate}") X509Certificate certificate;
@Bean
RelyingPartyRegistrationRepository registrations() {
Saml2X509Credential credential = Saml2X509Credential.signing(key, certificate);
RelyingPartyRegistration registration = RelyingPartyRegistrations
.fromMetadataLocation("https://ap.example.org/metadata") (1)
.registrationId("metadata")
.singleLogoutServiceLocation("{baseUrl}/logout/saml2/slo") (2)
.signingX509Credentials((signing) -> signing.add(credential)) (3)
.build();
return new InMemoryRelyingPartyRegistrationRepository(registration);
}
@Bean
SecurityFilterChain web(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests((authorize) -> authorize
.anyRequest().authenticated()
)
.saml2Login(withDefaults())
.saml2Logout(withDefaults()); (4)
return http.build();
}
}
@Configuration
class SecurityConfig(@Value("${private.key}") val key: RSAPrivateKey,
@Value("${public.certificate}") val certificate: X509Certificate) {
@Bean
fun registrations(): RelyingPartyRegistrationRepository {
val credential = Saml2X509Credential.signing(key, certificate)
val registration = RelyingPartyRegistrations
.fromMetadataLocation("https://ap.example.org/metadata") (1)
.registrationId("metadata")
.singleLogoutServiceLocation("{baseUrl}/logout/saml2/slo") (2)
.signingX509Credentials({ signing: List<Saml2X509Credential> -> signing.add(credential) }) (3)
.build()
return InMemoryRelyingPartyRegistrationRepository(registration)
}
@Bean
fun web(http: HttpSecurity): SecurityFilterChain {
http {
authorizeHttpRequests {
anyRequest = authenticated
}
saml2Login {
}
saml2Logout { (4)
}
}
return http.build()
}
}
| 1 | - IDP 的元数据 URI,它将向您的应用程序指示它对 SLO 的支持 |
| 2 | - 应用程序中的 SLO 端点 |
| 3 | - 要签名的签名凭据<saml2:LogoutRequest>s 和<saml2:LogoutResponse>s,您还可以将其添加到多个信赖方 |
| 4 | - 其次,指示您的应用程序希望使用 SAML SLO 注销最终用户 |
添加saml2Logout为您的服务提供商添加注销功能。
因为它是一项可选功能,所以您需要为每个人启用它RelyingPartyRegistration.
为此,您可以将RelyingPartyRegistration.Builder#singleLogoutServiceLocation属性,如上所示。 |
Saml 2.0 注销的工作原理
接下来,让我们看看 Spring Security 用于在基于 servlet 的应用程序中支持 SAML 2.0 Logout 的架构组件,就像我们刚刚看到的那个一样。
对于 RP 发起的注销:
Spring Security 执行其注销流程,调用其LogoutHandlers 使会话无效并执行其他清理。
然后它调用Saml2RelyingPartyInitiatedLogoutSuccessHandler.
注销成功处理程序使用Saml2LogoutRequestResolver创建、签名和序列化<saml2:LogoutRequest>.
它使用RelyingPartyRegistration与当前Saml2AuthenticatedPrincipal.
然后,它重定向 POST<saml2:LogoutRequest>到断言方 SLO 端点
浏览器将控制权移交给断言方。
如果断言方重定向回(可能不会),则应用程序将继续执行步骤
.
这Saml2LogoutResponseFilter反序列化、验证和处理<saml2:LogoutResponse>与其Saml2LogoutResponseValidator.
如果有效,则通过重定向到/login?logout,或已配置的任何内容。
如果无效,则以 400 响应。
对于 AP 发起的注销:
这Saml2LogoutRequestFilter反序列化、验证和处理<saml2:LogoutRequest>与其Saml2LogoutRequestValidator.
如果有效,则过滤器调用已配置的LogoutHandlers,使会话无效并执行其他清理。
它使用Saml2LogoutResponseResolver创建、签名和序列化<saml2:LogoutResponse>.
它使用RelyingPartyRegistration派生自端点或<saml2:LogoutRequest>.
然后,它重定向 POST<saml2:LogoutResponse>到断言方 SLO 终结点。
浏览器将控制权移交给断言方。
如果无效,则以 400 响应。
配置注销端点
不同的终结点可以触发三种行为:
-
RP 发起的注销,允许经过身份验证的用户
POST并通过向断言方发送一个<saml2:LogoutRequest> -
AP 发起的注销,允许断言方发送
<saml2:LogoutRequest>前往应用 -
AP 注销响应,允许断言方发送
<saml2:LogoutResponse>以响应 RP 发起的<saml2:LogoutRequest>
第一个是通过执行正常POST /logout当主体类型为Saml2AuthenticatedPrincipal.
第二个是通过 POST 触发的/logout/saml2/sloendpoint 的SAMLRequest由主张方签署。
第三个是由 POST 触发的/logout/saml2/sloendpoint 的SAMLResponse由主张方签署。
由于用户已登录或原始注销请求已知,因此registrationId已经知道了。
出于这个原因,{registrationId}默认情况下不属于这些 URL。
此 URL 可在 DSL 中自定义。
例如,如果您要将现有的信赖方迁移到 Spring Security,则您的断言方可能已经指向GET /SLOService.saml2.
若要减少断言方的配置更改,可以在 DSL 中配置筛选器,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutRequest((request) -> request.logoutUrl("/SLOService.saml2"))
.logoutResponse((response) -> response.logoutUrl("/SLOService.saml2"))
);
http {
saml2Logout {
logoutRequest {
logoutUrl = "/SLOService.saml2"
}
logoutResponse {
logoutUrl = "/SLOService.saml2"
}
}
}
您还应该在RelyingPartyRegistration.
此外,您可以自定义端点以在本地触发注销,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2.logoutUrl("/saml2/logout"));
http {
saml2Logout {
logoutUrl = "/saml2/logout"
}
}
将本地注销与 SAML 2.0 注销分开
在某些情况下,您可能希望公开一个用于本地注销的注销端点,以及另一个用于 RP 启动的 SLO 的注销端点。 与其他注销机制一样,您可以注册多个,只要它们每个都有不同的端点。
因此,例如,您可以像这样连接 DSL:
-
Java
-
Kotlin
http
.logout((logout) -> logout.logoutUrl("/logout"))
.saml2Logout((saml2) -> saml2.logoutUrl("/saml2/logout"));
http {
logout {
logoutUrl = "/logout"
}
saml2Logout {
logoutUrl = "/saml2/logout"
}
}
现在,如果客户端发送POST /logout,会话将被清除,但不会有<saml2:LogoutRequest>发送给主张方。
但是,如果客户端发送POST /saml2/logout,则应用程序将正常启动 SAML 2.0 SLO。
定制<saml2:LogoutRequest>分辨率
通常需要在<saml2:LogoutRequest>比 Spring Security 提供的默认值。
默认情况下,Spring Security 将发出<saml2:LogoutRequest>并供应:
-
这
Destination属性 - 来自RelyingPartyRegistration#getAssertingPartyDetails#getSingleLogoutServiceLocation -
这
ID属性 - GUID -
这
<Issuer>元素 - 从RelyingPartyRegistration#getEntityId -
这
<NameID>元素 - 从Authentication#getName
要添加其他值,您可以使用委托,如下所示:
-
Java
-
Kotlin
@Bean
Saml2LogoutRequestResolver logoutRequestResolver(RelyingPartyRegistrationRepository registrations) {
OpenSaml4LogoutRequestResolver logoutRequestResolver =
new OpenSaml4LogoutRequestResolver(registrations);
logoutRequestResolver.setParametersConsumer((parameters) -> {
String name = ((Saml2AuthenticatedPrincipal) parameters.getAuthentication().getPrincipal()).getFirstAttribute("CustomAttribute");
String format = "urn:oasis:names:tc:SAML:2.0:nameid-format:transient";
LogoutRequest logoutRequest = parameters.getLogoutRequest();
NameID nameId = logoutRequest.getNameID();
nameId.setValue(name);
nameId.setFormat(format);
});
return logoutRequestResolver;
}
@Bean
open fun logoutRequestResolver(registrations:RelyingPartyRegistrationRepository?): Saml2LogoutRequestResolver {
val logoutRequestResolver = OpenSaml4LogoutRequestResolver(registrations)
logoutRequestResolver.setParametersConsumer { parameters: LogoutRequestParameters ->
val name: String = (parameters.getAuthentication().getPrincipal() as Saml2AuthenticatedPrincipal).getFirstAttribute("CustomAttribute")
val format = "urn:oasis:names:tc:SAML:2.0:nameid-format:transient"
val logoutRequest: LogoutRequest = parameters.getLogoutRequest()
val nameId: NameID = logoutRequest.getNameID()
nameId.setValue(name)
nameId.setFormat(format)
}
return logoutRequestResolver
}
然后,您可以提供您的自定义Saml2LogoutRequestResolver在 DSL 中,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutRequest((request) -> request
.logoutRequestResolver(this.logoutRequestResolver)
)
);
http {
saml2Logout {
logoutRequest {
logoutRequestResolver = this.logoutRequestResolver
}
}
}
定制<saml2:LogoutResponse>分辨率
通常需要在<saml2:LogoutResponse>比 Spring Security 提供的默认值。
默认情况下,Spring Security 将发出<saml2:LogoutResponse>并供应:
-
这
Destination属性 - 来自RelyingPartyRegistration#getAssertingPartyDetails#getSingleLogoutServiceResponseLocation -
这
ID属性 - GUID -
这
<Issuer>元素 - 从RelyingPartyRegistration#getEntityId -
这
<Status>元素-SUCCESS
要添加其他值,您可以使用委托,如下所示:
-
Java
-
Kotlin
@Bean
public Saml2LogoutResponseResolver logoutResponseResolver(RelyingPartyRegistrationRepository registrations) {
OpenSaml4LogoutResponseResolver logoutRequestResolver =
new OpenSaml4LogoutResponseResolver(registrations);
logoutRequestResolver.setParametersConsumer((parameters) -> {
if (checkOtherPrevailingConditions(parameters.getRequest())) {
parameters.getLogoutRequest().getStatus().getStatusCode().setCode(StatusCode.PARTIAL_LOGOUT);
}
});
return logoutRequestResolver;
}
@Bean
open fun logoutResponseResolver(registrations: RelyingPartyRegistrationRepository?): Saml2LogoutResponseResolver {
val logoutRequestResolver = OpenSaml4LogoutResponseResolver(registrations)
logoutRequestResolver.setParametersConsumer { LogoutResponseParameters parameters ->
if (checkOtherPrevailingConditions(parameters.getRequest())) {
parameters.getLogoutRequest().getStatus().getStatusCode().setCode(StatusCode.PARTIAL_LOGOUT)
}
}
return logoutRequestResolver
}
然后,您可以提供您的自定义Saml2LogoutResponseResolver在 DSL 中,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutRequest((request) -> request
.logoutRequestResolver(this.logoutRequestResolver)
)
);
http {
saml2Logout {
logoutRequest {
logoutRequestResolver = this.logoutRequestResolver
}
}
}
定制<saml2:LogoutRequest>认证
要自定义验证,您可以实现自己的验证Saml2LogoutRequestValidator.
此时,验证是最小的,因此您可以首先委托给默认值Saml2LogoutRequestValidator这样:
-
Java
-
Kotlin
@Component
public class MyOpenSamlLogoutRequestValidator implements Saml2LogoutRequestValidator {
private final Saml2LogoutRequestValidator delegate = new OpenSamlLogoutRequestValidator();
@Override
public Saml2LogoutRequestValidator logout(Saml2LogoutRequestValidatorParameters parameters) {
// verify signature, issuer, destination, and principal name
Saml2LogoutValidatorResult result = delegate.authenticate(authentication);
LogoutRequest logoutRequest = // ... parse using OpenSAML
// perform custom validation
}
}
@Component
open class MyOpenSamlLogoutRequestValidator: Saml2LogoutRequestValidator {
private val delegate = OpenSamlLogoutRequestValidator()
@Override
fun logout(parameters: Saml2LogoutRequestValidatorParameters): Saml2LogoutRequestValidator {
// verify signature, issuer, destination, and principal name
val result = delegate.authenticate(authentication)
val logoutRequest: LogoutRequest = // ... parse using OpenSAML
// perform custom validation
}
}
然后,您可以提供您的自定义Saml2LogoutRequestValidator在 DSL 中,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutRequest((request) -> request
.logoutRequestValidator(myOpenSamlLogoutRequestValidator)
)
);
http {
saml2Logout {
logoutRequest {
logoutRequestValidator = myOpenSamlLogoutRequestValidator
}
}
}
定制<saml2:LogoutResponse>认证
要自定义验证,您可以实现自己的验证Saml2LogoutResponseValidator.
此时,验证是最小的,因此您可以首先委托给默认值Saml2LogoutResponseValidator这样:
-
Java
-
Kotlin
@Component
public class MyOpenSamlLogoutResponseValidator implements Saml2LogoutResponseValidator {
private final Saml2LogoutResponseValidator delegate = new OpenSamlLogoutResponseValidator();
@Override
public Saml2LogoutValidatorResult logout(Saml2LogoutResponseValidatorParameters parameters) {
// verify signature, issuer, destination, and status
Saml2LogoutValidatorResult result = delegate.authenticate(parameters);
LogoutResponse logoutResponse = // ... parse using OpenSAML
// perform custom validation
}
}
@Component
open class MyOpenSamlLogoutResponseValidator: Saml2LogoutResponseValidator {
private val delegate = OpenSamlLogoutResponseValidator()
@Override
fun logout(parameters: Saml2LogoutResponseValidatorParameters): Saml2LogoutResponseValidator {
// verify signature, issuer, destination, and status
val result = delegate.authenticate(authentication)
val logoutResponse: LogoutResponse = // ... parse using OpenSAML
// perform custom validation
}
}
然后,您可以提供您的自定义Saml2LogoutResponseValidator在 DSL 中,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutResponse((response) -> response
.logoutResponseAuthenticator(myOpenSamlLogoutResponseAuthenticator)
)
);
http {
saml2Logout {
logoutResponse {
logoutResponseValidator = myOpenSamlLogoutResponseValidator
}
}
}
定制<saml2:LogoutRequest>存储
当应用程序发送<saml2:LogoutRequest>,则该值存储在会话中,以便RelayState参数和InResponseTo属性中的<saml2:LogoutResponse>可以验证。
如果你想将注销请求存储在会话以外的某个地方,你可以在 DSL 中提供你的自定义实现,如下所示:
-
Java
-
Kotlin
http
.saml2Logout((saml2) -> saml2
.logoutRequest((request) -> request
.logoutRequestRepository(myCustomLogoutRequestRepository)
)
);
http {
saml2Logout {
logoutRequest {
logoutRequestRepository = myCustomLogoutRequestRepository
}
}
}
更多注销相关参考资料
-
在CSRF注意事项部分注销