Spring Security 简明教程

Spring Security - Taglibs

在 JSP 中使用 Spring MVC 应用程序时，我们可以使用 Spring Security 标签来应用安全约束以及访问安全信息。Spring Security 标签库为这样的操作提供了基本支持。使用这样的标签，我们可以根据用户的角色或权限控制向用户显示的信息。此外，我们可以在我们的表单中包含 CSRF 保护功能。

为了使用 Spring 安全标签，我们必须在 JSP 文件中声明安全标记库。

<%@ taglib prefix="sec" uri="http://www.springframework.org/security/tags" %>

现在，我们可以使用 sec 前缀的 Spring Security 标记。现在让我们了解一下标记的用法。

The authorize Tag

我们将讨论的第一个标签是 authorize 标签。让我们看一下一些使用示例。

<sec:authorize access="!isAuthenticated()"> Login </sec:authorize>
<sec:authorize access="isAuthenticated()"> Logout </sec:authorize>
<sec:authorize access="hasRole('ADMIN')"> Hello Admin. </sec:authorize>

正如我们看到的那样，我们可以使用此标记根据访问权限或角色隐藏或显示信息部分。

hasRole(*ADMIN )* − 如果当前用户具有管理员角色，则求值为 true。
hasAnyRole(‘ADMIN’,’USER’) − 如果当前用户具有列出的任何角色，则评估为 true
isAnonymous() − 如果当前用户是匿名用户，则评估为 true
isRememberMe() − 如果当前用户是记住我用户，则评估为 true
isFullyAuthenticated() − 如果用户经过认证并且既不是匿名用户也不是记住我用户，则评估为 true

正如我们看到的那样，access 属性是指定 Web 安全表达式的属性。然后，Spring Security 将评估该表达式。求值通常委托给 SecurityExpressionHandler<FilterInvocation>，它在应用程序上下文中定义。如果它返回 true，那么用户可以访问该部分中给出的信息。

如果我们使用 Spring Security 的 Permission Evaluator 将 authorize 标签与 Spring Security 权限评估器一起使用，我们还可以检查用户权限，如下所示 −

<p sec:authorize="hasPermission(#domain,'read') or hasPermission(#domain,'write')">
   This content is visible to users who have read or write permission.
</p>

我们还可以允许或限制用户点击内容中的特定链接。

<a sec:authorize href="/admin">
   This content will only be visible to users who are authorized to send requests to the "/admin" URL.
</agt;

The authentication tag

当我们需要访问存储在 Spring Security 上下文中的当前身份验证对象时，我们可以使用 authentication 标记。然后，我们可以使用它来直接在我们的 JSP 页面中呈现对象的属性。例如，如果我们想要在页面中呈现 Authentication 对象的 principal 属性，我们可以按照如下所示进行操作 −

<p sec:authentication="name" />

The csrfInput Tag

当启用 CSRF 保护时，我们可以使用 csrfInput 标记插入带 CSRF 保护令牌正确值的隐藏表单字段。如果未启用 CSRF 保护，此标记不输出任何内容。

我们可以将此标记放置在 HTML <form></form> 块中，以及其他输入字段。但是，我们不能将此标记放置在 <form:form></form:form> 块中，因为 Spring Security 会自动在这些标记中插入 CSRF 表单字段，还会自动处理 Spring 表单。

<form method="post" action="/do/something">
   <sec:csrfInput />
   Username:<br />
   <input type="text" username="username" />
   ...
</form>

The csrfMetaTags Tag

我们可以使用此标记插入包含 CSRF 保护标记表单字段和标题名称及 CSRF 保护标记值的元标记。这些元标记可用于在应用程序的 Javascript 中使用 CSRF 保护。但是，此标记仅在我们已在应用程序中启用了 CSRF 保护时才起作用，否则此标记不输出任何内容。

<html>
   <head>
      <title>CSRF Protection in Javascript</title>
      <sec:csrfMetaTags />
      <script type="text/javascript" language="javascript">
         var csrfParam = $("meta[name='_csrf_param']").attr("content");
         var csrfToken = $("meta[name='_csrf']").attr("content");
      </script>
   </head>
   <body>
      ...
   </body>
