rest 验证demo_如何实现REST资源的输入验证

rest 验证demo

如何实现REST资源的输入验证

我正在使用的SaaS平台具有一个RESTful接口，该接口可以接受XML有效负载。

实施REST资源

对于像我们这样的Java商店，使用JAX-B从XML Schema生成JavaBean类是有意义的。在像Jersey的JAX-RS环境中，使用JAX-B处理XML（和JSON）有效负载非常容易。

@Path("orders")
public class OrdersResource {@POST@Consumes({ "application/xml", "application/json" })public void place(Order order) {// Jersey marshalls the XML payload into the Order // JavaBean, allowing us to write type-safe code // using Order's getters and setters.int quantity = order.getQuantity();// ...}
}

（请注意，您不应使用这些通用媒体类型，但这是另一天的讨论。）

本文的其余部分假定使用JAX-B，但其要点也适用于其他技术。无论您做什么，都不要使用XMLDecoder ，因为这对许多漏洞都是开放的。

保护REST资源

假设订单的quantity用于结算，并且我们想防止人们输入负数来偷钱。

我们可以通过输入验证（ AppSec工具箱中最重要的工具之一）来做到这一点。让我们看一下实现它的一些方法。

使用XML模式进行输入验证

XML模式我们可以依靠XML Schema进行验证，但是XML Schema只能验证那么多。

验证单个属性可能会很好，但是当我们要验证属性之间的关系时，事情变得很麻烦。为了获得最大的灵活性，我们希望使用Java来表达约束。

更重要的是， 在REST服务中 ， 模式验证通常不是一个好主意 。

REST的主要目标是使客户端和服务器脱钩，以便它们可以分别发展。

如果我们根据模式进行验证，则发送新属性的新客户端将与无法理解该新属性的旧服务器发生冲突。通常最好静默忽略您不了解的属性。

JAX-B做到了这一点，反之亦然：旧客户端未发送的属性最终为null 。因此，新服务器必须小心以正确处理null值。

使用Bean验证的输入验证

豆验证如果我们不能使用模式验证，那么使用JSR 303 Bean验证又如何呢？

Jersey通过将jersey-bean-validation jar添加到您的类路径来支持Bean验证。

有一个非官方的Maven插件可以将Bean验证注释添加到JAX-B生成的类中，但是我宁愿使用更好的支持，并且可以与Gradle一起使用。

因此，让我们扭转局势。我们将手工制作JavaBean并从Bean生成XML模式以进行文档编制：

@XmlRootElement(name = "order")
public class Order {@XmlElement@Min(1)public int quantity;
}

@Path("orders")
public class OrdersResource {@POST@Consumes({ "application/xml", "application/json" })public void place(@Valid Order order) {// Jersey recognizes the @Valid annotation and// returns 400 when the JavaBean is not valid}
}

任何企图POST与非阳性数量的订单，现在将给予400 Bad Request状态。

现在假设我们要允许客户更改其挂单。我们将使用PATCH或PUT更新单个订单属性，例如数量：

@Path("orders")
public class OrdersResource {@Path("{id}")@PUT@Consumes("application/x-www-form-urlencoded")public Order update(@PathParam("id") String id, @Min(1) @FormParam("quantity") int quantity) {// ...}
}

我们也需要在此处添加@Min注释，这是重复的。为了使这个DRY ，我们可以将quantity变成负责验证的类：

@Path("orders")
public class OrdersResource {@Path("{id}")@PUT@Consumes("application/x-www-form-urlencoded")public Order update(@PathParam("id") String id, @FormParam("quantity")Quantity quantity) {// ...}
}

@XmlRootElement(name = "order")
public class Order {@XmlElementpublic Quantity quantity;
}

public class Quantity {private int value;public Quantity() { }public Quantity(String value) {try {setValue(Integer.parseInt(value));} catch (ValidationException e) {throw new IllegalArgumentException(e);}}public int getValue() {return value;}@XmlValuepublic void setValue(int value) throws ValidationException {if (value < 1) {throw new ValidationException("Quantity value must be positive, but is: " + value);}this.value = value;}
}

我们需要JAX-B的公共no-arg构造函数，以能够将有效载荷解组到JavaBean中，而另一个构造函数则使用String来使@FormParam起作用。

setValue()抛出javax.xml.bind.ValidationException以便JAX-B将停止解组。但是，Jersey看到异常时会返回500 Internal Server Error 。

我们可以通过使用异常映射器将验证异常映射到400状态代码来解决此问题。在此过程中，让我们对IllegalArgumentException做同样的事情：

@Provider
public class DefaultExceptionMapper implements ExceptionMapper<Throwable> {@Overridepublic Response toResponse(Throwable exception) {Throwable badRequestException = getBadRequestException(exception);if (badRequestException != null) {return Response.status(Status.BAD_REQUEST).entity(badRequestException.getMessage()).build();}if (exception instanceof WebApplicationException) {return ((WebApplicationException)exception).getResponse();}return Response.serverError().entity(exception.getMessage()).build();}private Throwable getBadRequestException(Throwable exception) {if (exception instanceof ValidationException) {return exception;}Throwable cause = exception.getCause();if (cause != null && cause != exception) {Throwable result = getBadRequestException(cause);if (result != null) {return result;}}if (exception instanceof IllegalArgumentException) {return exception;}if (exception instanceof BadRequestException) {return exception;}return null;}}