DataFlow::PathGraph Module not Found in codeql

[nam0netime]

DataFlow::PathGraph Module, not Found

When using codeql workspace and trying to use the following code to debug sink source

from MyTaintTrackingConfig cfg, ConstraintValidatorisValidMethod im, DataFlow::PartialPathNode source, DataFlow::PartialPathNode sink
where
cfg.hasPartialFlow(source, sink, _) and
source.getNode().asParameter() = im.getParameter(0)
select sink, source, sink, "Partial flow from unsanitized user data"

I receive error that DataFlow::PathGraph Module, not Found

[nam0netime]

Also DataFlow::PartialPathNode also show error

[owen-mc]

I think you need to add the line import DataFlow::PathGraph.

[nam0netime]

For some reason my configuration of codeql does not have PartialPathNode in it code import path so it keep getting error

[owen-mc]

Try removing the import DataFlow::PathGraph on line 4. I don't think you should have that if you have import DataFlow::PartialPathGraph. (In case you don't know, hovering your mouse over the things with red squiggly lines underneath should give you an error message, which is sometimes helpful in figuring out what's wrong.)

[nam0netime]

I try delete the "import DataFlow::PathGraph" and when hovering my mouse over the error the error still could not resolve module DataFlow::PartialPathGraph

[owen-mc]

Oh, I think I know what's going on. The DataFlow library has recently been re-written to use parameterized modules, and while a compatibility layer has been created for normal flow there isn't one for partial flow. There are two options:

1. Base your work on a slightly older commit, say 3538cf89b9, which is the commit before the refactor was merged. Then partial flow should work as you expect.
2. Convert your configuration to use the new API for DataFlow. It's pretty straightforward in most cases. I think all the java configurations have been converted now, in PRs like these: 1, 2, 3. Then partial flow should work - the only problem being that I don't think there is documentation for how to use it yet. I put a minimal working example in point 5 of this message that should be enough to get it working.

[nam0netime]

thank you i try the new way and it worked but now I am wondering about AdditionalTaintStep for example how can it be integrated with the new syntax since there like no document about this

[owen-mc]

That is great that you have got it working.

We are working on documentation, but until it is available you can find out how to do most things by searching to see what the existing Java configurations do. For additional taint steps, the most common way to do this is to implement isAdditionalTaintStep in your module, like this. If you search you will find many other examples of this being used. If you are used to instead extending the class AdditionalTaintStep from semmle.code.java.dataflow.FlowSteps then that should work too. Here is an example of it being used.