Crypto: Add Java Cryptographic Analysis Queries

cpp/ql/lib/experimental/quantum/OpenSSL/AlgorithmInstances/EllipticCurveAlgorithmInstance.qll

@@ -40,7 +40,7 @@ class KnownOpenSslEllipticCurveConstantAlgorithmInstance extends OpenSslAlgorith
     result = this.(Call).getTarget().getName()
   }
 
-  override Crypto::EllipticCurveFamilyType getEllipticCurveFamilyType() {
+  override Crypto::EllipticCurveType getEllipticCurveType() {
     if
       Crypto::ellipticCurveNameToKnownKeySizeAndFamilyMapping(this.getParsedEllipticCurveName(), _,
         _)

cpp/ql/lib/experimental/quantum/OpenSSL/AlgorithmInstances/HashAlgorithmInstance.qll

@@ -72,7 +72,7 @@ class KnownOpenSslHashConstantAlgorithmInstance extends OpenSslAlgorithmInstance
 
   override OpenSslAlgorithmValueConsumer getAvc() { result = getterCall }
 
-  override Crypto::THashType getHashFamily() {
+  override Crypto::THashType getHashType() {
     knownOpenSslConstantToHashFamilyType(this, result)
     or
     not knownOpenSslConstantToHashFamilyType(this, _) and result = Crypto::OtherHashType()

java/ql/lib/experimental/quantum/JCA.qll

@@ -426,7 +426,7 @@ module JCAModel {
 
     override string getRawHashAlgorithmName() { result = super.getPadding() }
 
-    override Crypto::THashType getHashFamily() { result = hash_name_to_type_known(hashName, _) }
+    override Crypto::THashType getHashType() { result = hash_name_to_type_known(hashName, _) }
 
     override int getFixedDigestLength() { exists(hash_name_to_type_known(hashName, result)) }
   }
@@ -859,7 +859,7 @@ module JCAModel {
 
     override string getRawHashAlgorithmName() { result = super.getValue() }
 
-    override Crypto::THashType getHashFamily() {
+    override Crypto::THashType getHashType() {
       result = hash_name_to_type_known(this.getRawHashAlgorithmName(), _)
     }
 
@@ -1302,7 +1302,7 @@ module JCAModel {
 
     override string getRawHashAlgorithmName() { result = this.(StringLiteral).getValue() }
 
-    override Crypto::THashType getHashFamily() { result = hash_name_to_type_known(hashName, _) }
+    override Crypto::THashType getHashType() { result = hash_name_to_type_known(hashName, _) }
 
     override int getFixedDigestLength() { exists(hash_name_to_type_known(hashName, result)) }
   }
@@ -1770,7 +1770,7 @@ module JCAModel {
 
     override string getRawHashAlgorithmName() { result = this.(StringLiteral).getValue() }
 
-    override Crypto::THashType getHashFamily() { result = hashType }
+    override Crypto::THashType getHashType() { result = hashType }
 
     override int getFixedDigestLength() { result = digestLength }
   }
@@ -1905,7 +1905,7 @@ module JCAModel {
 
     override string getRawEllipticCurveName() { result = super.getValue() }
 
-    override Crypto::EllipticCurveFamilyType getEllipticCurveFamilyType() {
+    override Crypto::EllipticCurveType getEllipticCurveType() {
       if
         Crypto::ellipticCurveNameToKnownKeySizeAndFamilyMapping(this.getRawEllipticCurveName(), _, _)
       then

java/ql/src/experimental/quantum/Analysis/InsecureNonceGeneration.ql

@@ -0,0 +1,22 @@
+/**
+ * @name Insecure nonce at a cipher operation
+ * @id java/quantum/insecure-nonce
+ * @description A nonce is generated from a source that is not secure. This can lead to
+ *              vulnerabilities such as replay attacks or key recovery.
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import experimental.quantum.Language
+
+predicate isInsecureNonceSource(Crypto::NonceArtifactNode n, Crypto::NodeBase src) {
+  src = n.getSourceNode() and
+  not src.asElement() instanceof SecureRandomnessInstance
+}
+
+from Crypto::KeyOperationNode op, Crypto::NodeBase src
+where isInsecureNonceSource(op.getANonce(), src)
+select op, "Operation uses insecure nonce source $@", src, src.toString()

java/ql/src/experimental/quantum/Analysis/NonAESGCMCipher.ql

@@ -0,0 +1,24 @@
+/**
+ * @name Cipher not AES-GCM mode
+ * @id java/quantum/non-aes-gcm
+ * @description An AES cipher is in use without GCM
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import experimental.quantum.Language
+
+class NonAESGCMAlgorithmNode extends Crypto::KeyOperationAlgorithmNode {
+  NonAESGCMAlgorithmNode() {
+    this.getAlgorithmType() = Crypto::KeyOpAlg::TSymmetricCipher(Crypto::KeyOpAlg::AES()) and
+    this.getModeOfOperation().getModeType() != Crypto::KeyOpAlg::GCM()
+  }
+}
+
+from Crypto::KeyOperationNode op, Crypto::KeyOperationOutputNode codeNode
+where op.getAKnownAlgorithm() instanceof NonAESGCMAlgorithmNode and
+    codeNode = op.getAnOutputArtifact()
+select op, "Non-AES-GCM instance."

java/ql/src/experimental/quantum/Analysis/ReusedNonce.ql

@@ -4,7 +4,7 @@
  * @id java/quantum/reused-nonce
  * @kind problem
  * @problem.severity error
- * @precision medium
+ * @precision high
  * @tags quantum
  *       experimental
  */

java/ql/src/experimental/quantum/Analysis/UnknownKDFIterationCount.ql

@@ -4,7 +4,6 @@
  * @id java/quantum/unknown-kdf-iteration-count
  * @kind problem
  * @precision medium
- * @severity warning
  * @tags quantum
  *       experimental
  */

java/ql/src/experimental/quantum/Analysis/WeakAsymmetric.ql

@@ -0,0 +1,24 @@
+/**
+ * @name Weak Asymmetric Key Size
+ * @id java/quantum/weak-asymmetric-key-size
+ * @description An asymmetric cipher with a short key size is in use
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+
+from Crypto::KeyOperationAlgorithmNode op, DataFlow::Node configSrc, int keySize, string algName
+where
+  keySize = op.getKeySizeFixed() and
+  keySize < 2048 and
+  algName = op.getAlgorithmName() and
+  // Can't be an elliptic curve
+  not Crypto::isEllipticCurveAlgorithmName(algName)
+select op,
+  "Use of weak asymmetric key size (" + keySize.toString() + " bits) for algorithm " +
+    algName.toString() + " at config source $@", configSrc, configSrc.toString()

java/ql/src/experimental/quantum/Analysis/WeakBlockModes.ql

@@ -0,0 +1,31 @@
+/**
+ * @name Weak AES Block mode
+ * @id java/quantum/weak-block-modes
+ * @description An AES cipher is in use with an insecure block mode
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+
+class WeakAESBlockModeAlgNode extends Crypto::KeyOperationAlgorithmNode {
+  WeakAESBlockModeAlgNode() {
+    this.getAlgorithmType() = Crypto::KeyOpAlg::TSymmetricCipher(Crypto::KeyOpAlg::AES()) and
+    (
+      this.getModeOfOperation().getModeType() = Crypto::KeyOpAlg::ECB() or
+      this.getModeOfOperation().getModeType() = Crypto::KeyOpAlg::CFB() or
+      this.getModeOfOperation().getModeType() = Crypto::KeyOpAlg::OFB() or
+      this.getModeOfOperation().getModeType() = Crypto::KeyOpAlg::CTR()
+    )
+  }
+}
+
+from Crypto::KeyOperationNode op, Crypto::KeyOperationOutputNode codeNode
+where
+  op.getAKnownAlgorithm() instanceof WeakAESBlockModeAlgNode and
+  codeNode = op.getAnOutputArtifact()
+select op, "Weak AES block mode instance."

java/ql/src/experimental/quantum/Analysis/WeakHashing.ql

@@ -0,0 +1,34 @@
+/**
+ * @name Weak hashes
+ * @description Finds uses of cryptographic hashing algorithms that are unapproved or otherwise weak.
+ * @id java/quantum/weak-hashes
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags external/cwe/cwe-327
+ *       quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+
+from Crypto::HashAlgorithmNode alg, Crypto::HashType htype, string msg
+where
+  htype = alg.getHashType() and
+  (
+    htype != Crypto::SHA2() and
+    msg = "Use of unapproved hash algorithm or API " + htype.toString() + "."
+    or
+    htype = Crypto::SHA2() and
+    not exists(alg.getDigestLength()) and
+    msg =
+      "Use of approved hash algorithm or API type " + htype.toString() + " but unknown digest size."
+    or
+    htype = Crypto::SHA2() and
+    alg.getDigestLength() < 256 and
+    msg =
+      "Use of approved hash algorithm or API type " + htype.toString() + " but weak digest size (" +
+        alg.getDigestLength() + ")."
+  )
+select alg, msg

java/ql/src/experimental/quantum/Analysis/WeakKDFIterationCount.ql

@@ -0,0 +1,20 @@
+/**
+ * @name Weak known key derivation function iteration count
+ * @description Detects key derivation operations with a known weak iteration count.
+ * @id java/quantum/weak-kdf-iteration-count
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+
+from Crypto::KeyDerivationOperationNode op, Literal l
+where
+  op.getIterationCount().asElement() = l and
+  l.getValue().toInt() < 100000
+select op, "Key derivation operation configures iteration count below 100k: $@", l,
+  l.getValue().toString()

java/ql/src/experimental/quantum/Analysis/WeakKDFKeySize.ql

@@ -0,0 +1,20 @@
+/**
+ * @name Weak known key derivation function output length
+ * @description Detects key derivation operations with a known weak output length
+ * @id java/quantum/weak-kdf-key-size
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+
+from Crypto::KeyDerivationOperationNode op, Literal l
+where
+  op.getOutputKeySize().asElement() = l and
+  l.getValue().toInt() < 256
+select op, "Key derivation operation configures output key length below 256: $@", l,
+  l.getValue().toString()

java/ql/src/experimental/quantum/Analysis/WeakRSA.ql

@@ -0,0 +1,25 @@
+/**
+ * @name Cipher is Weak RSA Implementation
+ * @id java/quantum/weak-rsa
+ * @description RSA with a key length <2048 found
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags quantum
+ *       experimental
+ */
+
+import experimental.quantum.Language
+
+class WeakRsaAlgorithmNode extends Crypto::KeyOperationAlgorithmNode {
+  WeakRsaAlgorithmNode() {
+    this.getAlgorithmType() = Crypto::KeyOpAlg::TAsymmetricCipher(Crypto::KeyOpAlg::RSA()) and
+    this.getKeySizeFixed() < 2048
+  }
+}
+
+from Crypto::KeyOperationNode op, string message
+where
+  op.getAKnownAlgorithm() instanceof WeakRsaAlgorithmNode and
+  message = "Weak RSA instance found with key length <2048"
+select op, message

java/ql/src/experimental/quantum/Analysis/WeakSymmetricCiphers.ql

@@ -0,0 +1,30 @@
+/**
+ * @name Weak symmetric ciphers
+ * @description Finds uses of cryptographic symmetric cipher algorithms that are unapproved or otherwise weak.
+ * @id java/quantum/weak-ciphers
+ * @kind problem
+ * @problem.severity error
+ * @precision high
+ * @tags external/cwe/cwe-327
+ *       quantum
+ *       experimental
+ */
+
+import java
+import experimental.quantum.Language
+import Crypto::KeyOpAlg as KeyOpAlg
+
+from Crypto::KeyOperationAlgorithmNode alg, KeyOpAlg::AlgorithmType algType, string msg
+where
+  algType = alg.getAlgorithmType() and
+  (
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::DES()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::TRIPLE_DES()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::DOUBLE_DES()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::RC2()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::RC4()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::IDEA()) or
+    algType = KeyOpAlg::TSymmetricCipher(KeyOpAlg::BLOWFISH())
+  ) and
+  msg = "Use of unapproved symmetric cipher algorithm or API: " + algType.toString() + "."
+select alg, msg

shared/quantum/codeql/quantum/experimental/Model.qll

@@ -825,20 +825,20 @@ module CryptographyBase<LocationSig Location, InputSig<Location> Input> {
      */
     abstract string getRawEllipticCurveName();
 
-    abstract TEllipticCurveFamilyType getEllipticCurveFamilyType();
+    abstract TEllipticCurveType getEllipticCurveType();
 
     abstract int getKeySize();
 
     /**
      * The 'parsed' curve name, e.g., "P-256" or "secp256r1"
-     * The parsed name is full name of the curve, including the family, key size, and other
+     * The parsed name is full name of the curve, including the type, key size, and other
      * typical parameters found on the name.
      *
      * In many cases this will be equivalent to `getRawEllipticCurveAlgorithmName()`,
      * but not always (e.g., if the curve is specified through a raw NID).
      *
      * In cases like an NID, we want the standardized name so users can quickly
-     * understand what the curve is, while also parsing out the family and key size
+     * understand what the curve is, while also parsing out the type and key size
      * separately.
      */
     string getParsedEllipticCurveName() { result = this.getRawEllipticCurveName() }
@@ -854,7 +854,7 @@ module CryptographyBase<LocationSig Location, InputSig<Location> Input> {
     /**
      * Gets the type of this digest algorithm, e.g., "SHA1", "SHA2", "MD5" etc.
      */
-    abstract THashType getHashFamily();
+    abstract THashType getHashType();
 
     /**
      * Gets the isolated name as it appears in source, e.g., "SHA-256" in "SHA-256/PKCS7Padding".
@@ -2293,13 +2293,13 @@ module CryptographyBase<LocationSig Location, InputSig<Location> Input> {
      *
      * When modeling a new hashing algorithm, use this predicate to specify the type of the algorithm.
      */
-    HashType getHashFamily() { result = instance.asAlg().getHashFamily() }
+    HashType getHashType() { result = instance.asAlg().getHashType() }
 
-    override string getAlgorithmName() { result = this.getHashFamily().toString() }
+    override string getAlgorithmName() { result = this.getHashType().toString() }
 
     int getDigestLength() {
       result = instance.asAlg().getFixedDigestLength() or
-      fixedImplicitDigestLength(instance.asAlg().getHashFamily(), result)
+      fixedImplicitDigestLength(instance.asAlg().getHashType(), result)
     }
 
     final override predicate properties(string key, string value, Location location) {
@@ -2340,9 +2340,7 @@ module CryptographyBase<LocationSig Location, InputSig<Location> Input> {
 
     override string getAlgorithmName() { result = this.getRawAlgorithmName() }
 
-    EllipticCurveFamilyType getEllipticCurveFamilyType() {
-      result = instance.asAlg().getEllipticCurveFamilyType()
-    }
+    EllipticCurveType getEllipticCurveType() { result = instance.asAlg().getEllipticCurveType() }
 
     override predicate properties(string key, string value, Location location) {
       super.properties(key, value, location)