Skip to content

Commit b5ec99c

Browse files
committed
Ruby: fix missing qldoc
1 parent 5b013dd commit b5ec99c

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

ruby/ql/lib/codeql/ruby/security/CodeInjectionCustomizations.qll

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ module CodeInjection {
3131

3232
/** A flow state used to distinguish whether an attacker controls the entire string. */
3333
class State extends TState {
34+
/**
35+
* Gets a string representation of this state.
36+
*/
3437
string toString() { result = this.getStringRepresentation() }
3538

3639
/**

ruby/ql/lib/codeql/ruby/security/HardcodedDataInterpretedAsCodeCustomizations.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ module HardcodedDataInterpretedAsCode {
3535
* Flow states used to distinguish value-preserving flow from taint flow.
3636
*/
3737
newtype State =
38+
/** Flow state used to track value-preserving flow. */
3839
Data() or
40+
/** Flow state used to tainted data (non-value preserving flow). */
3941
Taint()
4042
}
4143

ruby/ql/lib/codeql/ruby/security/InsecureDownloadCustomizations.qll

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ module InsecureDownload {
2525
*/
2626
abstract deprecated DataFlow::FlowState getALabel();
2727

28+
/**
29+
* Gets a flow-label for this source.
30+
*/
2831
abstract Label::State getAFlowLabel();
2932
}
3033

@@ -43,6 +46,9 @@ module InsecureDownload {
4346
*/
4447
abstract deprecated DataFlow::FlowState getALabel();
4548

49+
/**
50+
* Gets a flow-label where this sink is vulnerable.
51+
*/
4652
abstract Label::State getAFlowLabel();
4753
}
4854

@@ -83,8 +89,11 @@ module InsecureDownload {
8389
* Flow-labels for reasoning about download of sensitive file through insecure connection.
8490
*/
8591
newtype State =
92+
/** A flow-label for a URL that is downloaded over an insecure connection. */
8693
InsecureState() or
94+
/** A flow-label for a URL that is sensitive. */
8795
SensitiveState() or
96+
/** A flow-label for file URLs that are both sensitive and downloaded over an insecure connection. */
8897
SensitiveInsecureState()
8998
}
9099

0 commit comments

Comments
 (0)