</html>

让我们使用 Spring Security 开始实际编程。在开始使用 Spring 框架编写示例之前，您必须确保已正确设置 Spring 环境，如 Spring Security - Environment Setup 章节所述。我们还假设您具备 Spring Tool Suite IDE 方面的部分工作知识。

现在，让我们开始编写一个由 Maven 管理的基于 Spring MVC 的应用程序，该应用程序将要求用户登录、认证用户，然后提供使用 Spring Security 表单登录功能注销的选项。

Create Project using Spring Initializr

Spring Initializr 是开始 Spring Boot 项目的一个好方法。它提供了一个易于使用的用户界面来创建项目、添加依赖项、选择 Java 运行时等。它会生成一个框架项目结构，下载后可以在 Spring Tool Suite 中导入，然后我们可以使用现成的项目结构继续进行。

我们选择了一个 maven 项目，将项目命名为 formlogin，并将 java 版本指定为 21。添加了以下依赖项：

Spring Web
Spring Security
Thymeleaf
Spring Boot DevTools

Thymeleaf 是 Java 的模板引擎。它使我们能够快速开发用于在浏览器中渲染的静态或动态网页。它已得到极大的扩展，它允许我们定义和定制精细处理的模板。除此之外，我们可以通过点击 link 来了解更多有关 Thymeleaf 的信息。

让我们开始生成并下载项目。然后我们将它解压到我们选择的文件夹中并使用任何 IDE 来打开它。我将使用 Spring Tools Suite 4 。它可以从 https://spring.io/tools 网站免费下载，且已针对 spring 应用进行优化。

pom.xml with all relevant dependencies

让我们看一看我们的 pom.xml 文件。它应该与以下内容类似 −

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>3.3.1</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.tutorialspoint.security</groupId>
   <artifactId>formlogin</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>formlogin</name>
   <description>Demo project for Spring Boot</description>
   <url/>
   <licenses>
      <license/>
   </licenses>
   <developers>
      <developer/>
   </developers>
   <scm>
      <connection/>
      <developerConnection/>
      <tag/>
      <url/>
   </scm>
   <properties>
      <java.version>21</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-security</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-thymeleaf</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
         <groupId>org.thymeleaf.extras</groupId>
         <artifactId>thymeleaf-extras-springsecurity6</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-devtools</artifactId>
         <scope>runtime</scope>
         <optional>true</optional>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework.security</groupId>
         <artifactId>spring-security-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

Spring Security Configuration Class

在我们的 config 包中，我们创建了 WebSecurityConfig 类。我们将使用此类来进行我们的安全配置，因此让我们用 @Configuration 注解和 @EnableWebSecurity 为它添加注释。因此，Spring Security 知道将此类视为配置类。正如我们所看到的，Spring 让我们能很轻松地配置应用。

WebSecurityConfig

package com.tutorialspoint.security.formlogin.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;
import org.springframework.security.web.SecurityFilterChain;

@Configuration
@EnableWebSecurity
public class WebSecurityConfig  {

   @Bean
   protected UserDetailsService userDetailsService() {
      UserDetails user = User.builder()
         .username("user")
         .password(passwordEncoder().encode("user123"))
         .roles("USER")
         .build();
      UserDetails admin = User.builder()
         .username("admin")
         .password(passwordEncoder().encode("admin123"))
         .roles("USER", "ADMIN")
         .build();
      return new InMemoryUserDetailsManager(user, admin);
   }

   @Bean
   protected PasswordEncoder passwordEncoder() {
      return new BCryptPasswordEncoder();
   }

   @Bean
   protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
      return http
         .csrf(AbstractHttpConfigurer::disable)
         .authorizeHttpRequests(
            request -> request.requestMatchers("/login").permitAll()
            .requestMatchers("/**").authenticated()
         )
         .formLogin(form -> form.loginPage("/login")
            .defaultSuccessUrl("/")
            .failureUrl("/login?error=true")
            .permitAll())
         .logout(config -> config
         .logoutUrl("/logout")
         .logoutSuccessUrl("/login"))
         .build();
   }
}

Controller Class

