【项目实战】Spring Boot项目抵御XSS攻击

本专栏将为大家总结项目实战相关的知识！ 点击即可关注本专栏，获取更多知识！

---

前言

作为Web网站来说，抵御XSS攻击是必须要做的事情，这是非常常见的黑客攻击手段之一。

一、什么是XSS攻击

XSS意思是跨站脚本攻击，英文全称Cross Site Scripting，为了不和层叠样式表(Cascading Style Sheets, CSS)的缩写混淆，故将跨站脚本攻击缩写为XSS。

XSS攻击的手段很简单，就是通过各种手段向我们的Web网站植入JS代码。比如说普通网站的用户注册、论坛网站的发帖和回帖，以及电商网站的商品评价等等，黑客在文本框中填写的文字信息里面包含一段JS代码，那么前端页面在显示这个信息的时候，就会执行这些JS代码了。

如下我是我在CSDN评论区评论的消息，如果CSDN没有做XSS防御的话，将来某个用户翻到这个评论的话，这时候<script>标签就会被当做JS脚本来执行了，用户浏览器就会弹出HelloWorld这样的文字。

这只是比较简单的脚本语句，如果黑客植入的JS脚本先读取浏览器的Cookie信息，然后把Cookie通过Ajax发送给黑客的服务器，那么远端的黑客就能用你的Cookie来模拟登陆，这后果是非常严重的。

二、如何抵御XSS攻击

防御XSS攻击的办法很简单，那就是对所有用户的数据先做转义处理，然后再保存到数据库里面。转义之后的信息，将来被加载到网页上面就丧失了作为脚本执行的能力。

比如说上面文本框里面的脚本，经过转义之后就变成了<script>alert("HelloWorld")</script>这个样子。就拿<script>来说吧，它会被渲染成<script>字符串，而不是当做脚本标签来执行。

如果我们能修改请求类的内容，那么我们只需要修改获取请求数据的函数，使得返回的数据并不是客户端Form表单或者Ajax提交的数据，而是经过转义之后数据。

但是在Web项目中，我们无法修改HttpServletRequest实现类的内容，因为请求的实现类是由各个Web容器厂商自己扩展的。但是有时候我们还想修改请求类中的内容，这该怎么办呢？

不用担心，Java语言给我们留出了缺口，我们只要继承Java Web内置的HttpServletRequestWrapper父类，就能修改请求类的内容。

接下来，我们正式开始在Spring Boot项目中实现抵御XSS攻击！

三、实现抵御XSS攻击

首先我们要创建一个执行转义的封装类XssHttpServletRequestWrapper，这个类继承HttpServletRequestWrapper父类。在这个类中我们需要把获取请求头和请求体数据的方法都要重写，返回的是经过XSS转义后的数据。

这里我们使用HtmlUtil.cleanHtmlTag()清除所有HTML标签，但是保留标签内的内容，达到转义的效果。

/**
 * HttpServletRequest的包装类，用于防止XSS攻击
 */
public class XssHttpServletRequestWrapper extends HttpServletRequestWrapper {
    public XssHttpServletRequestWrapper(HttpServletRequest request) {
        super(request);
    }


    /**
     * 重写getParameter方法，对参数值进行HTML标签清理
     */
    @Override
    public String getParameter(String name) {
        String value= super.getParameter(name);
        if(!StrUtil.hasEmpty(value)){
            value=HtmlUtil.cleanHtmlTag(value);
        }
        return value;
    }

    /**
     * 重写getParameterValues方法，对参数值数组进行HTML标签清理
     */
    @Override
    public String[] getParameterValues(String name) {
        String[] values= super.getParameterValues(name);
        if(values!=null){
            for (int i=0;i<values.length;i++){
                String value=values[i];
                if(!StrUtil.hasEmpty(value)){
                    value=HtmlUtil.cleanHtmlTag(value);
                }
                values[i]=value;
            }
        }
        return values;
    }

    /**
     * 重写getParameterMap方法，对参数值映射进行HTML标签清理
     */
    @Override
    public Map<String, String[]> getParameterMap() {
        Map<String, String[]> parameters = super.getParameterMap();
        LinkedHashMap<String, String[]> map=new LinkedHashMap();
        if(parameters!=null){
            for (String key:parameters.keySet()){
                String[] values=parameters.get(key);
                for (int i = 0; i < values.length; i++) {
                    String value = values[i];
                    if (!StrUtil.hasEmpty(value)) {
                        value = HtmlUtil.cleanHtmlTag(value);
                    }
                    values[i] = value;
                }
                map.put(key,values);
            }
        }
        return map;
    }

    /**
     * 重写getHeader方法，对请求头进行HTML标签清理
     */
    @Override
    public String getHeader(String name) {
        String value= super.getHeader(name);
        if (!StrUtil.hasEmpty(value)) {
            value = HtmlUtil.cleanHtmlTag(value);
        }
        return value;
    }

    /**
     * 重写getInputStream方法，对请求体进行HTML标签清理
     */
    @Override
    public ServletInputStream getInputStream() throws IOException {
        InputStream in= super.getInputStream();
        InputStreamReader reader=new InputStreamReader(in, Charset.forName("UTF-8"));
        BufferedReader buffer=new BufferedReader(reader);
        StringBuffer body=new StringBuffer();
        String line=buffer.readLine();
        while(line!=null){
            body.append(line);
            line=buffer.readLine();
        }
        buffer.close();
        reader.close();
        in.close();
        Map<String,Object> map=JSONUtil.parseObj(body.toString());
        Map<String,Object> result=new LinkedHashMap<>();
        for(String key:map.keySet()){
            Object val=map.get(key);
            if(val instanceof String){
                if(!StrUtil.hasEmpty(val.toString())){
                    result.put(key,HtmlUtil.cleanHtmlTag(val.toString()));
                }
            }
            else {
                result.put(key,val);
            }
        }
        String json=JSONUtil.toJsonStr(result);
        ByteArrayInputStream bain=new ByteArrayInputStream(json.getBytes());
        return new ServletInputStream() {
            @Override
            public int read() throws IOException {
                return bain.read();
            }

            @Override
            public boolean isFinished() {
                return false;
            }

            @Override
            public boolean isReady() {
                return false;
            }

            @Override
            public void setReadListener(ReadListener readListener) {

            }
        };
    }
}

接下来我们要创建一个Filter类XssFilter，它是一个XSS过滤器，使用@WebFilter注解将其应用到所有请求上。它拦截所有的HTTP请求，并将请求对象传递给XssHttpServletRequestWrapper类进行XSS过滤，然后将处理后的请求对象传递给下一个过滤器或Servlet进行处理。

/**
 * XSS过滤器，用于拦截所有请求并进行XSS过滤
 */
@WebFilter(urlPatterns = "/*")
public class XssFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化方法，留空
    }

    /**
     * 过滤方法，对请求进行XSS过滤
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        XssHttpServletRequestWrapper wrapper = new XssHttpServletRequestWrapper(request);
        filterChain.doFilter(wrapper, servletResponse);
    }

    @Override
    public void destroy() {
        // 销毁方法，留空
    }
}

在以上代码中我们使用了Hutool工具库中的一些方法，如果你对它感兴趣，可以去网站https://xiaojianzheng.cn/docs/hutool进行学习！

结语

更多项目实战知识可以关注本专栏，持续更新中…

🏳️‍🌈点击即可关注本专栏，学习更多知识！