Skip to content

Documentation: Fix typo in dataflow documentation for C# #5354

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
merged 1 commit into from
Mar 16, 2021
Merged

Documentation: Fix typo in dataflow documentation for C# #5354

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
18 changes: 9 additions & 9 deletions docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Analyzing data flow in C#
=========================

You can use CodeQL to track the flow of data through a C# program to its use.
You can use CodeQL to track the flow of data through a C# program to its use.

About this article
------------------
Expand Down Expand Up @@ -216,7 +216,7 @@ Flow sources

The data flow library contains some predefined flow sources. The class ``PublicCallableParameterFlowSource`` (defined in module ``semmle.code.csharp.dataflow.flowsources.PublicCallableParameter``) represents data flow from public parameters, which is useful for finding security problems in a public API.

The class ``RemoteSourceFlow`` (defined in module ``semmle.code.csharp.dataflow.flowsources.Remote``) represents data flow from remote network inputs. This is useful for finding security problems in networked services.
The class ``RemoteFlowSource`` (defined in module ``semmle.code.csharp.dataflow.flowsources.Remote``) represents data flow from remote network inputs. This is useful for finding security problems in networked services.

Example
~~~~~~~
Expand Down Expand Up @@ -251,7 +251,7 @@ Class hierarchy

- ``PublicCallableParameter`` - a parameter to a public method/callable in a public class.

- ``RemoteSourceFlow`` - data flow from network/remote input.
- ``RemoteFlowSource`` - data flow from network/remote input.

- ``AspNetRemoteFlowSource`` - data flow from remote ASP.NET user input.

Expand Down Expand Up @@ -437,11 +437,11 @@ Exercise 2

class Configuration extends DataFlow::Configuration {
Configuration() { this="String to System.Uri" }

override predicate isSource(DataFlow::Node src) {
src.asExpr().hasValue()
}

override predicate isSink(DataFlow::Node sink) {
exists(Call c | c.getTarget().(Constructor).getDeclaringType().hasQualifiedName("System.Uri")
and sink.asExpr()=c.getArgument(0))
Expand All @@ -458,7 +458,7 @@ Exercise 3
.. code-block:: ql

class EnvironmentVariableFlowSource extends DataFlow::ExprNode {
EnvironmentVariableFlowSource() {
EnvironmentVariableFlowSource() {
this.getExpr().(MethodCall).getTarget().hasQualifiedName("System.Environment.GetEnvironmentVariable")
}
}
Expand All @@ -471,18 +471,18 @@ Exercise 4
import csharp

class EnvironmentVariableFlowSource extends DataFlow::ExprNode {
EnvironmentVariableFlowSource() {
EnvironmentVariableFlowSource() {
this.getExpr().(MethodCall).getTarget().hasQualifiedName("System.Environment.GetEnvironmentVariable")
}
}

class Configuration extends DataFlow::Configuration {
Configuration() { this="Environment to System.Uri" }

override predicate isSource(DataFlow::Node src) {
src instanceof EnvironmentVariableFlowSource
}

override predicate isSink(DataFlow::Node sink) {
exists(Call c | c.getTarget().(Constructor).getDeclaringType().hasQualifiedName("System.Uri")
and sink.asExpr()=c.getArgument(0))
Expand Down