164

コントローラのURLが適切に保護されているかどうかを単体テストする方法を見つけようとしていました。誰かが状況を変えて誤ってセキュリティ設定を削除した場合に備えて。

私のコントローラーメソッドは次のようになります。

@RequestMapping("/api/v1/resource/test") 
@Secured("ROLE_USER")
public @ResonseBody String test() {
    return "test";
}

私は次のようにWebTestEnvironmentを設定しました。

import javax.annotation.Resource;
import javax.naming.NamingException;
import javax.sql.DataSource;

import org.junit.Before;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.web.FilterChainProxy;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration({ 
        "file:src/main/webapp/WEB-INF/spring/security.xml",
        "file:src/main/webapp/WEB-INF/spring/applicationContext.xml",
        "file:src/main/webapp/WEB-INF/spring/servlet-context.xml" })
public class WebappTestEnvironment2 {

    @Resource
    private FilterChainProxy springSecurityFilterChain;

    @Autowired
    @Qualifier("databaseUserService")
    protected UserDetailsService userDetailsService;

    @Autowired
    private WebApplicationContext wac;

    @Autowired
    protected DataSource dataSource;

    protected MockMvc mockMvc;

    protected final Logger logger = LoggerFactory.getLogger(this.getClass());

    protected UsernamePasswordAuthenticationToken getPrincipal(String username) {

        UserDetails user = this.userDetailsService.loadUserByUsername(username);

        UsernamePasswordAuthenticationToken authentication = 
                new UsernamePasswordAuthenticationToken(
                        user, 
                        user.getPassword(), 
                        user.getAuthorities());

        return authentication;
    }

    @Before
    public void setupMockMvc() throws NamingException {

        // setup mock MVC
        this.mockMvc = MockMvcBuilders
                .webAppContextSetup(this.wac)
                .addFilters(this.springSecurityFilterChain)
                .build();
    }
}

私の実際のテストでは、次のようなことを試みました。

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.Test;
import org.springframework.mock.web.MockHttpSession;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.context.HttpSessionSecurityContextRepository;

import eu.ubicon.webapp.test.WebappTestEnvironment;

public class CopyOfClaimTest extends WebappTestEnvironment {

    @Test
    public void signedIn() throws Exception {

        UsernamePasswordAuthenticationToken principal = 
                this.getPrincipal("test1");

        SecurityContextHolder.getContext().setAuthentication(principal);        

        super.mockMvc
            .perform(
                    get("/api/v1/resource/test")
//                    .principal(principal)
                    .session(session))
            .andExpect(status().isOk());
    }

}

私はここでこれを拾いました:

しかし、よく見ると、これは実際のリクエストをURLに送信しない場合にのみ役立ちますが、機能レベルでサービスをテストする場合にのみ役立ちます。私の場合、「アクセス拒否」例外がスローされました。

org.springframework.security.access.AccessDeniedException: Access is denied
    at org.springframework.security.access.vote.AffirmativeBased.decide(AffirmativeBased.java:83) ~[spring-security-core-3.1.3.RELEASE.jar:3.1.3.RELEASE]
    at org.springframework.security.access.intercept.AbstractSecurityInterceptor.beforeInvocation(AbstractSecurityInterceptor.java:206) ~[spring-security-core-3.1.3.RELEASE.jar:3.1.3.RELEASE]
    at org.springframework.security.access.intercept.aopalliance.MethodSecurityInterceptor.invoke(MethodSecurityInterceptor.java:60) ~[spring-security-core-3.1.3.RELEASE.jar:3.1.3.RELEASE]
    at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172) ~[spring-aop-3.2.1.RELEASE.jar:3.2.1.RELEASE]
        ...

次の2つのログメッセージは、基本的に、設定がPrincipal機能しなかったこと、または設定が上書きされたことを示すユーザーが認証されなかったことを示していることに注意してください。

