Add flow tests for JAX-RS

This commit is contained in:
Owen Mansel-Chan
2021-05-17 16:20:53 +01:00
parent 155d63d5f7
commit f2ff2aa3e1
3 changed files with 351 additions and 0 deletions

View File

@@ -0,0 +1,301 @@
import java.lang.reflect.Method;
import java.net.URI;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.ws.rs.core.CacheControl;
import javax.ws.rs.core.Cookie;
import javax.ws.rs.core.EntityTag;
import javax.ws.rs.core.Form;
import javax.ws.rs.core.GenericEntity;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Link;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.core.Variant;
public class JaxRsFlow {
String taint() { return "tainted"; }
private static class ResponseSource {
static Response taint() { return null; }
}
private static class ResponseBuilderSource {
static Response.ResponseBuilder taint() { return Response.noContent(); }
}
private static class IntSource {
static int taint() { return 0; }
}
private static class SetStringSource {
static Set<String> taint() { return new HashSet<String>(); }
}
static HttpHeaders taint(HttpHeaders h) { return h; }
static PathSegment taint(PathSegment ps) { return ps; }
static UriInfo taint(UriInfo ui) { return ui; }
static Map taint(Map m) { return m; }
static Link taint(Link l) { return l; }
static Class taint(Class c) { return c; }
private static class UriSource {
static URI taint() throws Exception { return new URI(""); }
}
void sink(Object o) {}
void testResponse() {
sink(Response.accepted(taint())); // $hasTaintFlow
sink(Response.fromResponse(ResponseSource.taint())); // $hasTaintFlow
sink(Response.ok(taint())); // $hasTaintFlow
sink(Response.ok(taint(), new MediaType())); // $hasTaintFlow
sink(Response.ok(taint(), "type")); // $hasTaintFlow
sink(Response.ok(taint(), new Variant(new MediaType(), "", ""))); // $hasTaintFlow
}
void testResponseBuilder(MultivaluedMap<String,Object> multivaluedMap, List<Variant> list) throws Exception {
sink(ResponseBuilderSource.taint().build()); // $hasTaintFlow
sink(Response.noContent().entity(taint())); // $hasTaintFlow
sink(ResponseBuilderSource.taint().allow(new HashSet<String>())); // $hasValueFlow
sink(ResponseBuilderSource.taint().cacheControl(new CacheControl())); // $hasValueFlow
sink(ResponseBuilderSource.taint().clone()); // $hasTaintFlow
sink(ResponseBuilderSource.taint().contentLocation(new URI(""))); // $hasValueFlow
sink(ResponseBuilderSource.taint().cookie()); // $hasValueFlow
sink(ResponseBuilderSource.taint().encoding("")); // $hasValueFlow
sink(ResponseBuilderSource.taint().entity("")); // $hasValueFlow
sink(ResponseBuilderSource.taint().expires(new Date())); // $hasValueFlow
sink(ResponseBuilderSource.taint().header("", "")); // $hasValueFlow
sink(ResponseBuilderSource.taint().language("")); // $hasValueFlow
sink(ResponseBuilderSource.taint().lastModified(new Date())); // $hasValueFlow
sink(ResponseBuilderSource.taint().link("", "")); // $hasValueFlow
sink(ResponseBuilderSource.taint().link(new URI(""), "")); // $hasValueFlow
sink(ResponseBuilderSource.taint().links()); // $hasValueFlow
sink(ResponseBuilderSource.taint().location(new URI(""))); // $hasValueFlow
sink(ResponseBuilderSource.taint().replaceAll(multivaluedMap)); // $hasValueFlow
sink(ResponseBuilderSource.taint().status(400)); // $hasValueFlow
sink(ResponseBuilderSource.taint().tag(new EntityTag(""))); // $hasValueFlow
sink(ResponseBuilderSource.taint().tag("")); // $hasValueFlow
sink(ResponseBuilderSource.taint().type("")); // $hasValueFlow
sink(ResponseBuilderSource.taint().variant(new Variant(new MediaType(), "", ""))); // $hasValueFlow
sink(ResponseBuilderSource.taint().variants(list)); // $hasValueFlow
sink(ResponseBuilderSource.taint().variants()); // $hasValueFlow
}
void testHttpHeaders(HttpHeaders h) {
sink(taint(h).getAcceptableLanguages()); // $hasTaintFlow
sink(taint(h).getAcceptableMediaTypes()); // $hasTaintFlow
sink(taint(h).getCookies()); // $hasTaintFlow
sink(taint(h).getHeaderString("")); // $hasTaintFlow
sink(taint(h).getLanguage()); // $hasTaintFlow
sink(taint(h).getMediaType()); // $hasTaintFlow
sink(taint(h).getRequestHeader("")); // $hasTaintFlow
sink(taint(h).getRequestHeaders()); // $hasTaintFlow
}
void testMultivaluedMapAdd(MultivaluedMap<String, String> mm1, MultivaluedMap<String, String> mm2) {
mm1.add(taint(), "value");
sink(mm1.keySet().iterator().next()); // $hasValueFlow
mm2.add("key", taint());
sink(mm2.get("key").get(0)); // $hasValueFlow
}
void testMultivaluedMapAddAll(MultivaluedMap<String, String> mm1, MultivaluedMap<String, String> mm2, MultivaluedMap<String, String> mm3) {
mm1.addAll(taint(), "a", "b");
sink(mm1.keySet().iterator().next()); // $hasValueFlow
List<String> l = new ArrayList<String>();
l.add(taint());
mm2.addAll("key", l);
sink(mm2.get("key").get(0)); // $hasValueFlow
mm3.addAll("key", "a", taint());
sink(mm3.get("key").get(0)); // $hasValueFlow
}
void testMultivaluedMapAddFirst(MultivaluedMap<String, String> mm1, MultivaluedMap<String, String> mm2) {
mm1.addFirst(taint(), "value");
sink(mm1.keySet().iterator().next()); // $hasValueFlow
mm2.addFirst("key", taint());
sink(mm2.get("key").get(0)); // $hasValueFlow
sink(mm2.getFirst("key")); // $hasValueFlow
}
void testMultivaluedMapputSingle(MultivaluedMap<String, String> mm1, MultivaluedMap<String, String> mm2) {
mm1.putSingle(taint(), "value");
sink(mm1.keySet().iterator().next()); // $hasValueFlow
mm2.putSingle("key", taint());
sink(mm2.get("key").get(0)); // $hasValueFlow
}
void testPathSegment(PathSegment ps1, PathSegment ps2) {
sink(taint(ps1).getMatrixParameters()); // $hasTaintFlow
sink(taint(ps2).getPath()); // $hasTaintFlow
}
void testUriInfo(UriInfo ui1, UriInfo ui2, UriInfo ui3, UriInfo ui4, UriInfo ui5) {
sink(taint(ui1).getPathParameters()); // $hasTaintFlow
sink(taint(ui2).getPathSegments()); // $hasTaintFlow
sink(taint(ui2).getQueryParameters()); // $hasTaintFlow
sink(taint(ui2).getRequestUri()); // $hasTaintFlow
sink(taint(ui2).getRequestUriBuilder()); // $hasTaintFlow
}
void testCookie() {
sink(new Cookie(taint(), "", "", "", 0)); // $hasTaintFlow
sink(new Cookie("", taint(), "", "", 0)); // $hasTaintFlow
sink(new Cookie("", "", taint(), "", 0)); // $hasTaintFlow
sink(new Cookie("", "", "", taint(), 0)); // $hasTaintFlow
sink(new Cookie("", "", "", "", IntSource.taint())); // $hasTaintFlow
sink(new Cookie(taint(), "", "", "")); // $hasTaintFlow
sink(new Cookie("", taint(), "", "")); // $hasTaintFlow
sink(new Cookie("", "", taint(), "")); // $hasTaintFlow
sink(new Cookie("", "", "", taint())); // $hasTaintFlow
sink(new Cookie(taint(), "")); // $hasTaintFlow
sink(new Cookie("", taint())); // $hasTaintFlow
sink(Cookie.valueOf(taint())); // $hasTaintFlow
sink(Cookie.valueOf(taint()).getDomain()); // $hasTaintFlow
sink(Cookie.valueOf(taint()).getName()); // $hasTaintFlow
sink(Cookie.valueOf(taint()).getPath()); // $hasTaintFlow
sink(Cookie.valueOf(taint()).getValue()); // $hasTaintFlow
sink(Cookie.valueOf(taint()).getVersion()); // $hasTaintFlow
sink(Cookie.valueOf(taint()).toString()); // $hasTaintFlow
}
void testForm(MultivaluedMap<String, String> mm1, MultivaluedMap<String, String> mm2) {
sink(new Form(taint(), "")); // $hasTaintFlow
sink(new Form("", taint())); // $hasTaintFlow
mm1.add(taint(), "value");
sink(new Form(mm1)); // $hasTaintFlow
mm2.add("key", taint());
sink(new Form(mm2)); // $hasTaintFlow
Form f1 = new Form(taint(), "");
sink(f1.asMap()); // $hasTaintFlow
Form f2 = new Form();
sink(f2.param(taint(), "b")); // $hasTaintFlow
Form f3 = new Form();
sink(f3.param("a", taint())); // $hasTaintFlow
Form f4 = new Form(taint(), "");
sink(f4.param("a", "b")); // $hasTaintFlow
}
void testGenericEntity() {
Method m = Dummy.class.getMethods()[0];
GenericEntity<Set<String>> ge = new GenericEntity<Set<String>>(SetStringSource.taint(), m.getGenericReturnType());
sink(ge); // $hasTaintFlow
sink(ge.getEntity()); // $hasTaintFlow
}
void testMediaType(Map<String, String> m) {
sink(new MediaType(taint(), "")); // $hasTaintFlow
sink(new MediaType("", taint())); // $hasTaintFlow
sink(new MediaType(taint(), "", m)); // $hasTaintFlow
sink(new MediaType("", taint(), m)); // $hasTaintFlow
sink(new MediaType("", "", taint(m))); // $hasTaintFlow
sink(new MediaType(taint(), "", "")); // $hasTaintFlow
sink(new MediaType("", taint(), "")); // $hasTaintFlow
sink(new MediaType("", "", taint())); // $hasTaintFlow
sink(MediaType.valueOf(taint()).getParameters()); // $hasTaintFlow
sink(MediaType.valueOf(taint()).getSubtype()); // $hasTaintFlow
sink(MediaType.valueOf(taint()).getType()); // $hasTaintFlow
sink(MediaType.valueOf(taint())); // $hasTaintFlow
}
void testUriBuilder() throws Exception {
sink(UriBuilder.fromPath("").build(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath("").build("", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath("").build(taint(), false)); // $hasTaintFlow
sink(UriBuilder.fromPath("").build("", taint(), true)); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).build("")); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).build("", false)); // $hasTaintFlow
sink(UriBuilder.fromPath("").buildFromEncoded(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath("").buildFromEncoded("", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).buildFromEncoded("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").buildFromEncodedMap(taint(new HashMap<String, String>()))); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).buildFromEncodedMap(new HashMap<String, String>())); // $hasTaintFlow
sink(UriBuilder.fromPath("").buildFromMap(taint(new HashMap<String, String>()), false)); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).buildFromMap(new HashMap<String, String>(), true)); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).clone()); // $hasTaintFlow
sink(UriBuilder.fromPath("").fragment(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).fragment("")); // $hasTaintFlow
sink(UriBuilder.fromLink(taint(Link.valueOf("")))); // $hasTaintFlow
sink(UriBuilder.fromPath(taint())); // $hasTaintFlow
sink(UriBuilder.fromUri(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath("").host(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).host("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").matrixParam(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").matrixParam("", "", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).matrixParam("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").path(taint(Dummy.class))); // $hasTaintFlow
sink(UriBuilder.fromPath("").path(Dummy.class, taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).path(Dummy.class)); // $hasTaintFlow
sink(UriBuilder.fromPath("").queryParam(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").queryParam("", "", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).queryParam("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceMatrix(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).replaceMatrix("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceMatrixParam(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceMatrixParam("", "", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).replaceMatrixParam("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replacePath(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).replacePath("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceQuery(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).replaceQuery("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceQueryParam(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").replaceQueryParam("", "", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).replaceQueryParam("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplate(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplate(taint(), "", false)); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplate("", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplate("", taint(), true)); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplate("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplate("", "", false)); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplateFromEncoded(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplateFromEncoded("", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplateFromEncoded("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplates(taint(new HashMap<String, Object>()))); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplates(taint(new HashMap<String, Object>()), true)); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplates(new HashMap<String, Object>())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplates(new HashMap<String, Object>(), false)); // $hasTaintFlow
sink(UriBuilder.fromPath("").resolveTemplatesFromEncoded(taint(new HashMap<String, Object>()))); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).resolveTemplatesFromEncoded(new HashMap<String, Object>())); // $hasTaintFlow
sink(UriBuilder.fromPath("").scheme(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).scheme("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").schemeSpecificPart(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).schemeSpecificPart("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").segment(taint(), "")); // $hasTaintFlow
sink(UriBuilder.fromPath("").segment("", "", taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).segment("", "")); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).toTemplate()); // $hasTaintFlow
sink(UriBuilder.fromPath("").uri(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).uri("")); // $hasTaintFlow
sink(UriBuilder.fromPath("").uri(UriSource.taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).uri(new URI(""))); // $hasTaintFlow
sink(UriBuilder.fromPath("").userInfo(taint())); // $hasTaintFlow
sink(UriBuilder.fromPath(taint()).userInfo("")); // $hasTaintFlow
}
}
class Dummy {
private static Set<String> foo() { return null; }
}

