Fix SwitchUserGrantedAuthority deserialization error (#7408)

#### What type of PR is this?

/kind bug
/area core
/milestone 2.20.x

#### What this PR does / why we need it:

This PR adds SwitchUserGrantedAuthorityMixin into HaloSecurityJackson2Module to fix the deserialization error.

See https://github.com/halo-dev/halo/issues/7406 for more.

#### Which issue(s) this PR fixes:

Fixes https://github.com/halo-dev/halo/issues/7406

#### Does this PR introduce a user-facing change?

```release-note
修复个人中心处可能出现登录设备查询异常的问题
```
pull/7413/head
John Niang 2025-05-06 17:21:37 +08:00 committed by GitHub
parent 5a6f1ef641
commit caf172786c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 76 additions and 0 deletions

View File

@ -3,6 +3,7 @@ package run.halo.app.security.jackson2;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.security.jackson2.SecurityJackson2Modules;
import org.springframework.security.web.authentication.switchuser.SwitchUserGrantedAuthority;
import run.halo.app.security.authentication.login.HaloUser;
import run.halo.app.security.authentication.oauth2.HaloOAuth2AuthenticationToken;
import run.halo.app.security.authentication.twofactor.TwoFactorAuthentication;
@ -28,6 +29,9 @@ public class HaloSecurityJackson2Module extends SimpleModule {
context.setMixInAnnotations(
HaloOAuth2AuthenticationToken.class, HaloOAuth2AuthenticationTokenMixin.class
);
context.setMixInAnnotations(
SwitchUserGrantedAuthority.class, SwitchUserGrantedAuthorityMixIn.class
);
}
}

View File

@ -0,0 +1,53 @@
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package run.halo.app.security.jackson2;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.switchuser.SwitchUserGrantedAuthority;
import org.springframework.security.web.jackson2.WebServletJackson2Module;
/**
* Jackson mixin class to serialize/deserialize {@link SwitchUserGrantedAuthority}.
* <b>This class is copied from repository spring-projects/spring-security.</b>
*
* @author Markus Heiden
* @see WebServletJackson2Module
* @see org.springframework.security.jackson2.SecurityJackson2Modules
* @since 6.3
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
@JsonAutoDetect(
fieldVisibility = JsonAutoDetect.Visibility.ANY,
getterVisibility = JsonAutoDetect.Visibility.NONE,
isGetterVisibility = JsonAutoDetect.Visibility.NONE
)
@JsonIgnoreProperties(ignoreUnknown = true)
abstract class SwitchUserGrantedAuthorityMixIn {
@JsonCreator
SwitchUserGrantedAuthorityMixIn(
@JsonProperty("role") String role,
@JsonProperty("source") Authentication source
) {
}
}

View File

@ -4,6 +4,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
@ -18,6 +19,7 @@ import org.springframework.security.core.userdetails.User;
import org.springframework.security.jackson2.SecurityJackson2Modules;
import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken;
import org.springframework.security.oauth2.core.user.DefaultOAuth2User;
import org.springframework.security.web.authentication.switchuser.SwitchUserGrantedAuthority;
import run.halo.app.security.authentication.login.HaloUser;
import run.halo.app.security.authentication.oauth2.HaloOAuth2AuthenticationToken;
import run.halo.app.security.authentication.twofactor.TwoFactorAuthentication;
@ -61,6 +63,23 @@ class HaloSecurityJacksonModuleTest {
});
}
@Test
void shouldReadSwitchUserGrantedAuthority() throws JsonProcessingException {
codecAssert(haloUser -> {
var authentication = UsernamePasswordAuthenticationToken.authenticated(
haloUser.getUsername(), haloUser.getPassword(), haloUser.getAuthorities()
);
var switchUserGrantedAuthority =
new SwitchUserGrantedAuthority("ADMIN", authentication);
var extendedAuthorities = new ArrayList<>(authentication.getAuthorities());
extendedAuthorities.add(switchUserGrantedAuthority);
authentication = UsernamePasswordAuthenticationToken.authenticated(
authentication.getPrincipal(), authentication.getCredentials(), extendedAuthorities
);
return authentication;
});
}
void codecAssert(Function<HaloUser, Authentication> authenticationConverter)
throws JsonProcessingException {
var userDetails = User.withUsername("faker")