@InitBinder与@RequestBody在Spring 3.2.4中转义XSS

时间:2014-08-20 11:36:13

标签: ajax spring spring-mvc spring-data

我的方法中有一个@RequestBody注释参数:

@RequestMapping(value = "/courses/{courseId}/{name}/comment", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public @ResponseBody CommentContainer addComment(@PathVariable Long courseId,
                          @ActiveAccount Account currentUser,
                          @Valid @RequestBody AddCommentForm form,
                          BindingResult formBinding,
                          HttpServletRequest request) throws RequestValidationException {

.....
}

然后我在同一个控制器中有一个@InitBinder带注释的方法:

@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    dataBinder.registerCustomEditor(AddCommentForm.class, new StringEscapeEditor());
}

我的StringEscapeEditor没有投放。但我的initBinder方法是。所以它没有将我的表单映射到转义编辑器。这似乎在阅读此帖子后(@RequestMapping不支持@InitBinder):

spring mvc @InitBinder is not called when processing ajax request

我测试了映射@PathVariable字符串然后我的编辑器正在工作。

这在我的应用程序中是一个大问题,因为我的大多数绑定都是用@RequestBody完成的,如果我可以对它应用一些自定义绑定,那将会很棒。

解决此问题的最常用方法是什么?并且为了脚本攻击而逃避我的输入数据。

1 个答案:

答案 0 :(得分:7)

为了逃避XSS,我建议在输出数据时完成转义,因为正确的转义取决于输出文档。

如果@ResponseBody生成的JSON响应由客户端直接使用,并且没有机会让XSS转义内容,则可以自定义JacksonMessageConverter以对字符串执行XSS转义。

可以像这样自定义JacksonMessageConverter:

1)首先,我们创建将创建自定义对象映射器的ObjectMapper工厂:

public class HtmlEscapingObjectMapperFactory implements FactoryBean<ObjectMapper> {

    private final ObjectMapper objectMapper;

    public HtmlEscapingObjectMapperFactory() {
        objectMapper = new ObjectMapper();
        objectMapper.getJsonFactory().setCharacterEscapes(new HTMLCharacterEscapes());
    }

    @Override
    public ObjectMapper getObject() throws Exception {
        return objectMapper;
    }

    @Override
    public Class<?> getObjectType() {
        return ObjectMapper.class;
    }

    @Override
    public boolean isSingleton() {
        return true;
    }

    public static class HTMLCharacterEscapes extends CharacterEscapes {

        private final int[] asciiEscapes;

        public HTMLCharacterEscapes() {
            // start with set of characters known to require escaping (double-quote, backslash etc)
            asciiEscapes = CharacterEscapes.standardAsciiEscapesForJSON();
            // and force escaping of a few others:
            asciiEscapes['<'] = CharacterEscapes.ESCAPE_CUSTOM;
            asciiEscapes['>'] = CharacterEscapes.ESCAPE_CUSTOM;
            asciiEscapes['&'] = CharacterEscapes.ESCAPE_CUSTOM;
            asciiEscapes['"'] = CharacterEscapes.ESCAPE_CUSTOM;
            asciiEscapes['\''] = CharacterEscapes.ESCAPE_CUSTOM;
        }


        @Override
        public int[] getEscapeCodesForAscii() {
            return asciiEscapes;
        }

        // and this for others; we don't need anything special here
        @Override
        public SerializableString getEscapeSequence(int ch) {
            return new SerializedString(StringEscapeUtils.escapeHtml4(Character.toString((char) ch)));

        }
    }
}

(HtmlCharacterEscapes的灵感来自这个问题:HTML escape with Spring MVC and Jackson Mapper

2)然后我们注册使用自定义对象映射器的消息转换器(xml配置中的示例):

<bean id="htmlEscapingObjectMapper" class="com.example.HtmlEscapingObjectMapperFactory" />

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" p:objectMapper-ref="htmlEscapingObjectMapper" />
    </mvc:message-converters>
</mvc:annotation-driven>

现在@ResponseBody创建的所有JSON消息都应该按照HTMLCharacterEscapes中的规定转义字符串。

问题的替代解决方案:

  • 在对象被反序列化后,XSS在控制器主体中转义所需的内容
  • 在输出内容
  • 之前,可能在客户端的javascript中进行XSS转义

除了执行输出转义之外,还可以使用一些输入验证(使用标准的Spring验证方法)来阻止您不希望输入系统/数据库的一些内容。

编辑:JavaConfig

我没有尝试过这个,但是在Java配置中它应该像这样工作(你不需要上面的Factory Bean,因为在这种情况下你可以在config中设置所有内容):

@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    super.configureMessageConverters(converters);
    converters.add(buildHtmlEscapingJsonConverter());

}

private MappingJacksonHttpMessageConverter buildHtmlEscapingJsonConverter() {
    MappingJacksonHttpMessageConverter htmlEscapingConverter = new MappingJacksonHttpMessageConverter();
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.getJsonFactory().setCharacterEscapes(new HTMLCharacterEscapes());
    htmlEscapingConverter.setObjectMapper(objectMapper);
    return htmlEscapingConverter;       
}

请注意,通常配置的任何其他非json默认消息转换器现在都将丢失(例如XML转换器等)。如果您需要它们,您需要手动添加它们(您可以看到什么是默认情况下在2.2节中有效:http://www.baeldung.com/spring-httpmessageconverter-rest