14:20:34.454 [main] DEBUG o.s.s.a.i.a.MethodSecurityInterceptor - Secure object: ReflectiveMethodInvocation: public java.util.List test.TestController.test(); target is of class [test.TestController]; Attributes: [ROLE_USER]
14:20:34.454 [main] DEBUG o.s.s.a.i.a.MethodSecurityInterceptor - Previously Authenticated: org.springframework.security.authentication.AnonymousAuthenticationToken@9055e4a6: Principal: anonymousUser; Credentials: [PROTECTED]; Authenticated: true; Details: org.springframework.security.web.authentication.WebAuthenticationDetails@957e: RemoteIpAddress: 127.0.0.1; SessionId: null; Granted Authorities: ROLE_ANONYMOUS
4

10 に答える 10

156

答えを探していると、簡単で柔軟な答えを見つけることができませんでしたが、Spring Security Referenceを見つけて、ほぼ完璧な解決策があることに気付きました。多くの場合、AOP ソリューションはテストに最適なソリューションであり、Spring はこのアーティファクトで@WithMockUser@WithUserDetailsおよびを提供します。@WithSecurityContext

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-test</artifactId>
    <version>4.2.2.RELEASE</version>
    <scope>test</scope>
</dependency>

ほとんどの場合、@WithUserDetails必要な柔軟性とパワーを集めます。

@WithUserDetails はどのように機能しますか?

UserDetailsService基本的に、テストしたいすべての可能なユーザー プロファイルでカスタムを作成する必要があります。例えば

@TestConfiguration
public class SpringSecurityWebAuxTestConfig {

    @Bean
    @Primary
    public UserDetailsService userDetailsService() {
        User basicUser = new UserImpl("Basic User", "user@company.com", "password");
        UserActive basicActiveUser = new UserActive(basicUser, Arrays.asList(
                new SimpleGrantedAuthority("ROLE_USER"),
                new SimpleGrantedAuthority("PERM_FOO_READ")
        ));

        User managerUser = new UserImpl("Manager User", "manager@company.com", "password");
        UserActive managerActiveUser = new UserActive(managerUser, Arrays.asList(
                new SimpleGrantedAuthority("ROLE_MANAGER"),
                new SimpleGrantedAuthority("PERM_FOO_READ"),
                new SimpleGrantedAuthority("PERM_FOO_WRITE"),
                new SimpleGrantedAuthority("PERM_FOO_MANAGE")
        ));

        return new InMemoryUserDetailsManager(Arrays.asList(
                basicActiveUser, managerActiveUser
        ));
    }
}

これでユーザーの準備が整ったので、このコントローラー関数へのアクセス制御をテストしたいとします。

@RestController
@RequestMapping("/foo")
public class FooController {

    @Secured("ROLE_MANAGER")
    @GetMapping("/salute")
    public String saluteYourManager(@AuthenticationPrincipal User activeUser)
    {
        return String.format("Hi %s. Foo salutes you!", activeUser.getUsername());
    }
}

ここでは、ルート/foo/saluteにマップされた関数があり、アノテーションを使用してロール ベースのセキュリティをテストしていますが、テストすることもできます。2 つのテストを作成してみましょう。1 つは有効なユーザーがこの敬礼の応答を見ることができるかどうかを確認するテストで、もう 1 つはそれが実際に禁止されているかどうかを確認するテストです。@Secured@PreAuthorize@PostAuthorize

@RunWith(SpringRunner.class)
@SpringBootTest(
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
        classes = SpringSecurityWebAuxTestConfig.class
)
@AutoConfigureMockMvc
public class WebApplicationSecurityTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    @WithUserDetails("manager@company.com")
    public void givenManagerUser_whenGetFooSalute_thenOk() throws Exception
    {
        mockMvc.perform(MockMvcRequestBuilders.get("/foo/salute")
                .accept(MediaType.ALL))
                .andExpect(status().isOk())
                .andExpect(content().string(containsString("manager@company.com")));
    }

    @Test
    @WithUserDetails("user@company.com")
    public void givenBasicUser_whenGetFooSalute_thenForbidden() throws Exception
    {
        mockMvc.perform(MockMvcRequestBuilders.get("/foo/salute")
                .accept(MediaType.ALL))
                .andExpect(status().isForbidden());
    }
}

