Spring Boot Security配置教程

1.简介

在本文中，我们将了解Spring Boot对spring Security的支持。

简而言之，我们将专注于默认Security配置以及如何在需要时禁用或自定义它。

2.默认Security设置

为了增加Spring Boot应用程序的安全性，我们需要添加安全启动器依赖项：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

这将包括SecurityAutoConfiguration类 - 包含初始/默认安全配置。

注意我们在这里没有指定版本，假设项目已经使用Boot作为父项。

简而言之，默认情况下，为应用程序启用身份验证。此外，内容协商用于确定是否应使用basic或formLogin。

有一些预定义的属性，例如：

spring.security.user.name
spring.security.user.password

如果我们不使用预定义属性spring.security.user.password配置密码并启动应用程序，我们会注意到随机生成默认密码并在控制台日志中打印：

Using default security password: c8be15de-4488-4490-9dc6-fab3f91435c6

3.禁用自动配置

要放弃安全性自动配置并添加我们自己的配置，我们需要排除SecurityAutoConfiguration类。

这可以通过简单的排除来完成：

@SpringBootApplication(exclude = { SecurityAutoConfiguration.class })
public class SpringBootSecurityApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootSecurityApplication.class, args);
    }
}

或者通过在application.properties文件中添加一些配置：

spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration

还有一些特殊情况，这种设置还不够。

例如，几乎每个Spring Boot应用程序都在类路径中使用Actuator启动。

这会导致问题，因为另一个自动配置类需要我们刚刚排除的那个，因此应用程序将无法启动。

为了解决这个问题，我们需要排除该类;并且，特定于Actuator情况，我们需要排除ManagementWebSecurityAutoConfiguration。

3.1. 禁用和超越 Security Auto-Configuration

禁用自动配置和超越它之间存在显着差异。

通过禁用它，就像从头开始添加Spring Security依赖项和整个设置一样。这在以下几种情况下很有用：

• 将应用程序security与自定义security提供程序集成
• 将已有security设置的旧Spring应用程序迁移到Spring Boot

但是，大多数情况下我们不需要完全禁用安全自动配置。

Spring Boot的配置方式允许通过添加我们的新/自定义配置类来超越自动配置的安全性。这通常更容易，因为我们只是定制现有的安全设置以满足我们的需求。

4.配置Spring Boot Security

如果我们选择了禁用Security自动配置的路径，我们自然需要提供自己的配置。

正如我们之前讨论过的，这是默认的安全配置;我们可以通过修改属性文件来自定义它。

例如，我们可以通过添加我们自己的密码来覆盖默认密码：

security.user.password=password

如果我们想要一个更灵活的配置，例如多个用户和角色 - 您现在需要使用完整的@Configuration类：

@Configuration
@EnableWebSecurity
public class BasicConfiguration extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(AuthenticationManagerBuilder auth)
      throws Exception {
        auth
          .inMemoryAuthentication()
          .withUser("user")
            .password("password")
            .roles("USER")
            .and()
          .withUser("admin")
            .password("admin")
            .roles("USER", "ADMIN");
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
          .authorizeRequests()
          .anyRequest()
          .authenticated()
          .and()
          .httpBasic();
    }
}

如果我们禁用默认安全配置，则@EnableWebSecurity注释至关重要。

如果丢失，应用程序将无法启动。只有在我们使用WebSecurityConfigurerAdapter覆盖默认行为时，注释才是可选的。

现在，我们应该通过几个快速实时测试验证我们的安全配置是否正确应用：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = RANDOM_PORT)
public class BasicConfigurationIntegrationTest {

    TestRestTemplate restTemplate;
    URL base;
    @LocalServerPort int port;

    @Before
    public void setUp() throws MalformedURLException {
        restTemplate = new TestRestTemplate("user", "password");
        base = new URL("http://localhost:" + port);
    }

    @Test
    public void whenLoggedUserRequestsHomePage_ThenSuccess()
     throws IllegalStateException, IOException {
        ResponseEntity<String> response
          = restTemplate.getForEntity(base.toString(), String.class);

        assertEquals(HttpStatus.OK, response.getStatusCode());
        assertTrue(response
          .getBody()
          .contains("Baeldung"));
    }

