feat(anta): Added the test case to verify the Entropy source security (…

…#780)
aristanetworks · Aug 21, 2024 · 61e206e · 61e206e
1 parent b9f95ae
commit 61e206e
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/anta/tests/security.py b/anta/tests/security.py
@@ -820,3 +820,37 @@ def test(self) -> None:
                     self.result.is_failure(
                         f"IPv4 security connection `source:{source_input} destination:{destination_input} vrf:{vrf}` for peer `{peer}` is not found."
                     )
+
+
+class VerifyHardwareEntropy(AntaTest):
+    """
+    Verifies hardware entropy generation is enabled on device.
+
+    Expected Results
+    ----------------
+    * Success: The test will pass if hardware entropy generation is enabled.
+    * Failure: The test will fail if hardware entropy generation is not enabled.
+
+    Examples
+    --------
+    ```yaml
+    anta.tests.security:
+      - VerifyHardwareEntropy:
+    ```
+    """
+
+    name = "VerifyHardwareEntropy"
+    description = "Verifies hardware entropy generation is enabled on device."
+    categories: ClassVar[list[str]] = ["security"]
+    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show management security")]
+
+    @AntaTest.anta_test
+    def test(self) -> None:
+        """Main test function for VerifyHardwareEntropy."""
+        command_output = self.instance_commands[0].json_output
+
+        # Check if hardware entropy generation is enabled.
+        if not command_output.get("hardwareEntropyEnabled"):
+            self.result.is_failure("Hardware entropy generation is disabled.")
+        else:
+            self.result.is_success()
diff --git a/examples/tests.yaml b/examples/tests.yaml
@@ -354,6 +354,7 @@ anta.tests.security:
               destination_address: 100.64.2.2
             - source_address: 172.18.3.2
               destination_address: 172.18.2.2
+  - VerifyHardwareEntropy:
 
 anta.tests.services:
   - VerifyHostname:

diff --git a/tests/units/anta_tests/test_security.py b/tests/units/anta_tests/test_security.py
@@ -15,6 +15,7 @@
     VerifyAPISSLCertificate,
     VerifyBannerLogin,
     VerifyBannerMotd,
+    VerifyHardwareEntropy,
     VerifyIPSecConnHealth,
     VerifyIPv4ACL,
     VerifySpecificIPSecConn,
@@ -1213,4 +1214,18 @@
             ],
         },
     },
+    {
+        "name": "success",
+        "test": VerifyHardwareEntropy,
+        "eos_data": [{"cpuModel": "2.20GHz", "cryptoModule": "Crypto Module v3.0", "hardwareEntropyEnabled": True, "blockedNetworkProtocols": []}],
+        "inputs": {},
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure",
+        "test": VerifyHardwareEntropy,
+        "eos_data": [{"cpuModel": "2.20GHz", "cryptoModule": "Crypto Module v3.0", "hardwareEntropyEnabled": False, "blockedNetworkProtocols": []}],
+        "inputs": {},
+        "expected": {"result": "failure", "messages": ["Hardware entropy generation is disabled."]},
+    },
 ]