Merge pull request #20 from ByteInternet/add-method-for-blocking-bots

add method for blocking various attacks

Author: vdloo

hypernode_api_python/client.py

@@ -16,6 +16,7 @@
 HYPERNODE_API_APP_XGRADE_CHECK_ENDPOINT = "/v2/app/xgrade/{}/check/{}/"
 HYPERNODE_API_APP_XGRADE_ENDPOINT = "/v2/app/xgrade/{}/"
 HYPERNODE_API_BACKUPS_ENDPOINT = "/v2/app/{}/backup/"
+HYPERNODE_API_BLOCK_ATTACK_ENDPOINT = "/v2/app/{}/block_attack/"
 HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT = "/v2/app/block_attack_descriptions/"
 HYPERNODE_API_BRANCHER_APP_ENDPOINT = "/v2/brancher/app/{}/"
 HYPERNODE_API_BRANCHER_ENDPOINT = "/v2/brancher/{}/"
@@ -411,7 +412,7 @@ def get_block_attack_descriptions(self):
         by automatically placing an NGINX snippet in /data/web/nginx if the
         specified block is compatible with the current NGINX configuration.
         Example:
-        >    client.requests("GET", "/v2/app/block_attack_descriptions/").json()
+        >    client.get_block_attack_descriptions().json()
         >    {
         >        'BlockSqliBruteForce': 'Attempts to deploy NGINX rules to block suspected (blind) SQL injection attack',
         >        ...
@@ -421,6 +422,27 @@ def get_block_attack_descriptions(self):
         """
         return self.requests("GET", HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT)
 
+    def block_attack(self, app_name, attack_name):
+        """
+        Attempts to deploy one of the block attack rules. The list of rules can be retrieved with the
+        get_block_attack_descriptions method. This will place an NGINX snippet to block the specified attack
+        in /data/web/nginx. If the nginx-config-validator detects that the new config is valid, it will leave
+        the newly placed config. Otherwise it will be removed again.
+
+        Example:
+        >    client.block_attack('yourhypernodeappname', 'BlockSqliBruteForce').ok
+        >    True
+
+        :param str app_name: The name of the Hypernode you want to deploy the block attack nginx configuration on
+        :param str attack_name: The specific attack you want to block. See get_block_attack_descriptions for options.
+        :return obj response: The request response object
+        """
+        return self.requests(
+            "POST",
+            HYPERNODE_API_BLOCK_ATTACK_ENDPOINT.format(app_name),
+            data={"attack_name": attack_name},
+        )
+
     def get_whitelist_options(self, app_name):
         """
         Get whitelist options for app. Retrieve the options for specifying

tests/client/test_block_attack.py

@@ -0,0 +1,39 @@
+from unittest import TestCase
+from unittest.mock import Mock
+
+from hypernode_api_python.client import (
+    HYPERNODE_API_BLOCK_ATTACK_ENDPOINT,
+    HypernodeAPIPython,
+)
+
+
+class TestBlockAttack(TestCase):
+    def setUp(self):
+        self.client = HypernodeAPIPython(token="my_token")
+        self.mock_request = Mock()
+        self.client.requests = self.mock_request
+        self.app_name = "my_app"
+
+    def test_block_attack_endpoint_is_correct(self):
+        self.assertEqual(
+            "/v2/app/{}/block_attack/", HYPERNODE_API_BLOCK_ATTACK_ENDPOINT
+        )
+
+    def test_calls_block_attack_endpoint_correctly(self):
+        self.client.block_attack(self.app_name, "BlockSqliBruteForce")
+
+        self.mock_request.assert_called_once_with(
+            "POST",
+            f"/v2/app/{self.app_name}/block_attack/",
+            data={"attack_name": "BlockSqliBruteForce"},
+        )
+
+    def test_returns_block_attack_data(self):
+        response = Mock()
+        response.status_code = 202
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.block_attack(self.app_name, "BlockSqliBruteForce"),
+            self.mock_request.return_value,
+        )