Ruby: Add qldoc for Cryptography module (from python version)

alexrford · alexrford · commit 6eca036b445e · 2022-03-14T08:57:13.000Z
diff --git a/ruby/ql/lib/codeql/ruby/Concepts.qll b/ruby/ql/lib/codeql/ruby/Concepts.qll
@@ -763,6 +763,14 @@ module Logging {
   }
 }
 
+/**
+ * Provides models for cryptographic things.
+ *
+ * Note: The `CryptographicAlgorithm` class currently doesn't take weak keys into
+ * consideration for the `isWeak` member predicate. So RSA is always considered
+ * secure, although using a low number of bits will actually make it insecure. We plan
+ * to improve our libraries in the future to more precisely capture this aspect.
+ */
 module Cryptography {
   import security.CryptoAlgorithms
 

Original file line number	Diff line number	Diff line change
`@@ -763,6 +763,14 @@ module Logging {`
`763`	`763`	`}`
`764`	`764`	`}`
`765`	`765`
	`766`	`+/**`
	`767`	`+ * Provides models for cryptographic things.`
	`768`	`+ *`
	`769`	+ * Note: The `CryptographicAlgorithm` class currently doesn't take weak keys into
	`770`	+ * consideration for the `isWeak` member predicate. So RSA is always considered
	`771`	`+ * secure, although using a low number of bits will actually make it insecure. We plan`
	`772`	`+ * to improve our libraries in the future to more precisely capture this aspect.`
	`773`	`+ */`
`766`	`774`	`module Cryptography {`
`767`	`775`	`import security.CryptoAlgorithms`
`768`	`776`