    @Test
    public void whenUserWithWrongCredentials_thenUnauthorizedPage()
      throws Exception {

        restTemplate = new TestRestTemplate("user", "wrongpassword");
        ResponseEntity<String> response
          = restTemplate.getForEntity(base.toString(), String.class);

        assertEquals(HttpStatus.UNAUTHORIZED, response.getStatusCode());
        assertTrue(response
          .getBody()
          .contains("Unauthorized"));
    }
}

实际上，Spring Boot Security的背后是Spring Security，所以任何可以用这个完成的安全配置，或者这个支持的任何集成都可以实现到Spring Boot中。

5. Spring Boot OAuth2自动配置

Spring Boot为OAuth2提供专用的自动配置支持。

在我们开始之前，让我们添加Maven依赖项来开始设置我们的应用程序：

<dependency>
   <groupId>org.springframework.security.oauth</groupId>
   <artifactId>spring-security-oauth2</artifactId>
</dependency>

此依赖项包括一组能够触发OAuth2AutoConfiguration类中定义的自动配置机制的类。

现在，我们有多种选择可以继续，具体取决于我们的应用范围。

5.1。 OAuth2授权服务器自动配置

如果我们希望我们的应用程序是OAuth2提供程序，我们可以使用@EnableAuthorizationServer。

在启动时，我们会在日志中注意到自动配置类将为我们的授权服务器生成客户端ID和客户端密钥，当然还有用于基本身份验证的随机密码。

Using default security password: a81cb256-f243-40c0-a585-81ce1b952a98
security.oauth2.client.client-id = 39d2835b-1f87-4a77-9798-e2975f36972e
security.oauth2.client.client-secret = f1463f8b-0791-46fe-9269-521b86c55b71

这些凭据可用于获取访问令牌：

curl -X POST -u 39d2835b-1f87-4a77-9798-e2975f36972e:f1463f8b-0791-46fe-9269-521b86c55b71 \
 -d grant_type=client_credentials -d username=user -d password=a81cb256-f243-40c0-a585-81ce1b952a98 \
 -d scope=write  http://localhost:8080/oauth/token

5.2。其他Spring Boot OAuth2自动配置设置

Spring Boot OAuth2涵盖了一些其他用例，例如：

• 资源服务器 - @EnableResourceServer
• 客户端应用程序 - @ EnableOAuth2Sso或@ EnableOAuth2Client

如果我们需要将我们的应用程序作为上述类型之一，我们只需要为应用程序属性添加一些配置。

6. Spring Boot 2 security与Spring Boot 1 security

与Spring Boot 1相比，Spring Boot 2大大简化了自动配置。

在Spring Boot 2中，如果我们想要自己的安全配置，我们可以简单地添加一个自定义的WebSecurityConfigurerAdapter。这将禁用默认自动配置并启用我们的自定义安全配置。

Spring Boot 2使用Spring Security的大部分默认值。因此，默认情况下，Spring Boot 1中默认不安全的某些端点现在是安全的。

这些端点包括静态资源，如/ css / **，/ js / ，/ images / ，/ webjars / ，//favicon.ico和错误端点。如果我们需要允许对这些端点进行未经身份验证的访问，我们可以明确地配置它。

为了简化与安全相关的配置，Spring Boot 2删除了以下Spring Boot 1属性：

security.basic.authorize-mode
security.basic.enabled
security.basic.path
security.basic.realm
security.enable-csrf
security.headers.cache
security.headers.content-security-policy
security.headers.content-security-policy-mode
security.headers.content-type
security.headers.frame
security.headers.hsts
security.headers.xss
security.ignored
security.require-ssl
security.sessions

7.结论

在本文中，我们重点介绍Spring Boot提供的默认安全配置。我们了解了如何禁用或覆盖安全性自动配置机制以及如何应用新的安全性配置。

源代码可以在Github上找到。