Documentation for FlowSources library

egregius313 · egregius313 · commit 51564200a17a · 2024-01-22T11:09:48.000-05:00
diff --git a/csharp/ql/lib/semmle/code/csharp/security/dataflow/flowsources/FlowSources.qll b/csharp/ql/lib/semmle/code/csharp/security/dataflow/flowsources/FlowSources.qll
@@ -1,3 +1,5 @@
+/** Provides classes representing various flow sources for taint tracking. */
+
 private import semmle.code.csharp.dataflow.internal.ExternalFlow
 private import codeql.threatmodels.ThreatModels
 import semmle.code.csharp.security.dataflow.flowsources.Remote
diff --git a/csharp/ql/lib/semmle/code/csharp/security/dataflow/flowsources/Stored.qll b/csharp/ql/lib/semmle/code/csharp/security/dataflow/flowsources/Stored.qll
@@ -16,6 +16,9 @@ abstract class StoredFlowSource extends SourceNode {
   override string getThreatModel() { result = "local" }
 }
 
+/**
+ * A node with input from a database.
+ */
 abstract class DatabaseInputSource extends StoredFlowSource {
   override string getThreatModel() { result = "database" }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/** Provides classes representing various flow sources for taint tracking. */`
	`2`	`+`
`1`	`3`	`private import semmle.code.csharp.dataflow.internal.ExternalFlow`
`2`	`4`	`private import codeql.threatmodels.ThreatModels`
`3`	`5`	`import semmle.code.csharp.security.dataflow.flowsources.Remote`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@ abstract class StoredFlowSource extends SourceNode {`
`16`	`16`	`override string getThreatModel() { result = "local" }`
`17`	`17`	`}`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * A node with input from a database.`
	`21`	`+ */`
`19`	`22`	`abstract class DatabaseInputSource extends StoredFlowSource {`
`20`	`23`	`override string getThreatModel() { result = "database" }`
`21`	`24`	`}`