hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-01-29 22:32:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update qhelp files

Browse Source
This commit is contained in:
Owen Mansel-Chan
2020-11-25 11:28:06 +00:00
parent e7697963d3
commit dec7967c7a
5 changed files with 119 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
ql/src/Security/CWE-020/ExternalAPISinkExample.go
View File

@@ -1,8 +1,20 @@
public class XSS extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
// BAD: a request parameter is written directly to an error response page
response.sendError(HttpServletResponse.SC_NOT_FOUND,
"The page \"" + request.getParameter("page") + "\" was not found.");
}
package main
import (
"fmt"
"net/http"
)
func serve() {
http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
r.ParseForm()
username := r.Form.Get("username")
if !isValidUsername(username) {
// BAD: a request parameter is incorporated without validation into the response
fmt.Fprintf(w, "%q is an unknown user", username)
} else {
// TODO: do something exciting
}
})
http.ListenAndServe(":80", nil)
}

19
ql/src/Security/CWE-020/ExternalAPITaintStepExample.go
View File

@@ -1,12 +1,13 @@
public class SQLInjection extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
package main
StringBuilder sqlQueryBuilder = new StringBuilder();
sqlQueryBuilder.append("SELECT * FROM user WHERE user_id='");
sqlQueryBuilder.append(request.getParameter("user_id"));
sqlQueryBuilder.append("'");
import (
"database/sql"
"fmt"
"net/http"
)
// ...
}
func handler(db *sql.DB, req *http.Request) {
q := fmt.Sprintf("SELECT ITEM,PRICE FROM PRODUCT WHERE ITEM_CATEGORY='%s' ORDER BY PRICE",
req.URL.Query()["category"])
db.Query(q)
}

21
ql/src/Security/CWE-020/ExternalAPIsUsedWithUntrustedData.qhelp
View File

@@ -8,12 +8,12 @@ all external APIs that are used with untrusted data, along with how frequently t
unique sources of untrusted data flow to this API. This query is designed primarily to help identify which APIs
may be relevant for security analysis of this application.</p>
<p>An external API is defined as a method call to a method that is not defined in the source code, not overridden
in the source code, and is not modeled as a taint step in the default taint library. External APIs may be from the
Go standard library, third party dependencies or from internal dependencies. The query will report the method
signature with a fully qualified name, along with either <code>[param x]</code>, where <code>x</code> indicates the
position of the parameter receiving the untrusted data or <code>[receiver]</code> indicating the untrusted data is
used as the receiver of the method call.</p>
<p>An external API is defined as a call to a function that is not defined in the source code and is not
modeled as a taint step in the default taint library. Calls made in test files are also excluded.
External APIs may be from the Go standard library, third party dependencies or from internal dependencies.
The query will report the fully qualified method name, along with either <code>[param x]</code>,
where <code>x</code> indicates the position of the parameter receiving the untrusted data or <code>[receiver]</code>
indicating the untrusted data is used as the receiver of the method call.</p>
</overview>
<recommendation>
@@ -33,12 +33,13 @@ class to exclude known safe external APIs from future analysis.</p>
</recommendation>
<example>
<p>If the query were to return the API <code>javax.servlet.http.HttpServletResponse.sendError(int, java.lang.String) [param 1]</code>
then we should first consider whether this a security relevant sink. In this case, this is writing to a HTTP response, so we should
<p>If the query were to return the API <code>fmt.Fprintf [param 2]</code> then we should first consider
whether this a security relevant sink. In this case, this is writing to a HTTP response, so we should
consider whether this is an XSS sink. If it is, we should confirm that it is handled by the XSS query.</p>
<p>If the query were to return the API <code>java.lang.StringBuilder.append(java.lang.String) [param 0]</code>, then this should be
reviewed as a possible taint step, because tainted data would flow from the 0th argument to the qualifier of the call.</p>
<p>If the query were to return the API <code>fmt.Sprintf [param 1]</code>, then this should be
reviewed as a possible taint step, because tainted data would flow from the 1st argument to the return value
of the call.</p>
<p>Note that both examples are correctly handled by the standard taint tracking library and XSS query.</p>
</example>

35
ql/src/Security/CWE-020/UntrustedDataToExternalAPI.qhelp
View File