View File

@@ -0,0 +1,50 @@
import java
import semmle.code.java.dataflow.TaintTracking
import TestUtilities.InlineExpectationsTest
class TaintFlowConf extends TaintTracking::Configuration {
TaintFlowConf() { this = "qltest:frameworks:jax-rs-taint" }
override predicate isSource(DataFlow::Node n) {
n.asExpr().(MethodAccess).getMethod().hasName("taint")
}
override predicate isSink(DataFlow::Node n) {
exists(MethodAccess ma | ma.getMethod().hasName("sink") | n.asExpr() = ma.getAnArgument())
}
}
class ValueFlowConf extends DataFlow::Configuration {
ValueFlowConf() { this = "qltest:frameworks:jax-rs-value" }
override predicate isSource(DataFlow::Node n) {
n.asExpr().(MethodAccess).getMethod().hasName("taint")
}
override predicate isSink(DataFlow::Node n) {
exists(MethodAccess ma | ma.getMethod().hasName("sink") | n.asExpr() = ma.getAnArgument())
}
}
class HasFlowTest extends InlineExpectationsTest {
HasFlowTest() { this = "HasFlowTest" }
override string getARelevantTag() { result = ["hasTaintFlow", "hasValueFlow"] }
override predicate hasActualResult(Location location, string element, string tag, string value) {
tag = "hasTaintFlow" and
exists(DataFlow::Node src, DataFlow::Node sink, TaintFlowConf conf | conf.hasFlow(src, sink) |
not any(ValueFlowConf vconf).hasFlow(src, sink) and
sink.getLocation() = location and
element = sink.toString() and
value = ""
)
or
tag = "hasValueFlow" and
exists(DataFlow::Node src, DataFlow::Node sink, ValueFlowConf conf | conf.hasFlow(src, sink) |
sink.getLocation() = location and
element = sink.toString() and
value = ""
)
}
}