add placeholder qldocs

Jami Cogswell · Jami Cogswell · commit bcb506b63795 · 2022-10-12T17:04:51.000-04:00
diff --git a/java/ql/lib/semmle/code/java/security/InsufficientKeySize.qll b/java/ql/lib/semmle/code/java/security/InsufficientKeySize.qll
@@ -11,17 +11,20 @@ abstract class InsufficientKeySizeSink extends DataFlow::Node { }
 
 // TODO: Consider if below 3 sources should be private and if it's possible to only use InsufficientKeySizeSource in the configs
 // TODO: add QLDocs if keeping non-private
+/** A source for an insufficient key size (asymmetric-non-ec). */
 class AsymmetricNonECSource extends InsufficientKeySizeSource {
   AsymmetricNonECSource() { getNodeIntValue(this) < 2048 }
 }
 
+/** A source for an insufficient key size (asymmetric-ec). */
 class AsymmetricECSource extends InsufficientKeySizeSource {
   AsymmetricECSource() {
     getNodeIntValue(this) < 256 or
     getECKeySize(this.asExpr().(StringLiteral).getValue()) < 256 // need this for the cases when the key size is embedded in the curve name.
   }
 }
 
+/** A source for an insufficient key size (symmetric). */
 class SymmetricSource extends InsufficientKeySizeSource {
   SymmetricSource() { getNodeIntValue(this) < 128 }
 }
@@ -46,6 +49,7 @@ private int getECKeySize(string algorithm) {
 
 // TODO: Consider if below 3 sinks should be private and if it's possible to only use InsufficientKeySizeSink in the configs
 // TODO: add QLDocs if keeping non-private
+/** A sink for an insufficient key size (asymmetric-non-ec). */
 class AsymmetricNonECSink extends InsufficientKeySizeSink {
   AsymmetricNonECSink() {
     hasKeySizeInInitMethod(this, "asymmetric-non-ec")
@@ -63,6 +67,7 @@ private class AsymmetricNonECSpec extends RefType {
   }
 }
 
+/** A sink for an insufficient key size (asymmetric-ec). */
 class AsymmetricECSink extends InsufficientKeySizeSink {
   AsymmetricECSink() {
     hasKeySizeInInitMethod(this, "asymmetric-ec")
@@ -71,6 +76,7 @@ class AsymmetricECSink extends InsufficientKeySizeSink {
   }
 }
 
+/** A sink for an insufficient key size (symmetric). */
 class SymmetricSink extends InsufficientKeySizeSink {
   SymmetricSink() { hasKeySizeInInitMethod(this, "symmetric") }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,17 +11,20 @@ abstract class InsufficientKeySizeSink extends DataFlow::Node { }`
`11`	`11`
`12`	`12`	`// TODO: Consider if below 3 sources should be private and if it's possible to only use InsufficientKeySizeSource in the configs`
`13`	`13`	`// TODO: add QLDocs if keeping non-private`
	`14`	`+/** A source for an insufficient key size (asymmetric-non-ec). */`
`14`	`15`	`class AsymmetricNonECSource extends InsufficientKeySizeSource {`
`15`	`16`	`AsymmetricNonECSource() { getNodeIntValue(this) < 2048 }`
`16`	`17`	`}`
`17`	`18`
	`19`	`+/** A source for an insufficient key size (asymmetric-ec). */`
`18`	`20`	`class AsymmetricECSource extends InsufficientKeySizeSource {`
`19`	`21`	`AsymmetricECSource() {`
`20`	`22`	`getNodeIntValue(this) < 256 or`
`21`	`23`	`getECKeySize(this.asExpr().(StringLiteral).getValue()) < 256 // need this for the cases when the key size is embedded in the curve name.`
`22`	`24`	`}`
`23`	`25`	`}`
`24`	`26`
	`27`	`+/** A source for an insufficient key size (symmetric). */`
`25`	`28`	`class SymmetricSource extends InsufficientKeySizeSource {`
`26`	`29`	`SymmetricSource() { getNodeIntValue(this) < 128 }`
`27`	`30`	`}`
`@@ -46,6 +49,7 @@ private int getECKeySize(string algorithm) {`
`46`	`49`
`47`	`50`	`// TODO: Consider if below 3 sinks should be private and if it's possible to only use InsufficientKeySizeSink in the configs`
`48`	`51`	`// TODO: add QLDocs if keeping non-private`
	`52`	`+/** A sink for an insufficient key size (asymmetric-non-ec). */`
`49`	`53`	`class AsymmetricNonECSink extends InsufficientKeySizeSink {`
`50`	`54`	`AsymmetricNonECSink() {`
`51`	`55`	`hasKeySizeInInitMethod(this, "asymmetric-non-ec")`
`@@ -63,6 +67,7 @@ private class AsymmetricNonECSpec extends RefType {`
`63`	`67`	`}`
`64`	`68`	`}`
`65`	`69`
	`70`	`+/** A sink for an insufficient key size (asymmetric-ec). */`
`66`	`71`	`class AsymmetricECSink extends InsufficientKeySizeSink {`
`67`	`72`	`AsymmetricECSink() {`
`68`	`73`	`hasKeySizeInInitMethod(this, "asymmetric-ec")`
`@@ -71,6 +76,7 @@ class AsymmetricECSink extends InsufficientKeySizeSink {`
`71`	`76`	`}`
`72`	`77`	`}`
`73`	`78`
	`79`	`+/** A sink for an insufficient key size (symmetric). */`
`74`	`80`	`class SymmetricSink extends InsufficientKeySizeSink {`
`75`	`81`	`SymmetricSink() { hasKeySizeInInitMethod(this, "symmetric") }`
`76`	`82`	`}`