Skip to content

Java: Make XssSink extensible. #4042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeql-ci merged 1 commit into from
Aug 31, 2020
Merged

Java: Make XssSink extensible. #4042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions java/ql/src/Security/CWE/CWE-079/XSS.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@

import java
import semmle.code.java.dataflow.FlowSources
import semmle.code.java.dataflow.TaintTracking2
import semmle.code.java.security.XSS
import DataFlow2::PathGraph
import DataFlow::PathGraph

class XSSConfig extends TaintTracking2::Configuration {
class XSSConfig extends TaintTracking::Configuration {
XSSConfig() { this = "XSSConfig" }

override predicate isSource(DataFlow::Node source) { source instanceof RemoteFlowSource }
Expand All @@ -28,7 +27,7 @@ class XSSConfig extends TaintTracking2::Configuration {
}
}

from DataFlow2::PathNode source, DataFlow2::PathNode sink, XSSConfig conf
from DataFlow::PathNode source, DataFlow::PathNode sink, XSSConfig conf
where conf.hasFlowPath(source, sink)
select sink.getNode(), source, sink, "Cross-site scripting vulnerability due to $@.",
source.getNode(), "user-provided value"
7 changes: 3 additions & 4 deletions java/ql/src/Security/CWE/CWE-079/XSSLocal.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@

import java
import semmle.code.java.dataflow.FlowSources
import semmle.code.java.dataflow.TaintTracking2
import semmle.code.java.security.XSS
import DataFlow2::PathGraph
import DataFlow::PathGraph

class XSSLocalConfig extends TaintTracking2::Configuration {
class XSSLocalConfig extends TaintTracking::Configuration {
XSSLocalConfig() { this = "XSSLocalConfig" }

override predicate isSource(DataFlow::Node source) { source instanceof LocalUserInput }

override predicate isSink(DataFlow::Node sink) { sink instanceof XssSink }
}

from DataFlow2::PathNode source, DataFlow2::PathNode sink, XSSLocalConfig conf
from DataFlow::PathNode source, DataFlow::PathNode sink, XSSLocalConfig conf
where conf.hasFlowPath(source, sink)
select sink.getNode(), source, sink, "Cross-site scripting vulnerability due to $@.",
source.getNode(), "user-provided value"
6 changes: 3 additions & 3 deletions java/ql/src/Security/CWE/CWE-209/StackTraceExposure.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import java
import semmle.code.java.dataflow.DataFlow
import semmle.code.java.dataflow.TaintTracking2
import semmle.code.java.dataflow.TaintTracking
import semmle.code.java.security.XSS

/**
Expand Down Expand Up @@ -84,7 +84,7 @@ predicate stackTraceExpr(Expr exception, MethodAccess stackTraceString) {
)
}

class StackTraceStringToXssSinkFlowConfig extends TaintTracking2::Configuration {
class StackTraceStringToXssSinkFlowConfig extends TaintTracking::Configuration {
StackTraceStringToXssSinkFlowConfig() {
this = "StackTraceExposure::StackTraceStringToXssSinkFlowConfig"
}
Expand Down Expand Up @@ -124,7 +124,7 @@ class GetMessageFlowSource extends MethodAccess {
}
}

class GetMessageFlowSourceToXssSinkFlowConfig extends TaintTracking2::Configuration {
class GetMessageFlowSourceToXssSinkFlowConfig extends TaintTracking::Configuration {
GetMessageFlowSourceToXssSinkFlowConfig() {
this = "StackTraceExposure::GetMessageFlowSourceToXssSinkFlowConfig"
}
Expand Down
23 changes: 13 additions & 10 deletions java/ql/src/semmle/code/java/security/XSS.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,36 @@ import semmle.code.java.frameworks.Servlets
import semmle.code.java.frameworks.android.WebView
import semmle.code.java.frameworks.spring.SpringController
import semmle.code.java.frameworks.spring.SpringHttp
import semmle.code.java.dataflow.TaintTracking
import semmle.code.java.dataflow.DataFlow
import semmle.code.java.dataflow.TaintTracking2

/*
* Definitions for XSS sinks
*/

class XssSink extends DataFlow::ExprNode {
XssSink() {
abstract class XssSink extends DataFlow::Node { }

private class DefaultXssSink extends XssSink {
DefaultXssSink() {
exists(HttpServletResponseSendErrorMethod m, MethodAccess ma |
ma.getMethod() = m and
this.getExpr() = ma.getArgument(1)
this.asExpr() = ma.getArgument(1)
)
or
exists(ServletWriterSourceToWritingMethodFlowConfig writer, MethodAccess ma |
ma.getMethod() instanceof WritingMethod and
writer.hasFlowToExpr(ma.getQualifier()) and
this.getExpr() = ma.getArgument(_)
this.asExpr() = ma.getArgument(_)
)
or
exists(Method m |
m.getDeclaringType() instanceof TypeWebView and
(
m.getAReference().getArgument(0) = this.getExpr() and m.getName() = "loadData"
m.getAReference().getArgument(0) = this.asExpr() and m.getName() = "loadData"
or
m.getAReference().getArgument(0) = this.getExpr() and m.getName() = "loadUrl"
m.getAReference().getArgument(0) = this.asExpr() and m.getName() = "loadUrl"
or
m.getAReference().getArgument(1) = this.getExpr() and m.getName() = "loadDataWithBaseURL"
m.getAReference().getArgument(1) = this.asExpr() and m.getName() = "loadDataWithBaseURL"
)
)
or
Expand Down Expand Up @@ -77,7 +80,7 @@ class XssSink extends DataFlow::ExprNode {
}
}

class ServletWriterSourceToWritingMethodFlowConfig extends TaintTracking::Configuration {
private class ServletWriterSourceToWritingMethodFlowConfig extends TaintTracking2::Configuration {
Copy link
Copy Markdown
Contributor

@aibaars aibaars Aug 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for using TaintTracking2 versus TaintTracking ?

Copy link
Copy Markdown
Contributor Author

@aschackmull aschackmull Aug 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The result of this configuration is used in the definition of XssSink. So this config must come from a different library copy than any config that uses XssSink (otherwise we'd have negative recursion through the dataflow library). In this PR I simply switch use of the two copies around, such that the queries can use the default copy.

ServletWriterSourceToWritingMethodFlowConfig() {
this = "XSS::ServletWriterSourceToWritingMethodFlowConfig"
}
Expand All @@ -91,7 +94,7 @@ class ServletWriterSourceToWritingMethodFlowConfig extends TaintTracking::Config
}
}

class WritingMethod extends Method {
private class WritingMethod extends Method {
WritingMethod() {
getDeclaringType().getASupertype*().hasQualifiedName("java.io", _) and
(
Expand Down