@@ -4,14 +4,14 @@
<qhelp>
<overview>
<p>Using unsanitized untrusted data in an external API can cause a variety of security issues. This query reports
external APIs that use untrusted data. The results are not filtered so that you can audit all examples. The query
provides data for security reviews of the application and you can also use it to identify external APIs that should
be modeled as either taint steps, or sinks for specific problems.</p>
external APIs that use untrusted data. The results have very little filtering so that you can audit almost all
examples. The query provides data for security reviews of the application and you can also use it to identify
external APIs that should be modeled as either taint steps, or sinks for specific problems.</p>
<p>An external API is defined as a call to a function that is not defined in the source code, not overridden
in the source code, and is not modeled as a taint step in the default taint library. External APIs may be from the
Go standard library, third-party dependencies or from internal dependencies. The query reports uses of
untrusted data in either the qualifier or as one of the arguments of external APIs.</p>
<p>An external API is defined as a call to a function that is not defined in the source code and is not
modeled as a taint step in the default taint library. Calls made in test files are also excluded.
External APIs may be from the Go standard library, third-party dependencies or from internal dependencies.
The query reports uses of untrusted data in either the receiver or as one of the arguments of external APIs.</p>
</overview>
<recommendation>
@@ -33,25 +33,26 @@ class to exclude known safe external APIs from future analysis.</p>
</recommendation>
<example>
<p>In this first example, a request parameter is read from <code>HttpServletRequest</code> and then ultimately used in a call to the
<code>HttpServletResponse.sendError</code> external API:</p>
<p>In this first example, a request parameter is read from <code>http.Request</code> and then ultimately used in a call to the
<code>fmt.Fprintf</code> external API:</p>
<sample src="ExternalAPISinkExample.java" />
<sample src="ExternalAPISinkExample.go" />
<p>This is an XSS sink. The XSS query should therefore be reviewed to confirm that this sink is appropriately modeled,
and if it is, to confirm that the query reports this particular result, or that the result is a false positive due to
some existing sanitization.</p>
<p>In this second example, again a request parameter is read from <code>HttpServletRequest</code>.</p>
<p>In this second example, again a request parameter is read from <code>http.Request</code>.</p>
<sample src="ExternalAPITaintStepExample.java" />
<sample src="ExternalAPITaintStepExample.go" />
<p>If the query reported the call to <code>StringBuilder.append</code> on line 7, this would suggest that this external API is
not currently modeled as a taint step in the taint tracking library. The next step would be to model this as a taint step, then
re-run the query to determine what additional results might be found. In this example, it seems likely that the result of the
<code>StringBuilder</code> will be executed as an SQL query, potentially leading to an SQL injection vulnerability.</p>
<p>If the query reported the call to <code>fmt.Sprintf</code>, this would suggest that this external API is not currently
modeled as a taint step in the taint tracking library. The next step would be to model this as a taint step, then
re-run the query to determine what additional results might be found. In this example, an SQL injection vulnerability
would be reported.</p>
<p>Note that both examples are correctly handled by the standard taint tracking library and XSS query.</p>
<p>Note that both examples are correctly handled by the standard taint tracking library, the reflected XSS query and SQL
injection query.</p>
</example>
<references>

61
ql/src/Security/CWE-020/UntrustedDataToUnknownExternalAPI.qhelp Normal file
View File

@@ -0,0 +1,61 @@
<!DOCTYPE qhelp PUBLIC
"-//Semmle//qhelp//EN"
"qhelp.dtd">
<qhelp>
<overview>
<p>Using unsanitized untrusted data in an external API can cause a variety of security issues. This query reports
external APIs that use untrusted data. The results have been filtered. The query provides data for security
reviews of the application and you can also use it to identify external APIs that should be modeled as either
taint steps, or sinks for specific problems.</p>
<p>An external API is defined as a call to a function that is not defined in the source code and is not
modeled as a taint step in the default taint library. Calls made in test files are also excluded.
External APIs may be from the Go standard library, third-party dependencies or from internal dependencies.
The query reports uses of untrusted data in either the receiver or as one of the arguments of external APIs.</p>
<p>An external API is considered unknown if it is not in a package which has already been modeled, it is not
a sink for an existing query and it is not in a list of external APIs which have been examined and determined
to not be a possible source of security vulnerabilities.</p>
</overview>
<recommendation>
<p>For each result:</p>
<ul>
<li>If the result highlights an unknown sink for a problem, then add modeling for the sink to the relevant query,
and confirm that the result is either found, or is safe due to appropriate sanitization.</li>
<li>If the result represents a call to an external API that transfers taint, add the appropriate modeling, and
re-run the query to determine what new results have appeared due to this additional modeling.</li>
</ul>
<p>Otherwise, the result is likely uninteresting. Custom versions of this query can extend the <code>SafeExternalAPIMethod</code>
class to exclude known safe external APIs from future analysis.</p>
</recommendation>
<example>
<p>In this first example, a request parameter is read from <code>http.Request</code> and then ultimately used in a call to the
<code>fmt.Fprintf</code> external API:</p>
<sample src="ExternalAPISinkExample.go" />
<p>This is an XSS sink. The XSS query should therefore be reviewed to confirm that this sink is appropriately modeled,
and if it is, to confirm that the query reports this particular result, or that the result is a false positive due to
some existing sanitization.</p>
<p>In this second example, again a request parameter is read from <code>http.Request</code>.</p>
<sample src="ExternalAPITaintStepExample.go" />
<p>If the query reported the call to <code>fmt.Sprintf</code>, this would suggest that this external API is not currently
modeled as a taint step in the taint tracking library. The next step would be to model this as a taint step, then
re-run the query to determine what additional results might be found. In this example, an SQL injection vulnerability
would be reported.</p>
<p>Note that both examples are correctly handled by the standard taint tracking library, the reflected XSS query and SQL
injection query.</p>
</example>
<references>
</references>
</qhelp>