Skip to content

Commit ac6da6c

Browse files
committed
JS: Add some missing qldoc
1 parent d993c88 commit ac6da6c

7 files changed

+15
-0
lines changed

javascript/ql/lib/semmle/javascript/security/TaintedObject.qll

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ module TaintedObject {
2626
ConcreteTaintedObjectLabel() { this = this }
2727
}
2828

29+
/**
30+
* DEPRECATED. Use `isAdditionalFlowStep(node1, state1, node2, state2)` instead.
31+
*/
2932
deprecated predicate step(Node src, Node trg, FlowLabel inlbl, FlowLabel outlbl) {
3033
isAdditionalFlowStep(src, FlowState::fromFlowLabel(inlbl), trg, FlowState::fromFlowLabel(outlbl))
3134
}

javascript/ql/lib/semmle/javascript/security/dataflow/ExceptionXssCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ module ExceptionXss {
2727
this = TNotYetThrown() and result = "not-yet-thrown"
2828
}
2929

30+
/** Gets the corresponding flow label. */
3031
deprecated DataFlow::FlowLabel toFlowLabel() {
3132
this = TThrown() and result.isTaint()
3233
or
@@ -36,6 +37,7 @@ module ExceptionXss {
3637

3738
/** Predicates for working with flow states. */
3839
module FlowState {
40+
/** Gets the flow state corresponding to `label`. */
3941
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
4042

4143
/** A tainted value originating from a thrown and caught exception. */

javascript/ql/lib/semmle/javascript/security/dataflow/HardcodedDataInterpretedAsCodeCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ module HardcodedDataInterpretedAsCode {
2121
this = TModified() and result = "modified"
2222
}
2323

24+
/** Gets the corresponding flow label. */
2425
deprecated DataFlow::FlowLabel toFlowLabel() {
2526
this = TUnmodified() and result.isData()
2627
or
@@ -30,6 +31,7 @@ module HardcodedDataInterpretedAsCode {
3031

3132
/** Predicates for working with flow states. */
3233
module FlowState {
34+
/** Gets the flow state corresponding to `label`. */
3335
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
3436

3537
/** An unmodified value originating from a string constant. */

javascript/ql/lib/semmle/javascript/security/dataflow/InsecureDownloadCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module InsecureDownload {
2323
this = TInsecureUrl() and result = "insecure-url"
2424
}
2525

26+
/** Gets the corresponding flow label. */
2627
deprecated DataFlow::FlowLabel toFlowLabel() {
2728
this = TSensitiveInsecureUrl() and result instanceof Label::SensitiveInsecureUrl
2829
or
@@ -32,6 +33,7 @@ module InsecureDownload {
3233

3334
/** Predicates for working with flow states. */
3435
module FlowState {
36+
/** Gets the flow state corresponding to `label`. */
3537
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
3638

3739
/**

javascript/ql/lib/semmle/javascript/security/dataflow/PrototypePollutingAssignmentCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module PrototypePollutingAssignment {
2323
this = TObjectPrototype() and result = "object-prototype"
2424
}
2525

26+
/** Gets the corresponding flow label. */
2627
deprecated DataFlow::FlowLabel toFlowLabel() {
2728
this = TTaint() and result.isTaint()
2829
or
@@ -32,6 +33,7 @@ module PrototypePollutingAssignment {
3233

3334
/** Predicates for working with flow states. */
3435
module FlowState {
36+
/** Gets the flow state corresponding to `label`. */
3537
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
3638

3739
/** A tainted value. */

javascript/ql/lib/semmle/javascript/security/dataflow/UnsafeDynamicMethodAccessCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module UnsafeDynamicMethodAccess {
2323
this = TUnsafeFunction() and result = "unsafe-function"
2424
}
2525

26+
/** Gets the corresponding flow label. */
2627
deprecated DataFlow::FlowLabel toFlowLabel() {
2728
this = TTaint() and result.isTaint()
2829
or
@@ -32,6 +33,7 @@ module UnsafeDynamicMethodAccess {
3233

3334
/** Predicates for working with flow states. */
3435
module FlowState {
36+
/** Gets the flow state corresponding to `label`. */
3537
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
3638

3739
/** A tainted value. */

javascript/ql/lib/semmle/javascript/security/dataflow/UnvalidatedDynamicMethodCallCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ module UnvalidatedDynamicMethodCall {
2626
this = TMaybeFromProto() and result = "maybe-from-proto"
2727
}
2828

29+
/** Gets the corresponding flow label. */
2930
deprecated DataFlow::FlowLabel toFlowLabel() {
3031
this = TTaint() and result.isTaint()
3132
or
@@ -37,6 +38,7 @@ module UnvalidatedDynamicMethodCall {
3738

3839
/** Predicates for working with flow states. */
3940
module FlowState {
41+
/** Gets the flow state corresponding to `label`. */
4042
deprecated FlowState fromFlowLabel(DataFlow::FlowLabel label) { result.toFlowLabel() = label }
4143

4244
/** A tainted value. */

0 commit comments

Comments
 (0)