測試 OAuth 2.0
在 OAuth 2.0 方面,之前介紹的相同原則仍然適用:最終,它取決於您的被測方法期望 SecurityContextHolder 中包含什麼。
考慮以下控制器示例
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(Principal user) {
return Mono.just(user.getName());
}
@GetMapping("/endpoint")
fun foo(user: Principal): Mono<String> {
return Mono.just(user.name)
}
它沒有任何 OAuth2 特有的內容,因此您可以使用 @WithMockUser 並且一切正常。
但是,考慮您的控制器繫結到 Spring Security OAuth 2.0 支援的某個方面的情況
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@AuthenticationPrincipal OidcUser user) {
return Mono.just(user.getIdToken().getSubject());
}
@GetMapping("/endpoint")
fun foo(@AuthenticationPrincipal user: OidcUser): Mono<String> {
return Mono.just(user.idToken.subject)
}
在這種情況下,Spring Security 的測試支援非常方便。
測試 OIDC 登入
使用 WebTestClient 測試上一節中顯示的方法需要模擬某種授權伺服器的授權流程。這是一項艱鉅的任務,這就是為什麼 Spring Security 提供支援來消除這種樣板程式碼。
例如,我們可以透過使用 SecurityMockServerConfigurers#oidcLogin 方法來告訴 Spring Security 包含一個預設的 OidcUser
-
Java
-
Kotlin
client
.mutateWith(mockOidcLogin()).get().uri("/endpoint").exchange();
client
.mutateWith(mockOidcLogin())
.get().uri("/endpoint")
.exchange()
該行使用一個 OidcUser 配置相關的 MockServerRequest,該 OidcUser 包含一個簡單的 OidcIdToken、一個 OidcUserInfo 和一個授權集合。
具體來說,它包含一個 OidcIdToken,其 sub 宣告設定為 user
-
Java
-
Kotlin
assertThat(user.getIdToken().getClaim("sub")).isEqualTo("user");
assertThat(user.idToken.getClaim<String>("sub")).isEqualTo("user")
它還包含一個未設定任何宣告的 OidcUserInfo
-
Java
-
Kotlin
assertThat(user.getUserInfo().getClaims()).isEmpty();
assertThat(user.userInfo.claims).isEmpty()
它還包含一個僅包含一個許可權 SCOPE_read 的許可權集合。
-
Java
-
Kotlin
assertThat(user.getAuthorities()).hasSize(1);
assertThat(user.getAuthorities()).containsExactly(new SimpleGrantedAuthority("SCOPE_read"));
assertThat(user.authorities).hasSize(1)
assertThat(user.authorities).containsExactly(SimpleGrantedAuthority("SCOPE_read"))
Spring Security 確保 OidcUser 例項可用於@AuthenticationPrincipal 註解。
此外,它還將 OidcUser 連結到一個簡單的 OAuth2AuthorizedClient 例項,並將其存入模擬的 ServerOAuth2AuthorizedClientRepository 中。如果您的測試使用 @RegisteredOAuth2AuthorizedClient 註解,這會很方便。
配置許可權
在許多情況下,您的方法受過濾器或方法安全性的保護,並且需要您的 Authentication 具有某些授予的許可權才能允許請求。
在這些情況下,您可以使用 authorities() 方法提供所需的授予許可權
-
Java
-
Kotlin
client
.mutateWith(mockOidcLogin()
.authorities(new SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOidcLogin()
.authorities(SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange()
配置宣告
雖然授予的許可權在所有 Spring Security 中都很常見,但在 OAuth 2.0 的情況下,我們也有宣告。
例如,假設您有一個 user_id 宣告,指示使用者在您系統中的 ID。您可以在控制器中按如下方式訪問它
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@AuthenticationPrincipal OidcUser oidcUser) {
String userId = oidcUser.getIdToken().getClaim("user_id");
// ...
}
@GetMapping("/endpoint")
fun foo(@AuthenticationPrincipal oidcUser: OidcUser): Mono<String> {
val userId = oidcUser.idToken.getClaim<String>("user_id")
// ...
}
在這種情況下,您可以使用 idToken() 方法指定該宣告
-
Java
-
Kotlin
client
.mutateWith(mockOidcLogin()
.idToken((token) -> token.claim("user_id", "1234"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOidcLogin()
.idToken { token -> token.claim("user_id", "1234") }
)
.get().uri("/endpoint").exchange()
這之所以有效,是因為 OidcUser 從 OidcIdToken 收集其宣告。
附加配置
還有其他方法可以進一步配置身份驗證,具體取決於您的控制器期望的資料
-
userInfo(OidcUserInfo.Builder):配置OidcUserInfo例項 -
clientRegistration(ClientRegistration):使用給定的ClientRegistration配置關聯的OAuth2AuthorizedClient -
oidcUser(OidcUser):配置完整的OidcUser例項
最後一個方法很方便,如果: * 您有自己的 OidcUser 實現,或者 * 需要更改名稱屬性
例如,假設您的授權伺服器在 user_name 宣告而不是 sub 宣告中傳送主體名稱。在這種情況下,您可以手動配置 OidcUser
-
Java
-
Kotlin
OidcUser oidcUser = new DefaultOidcUser(
AuthorityUtils.createAuthorityList("SCOPE_message:read"),
OidcIdToken.withTokenValue("id-token").claim("user_name", "foo_user").build(),
"user_name");
client
.mutateWith(mockOidcLogin().oidcUser(oidcUser))
.get().uri("/endpoint").exchange();
val oidcUser: OidcUser = DefaultOidcUser(
AuthorityUtils.createAuthorityList("SCOPE_message:read"),
OidcIdToken.withTokenValue("id-token").claim("user_name", "foo_user").build(),
"user_name"
)
client
.mutateWith(mockOidcLogin().oidcUser(oidcUser))
.get().uri("/endpoint").exchange()
測試 OAuth 2.0 登入
與測試 OIDC 登入一樣,測試 OAuth 2.0 登入也面臨類似的挑戰:模擬授權流程。因此,Spring Security 也為非 OIDC 用例提供了測試支援。
假設我們有一個控制器,它將登入使用者作為 OAuth2User 獲取
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@AuthenticationPrincipal OAuth2User oauth2User) {
return Mono.just(oauth2User.getAttribute("sub"));
}
@GetMapping("/endpoint")
fun foo(@AuthenticationPrincipal oauth2User: OAuth2User): Mono<String> {
return Mono.just(oauth2User.getAttribute("sub"))
}
在這種情況下,我們可以透過使用 SecurityMockServerConfigurers#oauth2User 方法來告訴 Spring Security 包含一個預設的 OAuth2User
-
Java
-
Kotlin
client
.mutateWith(mockOAuth2Login())
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOAuth2Login())
.get().uri("/endpoint").exchange()
前面的示例使用一個 OAuth2User 配置關聯的 MockServerRequest,該 OAuth2User 包含一個簡單的屬性 Map 和一個授予許可權的 Collection。
具體來說,它包含一個 Map,其鍵/值對為 sub/user
-
Java
-
Kotlin
assertThat((String) user.getAttribute("sub")).isEqualTo("user");
assertThat(user.getAttribute<String>("sub")).isEqualTo("user")
它還包含一個僅包含一個許可權 SCOPE_read 的許可權集合。
-
Java
-
Kotlin
assertThat(user.getAuthorities()).hasSize(1);
assertThat(user.getAuthorities()).containsExactly(new SimpleGrantedAuthority("SCOPE_read"));
assertThat(user.authorities).hasSize(1)
assertThat(user.authorities).containsExactly(SimpleGrantedAuthority("SCOPE_read"))
Spring Security 完成必要的工作,以確保 OAuth2User 例項可用於@AuthenticationPrincipal 註解。
此外,它還將該 OAuth2User 連結到一個簡單的 OAuth2AuthorizedClient 例項,並將其存入模擬的 ServerOAuth2AuthorizedClientRepository 中。如果您的測試使用 @RegisteredOAuth2AuthorizedClient 註解,這會很方便。
配置許可權
在許多情況下,您的方法受過濾器或方法安全性的保護,並且需要您的 Authentication 具有某些授予的許可權才能允許請求。
在這種情況下,您可以使用 authorities() 方法提供所需的授予許可權
-
Java
-
Kotlin
client
.mutateWith(mockOAuth2Login()
.authorities(new SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOAuth2Login()
.authorities(SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange()
配置宣告
雖然授予的許可權在所有 Spring Security 中都很常見,但在 OAuth 2.0 的情況下,我們也有宣告。
例如,假設您有一個 user_id 屬性,指示使用者在您系統中的 ID。您可以在控制器中按如下方式訪問它
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@AuthenticationPrincipal OAuth2User oauth2User) {
String userId = oauth2User.getAttribute("user_id");
// ...
}
@GetMapping("/endpoint")
fun foo(@AuthenticationPrincipal oauth2User: OAuth2User): Mono<String> {
val userId = oauth2User.getAttribute<String>("user_id")
// ...
}
在這種情況下,您可以使用 attributes() 方法指定該屬性
-
Java
-
Kotlin
client
.mutateWith(mockOAuth2Login()
.attributes((attrs) -> attrs.put("user_id", "1234"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOAuth2Login()
.attributes { attrs -> attrs["user_id"] = "1234" }
)
.get().uri("/endpoint").exchange()
附加配置
還有其他方法可以進一步配置身份驗證,具體取決於您的控制器期望的資料
-
clientRegistration(ClientRegistration):使用給定的ClientRegistration配置關聯的OAuth2AuthorizedClient -
oauth2User(OAuth2User):配置完整的OAuth2User例項
最後一個方法很方便,如果: * 您有自己的 OAuth2User 實現,或者 * 需要更改名稱屬性
例如,假設您的授權伺服器在 user_name 宣告而不是 sub 宣告中傳送主體名稱。在這種情況下,您可以手動配置 OAuth2User
-
Java
-
Kotlin
OAuth2User oauth2User = new DefaultOAuth2User(
AuthorityUtils.createAuthorityList("SCOPE_message:read"),
Collections.singletonMap("user_name", "foo_user"),
"user_name");
client
.mutateWith(mockOAuth2Login().oauth2User(oauth2User))
.get().uri("/endpoint").exchange();
val oauth2User: OAuth2User = DefaultOAuth2User(
AuthorityUtils.createAuthorityList("SCOPE_message:read"),
mapOf(Pair("user_name", "foo_user")),
"user_name"
)
client
.mutateWith(mockOAuth2Login().oauth2User(oauth2User))
.get().uri("/endpoint").exchange()
測試 OAuth 2.0 客戶端
無論您的使用者如何進行身份驗證,您正在測試的請求可能還會涉及其他令牌和客戶端註冊。例如,您的控制器可能依賴客戶端憑據授予來獲取一個與使用者完全無關的令牌
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@RegisteredOAuth2AuthorizedClient("my-app") OAuth2AuthorizedClient authorizedClient) {
return this.webClient.get()
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve()
.bodyToMono(String.class);
}
import org.springframework.web.reactive.function.client.bodyToMono
// ...
@GetMapping("/endpoint")
fun foo(@RegisteredOAuth2AuthorizedClient("my-app") authorizedClient: OAuth2AuthorizedClient?): Mono<String> {
return this.webClient.get()
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve()
.bodyToMono()
}
模擬與授權伺服器的這種握手可能很麻煩。相反,您可以使用 SecurityMockServerConfigurers#oauth2Client 將 OAuth2AuthorizedClient 新增到模擬的 ServerOAuth2AuthorizedClientRepository 中
-
Java
-
Kotlin
client
.mutateWith(mockOAuth2Client("my-app"))
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOAuth2Client("my-app"))
.get().uri("/endpoint").exchange()
這將建立一個 OAuth2AuthorizedClient,它包含一個簡單的 ClientRegistration、一個 OAuth2AccessToken 和一個資源所有者名稱。
具體來說,它包含一個 ClientRegistration,其客戶端 ID 為 test-client,客戶端金鑰為 test-secret
-
Java
-
Kotlin
assertThat(authorizedClient.getClientRegistration().getClientId()).isEqualTo("test-client");
assertThat(authorizedClient.getClientRegistration().getClientSecret()).isEqualTo("test-secret");
assertThat(authorizedClient.clientRegistration.clientId).isEqualTo("test-client")
assertThat(authorizedClient.clientRegistration.clientSecret).isEqualTo("test-secret")
它還包含一個資源所有者名稱 user
-
Java
-
Kotlin
assertThat(authorizedClient.getPrincipalName()).isEqualTo("user");
assertThat(authorizedClient.principalName).isEqualTo("user")
它還包含一個 OAuth2AccessToken,具有一個作用域 read
-
Java
-
Kotlin
assertThat(authorizedClient.getAccessToken().getScopes()).hasSize(1);
assertThat(authorizedClient.getAccessToken().getScopes()).containsExactly("read");
assertThat(authorizedClient.accessToken.scopes).hasSize(1)
assertThat(authorizedClient.accessToken.scopes).containsExactly("read")
然後,您可以在控制器方法中照常使用 @RegisteredOAuth2AuthorizedClient 檢索客戶端。
配置作用域
在許多情況下,OAuth 2.0 訪問令牌帶有一組作用域。考慮以下控制器如何檢查作用域的示例
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(@RegisteredOAuth2AuthorizedClient("my-app") OAuth2AuthorizedClient authorizedClient) {
Set<String> scopes = authorizedClient.getAccessToken().getScopes();
if (scopes.contains("message:read")) {
return this.webClient.get()
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve()
.bodyToMono(String.class);
}
// ...
}
import org.springframework.web.reactive.function.client.bodyToMono
// ...
@GetMapping("/endpoint")
fun foo(@RegisteredOAuth2AuthorizedClient("my-app") authorizedClient: OAuth2AuthorizedClient): Mono<String> {
val scopes = authorizedClient.accessToken.scopes
if (scopes.contains("message:read")) {
return webClient.get()
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve()
.bodyToMono()
}
// ...
}
給定一個檢查作用域的控制器,您可以使用 accessToken() 方法配置作用域
-
Java
-
Kotlin
client
.mutateWith(mockOAuth2Client("my-app")
.accessToken(new OAuth2AccessToken(BEARER, "token", null, null, Collections.singleton("message:read")))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOAuth2Client("my-app")
.accessToken(OAuth2AccessToken(BEARER, "token", null, null, setOf("message:read")))
)
.get().uri("/endpoint").exchange()
附加配置
您還可以使用其他方法進一步配置身份驗證,具體取決於您的控制器期望的資料
-
principalName(String);配置資源所有者名稱 -
clientRegistration(Consumer<ClientRegistration.Builder>):配置關聯的ClientRegistration -
clientRegistration(ClientRegistration):配置完整的ClientRegistration
如果您想使用真實的 ClientRegistration,最後一個方法很方便
例如,假設您想使用應用程式的某個 ClientRegistration 定義,如 application.yml 中指定的那樣。
在這種情況下,您的測試可以自動裝配 ReactiveClientRegistrationRepository 並查詢測試所需的那個
-
Java
-
Kotlin
@Autowired
ReactiveClientRegistrationRepository clientRegistrationRepository;
// ...
client
.mutateWith(mockOAuth2Client()
.clientRegistration(this.clientRegistrationRepository.findByRegistrationId("facebook").block())
)
.get().uri("/exchange").exchange();
@Autowired
lateinit var clientRegistrationRepository: ReactiveClientRegistrationRepository
// ...
client
.mutateWith(mockOAuth2Client()
.clientRegistration(this.clientRegistrationRepository.findByRegistrationId("facebook").block())
)
.get().uri("/exchange").exchange()
測試 JWT 身份驗證
要對資源伺服器進行授權請求,您需要一個不記名令牌。如果您的資源伺服器配置為使用 JWT,則不記名令牌需要根據 JWT 規範進行簽名和編碼。所有這些都可能非常艱鉅,尤其是在這不是您的測試重點時。
幸運的是,有許多簡單的方法可以克服這個困難,讓您的測試專注於授權而不是表示不記名令牌。我們將在接下來的兩個小節中介紹其中兩種方法。
mockJwt() WebTestClientConfigurer
第一種方法是使用 WebTestClientConfigurer。其中最簡單的方法是使用 SecurityMockServerConfigurers#mockJwt 方法,如下所示
-
Java
-
Kotlin
client
.mutateWith(mockJwt()).get().uri("/endpoint").exchange();
client
.mutateWith(mockJwt()).get().uri("/endpoint").exchange()
此示例建立一個模擬 Jwt 並將其透過任何身份驗證 API,以便您的授權機制可以對其進行驗證。
預設情況下,它建立的 JWT 具有以下特徵
{
"headers" : { "alg" : "none" },
"claims" : {
"sub" : "user",
"scope" : "read"
}
}
如果被測試,生成的 Jwt 將以以下方式透過
-
Java
-
Kotlin
assertThat(jwt.getTokenValue()).isEqualTo("token");
assertThat(jwt.getHeaders().get("alg")).isEqualTo("none");
assertThat(jwt.getSubject()).isEqualTo("sub");
assertThat(jwt.tokenValue).isEqualTo("token")
assertThat(jwt.headers["alg"]).isEqualTo("none")
assertThat(jwt.subject).isEqualTo("sub")
請注意,您可以配置這些值。
您還可以使用相應的各種方法配置任何標頭或宣告
-
Java
-
Kotlin
client
.mutateWith(mockJwt().jwt((jwt) -> jwt.header("kid", "one")
.claim("iss", "https://idp.example.org")))
.get().uri("/endpoint").exchange();
client
.mutateWith(mockJwt().jwt { jwt -> jwt.header("kid", "one")
.claim("iss", "https://idp.example.org")
})
.get().uri("/endpoint").exchange()
-
Java
-
Kotlin
client
.mutateWith(mockJwt().jwt((jwt) -> jwt.claims((claims) -> claims.remove("scope"))))
.get().uri("/endpoint").exchange();
client
.mutateWith(mockJwt().jwt { jwt ->
jwt.claims { claims -> claims.remove("scope") }
})
.get().uri("/endpoint").exchange()
這裡的 scope 和 scp 宣告的處理方式與普通不記名令牌請求中的處理方式相同。但是,可以透過簡單地提供測試所需的 GrantedAuthority 例項列表來覆蓋它
-
Java
-
Kotlin
client
.mutateWith(mockJwt().authorities(new SimpleGrantedAuthority("SCOPE_messages")))
.get().uri("/endpoint").exchange();
client
.mutateWith(mockJwt().authorities(SimpleGrantedAuthority("SCOPE_messages")))
.get().uri("/endpoint").exchange()
或者,如果您有一個自定義的 Jwt 到 Collection<GrantedAuthority> 轉換器,您也可以使用它來派生許可權
-
Java
-
Kotlin
client
.mutateWith(mockJwt().authorities(new MyConverter()))
.get().uri("/endpoint").exchange();
client
.mutateWith(mockJwt().authorities(MyConverter()))
.get().uri("/endpoint").exchange()
您還可以指定一個完整的 Jwt,為此,Jwt.Builder 非常方便
-
Java
-
Kotlin
Jwt jwt = Jwt.withTokenValue("token")
.header("alg", "none")
.claim("sub", "user")
.claim("scope", "read")
.build();
client
.mutateWith(mockJwt().jwt(jwt))
.get().uri("/endpoint").exchange();
val jwt: Jwt = Jwt.withTokenValue("token")
.header("alg", "none")
.claim("sub", "user")
.claim("scope", "read")
.build()
client
.mutateWith(mockJwt().jwt(jwt))
.get().uri("/endpoint").exchange()
authentication() 和 WebTestClientConfigurer
第二種方法是使用 authentication() Mutator。您可以例項化自己的 JwtAuthenticationToken 並在測試中提供它
-
Java
-
Kotlin
Jwt jwt = Jwt.withTokenValue("token")
.header("alg", "none")
.claim("sub", "user")
.build();
Collection<GrantedAuthority> authorities = AuthorityUtils.createAuthorityList("SCOPE_read");
JwtAuthenticationToken token = new JwtAuthenticationToken(jwt, authorities);
client
.mutateWith(mockAuthentication(token))
.get().uri("/endpoint").exchange();
val jwt = Jwt.withTokenValue("token")
.header("alg", "none")
.claim("sub", "user")
.build()
val authorities: Collection<GrantedAuthority> = AuthorityUtils.createAuthorityList("SCOPE_read")
val token = JwtAuthenticationToken(jwt, authorities)
client
.mutateWith(mockAuthentication<JwtMutator>(token))
.get().uri("/endpoint").exchange()
請注意,作為這些方法的替代,您還可以使用 @MockBean 註解模擬 ReactiveJwtDecoder bean 本身。
測試不透明令牌身份驗證
與JWT類似,不透明令牌需要授權伺服器來驗證其有效性,這會使測試更加困難。為了解決這個問題,Spring Security 為不透明令牌提供了測試支援。
假設您有一個控制器,它將身份驗證作為 BearerTokenAuthentication 檢索
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(BearerTokenAuthentication authentication) {
return Mono.just((String) authentication.getTokenAttributes().get("sub"));
}
@GetMapping("/endpoint")
fun foo(authentication: BearerTokenAuthentication): Mono<String?> {
return Mono.just(authentication.tokenAttributes["sub"] as String?)
}
在這種情況下,您可以透過使用 SecurityMockServerConfigurers#opaqueToken 方法來告訴 Spring Security 包含一個預設的 BearerTokenAuthentication
-
Java
-
Kotlin
client
.mutateWith(mockOpaqueToken())
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOpaqueToken())
.get().uri("/endpoint").exchange()
此示例使用一個 BearerTokenAuthentication 配置相關的 MockHttpServletRequest,該 BearerTokenAuthentication 包含一個簡單的 OAuth2AuthenticatedPrincipal、一個屬性 Map 和一個授予許可權的 Collection。
具體來說,它包含一個 Map,其鍵/值對為 sub/user
-
Java
-
Kotlin
assertThat((String) token.getTokenAttributes().get("sub")).isEqualTo("user");
assertThat(token.tokenAttributes["sub"] as String?).isEqualTo("user")
它還包含一個僅包含一個許可權 SCOPE_read 的許可權集合。
-
Java
-
Kotlin
assertThat(token.getAuthorities()).hasSize(1);
assertThat(token.getAuthorities()).containsExactly(new SimpleGrantedAuthority("SCOPE_read"));
assertThat(token.authorities).hasSize(1)
assertThat(token.authorities).containsExactly(SimpleGrantedAuthority("SCOPE_read"))
Spring Security 完成必要的工作,以確保 BearerTokenAuthentication 例項可用於您的控制器方法。
配置許可權
在許多情況下,您的方法受過濾器或方法安全性的保護,並且需要您的 Authentication 具有某些授予的許可權才能允許請求。
在這種情況下,您可以使用 authorities() 方法提供所需的授予許可權
-
Java
-
Kotlin
client
.mutateWith(mockOpaqueToken()
.authorities(new SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOpaqueToken()
.authorities(SimpleGrantedAuthority("SCOPE_message:read"))
)
.get().uri("/endpoint").exchange()
配置宣告
雖然授予的許可權在所有 Spring Security 中都很常見,但在 OAuth 2.0 的情況下,我們也有屬性。
例如,假設您有一個 user_id 屬性,指示使用者在您系統中的 ID。您可以在控制器中按如下方式訪問它
-
Java
-
Kotlin
@GetMapping("/endpoint")
public Mono<String> foo(BearerTokenAuthentication authentication) {
String userId = (String) authentication.getTokenAttributes().get("user_id");
// ...
}
@GetMapping("/endpoint")
fun foo(authentication: BearerTokenAuthentication): Mono<String?> {
val userId = authentication.tokenAttributes["user_id"] as String?
// ...
}
在這種情況下,您可以使用 attributes() 方法指定該屬性
-
Java
-
Kotlin
client
.mutateWith(mockOpaqueToken()
.attributes((attrs) -> attrs.put("user_id", "1234"))
)
.get().uri("/endpoint").exchange();
client
.mutateWith(mockOpaqueToken()
.attributes { attrs -> attrs["user_id"] = "1234" }
)
.get().uri("/endpoint").exchange()
附加配置
您還可以使用其他方法進一步配置身份驗證,具體取決於您的控制器期望的資料。
其中一種方法是 principal(OAuth2AuthenticatedPrincipal),您可以使用它來配置 BearerTokenAuthentication 底層的完整 OAuth2AuthenticatedPrincipal 例項。
如果您: * 有自己的 OAuth2AuthenticatedPrincipal 實現,或者 * 想指定不同的主體名稱,它很方便
例如,假設您的授權伺服器在 user_name 屬性而不是 sub 屬性中傳送主體名稱。在這種情況下,您可以手動配置 OAuth2AuthenticatedPrincipal
-
Java
-
Kotlin
Map<String, Object> attributes = Collections.singletonMap("user_name", "foo_user");
OAuth2AuthenticatedPrincipal principal = new DefaultOAuth2AuthenticatedPrincipal(
(String) attributes.get("user_name"),
attributes,
AuthorityUtils.createAuthorityList("SCOPE_message:read"));
client
.mutateWith(mockOpaqueToken().principal(principal))
.get().uri("/endpoint").exchange();
val attributes: Map<String, Any> = mapOf(Pair("user_name", "foo_user"))
val principal: OAuth2AuthenticatedPrincipal = DefaultOAuth2AuthenticatedPrincipal(
attributes["user_name"] as String?,
attributes,
AuthorityUtils.createAuthorityList("SCOPE_message:read")
)
client
.mutateWith(mockOpaqueToken().principal(principal))
.get().uri("/endpoint").exchange()
請注意,作為使用 mockOpaqueToken() 測試支援的替代方案,您還可以使用 @MockBean 註解模擬 OpaqueTokenIntrospector bean 本身。