Rust: Implement new query for non-HTTPS URLs (CWE-319) #20432
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,60 @@ | ||||||
| /** | ||||||
| * Provides classes and predicates for reasoning about the use of | ||||||
| * non-HTTPS URLs in Rust code. | ||||||
| */ | ||||||
|
|
||||||
| import rust | ||||||
| private import codeql.rust.dataflow.DataFlow | ||||||
| private import codeql.rust.dataflow.FlowSink | ||||||
| private import codeql.rust.elements.LiteralExprExt | ||||||
| private import codeql.rust.Concepts | ||||||
|
|
||||||
| /** | ||||||
| * Provides default sources, sinks and barriers for detecting use of | ||||||
| * non-HTTPS URLs, as well as extension points for adding your own. | ||||||
| */ | ||||||
| module UseOfHttp { | ||||||
| /** | ||||||
| * A data flow source for use of non-HTTPS URLs. | ||||||
| */ | ||||||
| abstract class Source extends DataFlow::Node { } | ||||||
|
|
||||||
| /** | ||||||
| * A data flow sink for use of non-HTTPS URLs. | ||||||
| */ | ||||||
| abstract class Sink extends QuerySink::Range { | ||||||
| override string getSinkType() { result = "UseOfHttp" } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * A barrier for use of non-HTTPS URLs. | ||||||
| */ | ||||||
| abstract class Barrier extends DataFlow::Node { } | ||||||
|
|
||||||
| /** | ||||||
| * A string containing an HTTP URL. | ||||||
| */ | ||||||
| class HttpStringLiteral extends StringLiteralExpr { | ||||||
| HttpStringLiteral() { | ||||||
| exists(string s | this.getTextValue() = s | | ||||||
| // Match HTTP URLs that are not private/local | ||||||
| s.regexpMatch("\"http://.*\"") and | ||||||
| not s.regexpMatch("\"http://(localhost|127\\.0\\.0\\.1|192\\.168\\.[0-9]+\\.[0-9]+|10\\.[0-9]+\\.[0-9]+\\.[0-9]+|172\\.16\\.[0-9]+\\.[0-9]+|\\[::1\\]|\\[0:0:0:0:0:0:0:1\\]).*\"") | ||||||
|
||||||
| not s.regexpMatch("\"http://(localhost|127\\.0\\.0\\.1|192\\.168\\.[0-9]+\\.[0-9]+|10\\.[0-9]+\\.[0-9]+\\.[0-9]+|172\\.16\\.[0-9]+\\.[0-9]+|\\[::1\\]|\\[0:0:0:0:0:0:0:1\\]).*\"") | |
| not s.regexpMatch("\"http://(localhost|127\\.0\\.0\\.1|192\\.168\\.[0-9]+\\.[0-9]+|10\\.[0-9]+\\.[0-9]+\\.[0-9]+|172\\.(1[6-9]|2[0-9]|3[01])\\.[0-9]+\\.[0-9]+|169\\.254\\.[0-9]+\\.[0-9]+|\\[::1\\]|\\[0:0:0:0:0:0:0:1\\]|\\[fc[0-9a-fA-F]{2}:.*\\]|\\[fd[0-9a-fA-F]{2}:.*\\]|\\[fe80:.*\\]).*\"") |
Contributor
There was a problem hiding this comment.
The IPv4 one has already been added in the latest version, I'll look into the IPv6 ranges as well...
Contributor
There was a problem hiding this comment.
... I've added the IPv6 private address range. 169.254.x.x and fe80::/10 appear to be something slightly different - "link-local addresses" - and my knowledge of IP doesn't extend to whether we should include those in this logic. I suspect it isn't that important (unless we start seeing lots of false positive results about them).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| category: newQuery | ||
| --- | ||
| * Added a new query, `rust/non-https-url`, for detecting the use of non-HTTPS URLs that can be intercepted by third parties. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <!DOCTYPE qhelp PUBLIC | ||
| "-//Semmle//qhelp//EN" | ||
| "qhelp.dtd"> | ||
| <qhelp> | ||
| <overview> | ||
|
|
||
| <p>Constructing URLs with the HTTP protocol can lead to unsecured connections.</p> | ||
geoffw0 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <p>Furthermore, constructing URLs with the HTTP protocol can create problems if other parts of the | ||
| code expect HTTPS URLs. A typical pattern is to use libraries that expect secure connections, | ||
| which may fail or fall back to insecure behavior when provided with HTTP URLs instead of HTTPS URLs.</p> | ||
|
|
||
| </overview> | ||
| <recommendation> | ||
|
|
||
| <p>When you construct a URL for network requests, ensure that you use an HTTPS URL rather than an HTTP URL. | ||
| Then, any connections that are made using that URL are secure SSL/TLS connections.</p> | ||
geoffw0 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| </recommendation> | ||
| <example> | ||
|
|
||
| <p>The following example shows two ways of making a network request using a URL. When the request is | ||
| made using an HTTP URL rather than an HTTPS URL, the connection is unsecured and can be intercepted | ||
| by attackers. When the request is made using an HTTPS URL, the connection is a secure SSL/TLS connection.</p> | ||
|
|
||
| <sample src="UseOfHttpBad.rs" /> | ||
|
|
||
| <p>A better approach is to use HTTPS:</p> | ||
|
|
||
| <sample src="UseOfHttpGood.rs" /> | ||
|
|
||
| </example> | ||
| <references> | ||
|
|
||
| <li> | ||
| OWASP: | ||
| <a href="https://cheatsheetseries.owasp.org/cheatsheets/Transport_Layer_Protection_Cheat_Sheet.html">Transport Layer Protection Cheat Sheet</a>. | ||
| </li> | ||
| <li> | ||
| OWASP Top 10: | ||
| <a href="https://owasp.org/Top10/A08_2021-Software_and_Data_Integrity_Failures/">A08:2021 - Software and Data Integrity Failures</a>. | ||
| </li> | ||
| <li>Rust reqwest documentation: | ||
| <a href="https://docs.rs/reqwest/">reqwest crate</a>. | ||
| </li> | ||
|
|
||
| </references> | ||
| </qhelp> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /** | ||
| * @name Failure to use HTTPS URLs | ||
| * @description Non-HTTPS connections can be intercepted by third parties. | ||
| * @kind path-problem | ||
| * @problem.severity warning | ||
| * @security-severity 8.1 | ||
| * @precision high | ||
| * @id rust/non-https-url | ||
| * @tags security | ||
| * external/cwe/cwe-319 | ||
| * external/cwe/cwe-345 | ||
| */ | ||
|
|
||
| import rust | ||
| import codeql.rust.dataflow.DataFlow | ||
| import codeql.rust.dataflow.TaintTracking | ||
| import codeql.rust.security.UseOfHttpExtensions | ||
|
|
||
| /** | ||
| * A taint configuration for HTTP URL strings that flow to URL-using sinks. | ||
| */ | ||
| module UseOfHttpConfig implements DataFlow::ConfigSig { | ||
| import UseOfHttp | ||
|
|
||
| predicate isSource(DataFlow::Node node) { node instanceof Source } | ||
|
|
||
| predicate isSink(DataFlow::Node node) { node instanceof Sink } | ||
|
|
||
| predicate isBarrier(DataFlow::Node barrier) { barrier instanceof Barrier } | ||
|
|
||
| predicate observeDiffInformedIncrementalMode() { any() } | ||
| } | ||
|
|
||
| module UseOfHttpFlow = TaintTracking::Global<UseOfHttpConfig>; | ||
|
|
||
| import UseOfHttpFlow::PathGraph | ||
|
|
||
| from UseOfHttpFlow::PathNode sourceNode, UseOfHttpFlow::PathNode sinkNode | ||
| where UseOfHttpFlow::flowPath(sourceNode, sinkNode) | ||
| select sinkNode.getNode(), sourceNode, sinkNode, | ||
| "This URL may be constructed with the HTTP protocol, from $@.", sourceNode.getNode(), | ||
| "this HTTP URL" | ||
github-advanced-security[bot] marked this conversation as resolved.
Dismissed
Show dismissed
Hide dismissed
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // BAD: Using HTTP URL which can be intercepted | ||
| use reqwest; | ||
|
|
||
| fn main() { | ||
| let url = "http://example.com/sensitive-data"; | ||
|
|
||
| // This makes an insecure HTTP request that can be intercepted | ||
| let response = reqwest::blocking::get(url).unwrap(); | ||
| println!("Response: {}", response.text().unwrap()); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // GOOD: Using HTTPS URL which provides encryption | ||
| use reqwest; | ||
|
|
||
| fn main() { | ||
| let url = "https://example.com/sensitive-data"; | ||
|
|
||
| // This makes a secure HTTPS request that is encrypted | ||
| let response = reqwest::blocking::get(url).unwrap(); | ||
| println!("Response: {}", response.text().unwrap()); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.