More precise testing of plugins

Instead of relying on a count of the severity and confidence levels found within an example file, make use of Python's native unit testing to verify the results of a plugin. The existing method of confirming counts can be inaccurate. It's very easy to have a false positive simply because one issue extra was found and one issue was missed, thus giving the same count. It tells nothing of the validation of a particular line of problematic code. Relates to #352 Signed-off-by: Eric Brown <[email protected]>
PyCQA · Apr 7, 2023 · 8c193a4 · 8c193a4
1 parent 36fc7be
commit 8c193a4
Show file tree

Hide file tree

Showing 49 changed files with 8,219 additions and 535 deletions.
diff --git a/tests/functional/test_functional.py b/tests/functional/test_functional.py
diff --git a/tests/unit/blacklists/base_test_case.py b/tests/unit/blacklists/base_test_case.py
@@ -0,0 +1,33 @@
+# SPDX-License-Identifier: Apache-2.0
+import testtools
+
+from bandit.core import config
+from bandit.core import manager
+from bandit.core import meta_ast
+from bandit.core import metrics
+from bandit.core import node_visitor
+from bandit.core import test_set
+
+
+class BaseTestCase(testtools.TestCase):
+    def setUp(self, test_ids):
+        super().setUp()
+        self.b_config = config.BanditConfig()
+        self.b_manager = manager.BanditManager(self.b_config, "file")
+        issue_metrics = metrics.Metrics()
+        issue_metrics.begin("test.py")
+        self.visitor = node_visitor.BanditNodeVisitor(
+            "test.py",
+            None,
+            metaast=meta_ast.BanditMetaAst(),
+            testset=test_set.BanditTestSet(
+                self.b_config,
+                profile={
+                    "include": test_ids,
+                    "exclude": [],
+                },
+            ),
+            debug=False,
+            nosec_lines={},
+            metrics=issue_metrics,
+        )
diff --git a/tests/unit/blacklists/test_cipher_call.py b/tests/unit/blacklists/test_cipher_call.py
@@ -0,0 +1,297 @@
+# SPDX-License-Identifier: Apache-2.0
+import textwrap
+
+import bandit
+from bandit.core import issue as b_issue
+from tests.unit.blacklists import base_test_case
+
+
+class CipherCallTests(base_test_case.BaseTestCase):
+    def setUp(self):
+        super().setUp(["B304"])
+
+    def test_crypto_cipher_arc2_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Crypto.Cipher import ARC2 as pycrypto_arc2
+            from Crypto import Random
+            key = b'Sixteen byte key'
+            iv = Random.new().read(pycrypto_arc2.block_size)
+            pycrypto_arc2.new(key, pycrypto_arc2.MODE_CFB, iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(6, issue.lineno)
+        self.assertEqual([6], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_crypto_cipher_arc4_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Crypto.Cipher import ARC4 as pycrypto_arc4
+            from Crypto import Random
+            key = b'Very long and confidential key'
+            nonce = Random.new().read(16)
+            tempkey = SHA.new(key+nonce).digest()
+            pycrypto_arc4.new(tempkey)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_crypto_cipher_blowfish_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Crypto.Cipher import Blowfish as pycrypto_blowfish
+            from Crypto import Random
+            key = b'An arbitrarily long key'
+            bs = pycrypto_blowfish.block_size
+            iv = Random.new().read(bs)
+            pycrypto_blowfish.new(key, pycrypto_blowfish.MODE_CBC, iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_crypto_cipher_des_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Crypto.Cipher import DES as pycrypto_des
+            from Crypto import Random
+            nonce = Random.new().read(pycrypto_des.block_size / 2)
+            ctr = Counter.new(pycrypto_des.block_size * 8 / 2, prefix=nonce)
+            pycrypto_des.new(key, pycrypto_des.MODE_CTR, counter=ctr)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(6, issue.lineno)
+        self.assertEqual([6], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_crypto_cipher_xor_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Crypto.Cipher import XOR as pycrypto_xor
+            key = b'Super secret key'
+            pycrypto_xor.new(key)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(4, issue.lineno)
+        self.assertEqual([4], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptodome_cipher_arc2_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Cryptodome.Cipher import ARC2 as pycryptodomex_arc2
+            from Crypto import Random
+            key = b'Sixteen byte key'
+            iv = Random.new().read(pycryptodomex_arc2.block_size)
+            pycryptodomex_arc2.new(key, pycryptodomex_arc2.MODE_CFB, iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(6, issue.lineno)
+        self.assertEqual([6], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptodome_cipher_arc4_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Cryptodome.Cipher import ARC4 as pycryptodomex_arc4
+            from Cryptodome import Random
+            key = b'Very long and confidential key'
+            nonce = Random.new().read(16)
+            tempkey = SHA.new(key + nonce).digest()
+            pycryptodomex_arc4.new(tempkey)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptodome_cipher_blowfish_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Cryptodome.Cipher import Blowfish as pycryptodomex_blowfish
+            from Cryptodome import Random
+            key = b'An arbitrarily long key'
+            bs = pycryptodomex_blowfish.block_size
+            iv = Random.new().read(bs)
+            mode = pycryptodomex_blowfish.MODE_CBC
+            pycryptodomex_blowfish.new(key, mode, iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(8, issue.lineno)
+        self.assertEqual([8], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptodome_cipher_des_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Cryptodome.Cipher import DES as pycryptodomex_des
+            from Cryptodome import Random
+            nonce = Random.new().read(pycryptodomex_des.block_size / 2)
+            ctr = Counter.new(pycryptodomex_des.block_size * 8/2, prefix=nonce)
+            pycryptodomex_des.new(key, pycryptodomex_des.MODE_CTR, counter=ctr)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(6, issue.lineno)
+        self.assertEqual([6], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptodome_cipher_xor_new(self):
+        fdata = textwrap.dedent(
+            """
+            from Cryptodome.Cipher import XOR as pycryptodomex_xor
+            key = b'Super secret key'
+            pycryptodomex_xor.new(key)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(4, issue.lineno)
+        self.assertEqual([4], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cryptography_ciphers_algorithms_arc4(self):
+        fdata = textwrap.dedent(
+            """
+            from cryptography.hazmat.primitives.ciphers import Cipher
+            from cryptography.hazmat.primitives.ciphers import algorithms
+            from cryptography.hazmat.backends import default_backend
+            key = b'Super secret key'
+            Cipher(
+                algorithms.ARC4(key),
+                mode=None,
+                backend=default_backend()
+            )
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(4, issue.col_offset)
+
+    def test_cryptography_ciphers_algorithms_blowfish(self):
+        fdata = textwrap.dedent(
+            """
+            from cryptography.hazmat.primitives.ciphers import Cipher
+            from cryptography.hazmat.primitives.ciphers import algorithms
+            from cryptography.hazmat.backends import default_backend
+            key = b'Super secret key'
+            Cipher(
+                algorithms.Blowfish(key),
+                mode=None,
+                backend=default_backend()
+            )
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(4, issue.col_offset)
+
+    def test_cryptography_ciphers_algorithms_idea(self):
+        fdata = textwrap.dedent(
+            """
+            from cryptography.hazmat.primitives.ciphers import Cipher
+            from cryptography.hazmat.primitives.ciphers import algorithms
+            from cryptography.hazmat.backends import default_backend
+            key = b'Super secret key'
+            Cipher(
+                algorithms.IDEA(key),
+                mode=None,
+                backend=default_backend(),
+            )
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B304", issue.test_id)
+        self.assertEqual(bandit.HIGH, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(7, issue.lineno)
+        self.assertEqual([7], issue.linerange)
+        self.assertEqual(4, issue.col_offset)
diff --git a/tests/unit/blacklists/test_cipher_modes.py b/tests/unit/blacklists/test_cipher_modes.py
@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: Apache-2.0
+import textwrap
+
+import bandit
+from bandit.core import issue as b_issue
+from tests.unit.blacklists import base_test_case
+
+
+class CipherModesTests(base_test_case.BaseTestCase):
+    def setUp(self):
+        super().setUp(["B305"])
+
+    def test_cipher_mode_ecb(self):
+        fdata = textwrap.dedent(
+            """
+            import os
+            from cryptography.hazmat.primitives.ciphers.modes import ECB
+            iv = os.urandom(16)
+            ECB(iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(1, len(self.visitor.tester.results))
+        issue = self.visitor.tester.results[0]
+        self.assertEqual("B305", issue.test_id)
+        self.assertEqual(bandit.MEDIUM, issue.severity)
+        self.assertEqual(bandit.HIGH, issue.confidence)
+        self.assertEqual(b_issue.Cwe.BROKEN_CRYPTO, issue.cwe.id)
+        self.assertEqual(5, issue.lineno)
+        self.assertEqual([5], issue.linerange)
+        self.assertEqual(0, issue.col_offset)
+
+    def test_cipher_mode_ctr(self):
+        fdata = textwrap.dedent(
+            """
+            import os
+            from cryptography.hazmat.primitives.ciphers import algorithms
+            from cryptography.hazmat.primitives.ciphers import modes
+            key = os.urandom(32)
+            iv = os.urandom(16)
+            algorithms.AES.new(key, modes.CTR, iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(0, len(self.visitor.tester.results))
+
+    def test_cipher_mode_cbc(self):
+        fdata = textwrap.dedent(
+            """
+            import os
+            from cryptography.hazmat.primitives.ciphers.modes import CBC
+            iv = os.urandom(16)
+            CBC(iv)
+            """
+        )
+        self.visitor.process(fdata)
+        self.assertEqual(0, len(self.visitor.tester.results))