SpringSecurityWebAuxTestConfigご覧のとおり、ユーザーにテストを提供するためにインポートしました。単純な注釈を使用するだけで、対応するテスト ケースでそれぞれが使用され、コードと複雑さが軽減されます。

ロールベースのセキュリティを簡素化するには、@WithMockUser を使用することをお勧めします

ご覧のとおり@WithUserDetails、ほとんどのアプリケーションに必要なすべての柔軟性があります。これにより、ロールや権限などの任意の GrantedAuthority を持つカスタム ユーザーを使用できます。ただし、役割だけを扱っている場合は、テストがさらに簡単になり、カスタムの構築を避けることができますUserDetailsServiceこのような場合、 @WithMockUserを使用して、ユーザー、パスワード、ロールの単純な組み合わせを指定します。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@WithSecurityContext(
    factory = WithMockUserSecurityContextFactory.class
)
public @interface WithMockUser {
    String value() default "user";

    String username() default "";

    String[] roles() default {"USER"};

    String password() default "password";
}

注釈は、非常に基本的なユーザーのデフォルト値を定義します。私たちの場合、テストしているルートは認証されたユーザーがマネージャーであることを必要とするだけなので、使用をやめてSpringSecurityWebAuxTestConfigこれを行うことができます。

@Test
@WithMockUser(roles = "MANAGER")
public void givenManagerUser_whenGetFooSalute_thenOk() throws Exception
{
    mockMvc.perform(MockMvcRequestBuilders.get("/foo/salute")
            .accept(MediaType.ALL))
            .andExpect(status().isOk())
            .andExpect(content().string(containsString("user")));
}

ユーザーmanager@company.comの代わりに、@WithMockUser次のユーザーによって提供されるデフォルトを取得していることに注意してください。しかし、私たちが本当に気にかけているのは彼の役割なので、それは問題ではありません: ROLE_MANAGER.

結論

@WithUserDetailsやのような注釈でわかるように、簡単なテストを行うためだけにアーキテクチャから切り離されたクラスを構築することなく、さまざまな認証済みユーザーのシナリオを切り替える@WithMockUserことができます。さらに柔軟性を高めるために、@WithSecurityContextがどのように機能するかを確認することもお勧めします。

于 2017-05-11T16:24:11.773 に答える
56

SecurityContextPersistenceFilterSpring Securityフィルターチェーンの一部である、は常に、SecurityContext呼び出しを設定しSecurityContextHolder.getContext().setAuthentication(principal)た(またはメソッドを使用して)私のをリセットすることが判明しました.principal(principal)。このフィルターは、前に設定SecurityContextしたものを上書きSecurityContextHolderするSecurityContextからのでを設定します。リポジトリはデフォルトです。は指定されたものを検査し、対応するにアクセスしようとします。存在する場合は、からの読み取りを試みます。これが失敗した場合、リポジトリは空を生成します。SecurityContextRepository HttpSessionSecurityContextRepositoryHttpSessionSecurityContextRepositoryHttpRequestHttpSessionSecurityContextHttpSessionSecurityContext

したがって、私の解決策は、 :HttpSessionを保持するリクエストと一緒にを渡すことです。SecurityContext

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.Test;
import org.springframework.mock.web.MockHttpSession;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.context.HttpSessionSecurityContextRepository;

import eu.ubicon.webapp.test.WebappTestEnvironment;

public class Test extends WebappTestEnvironment {

    public static class MockSecurityContext implements SecurityContext {

        private static final long serialVersionUID = -1386535243513362694L;

        private Authentication authentication;

        public MockSecurityContext(Authentication authentication) {
            this.authentication = authentication;
        }

        @Override
        public Authentication getAuthentication() {
            return this.authentication;
        }

        @Override
        public void setAuthentication(Authentication authentication) {
            this.authentication = authentication;
        }
    }