在此类中，我们分别为这个应用程序的索引页、登录页和管理员页创建了 "/" 端点、"/login" 和 "/admin" 的映射。

AuthController.java

package com.tutorialspoint.security.formlogin.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class AuthController {
   @GetMapping("/")
   public String home() {
      return "index";
   }
   @GetMapping("/login")
   public String login() {
      return "login";
   }
   @GetMapping("/admin")
   public String admin() {
      return "admin";
   }
}

Views

使用以下内容在 /src/main/resources/templates 文件夹中创建 index.html 以作为主页。

index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
   xmlns:th="https://www.thymeleaf.org"
   xmlns:sec="https://www.thymeleaf.org/thymeleaf-extras-springsecurity3">
   <head>
      <title>
         Hello World!
      </title>
   </head>
   <body>
      <h1 th:inline="text">Hello World!</h1>
      <form th:action="@{/logout}" method="post">
         <input type="submit" value="Sign Out"/>
      </form>
   </body>
<html>

让我们在 /src/main/resources/templates 文件夹中创建 login.html，并使其内容如下，以用作登录页面。我们对文本字段使用默认名称 username 、 password 和 remember-me 。对于其他名称，我们需要在 Spring 安全性配置类中设置相同的名称。

login.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
   xmlns:th="https://www.thymeleaf.org"
   xmlns:sec="https://www.thymeleaf.org/thymeleaf-extras-springsecurity3">
   <head>
      <title>Spring Security Example</title>
   </head>
   <body>
      <div th:if="${param.error}">
         <p>Bad Credentials</p>
      </div>
      <div th:if="${param.logout}">You have been logged out.</div>
      <form th:action="@{/login}" method="post">
         <h1>Please sign in</h1>
         <table>
            <tr>
               <td><label for="username"><b>Username</b></label></td>
               <td><input type="text" placeholder="Enter Username" name="username" id="username" required></td>
            </tr>
            <tr>
               <td><label for="password"><b>Password</b></label></td>
               <td><input type="password" placeholder="Enter Password" name="password" id="password" required></td>
            </tr>
            <tr>
               <td><label for="remember-me"><b>Remember Me</b></label> </td>
               <td><input type="checkbox" name="remember-me" /></td>
            </tr>
            <tr>
               <td> </td>
               <td><input type="submit"  value="Sign In" /></td>
            </tr>
         </table>
      </form>
   </body>
</html>

我们创建 admin.html 来使用授权标记。在这里，我们添加了 <%@ taglib uri="http://www.springframework.org/security/tags" prefix="sec"%>。正如之前讨论的那样，这将让我们了解 Spring 安全标记库。

admin.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:th="https://www.thymeleaf.org"
xmlns:sec="https://www.thymeleaf.org/thymeleaf-extras-springsecurity6">
   <head>
      <title>
         Hello Admin!
      </title>
   </head>
   <body>
      <p>Admin Console</p>
      <h1 th:inline="text">Welcome <span sec:authentication="name"></span>!</h1>
      <p sec:authorize="hasRole('ADMIN')"> Control Panel </p>
      <a href="/logout" alt="logout">Sign Out</a>
   </body>
<html>

正如我们看到的那样，我们在内容周围添加了 authorize 标记。该内容仅供管理员访问。访问此页面的任何其他用户将无法查看此内容。另一个标记 authentication 用于获取委托，以便检索已登录用户的用户名。

Running the Application

一旦我们准备好了所有组件，接下来运行应用程序。右击项目，选择 Run As 然后选择 Spring Boot App 。

它将启动该应用，并且一旦应用启动，我们就可以运行 localhost:8080 来查看更改。

Output

现在打开 localhost:8080，您将看到我们的登录页面。

Login Page with Admin Details entered

Admin Page

当我们输入有效的管理员证书后，它将加载主页。现在打开 localhost:8080/admin。您可以看到管理员用户的 Control Panel 文本 visible 。

Login Page with User Details entered

现在单击退出链接从应用程序注销，并使用用户证书登录。

Admin Page for User

当我们输入有效的用户证书后，它将加载主页。现在加载 localhost:8080/admin 以打开管理员页面。您可以看到 Control Panel 文本对普通用户来说是 not visible 。