Possibility to disable modules by default (#728)

CERT-Polska · Jan 19, 2024 · fccf63f · fccf63f
1 parent 4146e08
commit fccf63f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/artemis/config.py b/artemis/config.py
@@ -189,6 +189,11 @@ class Miscellaneous:
             "In order not to overload the DB and bandwidth, this determines how long the downloaded content would be (in bytes).",
         ] = get_config("CONTENT_PREFIX_SIZE", default=1024 * 100, cast=int)
 
+        MODULES_DISABLED_BY_DEFAULT: Annotated[
+            List[str],
+            "Artemis modules that are disabled by default (but may easily be enabled in the UI)",
+        ] = get_config("MODULES_DISABLED_BY_DEFAULT", default="humble", cast=decouple.Csv(str, delimiter=","))
+
         SUBDOMAIN_ENUMERATION_TTL_DAYS: Annotated[
             int,
             "If we request a domain for subdomain enumeration, we will save that it has already been enumerated, so that e.g. "

diff --git a/artemis/frontend.py b/artemis/frontend.py
@@ -10,6 +10,7 @@
 from karton.core.inspect import KartonState
 from starlette.datastructures import Headers
 
+from artemis.config import Config
 from artemis.db import DB, ColumnOrdering, TaskFilter
 from artemis.json_utils import JSONEncoderAdditionalTypes
 from artemis.karton_utils import restart_crashed_tasks
@@ -79,7 +80,14 @@ def get_root(request: Request) -> Response:
 def get_add_form(request: Request) -> Response:
     binds = sorted(get_binds_that_can_be_disabled(), key=lambda bind: bind.identity.lower())
 
-    return templates.TemplateResponse("add.jinja2", {"request": request, "binds": binds})
+    return templates.TemplateResponse(
+        "add.jinja2",
+        {
+            "request": request,
+            "binds": binds,
+            "modules_disabled_by_default": Config.Miscellaneous.MODULES_DISABLED_BY_DEFAULT,
+        },
+    )
 
 
 @router.post("/add", include_in_schema=False)

diff --git a/templates/add.jinja2 b/templates/add.jinja2
@@ -35,13 +35,20 @@
             (<a href="" onclick="setSelectionForAllModules(true); return false;">select all</a>
             <a href="" onclick="setSelectionForAllModules(false); return false;">unselect all</a>)
 
+            {% if modules_disabled_by_default %}
+                <div class="alert alert-info">
+                    The following modules are disabled by default: {{ ", ".join(modules_disabled_by_default) }}. Select the checkbox to start them.
+                    To change this, update the <tt>MODULES_DISABLED_BY_DEFAULT</tt> setting.
+                </div>
+            {% endif %}
+
             <input type="hidden" name="choose_modules_to_enable" value="1">
 
             <div class="row m-0">
                 {% for bind in binds %}
                     <div class="form-check col-md-4">
                         <label class="form-check-label">
-                            <input class="form-check-input" type="checkbox" value="" name="module_enabled_{{ bind.identity }}" checked>
+                            <input class="form-check-input" type="checkbox" value="" name="module_enabled_{{ bind.identity }}" {% if bind.identity not in modules_disabled_by_default %}checked{% endif %}>
                             {{ bind.identity }}<br/>
                             <span class="small text-muted">{{ bind.info|dedent|render_markdown|safe }}</span>
                         </label>