Skip to content
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.

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

Jump to bottom

Docs: Update data flow documentation to the new API. #13743

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: Update data flow documentation to the new API. #13743

wants to merge 2 commits into from
+352 −431

Conversation

aschackmull
Copy link
Contributor

This updates the pieces of documentation that I could find to the new data flow API.
I identified the places that needed updates, by grepping for the following list of words:

::Configuration
isSanitizer
AdditionalTaintStep
hasFlow
isBarrierGuard
DataFlow::PathNode
DataFlow::PathGraph

@aschackmull aschackmull added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Jul 14, 2023
github-code-scanning[bot]
github-code-scanning bot found potential problems Jul 14, 2023
View reviewed changes
docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql Outdated
@@ -1,14 +1,14 @@
import java
import semmle.code.java.dataflow.TaintTracking

class TaintedOGNLConfig extends TaintTracking::Configuration {
TaintedOGNLConfig() { this = "TaintedOGNLConfig" }
module TaintedOGNLConfig implements DataFlow::ConfigSig {

Check warning

Code scanning / CodeQL

Acronyms should be PascalCase/camelCase. Warning

Acronyms in TaintedOGNLConfig should be PascalCase/camelCase.
docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql Outdated
}

from TaintedOGNLConfig cfg, DataFlow::Node source, DataFlow::Node sink
where cfg.hasFlow(source, sink)
module TaintedOGNLFlow = TaintTracking::Global<TaintedOGNLConfig>;

Check warning

Code scanning / CodeQL

Acronyms should be PascalCase/camelCase. Warning

Acronyms in TaintedOGNLFlow should be PascalCase/camelCase.
docs/codeql/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql Dismissed
class TaintedFormatConfig extends TaintTracking::Configuration {
TaintedFormatConfig() { this = "TaintedFormatConfig" }
module TaintedFormatConfig implements DataFlow::ConfigSig {
predicate isSource(DataFlow::Node source) { /* TBD */ }

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.
docs/codeql/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql
override predicate isSource(DataFlow::Node source) { /* TBD */ }

override predicate isSink(DataFlow::Node sink) { /* TBD */ }
predicate isSink(DataFlow::Node sink) { /* TBD */ }

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.
docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql
class TaintedOGNLConfig extends TaintTracking::Configuration {
TaintedOGNLConfig() { this = "TaintedOGNLConfig" }
module TaintedOGNLConfig implements DataFlow::ConfigSig {
predicate isSource(DataFlow::Node source) { /* TBD */ }

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.
docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql
override predicate isSource(DataFlow::Node source) { /* TBD */ }

override predicate isSink(DataFlow::Node sink) { /* TBD */ }
predicate isSink(DataFlow::Node sink) { /* TBD */ }

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.
github-code-scanning[bot]
github-code-scanning bot found potential problems Jul 14, 2023
View reviewed changes
docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql
override predicate isSource(DataFlow::Node source) { /* TBD */ }

override predicate isSink(DataFlow::Node sink) { /* TBD */ }
predicate isSink(DataFlow::Node sink) { /* TBD */ }

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@aschackmull