    @Test
    public void signedIn() throws Exception {

        UsernamePasswordAuthenticationToken principal = 
                this.getPrincipal("test1");

        MockHttpSession session = new MockHttpSession();
        session.setAttribute(
                HttpSessionSecurityContextRepository.SPRING_SECURITY_CONTEXT_KEY, 
                new MockSecurityContext(principal));


        super.mockMvc
            .perform(
                    get("/api/v1/resource/test")
                    .session(session))
            .andExpect(status().isOk());
    }
}
于 2013-03-04T14:11:35.410 に答える
32

pom.xml に追加します。

    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-test</artifactId>
        <version>4.0.0.RC2</version>
    </dependency>

org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors認可リクエストに使用します。https://github.com/rwinch/spring-security-test-blog ( https://jira.spring.io/browse/SEC-2592 )で使用例を参照してください。

アップデート:

4.0.0.RC2 は spring-security 3.x で機能します。spring-security 4 の場合、spring-security-test は spring-security の一部になります ( http://docs.spring.io/spring-security/site/docs/4.0.x/reference/htmlsingle/#test、バージョンは同じです) )。

セットアップが変更されました: http://docs.spring.io/spring-security/site/docs/4.0.x/reference/htmlsingle/#test-mockmvc

public void setup() {
    mvc = MockMvcBuilders
            .webAppContextSetup(context)
            .apply(springSecurity())  
            .build();
}

basic-authentication のサンプル: http://docs.spring.io/spring-security/site/docs/4.0.x/reference/htmlsingle/#testing-http-basic-authentication

于 2014-05-14T14:57:04.637 に答える
7

Base64 基本認証を使用して Spring MockMvc Security Config をテストする場合の例を次に示します。

String basicDigestHeaderValue = "Basic " + new String(Base64.encodeBase64(("<username>:<password>").getBytes()));
this.mockMvc.perform(get("</get/url>").header("Authorization", basicDigestHeaderValue).accept(MediaType.APPLICATION_JSON)).andExpect(status().isOk());

Maven の依存関係

    <dependency>
        <groupId>commons-codec</groupId>
        <artifactId>commons-codec</artifactId>
        <version>1.3</version>
    </dependency>
于 2014-02-25T02:09:37.303 に答える
4

簡潔な答え:

@Autowired
private WebApplicationContext webApplicationContext;

@Autowired
private Filter springSecurityFilterChain;

@Before
public void setUp() throws Exception {
    final MockHttpServletRequestBuilder defaultRequestBuilder = get("/dummy-path");
    this.mockMvc = MockMvcBuilders.webAppContextSetup(this.webApplicationContext)
            .defaultRequest(defaultRequestBuilder)
            .alwaysDo(result -> setSessionBackOnRequestBuilder(defaultRequestBuilder, result.getRequest()))
            .apply(springSecurity(springSecurityFilterChain))
            .build();
}

private MockHttpServletRequest setSessionBackOnRequestBuilder(final MockHttpServletRequestBuilder requestBuilder,
                                                             final MockHttpServletRequest request) {
    requestBuilder.session((MockHttpSession) request.getSession());
    return request;
}

春のセキュリティテストから実行した後、formLogin各リクエストはログインユーザーとして自動的に呼び出されます。

長い答え:

この解決策を確認してください (答えは spring 4 用です): How to login a user with spring 3.2 new mvc testing

于 2017-11-02T07:32:06.287 に答える
2

テストでSecurityContextHolderを使用しないようにするオプション:

  • オプション1:モックSecurityContextHolderを使用する-モックライブラリを使用するモックを意味する-たとえばEasyMock
  • オプション2:あるサービスでコードの呼び出しをラップSecurityContextHolder.get...します。たとえば、インターフェイスを実装SecurityServiceImplするメソッドを使用して、テストで、にアクセスせずに目的のプリンシパルを返すこのインターフェイスのモック実装を簡単に作成できます。getCurrentPrincipalSecurityServiceSecurityContextHolder
于 2013-03-04T17:38:25.650 に答える