Starting playbooks (#2297)

* starting playbooks Signed-off-by: 0ssigeno <s.berni@certego.net> * Not starting Signed-off-by: 0ssigeno <s.berni@certego.net> * Fix migration Signed-off-by: 0ssigeno <s.berni@certego.net> * Prettier Signed-off-by: 0ssigeno <s.berni@certego.net> * Fix Signed-off-by: 0ssigeno <s.berni@certego.net> --------- Signed-off-by: 0ssigeno <s.berni@certego.net>
intelowlproject · May 7, 2024 · 6e8de55 · 6e8de55
1 parent b50311c
commit 6e8de55
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 2 deletions.
diff --git a/api_app/playbooks_manager/admin.py b/api_app/playbooks_manager/admin.py
@@ -21,9 +21,12 @@ class PlaybookConfigAdminView(AbstractConfigAdminView, ModelWithOwnershipAdminVi
         "get_pivots",
         "get_visualizers",
         "scan_mode",
+        "starting",
     ) + ModelWithOwnershipAdminView.list_display
     list_filter = (
-        AbstractConfigAdminView.list_filter + ModelWithOwnershipAdminView.list_filter
+        AbstractConfigAdminView.list_filter
+        + ("starting",)
+        + ModelWithOwnershipAdminView.list_filter
     )
 
     @staticmethod

diff --git a/api_app/playbooks_manager/migrations/0036_static_analyzer_remove_visualizer.py b/api_app/playbooks_manager/migrations/0036_static_analyzer_remove_visualizer.py
@@ -32,6 +32,7 @@ def reverse_migrate(apps, schema_editor):
 class Migration(migrations.Migration):
     dependencies = [
         ("playbooks_manager", "0035_playbook_config_takedown_request"),
+        ("visualizers_manager", "0037_4_change_primary_key"),
     ]
 
     operations = [

diff --git a/api_app/playbooks_manager/migrations/0037_playbookconfig_starting.py b/api_app/playbooks_manager/migrations/0037_playbookconfig_starting.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2.11 on 2024-05-07 13:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("playbooks_manager", "0036_static_analyzer_remove_visualizer"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="playbookconfig",
+            name="starting",
+            field=models.BooleanField(
+                default=True,
+                help_text="If False, the playbook can only be executed by pivots",
+            ),
+        ),
+    ]
diff --git a/api_app/playbooks_manager/migrations/0038_playbooks_not_starting.py b/api_app/playbooks_manager/migrations/0038_playbooks_not_starting.py
@@ -0,0 +1,29 @@
+# Generated by Django 4.2.11 on 2024-05-07 13:54
+
+from django.db import migrations
+
+playbooks_to_change = ["Abuse_IP"]
+
+
+def migrate(apps, schema_editor):
+    PlaybookConfig = apps.get_model("playbooks_manager", "PlaybookConfig")
+    for pc in PlaybookConfig.objects.filter(name__in=playbooks_to_change):
+        pc.starting = False
+        pc.save()
+
+
+def reverse_migrate(apps, schema_editor):
+    PlaybookConfig = apps.get_model("playbooks_manager", "PlaybookConfig")
+    for pc in PlaybookConfig.objects.filter(name__in=playbooks_to_change):
+        pc.starting = True
+        pc.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("playbooks_manager", "0037_playbookconfig_starting"),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate, reverse_migrate),
+    ]
diff --git a/api_app/playbooks_manager/models.py b/api_app/playbooks_manager/models.py
@@ -51,6 +51,10 @@ class PlaybookConfig(AbstractConfig, OwnershipAbstractModel):
 
     tlp = models.CharField(max_length=8, choices=TLP.choices)
 
+    starting = models.BooleanField(
+        default=True, help_text="If False, the playbook can only be executed by pivots"
+    )
+
     class Meta:
         ordering = ["name", "disabled"]
         indexes = OwnershipAbstractModel.Meta.indexes

diff --git a/authentication/migrations/0006_alter_userprofile_company_name_and_more.py b/authentication/migrations/0006_alter_userprofile_company_name_and_more.py
@@ -0,0 +1,24 @@
+# Generated by Django 4.2.11 on 2024-05-07 13:54
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('authentication', '0005_create_profiles'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='userprofile',
+            name='company_name',
+            field=models.CharField(blank=True, default='', max_length=32, validators=[django.core.validators.MinLengthValidator(3)]),
+        ),
+        migrations.AlterField(
+            model_name='userprofile',
+            name='company_role',
+            field=models.CharField(blank=True, default='', max_length=32, validators=[django.core.validators.MinLengthValidator(3)]),
+        ),
+    ]
diff --git a/frontend/src/components/scan/ScanForm.jsx b/frontend/src/components/scan/ScanForm.jsx
@@ -386,6 +386,7 @@ export default function ScanForm() {
     playbooksGrouped[classification]
       .map((playbook) => ({
         isDisabled: playbook.disabled,
+        starting: playbook.starting,
         value: playbook.name,
         analyzers: playbook.analyzers,
         connectors: playbook.connectors,
@@ -411,7 +412,7 @@ export default function ScanForm() {
         scan_check_time: playbook.scan_check_time,
         runtime_configuration: playbook.runtime_configuration,
       }))
-      .filter((item) => !item.isDisabled);
+      .filter((item) => !item.isDisabled && item.starting);
 
   const updateAdvancedConfig = (
     tags,

diff --git a/frontend/tests/mock.js b/frontend/tests/mock.js
@@ -125,6 +125,7 @@ export const mockedPlaybooks = {
       },
     ],
     tlp: "CLEAR",
+    starting: true,
   },
   TEST_PLAYBOOK_DOMAIN: {
     name: "TEST_PLAYBOOK_DOMAIN",
@@ -142,6 +143,7 @@ export const mockedPlaybooks = {
     scan_check_time: "02:00:00:00",
     tags: [],
     tlp: "CLEAR",
+    starting: true,
   },
   TEST_PLAYBOOK_URL: {
     name: "TEST_PLAYBOOK_URL",
@@ -159,6 +161,7 @@ export const mockedPlaybooks = {
     scan_check_time: null,
     tags: [],
     tlp: "AMBER",
+    starting: true,
   },
   TEST_PLAYBOOK_HASH: {
     name: "TEST_PLAYBOOK_HASH",
@@ -176,6 +179,7 @@ export const mockedPlaybooks = {
     scan_check_time: null,
     tags: [],
     tlp: "AMBER",
+    starting: true,
   },
   TEST_PLAYBOOK_FILE: {
     name: "TEST_PLAYBOOK_FILE",
@@ -193,6 +197,7 @@ export const mockedPlaybooks = {
     scan_check_time: null,
     tags: [],
     tlp: "AMBER",
+    starting: true,
   },
   TEST_PLAYBOOK_GENERIC: {
     name: "TEST_PLAYBOOK_GENERIC",
@@ -210,6 +215,7 @@ export const mockedPlaybooks = {
     scan_check_time: null,
     tags: [],
     tlp: "AMBER",
+    starting: true,
   },
 };